Kony MobileFabricTM Integration Service - Manual Upgrade

Release 7.2

Document Relevance and Accuracy

This document is considered relevant to the Release stated on this title page and the document version stated on the Revision History page. Remember to always view and download the latest document version relevant to the software release you are using.

© 2016 by Kony, Inc. All rights reserved 1 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Copyright © 2013 by Kony, Inc.

All rights reserved.

October, 2016

This document contains information proprietary to Kony, Inc., is bound by the Kony license agreements and may not be used except in the context of understanding the use and methods of Kony Inc, software without prior, express, written permission. Kony, Empowering Everywhere, Kony MobileFabric, Kony Nitro, and Kony Visualizer are trademarks of Kony, Inc. Microsoft, the Microsoft logo, Internet Explorer, Windows, and Windows Vista are registered trademarks of Microsoft Corporation. Apple, the Apple logo, iTunes, iPhone, iPad, OS X, Objective-, Safari, Apple Pay, Apple Watch and Xcode are trademarks or registered trademarks of Apple, Inc. Google, the Google logo, Android, and the Android logo are registered trademarks of Google, Inc. Chrome is a trademark of Google, Inc. BlackBerry, PlayBook, Research in Motion, and RIM are registered trademarks of BlackBerry. All other terms, trademarks, or service marks mentioned in this document have been capitalized and are to be considered the property of their respective owners.

© 2016 by Kony, Inc. All rights reserved 2 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Revision History

Date Document Description of Modifications/Release Version

10/24/2016 1.3 Document updated for release 7.2

07/20/2016 1.2 Document updated for release 7.1

06/10/2016 1.1 Appended new section Upgrading Tomcat from 5.0.x to 7.0.x.

03/22/2016 1.0 Document updated for 7.0 release.

© 2016 by Kony, Inc. All rights reserved 3 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Table of Contents

1. Preface 5

1.1 Purpose 6

1.2 Intended Audience 6

1.3 Formatting Conventions 6

1.4 Contact Us 8

2. Prerequisites 9

2.1 Hardware Requirements 9

2.2 Software System Requirements 9

3. Upgrading Kony MobileFabric Integration Service 10

3.1 Upgrading Kony MobileFabric Integration Service - Tomcat 10

3.2 Upgrading Kony MobileFabric Integration Service - JBoss 39

3.3 Upgrading Kony MobileFabric Integration Service - WebSphere 73

3.4 Upgrading Kony MobileFabric Integration Service - WebLogic 108

© 2016 by Kony, Inc. All rights reserved 4 of 130 1. Preface Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Preface

Kony Platform provides an integrated approach in the mobile application design, development, and management in a device independent manner and delivers the applications in different formats that run on all the major device platforms.

The Kony Platform consists of three main components:

l Kony Visulaizer: Used to design and develop the mobile applications.

l Kony MobileFabric Integration Service: Provides server side functionality for the applications, common data integration, and device support services

l Client Runtime: A component for each major device platform that enables the same mobile application to execute directly on the device.

Kony MobileFabric Integration Service

The Kony MobileFabric Integration Service is an important component of the Kony Platform installation. The Kony MobileFabric Integration Service acts as a gateway for Kony applications to access the existing services and web sites in your organization. The application functionality developed and generated by the Kony Studio is enabled and delivered using the Application Server. The SMS and Mobile Web channels are hosted on the Application Server and the Native App binaries are deployed to the server, which can be downloaded to the device.

The Application Server has the following features:

l A sophisticated device database which enables it to detect and deliver the appropriate binary to a requesting device.

l Inbuilt backend data services integration capability, with out-of-the-box support for Web Services, XML feeds and HTML extraction.

l Integration with optional third party connector libraries that offer access to a large number of ERP, database and legacy systems.

© 2016 by Kony, Inc. All rights reserved 5 of 130 1. Preface Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

l Built in usage tracking and analysis capability that provides a wide range of reports on system and application usage.

Important: Kony recommends using the MobileFabric Installer for deploying MobileFabric 7.0 onwards.

If you are required to install MobileFabric manually due to your business rules and policies, please contact [email protected] for approval and to obtain access to the MobileFabric manual install artifacts. Manual installs not approved by Kony will not be supported.

1.1 Purpose

This document describes the steps for manual upgrading of the Kony MobileFabric Integration Service.

1.2 Intended Audience

This document is intended for engineers or system administrators who are responsible for manually upgrading the Kony MobileFabric Integration Service. We assume that the reader of this document is familiar with deploying and installing MobileFabric application.

1.3 Formatting Conventions

Following are the formatting conventions used throughout the document:

© 2016 by Kony, Inc. All rights reserved 6 of 130 1. Preface Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Convention Explanation

Monospace l User input text, system prompts, and responses

l File path

l Commands

l Program code

l File names

Italic l Emphasis

l Names of books and documents

l New terminology

Bold l Windows

l Menus

l Buttons

l Icons

l Fields

l Tabs

URL Active link to a URL

Provides helpful hints or additional information Note:

Highlights actions or information that might cause Important: problems to systems or data

© 2016 by Kony, Inc. All rights reserved 7 of 130 1. Preface Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1.4 Contact Us

We welcome your feedback on our documentation. Write to us at [email protected]. For technical questions, suggestions, comments or to report problems on Kony's product line, contact [email protected].

© 2016 by Kony, Inc. All rights reserved 8 of 130 2. Prerequisites Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

2. Prerequisites

The following sections provide you the information to understand the hardware requirements and essential software required to upgrade the Kony MobileFabric Integration Service.

2.1 Hardware Requirements

For Hardware requirements, click here.

2.2 Software System Requirements

For software system requirements, click here.

© 2016 by Kony, Inc. All rights reserved 9 of 130 3. Upgrading Kony MobileFabric Integration Kony MobileFabric Integration Service - Manual Service Upgrade Version 1.3

3. Upgrading Kony MobileFabric Integration Service

Assuming that you have prior installation of Integration Service. To upgrade Kony MobileFabric Integration Service manually on different Servers through different versions, follow the below links:

Server Versions

Tomcat 5.5.x/5.6.x to 6.5.x 6.0.x to 6.5.x 6.5.x to 7.0.x 5.0.x to 7.0.x

JBoss 5.5.x/5.6.x to 6.5.x 6.0.x to 6.5.x 6.5.x to 7.0.x

WebSphere 5.0.x/5.5.x/5.6.x to 6.0.x 6.0.x to 6.5.x

WebLogic 5.5.x/5.6.x to 6.5.x 6.0.x to 6.5.x 6.5.x to 7.0.x

3.1 Upgrading Kony MobileFabric Integration Service - Tomcat

Upgrade Kony MobileFabric Integration Service manually on Tomcat server through different versions by following the below links:

Server From Version To Version Link

Tomcat 5.5.x/5.6.x 6.5.x Click here

5.0.x 7.0.x Click here

6.0.x 6.5.x Click here

6.5.x 7.0.x Click here

© 2016 by Kony, Inc. All rights reserved 10 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.1.1 Upgrade Tomcat Manually from 5.5.x / 5.6.x to 6.5.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 5.6.x to 6.5.x (Tomcat).

3.1.1.1 Prerequisites

The following table displays the prerequisites for upgrading Kony MobileFabric Integration Service.

Refer to http://community.kony.com/downloads/manual to download the following artifacts:

Artifacts Type Purpose

Respective Database scripts Database To setup the required Scripts schema

l admin.war WAR files To be deployed to Application Server l middleware.war

l metrics.ear (applicable only for metrics)

(Advantages)

l middleware-bootconfig.tar TAR files

l libraries-MIDDLEWARE-GA-ver.tar

l Thin client JARs from JAR files http://community.kony.com/downloads/manual

© 2016 by Kony, Inc. All rights reserved 11 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Advantages of Upgrading with metrics.ear File

From Kony MobileFabric Integration Service 6.0 release, metrics.ear is required for reporting. The Admin module is enhanced for a better user experience and instead of depending on server user management, users are now stored in the database. To use the new features, you need to setup a database and install metrics.ear file.

Note: It is mandatory to install metrics.ear file along with admin.war.

The Kony Reports portal provides the following features:

1. Enhanced User Session - A strong method for reporting the true session count in a given date range.

2. Mechanism for tracking unique users per application.

3. Middleware sends data in the new format to the specified JMS queue. Then metrics.ear processes messages from the JMS queue.

4. Support for legacy reports. Following are the features of on-premise metrics along with legacy reports:

a. Kony MobileFabric Integration Service Message

b. Geo Location

c. Custom Metrics

d. Message Processing

e. JasperSoft Reporting

f. Basic Reporting

Note: For more information on Kony Reports, click here.

© 2016 by Kony, Inc. All rights reserved 12 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Important: If you do not want to use the Kony Reports, use your existing admin.war file (for example, use the war file you have for 5.6.x version). By using the existing admin.war file, you avoid the need for additional hardware or software.

3.1.1.2 Backup

To backup files, follow these steps:

1. Stop the application server.

2. Take a backup of the following files from your current server installation location.

a. .WAR files - These files are available at \tomcat\instance1\webapps\ .

l middleware.war

l admin.war

l reports.war

l appdownload.war

b. middleware-bootconfig directory

Sample path for middleware -bootconfig

c. middleware libraries (.JAR files) - The files are located at \\install\lib\\middleware.

d. After taking the backup, delete all the above files.

3. Retain the changes made to middleware.properties or middleware- log4j.poperties files for version 5.x.

© 2016 by Kony, Inc. All rights reserved 13 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.1.1.3 Database Upgrade for Legacy Reports

To upgrade the database for legacy reports, follow these steps:

Download and run the upgrade scripts from http://community.kony.com/downloads/manual to upgrade the database and enable legacy reports.

For example: If your database version is 5.0.3 Oracle, run the schemas in "Oracle_upgrade_5.0.3 to 5.0.6" folder in the numerical order.

Note: To enable the legacy reports, the database should be the latest 5.0.6. version. If your database is not latest, run the database scripts based on your database and upgrade to 5.0.6 version.

3.1.1.4 Execute Database Scripts

1. Execute the database scripts downloaded artifacts and create the new Admin and Reports schema.

Note: This is required for new metrics.

3.1.1.5 Add New and Update Existing Property Files middleware-bootconfig of 6.5.x is bundled with few additional .properties files compared to earlier versions that are required during the upgrade process. You would also need few .properties files from your backup location.

To add new and update existing property files, follow these steps:

1. Download and extract the middleware-bootconfig.tar file from http://community.kony.com/downloads/manual to the \install\middleware.

The following new property files extracted are applicable only for metrics

© 2016 by Kony, Inc. All rights reserved 14 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

a. metrics-log4j.properties in the middleware-bootconfig folder that is available under middleware home.

b. admin-log4j.properties and serverconsole.properties in the admin folder available under middleware-bootconfig.

Note: If admin was used previously, update the admin-log4j.properties file by adding the location to previously used admin.logas shown log4j.appender.file.File=${middleware.home} /../logs/admin.log.

2. Copy the deployment-config.properties file from your backup location to .

3. Update existing property files:

a. Update the middleware.properties file from \install\middleware\middleware-bootconfig with the configuration you have used with earlier version.

b. Open the file and add the following content at the end of the file.

Note: You must replace the credentials and IP addresses according to your environment.

################################################## #Metrics Topic Configuration (applicable only for metrics) ################################################## #To enable / disable metrics # it true, if Kony Reports enabled and Metrics Topic is

© 2016 by Kony, Inc. All rights reserved 15 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

configured metrics.logging=true metrics.TopicName=jms/KonyMetricsTopic

metrics.TopicConnectionFactoryName=jms/KonyConnectionFactor y

#For JBOSS JMS

metrics.initialContextFactoryName=org.jboss.naming.remote.c lient. InitialContextFactory metrics.providerURL=remote://

#For Weblogic JMS #metrics.initialContextFactoryName=weblogic.jndi. WLInitialContextFactory #metrics.providerURL=remote://

#START- JBoss 6.2 EAP Additional Properties metrics.securityPrincipalName=admin metrics.securityCredentials=admin123 metrics.userName=admin metrics.password=admin123 #END- JBoss 6.2 EAP Additional Properties

#Add the Kony Account ID and Environment ID keys as shown below and change the values of these keys accordingly. KONY_ACCOUNT_ID= Account_ID ENVIRONMENT_ID= Environment_ID

© 2016 by Kony, Inc. All rights reserved 16 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

You can mention your own Account_ID and Environment_ID.

b. Open middleware-log4j.properties file from \install\middleware\middleware-bootconfig> and edit as following.

Note: You must replace the credentials and IP addresses according to your environment.

jms.logging=true (Change this value to false if you are not using old reports and remove the below content else no changes required to this file)

#if middleware is hosted on Tomcat server

log4j.appender.jms=com.konylabs.middleware.common.JMSAppend er

log4j.appender.jms.TopicBindingName=topic/KonyLogTopic log4j.appender.jms.TopicConnectionFactoryBindingName= jms/KonyConnectionFactory log4j.appender.jms.initialContextFactoryName= org.jboss.naming.remote.client.InitialContextFactory log4j.appender.jms.providerURL=remote:// #log4j.appender.jms.URLPkgPrefixes=jboss.naming: org.jnp.interfaces #NOTE: failoverDuration and failoverRetries introduced for kony middleware ( not defined by log4j) log4j.appender.jms.FailoverDuration=5000 log4j.appender.jms.FailoverRetries=3

© 2016 by Kony, Inc. All rights reserved 17 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

#START- JBoss 6.2 EAP Additional Properties log4j.appender.jms.securityPrincipalName=admin log4j.appender.jms.securityCredentials=admin123 log4j.appender.jms.userName=admin log4j.appender.jms.password=admin123 #END- JBoss 6.2 EAP Additional Properties

Note: From 6.0.3.3 GA, metrics.logging flag is available and by default, is set to true. Prior to that, the below error statement is displayed (you can ignore this). ERROR- logservice.JMSLogService - Error while look up topic .

Note: If we set metrics.logging property to false, call the kony.license.disableMetricReporting() API in app init to disable “Maximum Offline Sessions Exceeded” alert.

3.1.1.6 Update Data Source Configuration (Applicable Only For Metrics)

To update the data source configuration, follow these steps:

1. Add admin. file under Server\\tomcat\instance1\conf\Catalina\localhost.

2. Update the admin and report schema names accordingly. Following is the example for your reference in the admin.xml file.

© 2016 by Kony, Inc. All rights reserved 18 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

password="kony123!" url="jdbc:mysql:/// admin_db_upgrade?autoReconnect=true" testWhileIdle="true" testOnBorrow="true" testOnReturn="false" validationQuery="SELECT 1" validationInterval="30000" timeBetweenEvictionRunsMillis="30000" initialSize="10" maxActive="30" minIdle="10" maxWait="10000" maxIdle="30" removeAbandonedTimeout="60" removeAbandoned="true" logAbandoned="true" minEvictableIdleTimeMillis="30000" jmxEnabled="true"/>

3.1.1.7 Update JMS Configuration (Applicable Only For Metrics)

To update JMS Configuration, follow these steps:

© 2016 by Kony, Inc. All rights reserved 19 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Open standalone-full.xml file from <\installation_location>\jboss62_ jms\standalone\configuration\> and update data sources and JMS Topic configurations as shown below.

a. DataSource configuration:

jdbc:mysql:/// admin_db_upgrade?autoReconnect=true com.mysql 10 30

© 2016 by Kony, Inc. All rights reserved 20 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

IdleConnections userid pwd

b. JMS Topic configuration:

Replace the below configuration

with the below

3.1.1.8 Deploy the latest .WAR Files

To deploy the latest WAR files, follow these steps:

© 2016 by Kony, Inc. All rights reserved 21 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Deploy the latest admin.war and middleware.war files to the application server.

2. Deploy the metrics.ear file to the JBoss application server <\install_ location>\jboss62_jms\standalone\deployments\> (applicable only if you are using metrics).

3. Extract the jar files available in libraries-MIDDLEWARE-QA-ver.tar to this location - //install/lib/middleware.

Note: Based on the database used, copy the respective DB driver .JAR file to \\install\lib\middleware. For example if you are using MYSQL DB, copy MySQL.jar file from MySQL site.

Important: Start the JBoss application server followed by Tomcat.

3.1.1.9 Upgrade from 5.x to 6.x

To upgrade from 5.x to 6.x, follow these steps:

1. Install a fresh instance of JBoss 6.2 and configure Kony MobileFabric Integration Service 6.0.

a. Configure legacy database

b. Republish the apps

3.1.1.10 Kony Report Portal Configuration

If you are using the Kony Reporting Portal for tracking sessions and users, then you must make the following changes so that you continue to see the reports in the new Admin Console (under the section Reports > Legacy Reports).

To track sessions and users, follow these steps:

© 2016 by Kony, Inc. All rights reserved 22 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Place the following files in a location. These files are available in the 5.x installation:

o DbSpecificProcedureCall.properties

o konyreport.properties

o log4j.properties

2. Open catalina.properties file and provide the location where the files mentioned in Step-1 are placed - konyreports.home=.

3. Open admin.xml file and configure the data source for legacy reports (\instance1\conf\Catalina\localhost).

4. Execute the database scripts in konyreports.sql of KonyReportsDB and admin schema required for Kony reports.

© 2016 by Kony, Inc. All rights reserved 23 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.1.1.11 Verification

Verify the upgrade process by logging into the console and look for Server Version and Health Check. Use version. for verification.

To verify the upgrade process, follow these steps:

1. Navigate to the URL http://ipaddress:port/middleware/version.html and look for server version.

2. Navigate to Settings and click Health Check and look for Report DB, Admin DB and Reporting Queue. Note that the status should be in PASSED state.

© 2016 by Kony, Inc. All rights reserved 24 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3. Navigate to Settings and click Configuration.

© 2016 by Kony, Inc. All rights reserved 25 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.1.2 Upgrade Tomcat Manually from 6.x to 6.5.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 6.x to 6.5.x (Tomcat).

3.1.2.1 Prerequisites

The following table displays the prerequisites for upgrading Kony MobileFabric Integration Service.

Refer to http://community.kony.com/downloads/manual to download the following artifacts:

Artifacts Type Purpose

Resepective Database Upgrade Scripts Database To setup the required scripts schema

l admin.war WAR and EAR To be deployed to files Application Server l middleware.war

l appdownload.war

l metrics.ear (applicable only for metrics)

(Advantages)

l middleware-bootconfig.tar TAR files

l libraries-MIDDLEWARE-GA-<6.0.x>.tar

l Thin client JARs from JAR files http://community.kony.com/downloads/manual

3.1.2.2 Backup

To backup files, follow these steps:

© 2016 by Kony, Inc. All rights reserved 26 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Stop JMS and Tomcat middleware server.

2. Take a backup of the following files from your current server installation location.

a. .WAR files - These files are available at \install\webapps .

l middleware.war

l admin.war

l appdownload.war

l metrics.ear from \jboss62_ jms\standalone\deployments (applicable only for metrics).

b. middleware-bootconfig directory from \install\middleware

c. middleware libraries (.JAR files) - The files are located at \\install\lib\middleware.

d. After taking the backup, delete all the above files.

3.1.2.3 Execute Database Scripts

1. Execute the database upgrade scripts from http://community.kony.com/downloads/manual.

Note: Run the scripts in the given order. Replace the name of the konyadmin and konyreports schema name to your respective schemas.

3.1.2.4 Add Management Related Entries in Admin DB (Applicable Only For MobileFabric)

1. Open mobilefabric_configuration table from your admin database.

2. Add the following entries under the data column:

© 2016 by Kony, Inc. All rights reserved 27 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3. Take a backup of the following files and delete them.

a. management_server_host_name - assign your host name as prop_value.

b. managment_server_port - assign your management port number as prop_value

3.1.2.5 Add New and Update Existing Property Files

1. Extract the middleware-bootconfig.tar to the following location \install\middleware.

2. Retain the properties of admin-log4j.propertiesand deployment- config.properties under middleware-bootconfig\admin folder from the previous versions.

3. In middleware.properties and middleware-log4j.properties in middleware- bootconfig folder, retain all the existing properties from the previous versions.

4. Copy the appregistry folder under the middleware-bootconfig of previous version to the new middleware-bootconfig folder.

5. Open middleware-log4j.properties and edit the below paths for device- payload.log and datasource-payload.log as your requirement.

log4j.appender.DEVICE.File=${middleware.home} \..\logs\middleware\device-payload.log log4j.appender.DATASOURCE.File=${middleware.home} \..\logs\middleware\datasource-payload.log

6. If metrics is not used, open middleware.properties in the middleware-bootconfig folder from \install\middleware and mark the property under Metrics Topic Configuration as false

metrics.logging=false

© 2016 by Kony, Inc. All rights reserved 28 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Note: This property was introduced in 6.0.3.x.GA version of middleware. This property is used to enables the metrics. Request and Session data is captured in the database if this property is set to true.

Note: If we set metrics.logging property to false, call the kony.license.disableMetricReporting() API in app init to disable “Maximum Offline Sessions Exceeded” alert.

7. Mark the property metrics.logging =true (applicable only for metrics).

8. Retain the properties of metrics-log4j.properties in middlware- bootconfig\admin folder, and serverconsole.properties in middleware- bootconfig folder from the previous versions.

3.1.2.6 Deploy Latest Artifacts

1. Copy the latest admin.war, middleware.war and appdownload.war to \install\webapps.

2. Extract and copy the JARs from libraries-MIDDLEWARE-GA-.tar to \install\lib\middleware.

3. If you are using thin client application, add the thin client jars to \install\lib\tc , (create the folder tc under lib if it does not exist).

4. Copy the metrics.ear to \jboss62_ jms\standalone\deployments (applicable only for metrics).

3.1.2.7 Verification

Verify the upgrade process by logging into the console and look for Server Version and Health Check. Use version.html for verification.

To verify the upgrade process, follow these steps:

© 2016 by Kony, Inc. All rights reserved 29 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Start JMS server by clicking startjboss.bat from \jboss62_ jms\bin.

2. Start tomcat middleware server by clicking startup.bat from \tomcat\instance\bin.

3. To verify the middleware version, navigate to the URL http://ipaddress:port\middleware\version.html and look for server version.

4. Navigate to Settings and click Health Check and look for Report DB, Admin DB and Reporting.

5. Navigate to Settings and click Configuration and verify the version.

© 2016 by Kony, Inc. All rights reserved 30 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.1.3 Upgrade Tomcat Manually from 6.5.x to 7.0.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 6.x to 7.x on Tomcat on a single node setup.

3.1.3.1 Prerequisites

The following table displays the prerequisites for upgrading Kony MobileFabric Integration Service. Assuming that you have already installed Kony MobileFabric Integration Service and have setup the required Databases (Reports and Admin).

Artifacts Type Purpose

Respective Database and Database To setup the required schema Flyway scripts Scripts

l Scripts to migrate from 6.5.x to 7.x

l admin.war WAR files To be deployed to Application Server

l middleware.war

l services.war

l metrics.ear (applicable only for metrics)

l Flyway tool version 3.2.1 https://flywaydb.org/getstarted/download.html

3.1.3.2 Backup

1. Stop the Tomcat server.

2. Take a backup of the following files. These file are available at \install\webapps.

© 2016 by Kony, Inc. All rights reserved 31 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

a. .WAR files

l middleware.war

l admin.war

l services.war

b. metrics.ear from /jboss62_ jms/standalone/deployments (applicable only for metrics).

3. After taking the backup, delete or uninstall the above files.

3.1.3.3 Migrating Database from 6.5.x to 7.0.x

Migrating database from 6.5.x to 7.0.x is done using flyway tool.

l Download your DB specific migration scripts of 7.0.

Migrating Admin Database

To migrate admin DB, follow these steps:

1. Open V3_konyadmin-xxxx-7.0.0.0.sql. xxxx is the type of DB you are using.

Example: MS-SQL V3__konyadmin-sqlserver-7.0.0.0.sql. Similarly for My SQL, V3__konyadmin-mysql-7.0.0.0.sql etc.

2. In the V3_konyadmin-xxxx-7.0.0.sql, replace all KONY_SERVER place holders with the actual values from your middleware.properties file.

Example: ‘${KONY_SERVER_RICH_CLIENT_DEPLOY}' => ‘corresponding_ value_in_your_middleware.properties’

© 2016 by Kony, Inc. All rights reserved 32 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Note: If no values are assigned in middleware.properties, set those values to null in the SQL files. Example: In middleware.properties, if you have #Memcache configuration= #memcache.cluster= Then in SQL files, set the placeholders value as null.

Important: For null values, remove the colon ' '.

3. After editing, the V3-xxx.sql script, place all the scripts into SQL folder in flyway installation directory.

Example: \flyway-commandline-3.2.1-windows-x64\flyway-3.2.1\sql

4. Executing the scripts– Before executing the scripts, configure flyway to your database.

5. Open flyway.conf from \flyway-commandline-3.2.1-windows-x64\flyway- 3.2.1\conf

6. Edit the following variables. Un-comment them after editing

l flyway.url= example for MySQL, it is flyway.url=jdbc:mysql://:.

l flyway.driver=

l flyway.user

l flyway.password

l flyway.schemas=

l flyway.baselineVersion=3

7. Open the command line and type cd to \flyway-commandline-3.2.1-windows-

© 2016 by Kony, Inc. All rights reserved 33 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

x64\flyway-3.2.1.

1. Execute the command flyway repair followed by flyway migrate. Below is the expected output after executing flyway repair and flyway migrate commands:

8. You admin database is now migrated to 7.0.

Migrating Reports Database

To migrate your reports database, follow these steps:

1. Download the flyway scripts with respect to the type of database you are using (Oracle, MySQL, SQL) of 7.0.

2. Place the downloaded scripts in \flyway-commandline-3.2.1-windows- x64\flyway-3.2.1\sql.

3. Open flyway.conf from \flyway-commandline-3.2.1-windows-x64\flyway- 3.2.1\conf.

4. Edit the following variables. Un-comment them after editing and save the file.

l flyway.url= example for MySQL, it is flyway.url=jdbc:mysql://:.

© 2016 by Kony, Inc. All rights reserved 34 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

l flyway.driver=

l flyway.user

l flyway.password

l flyway.schemas=

l flyway.baselineVersion=3

5. Execute the flyway repair followed by flyway migrate as you have done with Admin Database.

6. Your Reports database in now migrated to 7.0.

3.1.3.4 Migrating WAR files

1. Download admin.war, middleware.war and services.war of 7.0.

2. Remove the data present in deployments folder from \tomcat\webapps after taking the backup.

3. Place the 7.0 war files admin.war, middleware.war, services.war in \tomcat\webapps

4. Delete the middleware folder shortcut from the tomcat lib folder. Copy konycache- derby.jar to \tomcat\lib.

5. Copy derby.jar and jboss-client.jar from the \lib\middleware to \tomcat\lib .Take the backup and delete the middleware folder from \lib folder.

3.1.3.5 Migrating Metrics

If you are using metrics in 6.0.x / 6.5.x and would like to update the same to 7.0.x, follow the below steps:

© 2016 by Kony, Inc. All rights reserved 35 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Download metrics.ear of 7.0.

2. Open metrics.ear in a ZIP editor and rename metricsJAR-0.0.1-SNAPSHOT.jar present inside it to metrics.jar.

3.1.3.6 Verification

Verify the upgrade process by logging into the console and look for Server Version and Health Check.

To verify the upgrade process

1. Access the URL http://ipaddress:port/middleware/version.html in a browser.

2. Navigate to the URL http://ipaddress:port/admin/version.html and look for server version.

3. Navigate to Settings and click Health Check and look for Report DB, Admin DB and Reporting Queue. Note that the status should be in PASSED state.

4. Navigate to Settings and click Configuration.

Note: Access to Reporting Queue will be green only if you have configured metrics and the JMS server is up and running.

© 2016 by Kony, Inc. All rights reserved 36 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.1.4 Upgrade Tomcat Manually from 5.0.x to 7.0.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 5.0.x to 7.0.x on Tomcat single node setup due to architectural changes in 7.0.x.

Note: Before performing the upgrade, stop the Tomcat server 5.0.x GA.

3.1.4.1 How to Upgrade Integration Service

Migrating Reports Database

Important: If you do not have reports configured, ignore the below process.

If you have reports configured, download and run the upgrade scripts to upgrade the database and enable legacy reports in the 7.0 reports portal.

For example: If your database version is 5.0.4 SQL Server, run the schemas in Upgrade Scripts (SQLServer_5.0.4_or_5.0.5_to_5.0.6) folder.

Setup of 7.0 Server

To setup the 7.0 server, follow these steps:

1. Setup of 7.0 server either manually or through installer.

a. Installer: Download and run the appropriate installer from http:community.kony.com/downloads/.

b. Manual: Follow the instructions in the MobileFabric Manual Installation guide.

Note: If the set up is done through installer follow the below steps. Else, go to step 4.

© 2016 by Kony, Inc. All rights reserved 37 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

2. When the set up is completed , copy the following entries from the new middleware.properties file available in the new setup to the middleware.properties file available in old setup.

metrics.securityPrincipalName=XXXXXX metrics.securityCredentials=XXXXXXXXXXXXX metrics.userName=XXXX metrics.password=XXXX

3. Delete the middleware.properties file from the new setup and copy the middleware.properties (modified one) (from the old setup) to new setup.

Verification

Verify the upgrade process by logging into the console and look for Server Version and Health Check.

To verify the upgrade process, follow these steps:

1. To verify the set up, access the URL http://hostname:port/admin/version.html and look for server version.

2. Navigate to Settings and click Health Check and look for Report DB and Admin DB. Note that the status should be in PASSED state.

3. If the health check is passed, proceed with the next step.

Upgrading Studio App and Services to 7.0

To upgrade the studio app and services, follow these steps:

1. To upgrade the Studio app and services to 7.0, refer to Migrate a Project from an Earlier Version of Kony Studio or Visualizer.

2. After the successful upgrade to publish the app and services, refer to Building and Viewing an Application.

© 2016 by Kony, Inc. All rights reserved 38 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Enabling Forward Request Feature

If you have native apps connected to the existing server, to accept the requests from the old native apps, enable the forward request feature in the new setup.

To enable the forward request feature, follow these steps:

1. If studio services are exported to MF services successfully then the _ MWMappings.properties file gets generated in /.

2. Create a new folder named migration in /middleware_ home/middleware/middleware-bootconfig/. Place the _ MWMappings.properties file under migration folder.

3. Restart the Tomcat server.

3.2 Upgrading Kony MobileFabric Integration Service - JBoss

Upgrade Kony MobileFabric Integration Service manually on JBoss server through different versions by following the below links:

Server From Version To Version Link

JBoss 5.5.x/5.6.x 6.5.x Click here

6.0.x 6.5.x Click here

6.0.x/6.5.x 7.0.x Click here

© 2016 by Kony, Inc. All rights reserved 39 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.2.1 Upgrade JBoss Manually from 5.5.x / 5.6.x to 6.5.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 5.5.x / 5.6.x to 6.5.x (JBoss).

3.2.1.1 Prerequisites

The following table displays the prerequisites for upgrading Kony MobileFabric Integration Service.

Refer to http://community.kony.com/archive/downloads/manual to download the following artifacts:

Artifacts Type Purpose

Respective Database scripts Database Scripts To setup the required schema

l admin.war WAR files To be deployed to Application Server l middleware.war

l metrics.ear (applicable only for metrics)

(Advantages)

l appdownload.war

l libraries-MIDDLEWARE-QA- TAR files ver.tar

l middleware-bootconfig.tar

© 2016 by Kony, Inc. All rights reserved 40 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Advantages of Upgrading from 5.x to 6.x with metrics.ear File

From Kony MobileFabric Integration Service 6.0 release, metrics.ear is required for reporting. The Admin module is enhanced for a better user experience and instead of depending on server user management, users are now stored in the database. To use the new features, you need to setup a database and install metrics.ear file.

Note: It is mandatory to install metrics.ear file along with admin.war.

The Kony Reports portal provides the following features:

1. Enhanced User Session - A strong method for reporting the true session count in a given date range.

2. Mechanism for tracking unique users per application.

3. Middleware sends data in the new format to the specified JMS queue. Then metrics.ear processes messages from the JMS queue.

4. Support for legacy reports. Following are the features of on-premise metrics along with legacy reports:

a. Kony MobileFabric Integration Service Message

b. Geo Location

c. Custom Metrics

d. Message Processing

e. JasperSoft Reporting

f. Basic Reporting

Note: For more information on Kony Reports, click here.

© 2016 by Kony, Inc. All rights reserved 41 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Important: If you do not want to use the Kony Reports, use your existing admin.war file (for example, use the war file you have for 5.6.x version). By using the existing admin.war file, you avoid the need for additional hardware or software.

3.2.1.2 Backup

1. Take a backup of the following files. These file are available at \instance\standalone\deployments

a. middleware.war

b. admin.war

c. appdownload.war

2. middleware-bootconfig directory

Sample path for middleware -bootconfig

3. middleware libraries (.JAR files) - The files are located at \\install\lib\\middleware.

4. After taking the backup, delete all the above files.

3.2.1.3 Database Upgrade for Legacy Reports

Download and run the upgrade scripts from http://community.kony.com/archive/downloads/manual to upgrade the database and enable legacy reports.

For example: If your database version is 5.0.3 Oracle, run the schemas in "Oracle_upgrade_5.0.3 to 5.0.6" folder in the numerical order.

Note: To enable the legacy reports, the database should be the latest 5.0.6. version. If your database is not latest, run the database scripts based on your database and upgrade to 5.0.6 version.

© 2016 by Kony, Inc. All rights reserved 42 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.2.1.4 Execute Database Scripts

Execute the database scripts and verify the Admin and Reports schema created in the database.

Note: Change the name of the konyadmin and konyreports database as per your requirements. This is required for metrics.

3.2.1.5 Add New and Update Existing Property Files

1. Download and extract the middleware-bootconfig.tar file from http://community.kony.com/archive/downloads/manual to the \install\middleware.

2. Open deployment-config.properties file from install\middleware\middleware-bootconfig\admin.

Remove all the entries between Tomcat and JBoss Entries Begin and Tomcat and JBoss Entries End and add the following entries :

#TOMCAT AND JBOSS ENTRIES BEGIN #Must be "false" for websphere and "true" for tomcat and Jboss config.usersdb.validation=false

# File based for Tomcat which move the wars in a given config..deploy.dir config.wap-default.type=JBoss config.wap-default.port=

#TOMCAT 7 server - value should be 'http://ipaddress:port/manager/text' #config.wap- default.deploy.URL=http://:/manager/text #config.wap-default.deploy.managerID=manager #config.wap-default.deploy.managerPWD=m@n@g3r123

© 2016 by Kony, Inc. All rights reserved 43 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

#config.wap-default.deploy.dir=/install/webapps

# File based for Tomcat which move the wars in a given config..deploy.dir config.sms-default.type=Tomcat config.sms-default.host=localhost config.sms-default.port=80 config.sms-default.deploy.dir=/home/core/install/apps

# TOMCAT 7 server - value should be 'http://:/manager/text' config.sms-default.deploy.URL=http://localhost/manager config.sms-default.deploy.managerID=manager config.sms-default.deploy.managerPWD=m@n@g3r123 config.rc-default.type=JBoss config.rc-default.host= config.rc-default.port= config.rc-default.deploy.dir=/install/webapps/download.war #TOMCAT AND JBOSS ENTRIES END

Note: You can retain the location from the above sample code from deploy- config.propertiesbackup file. You must replace the ipaddressport and port according to your environment.

3. Update existing property file.

a. Update the middleware.properties file from \install\middleware\middleware-bootconfig with the configuration you have used with earlier version.

b. Open the file and add the following content at the end of the file.

© 2016 by Kony, Inc. All rights reserved 44 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Note: You must replace the credentials and IP addresses according to your environment.

################################################## #Metrics Topic Configuration (applicable only for metrics) ################################################## #To enable / disable metrics #Make it true, if Kony Reports enabled and Metrics Topic is configured metrics.logging=true metrics.TopicName=jms/KonyMetricsTopic metrics.TopicConnectionFactoryName=jms/KonyConnectionFactory #For JBOSS JMS

metrics.initialContextFactoryName=org.jboss.naming.remote.clien t.InitialContextFactory metrics.providerURL=remote:// #For Weblogic JMS

#metrics.initialContextFactoryName=weblogic.jndi.WLInitialConte xtFactory #metrics.providerURL=remote:// #START- JBoss 6.2 EAP Additional Properties metrics.securityPrincipalName=admin metrics.securityCredentials=admin123 metrics.userName=admin metrics.password=admin123 #END- JBoss 6.2 EAP Additional Properties #ToDo #metrics.URLPkgPrefixes=jboss.naming:org.jnp.interfaces #NOTE: failoverDuration and failoverRetries introduced for kony middleware (not defined by log4j)

© 2016 by Kony, Inc. All rights reserved 45 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

#metrics.FailoverDuration=5000 #metrics.FailoverRetries=3

#Add the Kony Account ID and Environment ID keys for reports as shown below and change the values of these keys accordingly. KONY_ACCOUNT_ID= ENVIRONMENT_ID= You can mention your own Account_ID and Environment_ID. #Add to support 2D array in JSON Output jsonArraySupport=false (By default, this value should be false)

Note: From 6.0.3.3 GA, metrics.logging flag is available and by default, is set to true. Prior to that, the below error statement is displayed (you can ignore this). ERROR- logservice.JMSLogService - Error while look up topic .

Note: If we set metrics.logging property to false, call the kony.license.disableMetricReporting() API in app init to disable “Maximum Offline Sessions Exceeded” alert.

4. Open middleware-log4j.properties file and edit as below:

Note: You must replace the credentials and IP addresses according to your environment.

jms.logging=true (Change this value to false if you are not using old reports and keep the below content as below) #-- Start add for service wars deployed log4j.category.com.kony=INFO,file

© 2016 by Kony, Inc. All rights reserved 46 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

#-- End log4j.category.com.konylabs=INFO,file

#Enable below 2 line if kony reporting is enabled and jms topic is configured

log4j.category.com.konylabs.middleware.connectors.logservice=IN FO

log4j.additivity.com.konylabs.middleware.connectors.logservice= false

#Reduce logging in thin client. This property controls the logging by the thin client code. #log4j.category.com.konylabs.vm=INFO,file #log4j.category.com.konylabs.api=INFO,file

#The additivity property below prevents the classname from propagating the logs to it's ancestors and parent classes. If this flag is #set to true, then logging will happen in file1 as well as file. If it is set to false, logging shall happen only in file1 and these logs shall #not be propagated to it's ancestors. #log4j.additivity.com.konylabs.vm=false #log4j.additivity.com.konylabs.api=false

#if middleware is hosted on JBOSS server #log4j.appender.jms=org.apache.log4j.net.JMSAppender

© 2016 by Kony, Inc. All rights reserved 47 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

#if middleware is hosted on Tomcat server #log4j.appender.jms=com.konylabs.middleware.common.JMSAppender #log4j.appender.jms.TopicBindingName=topic/KonyLogTopic

#log4j.appender.jms.TopicConnectionFactoryBindingName=jms/KonyC onnectionFactory

#log4j.appender.jms.initialContextFactoryName=org.jboss.naming. remote.client. InitialContextFactory #log4j.appender.jms.providerURL=remote://ipaddress:port

#log4j.appender.jms.URLPkgPrefixes=jboss.naming:org.jnp.interfa ces #NOTE: failoverDuration and failoverRetries introduced for kony middleware (not defined by log4j) #log4j.appender.jms.FailoverDuration=5000 #log4j.appender.jms.FailoverRetries=3

#START- JBoss 6.2 EAP Additional Properties #log4j.appender.jms.securityPrincipalName=admin #log4j.appender.jms.securityCredentials=admin123 #log4j.appender.jms.userName=admin #log4j.appender.jms.password=admin123 #END- JBoss 6.2 EAP Additional Properties

### temp appender for backup log4j.appender.file=org.apache.log4j.RollingFileAppender log4j.appender.file.maxFileSize=10240KB log4j.appender.file.maxBackupIndex=5 log4j.appender.file.File=/Server

© 2016 by Kony, Inc. All rights reserved 48 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

location>/logs/middleware/middleware.log log4j.appender.file.threshold=debug log4j.appender.file.layout=org.apache.log4j.PatternLayout # %L should be used only in dev, its extremely slow #log4j.appender.file.layout.ConversionPattern=[%x] %d{ABSOLUTE} %5p %c{2}:%L - %m%n log4j.appender.file.layout.ConversionPattern=[%x][KonyServer] [%p] [%d{dd MMM yyyy HH:mm:ss,SSS}]-%5p-%c{2} - %m%n

#The properties below are required to be added if logging is required in multiple locations based on the class name or hierarchy. #Add the classname/hierarchy here and give it a log level and unique appender name

#log4j.category.com.konylabs.middleware.common.CSRIssueLogger=D EBUG,file1

#The additivity property below prevents the classname from propagating the logs to it's ancestors and parent classes. If this flag is #set to true, then logging will happen in file1 as well as file. If it is set to false, logging shall happen only in file1 and these logs shall #not be propagated to it's ancestors.

#log4j.additivity.com.konylabs.middleware.common.CSRIssueLogger =false

### temp appender for backup #log4j.appender.file1=org.apache.log4j.RollingFileAppender

© 2016 by Kony, Inc. All rights reserved 49 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

#log4j.appender.file1.maxFileSize=10240KB #log4j.appender.file1.maxBackupIndex=5 #log4j.appender.file1.File=D:/Middleware-Config/middleware-log_ file1.txt #log4j.appender.file1.threshold=debug #log4j.appender.file1.layout=org.apache.log4j.PatternLayout #log4j.appender.file1.layout.ConversionPattern=[%x] %d {ABSOLUTE} %5p %c{2} - %m%n #

3.2.1.6 Update Data Source Configuration (Applicable Only For Metrics)

1. Open standalone.xml file of standalone JBoss (Not the JMS JBoss) available at, \Server\Jboss_location \jboss\instance1\standalone\configuration.

2. Update the data sources as in the following code:

Note: You must replace the credentials and IP addresses according to your environment.

jdbc:sqlserver://ipaddress:port;DatabaseName=reportsdbname; com.sqlserver SELECT 1 10 30

© 2016 by Kony, Inc. All rights reserved 50 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

IdleConnections dbusername dbpassword SELECT 1 true jdbc:mysql://ipaddress:port;DatabaseName=admindbname?autoRe connect=true; com.sqlserver SELECT1 10 30 IdleConnections dbusername dbpassword SELECT 1

© 2016 by Kony, Inc. All rights reserved 51 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

sql> true jdbc:mysql://ipadress:port/ADMIN com.mysql 10 30 IdleConnections dbusername dbpassword

Replace the driver entry under tag as below: org.apache.derby.jdbc.EmbeddedDriver

Add these two selected entries under tag. Ex:

© 2016 by Kony, Inc. All rights reserved 52 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Snippet

3.2.1.7 Update JMS Configuration (Applicable Only For Metrics)

1. Open standalone-full.xml file of JBoss using JMS and update data sources and JMS Topic configurations as shown below.

Note: You must replace the credentials and IP addresses according to your environment.

a. DataSource configuration:

jdbc:sqlserver://ipaddress:port;DatabaseName=databasena me; SelectMethod=cursor; com.sqlserver userid password

© 2016 by Kony, Inc. All rights reserved 53 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

10 30 IdleConnections jdbc:sqlserver://ipaddress:port;DatabaseName=databasena me; SelectMethod=cursor; com.sqlserver userid password 10 30 IdleConnections jdbc:sqlserver://ipaddress:port;DatabaseName=databasena me; SelectMethod=cursor;

© 2016 by Kony, Inc. All rights reserved 54 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

com.sqlserver userid password

b. JMS Topic configuration:

Replace the below configuration

with the below

© 2016 by Kony, Inc. All rights reserved 55 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.2.1.8 Deploy the latest WAR Files

1. Deploy the latest admin.war, middleware.war and appdownload.war files to the deployment folder of JBoss application server \jboss\instance\standalone\deployments.

2. Deploy the metrics.ear file to JBoss application server for JMS \jboss62_jms\instance\standalone\deployments (applicable only if you are using metrics).

3. Open serverconsole.properties file from \install\middleware\middleware-bootconfig\admin.

3.2.1.9 Edit Metrics and Admin-log4j Properties

1. Open the admin-log4j.properties from the following location: \install\middleware\middleware-bootconfig\admin and edit the property log4j.appender.file (the location of the admin.).

2. Open the metrics-log4j.properties from the following location \install\middleware\middleware-bootconfig and edit the property log4j.appender.file (File is the location of the metrics.log file).

3. Open the serverconsole.properties file from the following location : \install\middleware\middleware-bootconfig\admin and compare the admin.dbtype and reports.dbtype.

Both the database types compared should match your database.

Note: You should select konyadmindb.dialect property as your database.

For example:

© 2016 by Kony, Inc. All rights reserved 56 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

If you are using MySQL database, the property should be konyadmindb.dialect=com.kony.console.admin.dialect.CustomMySQLDial ect.

Similarly, admindb.dbtype and reportsdb.dbtype property should match your database.

l admindb.dbtype=mysql

l reportsdb.dbtype=mysql

4. Extract the jar files available in libraries-MIDDLEWARE-QA-ver.tarto /\install\lib\middleware.

5. Add the thin client jars from to the middleware libraries folder \install\lib\middleware and add the jar entries to the module.xml file.

6. Create a folder (Example: MySQL) in \jboss\instance1\modules\system\layers\base\com . (The name of the folder created depends on the database you are using).

7. Create a sub-folder Main in the folder created and add the selected database JAR to the folder.

8. Create a module.xml file and enter the following code.

© 2016 by Kony, Inc. All rights reserved 57 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

9. Copy the appregistry folder from the middleware-bootconfig folder of the 5.6.x backup folder and paste it into the middleware-bootconfig of the 6.5.x server (i.e. /install/middleware/middleware-bootconfig).

10. Open mobilefabric_configuration table in konyadmin database and add two entries to the table as shown below :

Note: The above step is required to publish application to a server integrated with the MobileFabric. If you are not using MobileFabric, ignore this step.

l First entry should have prop_name as management_server_host_name and prop_value is the jboss.bind.address.management provided in the standalone.xml file of jboss_install- location>\jboss\instance\standalone\configuration of the jboss server.

l Similarly, the second entry should have prop_name as management_server_port and prop_value as the jboss.management.native.port given in the standalone.xml file of jboss_install- location>\jboss\instance\standalone\configuration.

3.2.1.10 Kony Report Portal Configuration

If you are using the Kony Reporting Portal for tracking sessions and users, then you must make the following changes so that you continue to see the reports in the new Admin Console (under the section Reports > Legacy Reports).

© 2016 by Kony, Inc. All rights reserved 58 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Place the following files in a location. These files are available in the 5.x installation:

a. DbSpecificProcedureCall.properties

b. konyreport.properties

c. log4j.properties

2. Open the konyreports.properties file and update the database properties.

#database properties #konyadminreports.jndi.name=java:comp/env/jdbc/KARDB konyadminreports.jndi.name=java:/jdbc/KARDB

3. Open standalone.conf.bat from /jboss/instance/bin.

Add a –D parameter -Dkonyreports.home= in the JAVA_OPTS.

3.2.1.11 Verification

Verify the upgrade process by logging into the console and look for Server Version and Health Check.

To verify the upgrade process

1. Navigate to the URL http://ipaddress:port/middleware/version.html and look for server version.

2. Navigate to Settings and click Health Check and look for Report DB, Admin DB and Reporting Queue. Note that the status should be in PASSED state.

© 2016 by Kony, Inc. All rights reserved 59 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3. Navigate to Settings and click Configuration.

© 2016 by Kony, Inc. All rights reserved 60 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.2.2 Upgrade JBoss Manually from 6.0.x to 6.5.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 6.x to 6.5.x (JBoss).

3.2.2.1 Prerequisites

The following table displays the prerequisites for upgrading Kony MobileFabric Integration Service.

Refer to http://community.kony.com/archive/downloads/manual to download the following artifacts:

Artifacts Type Purpose

Respective Database scripts Database To setup the required Scripts schema

l admin.war WAR files To be deployed to Application Server l middleware.war

l appdownload.war

l metrics.ear (applicable only for metrics)

l libraries-MIDDLEWARE-GA-ver.tar TAR files

l middleware-bootconfig.tar

l Thin client JARs from JAR files http://community.kony.com/archive/downloads/manual

3.2.2.2 Backup

1. Stop JMS and JBoss Middleware server.

2. Take a backup of the following files. These file are available at /jboss/instance/standalone/deployments

© 2016 by Kony, Inc. All rights reserved 61 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

a. .WAR files

l middleware.war

l admin.war

l appdownload.war

b. middleware-bootconfig directory from /install/middleware

c. metrics.ear from /jboss62_ jms/standalone/deployments (applicable only for metrics)

d. middleware JAR files from /install/lib/middleware.

3. After taking the backup, delete or uninstall the above files.

3.2.2.3 Execute Database Scripts

1. Stop the application server.

2. Execute the upgrade database scripts from 6.x to 6.5.x from http://community.kony.com/archive/downloads/manualand verify the Admin and Reports schema created in the database.

Note: You have to run the scripts in the given order. While executing in this order, exclude the 6.x scripts. Replace the name of the konyadmin and konyreports schema name to your respective schemas.

© 2016 by Kony, Inc. All rights reserved 62 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.2.2.4 Add New and Update Existing Property Files

1. Extract themiddleware-bootconfig.tar to the /install/middleware directory.

2. Retain the properties of admin-log4j.properties and deployment- config.properties under middleware-bootconfig/admin folder from the previous version (which are already backed up).

3. Retain the changes made to the middleware.properties and middleware- log4j.properties in middleware-bootconfig folder from the previous version (which are already backed up).

4. Open middleware-log4j.properties and edit the below path for device- payload.log and datasource-payload.log as per your requirement.

log4j.appender.DEVICE.File=${middleware.home} /../logs/middleware/ device-payload.log log4j.appender.DATASOURCE.File=${middleware.home} /../logs/middleware/ datasource-payload.log

5. Copy the appregistry folder under the middleware-bootconfig of older version to the new middleware-bootconfig in /install/middleware folder.

6. If metrics is not used, open middleware.properties in the middleware-bootconfig folder and mark the property under metrics.logging as false.

Note: If metrics is used, set the property as true.

© 2016 by Kony, Inc. All rights reserved 63 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Note: This property was introduced in 6.0.3.2.GA version of middleware. This property enables the metrics. Request and Session data is captured in the database, if this property is set to true.

Note: If we set metrics.logging property to false, call the kony.license.disableMetricReporting() API in app init to disable “Maximum Offline Sessions Exceeded” alert.

7. Retain the properties in metrics-log4j.properties in middleware- bootconfig/admin folder and serverconsole.properties in middleware- bootconfig folder from the same respective files of previous version (applicable only for metrics).

8. Open standalone.xml file of Standalone JBoss (Not the JMS JBoss) available at /jboss/instance/standalone/configuration and add these two entries under :

3.2.2.5 Deploy Latest Artifacts

1. Copy the latest admin.war, middleware.war and appdownload.war to /jboss/instance/standalone/deployments.

2. Extract and copy the jars from libraries-MIDDLEWARE-GA-.tar to /install/lib/middleware.

3. Add the thin client jars to /install/lib/middleware , if the user is using thin client apps and add the jar entries to module.xml.

© 2016 by Kony, Inc. All rights reserved 64 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

4. If the user wants to use mobilefabric , follow the below steps :

a. Open konyadmindb and go to mobilefabric_configuration table.

b. Add the below two entries in the table.

l First entry should have prop_name as management_server_host_name and prop_value is the jboss.bind.address.management provided in the standalone.xml file available in /jboss/instance/standalone/configuration.

l Similarly, the second entry should have prop_name as management_server_ port and prop_value as the jboss.management.native.port given in the same standalone.xml.

5. Copy the metrics.ear to /jboss62_ jms/standalone/deployments (applicable only for metrics).

3.2.2.6 Verification

Verify the upgrade process by logging into the console and look for Server Version and Health Check.

To verify the upgrade process

1. Start JMS server by clicking startjboss.bat from / jboss62_jms/bin.

2. Start JBoss middleware server by clicking standalone.bat from /jboss/instance/bin.

3. Navigate to the URL http://ipaddress:port/admin/version.html and look for server version.

4. Navigate to Settings and click Health Check and look for Report DB, Admin DB and Reporting Queue. Note that the status should be in PASSED state.

© 2016 by Kony, Inc. All rights reserved 65 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

5. Navigate to Settings and click Configuration.

3.2.3 Upgrade JBoss Manually from 6.x / 6.5.x to 7.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 6.x to 7.x on JBoss single node setup.

3.2.3.1 Prerequisites

The following table displays the prerequisites for upgrading Kony MobileFabric Integration Service. Assuming that you have already installed Kony MobileFabric Integration Service and have setup the required Databases (Reports and Admin).

Artifacts Type Purpose

© 2016 by Kony, Inc. All rights reserved 66 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Respective Database and Database To setup the required schema Flyway scripts Scripts

l Scripts to migrate from 6.x to 6.5.x

l Scripts to migrate from 6.5.x to 7.x

l admin.war WAR files To be deployed to Application Server

l middleware.war

l services.war

l metrics.ear (applicable only for metrics)

l Flyway tool version 3.2.1 https://flywaydb.org/getstarted/download.html

3.2.3.2 Backup

1. Stop JMS and JBoss Middleware server.

2. Take a backup of the following files. These file are available at /jboss/instance/standalone/deployments

a. .WAR files

l middleware.war

l admin.war

l services.war

b. metrics.ear from /jboss62_ jms/standalone/deployments (applicable only for metrics).

3. After taking the backup, delete or uninstall the above files.

© 2016 by Kony, Inc. All rights reserved 67 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.2.3.3 Execute Database Scripts

1. Stop the application server.

2. Download the respective database scripts of 7.0. Following scripts are downloaded for migrating Admin DB and Reports DB.

l konyreports-sqlserver-upg-6.0.3-6.0.3.1.sql

l konyadmin-sqlserver-upg-6.0.3-6.0.3.1.sql

3. Execute the upgrade database scripts of 7.0

4. Verify the Admin and Reports schema created in the database. It should display the last executed scripts.

Note: You have to run the scripts in the sequential order. Replace the name of the konyadmin and konyreports schema name to your respective schemas.

Important: Executing the database scripts is applicable only if you are migrating from 6.x to 7.x.

3.2.3.4 Migrating Database from 6.5.x to 7.0.x

Migrating database from 6.5.x to 7.0.x is done using flyway tool.

l Download your DB specific migration scripts of 7.0.

Migrating Admin Database

To migrate admin DB, follow these steps:

© 2016 by Kony, Inc. All rights reserved 68 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Open V3_konyadmin-xxxx-7.0.0.0.sql. xxxx is the type of DB you are using.

Example: MS-SQL V3__konyadmin-sqlserver-7.0.0.0.sql. Similarly for My SQL, V3__konyadmin-mysql-7.0.0.0.sql etc.

2. In the V3_konyadmin-xxxx-7.0.0.sql, replace all KONY_SERVER place holders with the actual values from your middleware.properties file.

Example: ‘${KONY_SERVER_RICH_CLIENT_DEPLOY}' => ‘corresponding_ value_in_your_middleware.properties’

Note: If no values are assigned in middleware.properties, set those values to null in the SQL files. Example: In middleware.properties, if you have #Memcache configuration= #memcache.cluster= Then in SQL files, set the placeholders value as null.

Important: For null values, remove the colon ' '.

3. After editing, the V3-xxx.sql script, place all the scripts into SQL folder in flyway installation directory.

Example: \flyway-commandline-3.2.1-windows-x64\flyway-3.2.1\sql

4. Executing the scripts– Before executing the scripts, configure flyway to your database.

5. Open flyway.conf from \flyway-commandline-3.2.1-windows-x64\flyway- 3.2.1\conf

6. Edit the following variables. Un-comment them after editing

l flyway.url= example for MySQL, it is flyway.url=jdbc:mysql://:.

l flyway.driver=

© 2016 by Kony, Inc. All rights reserved 69 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

l flyway.user

l flyway.password

l flyway.schemas=

l flyway.baselineVersion=3

7. Open the command line and type cd to \flyway-commandline-3.2.1-windows- x64\flyway-3.2.1.

8. Execute the command flyway repair followed by flyway migrate. Below the expected output after executing flyway repair and flyway migrate commands:

9. You admin database is now migrated to 7.0.

Migrating Reports Database

To migrate your reports database, follow these steps:

1. Download the flyway scripts with respect to the type of database you are using (Oracle, MySQL, SQL) of 7.0.

2. Place the downloaded scripts in \flyway-commandline-3.2.1-windows- x64\flyway-3.2.1\sql.

3. Open flyway.conf from \flyway-commandline-3.2.1-windows-x64\flyway-

© 2016 by Kony, Inc. All rights reserved 70 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.2.1\conf.

4. Edit the following variables. Un-comment them after editing and save the file.

l flyway.url= example for MySQL, it is flyway.url=jdbc:mysql://:.

l flyway.driver=

l flyway.user

l flyway.password

l flyway.schemas=

l flyway.baselineVersion=3

5. Execute the flyway repair followed by flyway migrate as you have done with Admin Database.

6. Your Reports database in now migrated to 7.0.

3.2.3.5 Migrating WAR files

1. Download admin.war, middleware.war and services.war of 7.0.

2. Remove the data present in deployments folder from \jboss\instance1\standalone\ after taking the backup.

3. Place the 7.0 war files admin.war, middleware.war, services.war in \jboss\instance1\standalone\deployments.

4. Delete the Kony folder from \jboss\instance1\modules\system\layers\base\com.

5. Open standalone.xml from \jboss\instance1\standalone\configuration.

6. Delete com.kony.middleware entry from .

© 2016 by Kony, Inc. All rights reserved 71 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

7. Add two entries in the global-modules related to JMS as below and save the file.

8. Delete the data present in tmp folder. Location of tmp folder is \jboss\instance1\standalone\tmp.

3.2.3.6 Migrating Metrics

If you are using metrics in 6.0.x / 6.5.x and would like to update the same to 7.0.x, follow the below steps:

1. Download metrics.ear of 7.0.

2. Open metrics.ear in a ZIP editor and rename metricsJAR-0.0.1-SNAPSHOT.jar present inside it to metrics.jar.

3.2.3.7 Verification

Verify the upgrade process by logging into the console and look for Server Version and Health Check.

To verify the upgrade process

1. Start JMS server by clicking startjboss.bat from / jboss62_jms/bin.

2. Start JBoss middleware server by clicking standalone.bat from /jboss/instance/bin.

3. Access the URL http://ipaddress:port/middleware/version.html in a browser.

4. Navigate to the URL http://ipaddress:port/admin/version.html and look for server version.

© 2016 by Kony, Inc. All rights reserved 72 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

5. Navigate to Settings and click Health Check and look for Report DB, Admin DB and Reporting Queue. Note that the status should be in PASSED state.

6. Navigate to Settings and click Configuration.

Note: Access to Reporting Queue will be green only if you have configured metrics and the JMS server is up and running.

3.3 Upgrading Kony MobileFabric Integration Service - WebSphere

Upgrade Kony MobileFabric Integration Service manually on WebSphere server through different versions by following the below links:

Server From Version To Version Link

WebSphere 5.0.x/5.5.x/5.6.x 6.0.x Click here

6.0.x 6.5.x Click here

3.3.1 Upgrade WebSphere Manually from 5.0.x/5.5.x/5.6.x to 6.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 5.6.x to 6.0.x (WebSphere). Assume that you have prior installation of Kony MobileFabric Integration Service.

© 2016 by Kony, Inc. All rights reserved 73 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.3.1.1 Prerequisites

The following table displays the prerequisites for upgrading Kony MobileFabric Integration Service.

Refer to http://community.kony.com/downloads/manual to download the following artifacts of </Middleware/>:

Artifacts Type Purpose

Respective Database scripts Database Scripts To setup the required schema

l WebSphere/admin.war WAR and EAR To be deployed to Application files Server l Metrics/metrics.ear

l middleware- TAR files bootconfig.tar

3.3.1.2 Backup

To backup the existing files, follow these steps:

1. Take a backup of existing middleware.ear and admin.war files from your current installation server. These files are located at /. For example, data/IBM/WebSphere/AppServer/profiles/AppSrv01/installedApps/local hostNode01Cell.

2. Also, take the backup of existing shared-lib and middleware-bootconfig folders.

3.3.1.3 Database Upgrade for Legacy Reports

Note: This section is applicable only for upgrading from 5.5.x to 6.x.

To upgrade the database for legacy reports, follow the below step:

© 2016 by Kony, Inc. All rights reserved 74 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Download the upgrade scripts from the http://developer.kony.com/KonyDBScripts location.

2. Run all the downloaded scripts.

Note: To enable the legacy reports, the database should be the 5.0.6. version. If your database is not latest, run the database scripts based on your database and upgrade to 5.0.6 version.

For example, if your database version is 5.0.3 Oracle, run the schemas in the Oracle_upgrade_ 5.0.3 to 5.0.6 folder in the numerical order.

3.3.1.4 Execute Database Scripts

Execute the database scripts and verify the Admin and Reports schema created in the database

Note: Change the name of the konyadmin and konyreports database as per your requirements. This is required for metrics.

3.3.1.5 Upgrading middleware.ear

Add New and Update Existing Property Files

Extract the middleware-bootconfig.tar file to a temporary location (/home/temp) in your local machine. Here after, /home/temp location is referred as in this guide.

Retain the changes made in middleware.properties and middleware- log4j.properties files as in 5.6.x for your configuration details.

To retain the changes, follow these steps:

1. Open the /middleware- bootconfig/middleware.properties file of 5.6.x and add the below code at the end of the file. You can also find this code in the middleware.properties file available at the /middleware-bootconfig.

© 2016 by Kony, Inc. All rights reserved 75 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

################################################## #Metrics Topic Configuration ################################################## #To enable/disable metrics #Make it true, if Kony Reports enabled and Metrics Topic is configured metrics.logging=true

metrics.TopicName=jms/KonyMetricsTopic metrics.TopicConnectionFactoryName=jms/KonyConnectionFactory

##-- START - Should be enabled only on Websphere JMS Server

metrics.initialContextFactoryName==com.ibm.websphere.naming.Wsn InitialContextFactory metrics.providerUR=iiop://localhost:2809 ##-- END - Should be enabled only on Websphere JMS Server #Account ID and Environment ID for Reports KONY_ACCOUNT_ID=Kony ENVIRONMENT_ID=Dev

Note: From 6.0.3.3 GA onwards, metrics.logging flag is available and by default, it is set to true. Prior to that, below error statement is displayed. You can skip this.

Note: If the metrics.logging property is set to false, call the kony.license.disableMetricReporting() API in app init to disable “Maximum Offline Sessions Exceeded” alert.

ERROR-logservice.JMSLogService - Error while lookup Topic

© 2016 by Kony, Inc. All rights reserved 76 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

2. Open /middleware-bootconfig/middleware- log4j.properties file of 5.6.x and add the below code at the end of the file. You can also find this code in the middleware-log4j.properties file available at the /middleware-bootconfig.

#-- Start add for service wars deployed log4j.category.com.kony=ERROR,file #-- End log4j.category.com.konylabs=ERROR,file

log4j.appender.file=org.apache.log4j.RollingFileAppender log4j.appender.file.maxFileSize=10240KB log4j.appender.file.maxBackupIndex=5 log4j.appender.file.File=/home/core/install/logs/middleware.log log4j.appender.file.threshold=debug log4j.appender.file.layout=org.apache.log4j.PatternLayout # %L should be used only in dev, its extremely slow #log4j.appender.file.layout.ConversionPattern=[%x] %d{ABSOLUTE} %5p %c{2}:%L - %m%n log4j.appender.file.layout.ConversionPattern=[%x][KonyServer] [%p][%d{dd MMM yyyy HH:mm:ss,SSS}]-%5p-%c{2} - %m%n

#jms.loggging is used for kony reporting validation. Make it true, if kony reporting is enabled and jms topic is configured jms.logging=false

Note: Below set of properties are required for 6.5 and above. If your middleware version is prior to 6.5, skip the below steps.

log4j.additivity.com.konylabs.middleware.services.logObservers. DevicePayloadLogger=false

© 2016 by Kony, Inc. All rights reserved 77 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

log4j.logger.com.konylabs.middleware.services.logObservers.Devi cePayloadLogger=OFF,DEVICE log4j.appender.DEVICE=org.apache.log4j.RollingFileAppender log4j.appender.DEVICE.maxFileSize=10240KB log4j.appender.DEVICE.maxBackupIndex=50 log4j.appender.DEVICE.File=/home/core/install/logs/device- payload.log log4j.appender.DEVICE.layout=org.apache.log4j.PatternLayout log4j.appender.DEVICE.layout.ConversionPattern=%n[%d{dd MMM yyyy HH:mm:ss,SSS}]:[%x]:%m log4j.additivity.com.konylabs.middleware.services.logObservers. DatasourcePayloadLogger=false log4j.logger.com.konylabs.middleware.services.logObservers.Data sourcePayloadLogger=OFF,DATASOURCE log4j.appender.DATASOURCE=org.apache.log4j.RollingFileAppender log4j.appender.DATASOURCE.maxFileSize=10240KB log4j.appender.DATASOURCE.maxBackupIndex=50 log4j.appender.DATASOURCE.File=/home/core/install/logs/datasour ce-payload.log log4j.appender.DATASOURCE.layout=org.apache.log4j.PatternLayout log4j.appender.DATASOURCE.layout.ConversionPattern=%n[%d{dd MMM yyyy HH:mm:ss,SSS}]:[%x]:%m

3. Replace the old /middleware- bootconfig/tc/deviceDetectionLogic.xml file with new one available at the /middleware-bootconfig.

Note: If your environment is Cluster, repeat the above steps for all members of Cluster. For example, if there are three members in Cluster and each member has separate middleware.home; so above steps need to be performed in each middleware.home.

© 2016 by Kony, Inc. All rights reserved 78 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Add or Update the middleware shared libraries

This section provides you steps to creating and updating the shared libraries in WebSphere.

After downloading following files of 6.x from community portal to your local machine, extract them.

l shared-libraries-was.tar

l shared-libraries-was8.tar

Create Shared Libraries in WebSphere

1. Open the Websphere Administration console.

2. In the left pane, click Environment>Shared libraries. The Shared Libraries page opens.

3. Under Scope section, select the desired server from the drop-down list. If your environment is Cluster, select scope as cell (cells:plqa1was-1Cell03). If your environment is single node, select scope as server (Node=XXXXNode01, Server=server1).

© 2016 by Kony, Inc. All rights reserved 79 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

4. Under Preferences, click New. A new page opens to define shared library.

5. In the Name box, type a name for shared library. For example, shared-libraries-was.

6. In the Description box, provide description for the shared library. For example, Shared libraries (Optional).

7. In the Classpath box, provide the path of the folder where shared-libraries-was.tar is extracted. For example, /data/middleware_installable_dirs/shared- libraries-was.

8. Do not select the Class Loading check box.

9. Click OK and click Save to save the details in master configuration.

Update Shared Libraries in WebSphere

You can update the shared libraries that are already created. For example, as you have already created the shared-libraries-was8.x shared library for HTTP related jars, you can just replace old jars with new set of jars. For this shared library, you need to select the Class Loading check box.

It is recommended to create separate shared libraries for each application. For more information on creating shared libraries, see Create Shared Libraries.

Note: If your environment is Cluster, make sure that all shared libraries are defined in cell scope. This cell has DMGR configured.

Deploy middleware.ear

1. Open the Websphere Administration console.

2. In the left pane, click Applications>Application Types> WebSphere enterprise applications.

3. Select the check box of existing middleware application and click Uninstall. If middleware.ear was already uninstalled, skip steps 1 and 2.

© 2016 by Kony, Inc. All rights reserved 80 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

4. Click Install to deploy new middleware.ear. The Preparing for the application installation page opens.

5. Click Local file system and then click Choose File to browse and select the middleware.ear file from local machine. (or) Click Remote file system if middleware.ear was downloaded to remote system and browse for middleware.ear file.

6. Click Next.

7. In the How do you want to install the application section, click Detailed - Show all installation options and parameters and continue clicking Next till you reach Map modules to servers.

8. Select check box and select target. For example, if your environment is Cluster, select target as desired cluster. If your environment is single node, select target as desired server.

© 2016 by Kony, Inc. All rights reserved 81 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

9. Continue clicking Next till you reach Map Shared libraries step. The Install New Application page opens.

10. Select the application, click the shared library references hyperlink.

11. Map the shared libraries for the selected application and click OK.

© 2016 by Kony, Inc. All rights reserved 82 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

12. Continue clicking Next till you reach Summary page. Click Finish and then Save to save the details to master configuration.

3.3.1.6 Upgrading admin.war

This section provides procedures for following:

l Create Datasource for admin

l Update Existing Property Files

l Kony Legacy Report Portal Configuration for 6.x

l Deploy admin.war of 6.x

Note: You can skip upgrading admin.war if you are not using admin and metrics. Metrics has to be deployed on single node, which should not be part of Cluster.

Prerequisites

For upgrading admin.war, you need to upgrade the database from 5.6.x to 6.x (DB2). You can set up the database by executing the following scripts, which are downloaded from community portal.

l konyadmin-.sql

l Schema/konyreports-.sql

© 2016 by Kony, Inc. All rights reserved 83 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

After execution of these scripts, spool files are created at script locations. You can use these spool files to verify the smooth execution of the script files.

To set up the database, follow these steps:

1. Log on to DB2 Server with appropriate credentials.

2. Test the database connection using the DB2 command line utility:

db2 db2=> connect to KONYDB user dbclient using

3. Execute the konyadmin-.sql file. This script creates konyadmin database objects in KONYADMIN schema.

cd db2 -td';' -vf konyadmin-.sql > 00_konyadmin_spool.log

4. Execute the konyreports-.sql file. This script creates konyreports database objects in KONYREPORTS schema.

db2 -td';' -vf konyreports-.sql > 01_konyreports_ spool.log

Create Datasource for admin and reports (DB2)

Creating Datasource process involves following steps:

1. Defining DB2 Provider

2. Configuring datasource

© 2016 by Kony, Inc. All rights reserved 84 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Define DB2 Provider

1. Open the Websphere Administration console.

2. In the left pane, click Resources>JDBC> JDBC Provider. The JDBC Provider page opens.

3. Under Scope section, select the desired option from the drop-down list. For example, for Cluster, select scope name as cell(cells:plqa1was-1Cell03). In this cell, DMGR is available. For single node, select scope name as node (Node=XXXXNode01).

4. Under Preferences, click New. The Create a new JDBC Provider page opens.

5. Select the following options:

l Database Type: DB2

l Provider Type: DB2 Universal JDBC Driver Provider

l Implementation Type: Connection pool data source

Note: By default, Name field is populated as DB2 Universal JDBC Driver Provider (Optional).

6. Click Next.

Note: If you need to use custom or updated DB2 Jars, then update: DB2UNIVERSAL_ JDBC_DRIVER_PATH and DB2UNIVERSAL_JDBC_DRIVER_ NATIVEPATH

7. Ensure that DB2 driver files, db2jcc.jar and db2jcc_license_cu.jar are downloaded and copied to the file system - /opt/db2jars.

8. Click Next. Verify the implementation class name on Summary page and click Finish.

Set up user credentials for JNDI database connection

© 2016 by Kony, Inc. All rights reserved 85 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Open the Websphere Administration console.

2. In the left pane, click Security>Global Security. The Global Securitypage opens.

3. In the Authentication section, select Java Authentication And Authorization Service>J2C Authentication Data.

4. In the page that appears, click New.

5. Provide the following details to connect to Oracle database:

l Alias: konyAuth

l Userid: dbclient

l Passwd:

6. Click OK and save the configuration.

Configure Admin and Reports Datasource

1. Open the Websphere Administration console.

2. In the left pane, click Resources>JDBC> Data sources. The Data sourcespage opens.

3. Under Scope section, select the desired option from the drop-down list. For example, for Cluster, select scope name as cell (cells:plqa1was-1Cell03). In this cell, DMGR is available. For single node, select scope name as node (Node=XXXXNode01).

4. Under Preferences, click New. The Create a data source page opens.

5. Provide the following details:

l Datasource Name: konyadmindb

l JNDI Name: jdbc/ konyadmindb (The same JNDI name should be configured in serverconsole.properties file)

6. Click Next.

© 2016 by Kony, Inc. All rights reserved 86 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

7. Select an existing JDBC provider. Here it is DB2 Universal JDBC Driver Provider (created in previous step).

8. Click Next.

9. Provide following details:

l Database Name: KONYDB (the database is created using schema script initially)

l Port Number: Type your database port number. For example, 50000

l Server Name: Type your database host name or IP address and click Next. The Setup security aliases page opens.

10. Select JAAS – J2C Authentication Data here.

11. Set up security aliases as following:

l Component-managed authentication alias: XXXNode01/dbclient.

l Mapping configuration alias: Default Principal Mapping.

l Container-managed authentication alias: XXXNode01/ dbclient.

12. Click Next, verify the changes and Click Finish.

© 2016 by Kony, Inc. All rights reserved 87 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

13. Similarly, add another datasource repeating steps 1 - 12, but with following details:

l Name: konyreportsdb

l JNDI Name: jdbc/konyreportsdb

14. After creating konyreportsdb datasource, click on it. The konyreportsdb page opens.

© 2016 by Kony, Inc. All rights reserved 88 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

15. Under Additional Properties section, click Custom properties>currentSchema. The currentSchema page opens.

16. In the Value box, type KONYREPORTS and click OK.

Note: This value refers to reports schema name.

17. Click Save to save directly to master configuration.

18. Click Resources>JDBC>DataSources.

19. Click konyadmindb. The konyadmindb page opens.

20. Under Additional Properties section, click Custom properties>currentSchema. The currentSchema page opens.

21. In the Value box, type KONYADMIN and click OK.

© 2016 by Kony, Inc. All rights reserved 89 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Note: This value refers to admin schema name.

22. Click Save to save directly to master configuration.

23. Restart the Websphere application server to changes take effect.

Add New and Update Existing Property Files

Add serverconsole.properties file

1. Copy the serverconsole.properties file from /middleware- bootconfig/admin to the existing middleware-bootconfig/admin folder.

2. Update the below properties in the serverconsole.properties file.

############################################################### ########## #Admin and Report Database JNDI Names ############################################################### ########## admindb.jndi.name=jdbc/konyadmindb reportsdb.jndi.name=jdbc/konyreportsdb ############################################################### ########## #Database Type (mysql/oracle/sqlserver/db2) ############################################################### ########## admindb.dbtype=db2 reportsdb.dbtype=db2 #For DB2 konyadmindb.dialect=com.kony.console.admin.dialect.CustomDB2Dia lect

© 2016 by Kony, Inc. All rights reserved 90 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Updating admin-log4j.properties file

1. Replace the existing /middleware- bootconfig/admin/admin-log4j.properties file with the new one. The new admin-log4j.properties file is located at /middlewarebootconfig/admin.

2. Open the admin-log4j.properties file and update following property:

log4j.appender.file.File=/home/middleware/logs/admin.log

Kony Legacy Report Portal Configuration

If you are using the Kony Reporting Portal for tracking sessions and users, you must make the following changes so that you continue to see the reports in the new Admin Console (under Reports > Legacy Reports in admin console).

Note: If you have not configured reports home for your server, add –D parameter of reports home to your server. For example, –DkonyReports.home=/data/config

Note: If your environment is Cluster, make sure that you have configured konyReports.home for all members of cluster.

Make sure that following files are available in reports home. For example, /data/config.

l DbSpecificProcedureCall.properties

l konyreport.properties

l log4j.properties

Make sure that below property value was set properly in the konyreports.properties file.

© 2016 by Kony, Inc. All rights reserved 91 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

#database properties konyadminreports.jndi.name=jdbc/KARDB

Deploy admin.war

1. Open the Websphere Administration console.

2. In the left pane, click Application>Application Types>WebSphere enterprise Applications. The Enterprise Applicationspage opens.

3. Select existing admin application and click Uninstall.

Note: If admin.war was already uninstalled, skip step 3.

4. Click Install to deploy new admin.war.

5. Click Local file system and then click Choose File to browse and select the admin.war file from local machine. (or) Click Remote file system if admin.war was downloaded to remote system and browse for admin.war file.

6. Click Next. The Preparing for the application installation page opens.

7. Select Detailed - Show all installation options and parameters and click Next. The Application Security Warnings page opens, click Continue. This opens a page with 11 steps.

8. Step 1: Select installation options, change application name if required, leave default values and click Next.

9. Step 2: Map modules to servers, Map the Server Console module to your desired server or cluster and click Next.

© 2016 by Kony, Inc. All rights reserved 92 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

10. Step 3: Provide JSP reloading options for Web modules, leave default values and click Next.

11. Step 4: Map shared libraries, map previously created shared library, shared-libraries-was, shared-libraries-was8.x to both Application (admin_war) and Module (Server Console). The Shared library references page opens.

12. Select application and click Reference shared libraries button. The Shared Library Mapping page opens.

13. Select your shared library from Available box and move it to Selected box using arrow keys provided and click OK.

14. Similarly, Go to Shared Library Mapping page, select module and click Reference shared libraries button, and repeat step 13 to map shared libraries.

Note: You cannot map both application and module simultaneously.

15. Step 5: Map shared library relationships, leave default values and click Next.

16. Step 6: Map virtual hosts for Web modules, map your virtual host (default_host) to module and click Next.

17. Step 7: Map context roots for Web modules, select Context Root value as /admin and click Next till you reach Summary page.

18. Step 11: Summary, review summary and click Finish.

19. Wait till you get application installed successfully message.

20. Click Save to save to master configuration.

© 2016 by Kony, Inc. All rights reserved 93 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

21. Click Applications>Application Types>Websphere enterprise applications.

22. Select the admin_war application and click Start.

3.3.1.7 Upgrading Metrics (logdaemon) metrics.ear is a new application developed in 6.x that supports same features as logdaemon and reports of 5.6.x.

Note: Stop existing logdaemon process and deploy metrics.ear application for 6.x version.

Note: metrics.ear should be deployed only on single server.

Configure JMS

Create bus

1. Open the Websphere Administration console.

2. In the left pane, click Service integration>Buses. The Buses page opens.

3. Click New to create new bus. The Create a new Service Integration bus page opens.

4. In the Enter the name for your new bus box, type a name for the bus and click Next.

5. Step 2: Confirm create of new bus and click Finish.

6. Click Save to save directly to the master configuration.

© 2016 by Kony, Inc. All rights reserved 94 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Adding a new Bus Member

1. Click on previously created bus that is, serverBus. The serverBus page opens.

2. Under the Topology section, click the Bus members link.

3. Click Add to add bus members. The Add a new bus member page opens.

4. Step 1: Click Server, select desired server (for example, server1) from the drop-down box, and click Next.

5. Step 1.1: Select the type of message store as File Store and click Next.

6. Step 1.2: Configure the file store, do not change the default values and click Next.

7. Step 1.3: Do not change the default heap sizes and click Next.

8. Step 2: Verify the complete summary and click Finish.

9. Click Save to save directly to the master configuration.

Creating Bus Destination

1. Open serverBus page.

2. Under the Destinations resources section, click the Destination link. The Destinations page opens.

3. Click New. The Create a new destination page opens.

© 2016 by Kony, Inc. All rights reserved 95 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

4. Click Topic Space and click Next. The Create new topic space page opens.

5. In the Identifier box, type KonyMetricsTopic.

6. In the Description box, type description for the new topic space and click Next. The Confirm topic space creation page opens.

7. Verify the details and click Finish.

8. Click Save to save directly to the master configuration.

Creating Topic connection factories

1. Open the Websphere Administration console.

2. In the left pane, click Resources>JMS>Topic connection factories. The Topic connection factories page opens.

3. Click New.

4. Select JMS rosource provider as Default messaging provider and click OK.

5. Provide the following details:

l Name: KonyMetricsTopicCF

l Jndi name: jms/KonyConnectionFactory

l Bus name: serverBus

6. Click Save to save directly to the master configuration.

© 2016 by Kony, Inc. All rights reserved 96 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Creating Topic

1. Open the Websphere Administration console.

2. In the left pane, click Resources>JMS>Topics. The Topics page opens.

3. Click New.

4. Select JMS rosource provider as Default messaging provider and click OK.

5. Provide following details:

l Name: KonyMetricsTopic

l Jndi name: jms/KonyMetricsTopic

l Bus name: serverBus

l Topic Space: select other, please specify from the drop-down list and in the text box, type KonyMetricsTopic. Click OK.

6. Click Save to save directly to the master configuration.

Creating Activation Specifications

1. Open the Websphere Administration console.

2. In the left pane, click Resources>JMS>Activation specifications. The Activation specifications page opens.

3. Click New.

4. Select JMS rosource provider as Default messaging provider and click OK.

© 2016 by Kony, Inc. All rights reserved 97 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

5. Provide following details:

l Name: KMT

l Jndi name: jms/KMT

l Destination type: Topic

l Destination JNDI name: jms/KonyMetricsTopic

l Bus name: serverBus

6. Click OK.

7. Click Save to save directly to the master configuration.

Configure middleware.home as JVM Property

1. Open the Websphere Administration console.

2. In the left pane, click Servers>Server Types>Webspere application server. The Activation specifications page opens.

3. Select the application server in which you want to install metrics.ear. The selected application server page opens.

4. Under Server Infrastructure section, click Java and Process Management>Process definition. The Process definition page opens.

5. Under Additional Properties section, click the Java Virtual Machine link.

6. In the Generic JVM arguments box, type the middleware.home property with your middleware home path as below (-D must be prefixed). -Dmiddleware.home=/home/core/install

7. Click OK and then Save to save in the master configuration.

© 2016 by Kony, Inc. All rights reserved 98 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Files required in middleware.home

Following files need to be updated:

l middleware.properties

l metrics-log4j.properties

l admin/serverconsole.properties

Update middleware.properties file

1. Copy the middleware.properties file from /middleware-bootconfig/ to /middleware-bootconfig/ folder.

2. Open the middleware.properties file and make sure that following properties set to correct value as shown below.

################################################## #Metrics Topic Configuration ################################################## #To enable/disable metrics #Make it true, if Kony Reports enabled and Metrics Topic is configured metrics.logging=true metrics.TopicName=jms/KonyMetricsTopic metrics.TopicConnectionFactoryName=jms/KonyConnectionFactory ##-- START - Should be enabled only on Websphere JMS Server log4j.appender.jms.initialContextFactoryName=com.ibm.websphere. naming.WsnInitialContextFactory log4j.appender.jms.providerURL=iiop://localhost:2809 ##-- END - Should be enabled only on Websphere JMS Server #Account ID and Environment ID for Reports KONY_ACCOUNT_ID=Kony ENVIRONMENT_ID=Dev

© 2016 by Kony, Inc. All rights reserved 99 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Updating metrics-log4j.properties file

1. Copy the metrics-log4j.properties file from /middleware-bootconfig/ to /middleware-bootconfig/ folder.

2. Open the metrics-log4j.properties file and make sure that following property set to correct value as shown below.

log4j.appender.file.File=/home/middleware/logs/metrics.log

Updating serverconsole.properties

1. Copy the serverconsole.properties file from /middleware- bootconfig/admin to /middleware-bootconfig/admin folder.

2. Open the serverconsole.properties file and make sure that following properties set to correct value as shown below.

############################################################### ########## #Admin and Report Database JNDI Names ############################################################### ########## admindb.jndi.name=jdbc/konyadmindb reportsdb.jndi.name=jdbc/konyreportsdb ############################################################### ########## #Database Type (mysql/oracle/sqlserver/db2) ############################################################### ########## admindb.dbtype=db2 reportsdb.dbtype=db2 #For DB2

© 2016 by Kony, Inc. All rights reserved 100 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

konyadmindb.dialect=com.kony.console.admin.dialect.CustomDB2Dia lect

Deploy metrics.ear

1. Open the Websphere Administration console.

2. In the left pane, click Application>New Application. The New Application page opens.

3. Click New Enterprise Application.

4. Click Local file system and then click Choose File to browse and select the metrics.ear file from local machine. (or) Click Remote file system if metrics.ear was downloaded to remote system and browse formetrics.earfile.

5. Click Next. The Preparing for the application installation page opens.

6. Click Detailed - Show all installation options and parameters and click Next. The Application Security Warnings page opens and click Continue.

7. Step 1: Select installation options, change application name if required, leave default values and click Next.

8. Step 2: Map modules to servers, map the metrics module to your selected desired server (for example, server1) if not mapped by default and click Next.

9. Step 3 : Map shared libraries, map previously created shared library shared-libraries-was, shared-libraries-was8.x to application (metrics.ear). The Shared library reference page opens.

© 2016 by Kony, Inc. All rights reserved 101 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

10. Select the application and click Reference shared libraries. The Shared Map libraries page opens.

11. Select your shared library from Available box and move to Selected box using arrow keys provided.

12. Click OK.

13. If shared libraries are not defined, perform steps in section "Add or Update the middleware shared libraries" on page 79.

14. Step 4: Map shared library relationships, leave default values and click Next.

15. Step 5: Bind listeners for message-driven beans, select Activation Specification, specify target resource jndi name as jms/KMTand click Next.

16. Step 6: Metadata for modules, leave default values and continue clicking Next till you reach Summary page.

17. Step 8: Summary, review summary and click Finish.

18. Wait till you get application installed successfully message.

19. Click Save to save directly to master configuration.

20. Restart the Websphere Application Server to take the changes effect.

Maker sure that server is started in following order:

l Metrics server

l Clustered Middleware

© 2016 by Kony, Inc. All rights reserved 102 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.3.1.8 Verify the Upgrade Process

Verification of admin.war

l Invoke the http:///admin/version.html URL and check the version. In the URL, replace with proper IP address and port number.

Verification of middleware.ear

l Invoke the http://ipaddress:port/middleware/version.html URL and check the version. In the URL, replace with proper IP address and port number.

Verification of environment health

This step is required only when you have admin, middleware and metrics in your environment.

1. Log on to the admin console using the following URL and look for Health Check. http://ipaddress:port/admin (replace with proper IP address and port number).

2. Provide admin credentials (default credentials from SQL script are username: admin and password: admin123) to log on to Server Console.

3. Navigate to Settings and click Health Check and look for Report DB, Admin DB and Reporting Queue. Note that the status should be in PASSED state.

3.3.2 Upgrade WebSphere Manually from 6.x to 6.5.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 6.0.x to 6.5.x (WebSphere). Assume that you have prior installation of Kony MobileFabric Integration Service.

3.3.2.1 Prerequisites

The following table displays the prerequisites for upgrading Kony MobileFabric Integration Service.

© 2016 by Kony, Inc. All rights reserved 103 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Refer to http://community.kony.com/downloads/archive/manual and click Kony MobileFabric. Click Download for Middleware to download the following artifacts of </Middleware/>:

Artifacts Type Purpose

Respective Database scripts Database To setup the required Scripts schema

l admin.war WAR and To be deployed to EAR files Application Server

l middleware.ear

l metrics.ear (this is required only if you have metrics)

l middleware- TAR files bootconfig.tar

l shared-libraries-was

l shared-libraries-was8.x

3.3.2.2 Backup

Before taking the backup, Stop the WebSphere application server.

To backup the existing files, follow these steps:

1. Take a backup of existing shared libraries, shared-libraries-was and shared- libraries-was8 files from the location where you have defined libraries.

2. Take a backup of middleware-bootconfig located at /middleware.

© 2016 by Kony, Inc. All rights reserved 104 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Note: After taking the backup, delete all the files from the original location. Uninstall previous admin.war, middleware.war and metrics.ear. metrics.ear only in case if you are using metrics.

3.3.2.3 Execute Database Scripts

1. Execute all the database upgrade scripts from 6.0.x to 6.5.x.

2. Run the scripts in the sequence specified at the location from where you downloaded the scripts. Below is the screen shot of the scripts specified in a sequence. Replace the name of the konyadmin and konyreports schema names with your respective schema names.

3. Following are the db upgrade scripts for upgrading from 6.0.3.x to 6.5.0.x.

3.3.2.4 Add and Update Properties Files

1. Extract the middleware-bootconfig tar to the /middleware location.

2. Retain the properties of the admin-log4j.properties and deployment- config.properties files located at middleware-bootconfig/admin folder from the respective files of the previous version, which are already backed up.

3. Retain the properties of the middleware.properties and middleware- log4j.properties files located at middleware-bootconfig folder from the respective files of the previous version which are already backed up.

4. Open the middleware-log4j.properties file and edit the below paths for device- payload.log and datasource-payload.log as per your requirement.

l log4j.appender.DEVICE.File=${middleware.home} /../logs/middleware/device-payload.log

l log4j.appender.DATASOURCE.File=${middleware.home} /../logs/middleware/datasource-payload.log

© 2016 by Kony, Inc. All rights reserved 105 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

5. Copy the appregistry folder from the previous version of middleware-bootconfig (located at /middleware) to the new middleware- bootconfig folder.

If metrics is not used:

6. Open the middleware.properties file located at the middleware-bootconfig folder and mark the property under Metrics Topic Configuration as false.

metrics.logging=false

Note: This property was introduced in 6.0.3.3.GA version of middleware. This property enables the metrics. Request and Session data is captured in the database if this property is set to true.

Note: If the metrics.logging property is set to false, call the kony.license.disableMetricReporting() API in app init to disable “Maximum Offline Sessions Exceeded” alert.

If metrics is used:

7. Open middleware.properties in the middleware-bootconfig folder and mark the property under Metrics Topic Configuration as true.

metrics.logging=true

8. Retain the properties in the metrics-log4j.properties file located at the middlware- bootconfig/admin folder, and the serverconsole.properties file located at the middleware-bootconfig folder from the same respective files of previous version which are backed up.

© 2016 by Kony, Inc. All rights reserved 106 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.3.2.5 Deploy Latest Artifacts

1. Deploy the latest admin.war and middleware.ear. Refer to the Deploy admin.war and Deploy middleware.ear.

2. Deploy the latest metrics.ear. Refer to the Deploy metrics.ear.

Note: You can skip the step 2 if you are not using metrics.

3. Replace the downloaded shared libraries ( shared-library-was and shared-library- was8) with the 6.5.x shared libraries.

3.3.2.6 Verification

Start the WebSphere application server.

Verification of middleware.ear

l Invoke the http://ipaddress:port/admin/version.html URL and check the version. In the URL, replace with proper IP address and port number.

Verification of environment health

This step is required only when you have admin, middleware and metrics in your environment.

1. Log on to the admin console using the following URL http://ipaddress:port/admin (replace with proper IP address and port number).

2. Provide admin credentials to log on to Server Console.

3. Navigate to Settings and click Health Check and look for Report DB, Admin DB and Reporting Queue. Note that the status should be in PASSEDstate.

© 2016 by Kony, Inc. All rights reserved 107 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

4. Navigate to Settings and click Configuration and verify the version.

3.4 Upgrading Kony MobileFabric Integration Service - WebLogic

Upgrade Kony MobileFabric Integration Service manually on WebLogic server through different versions by following the below links:

© 2016 by Kony, Inc. All rights reserved 108 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Server From Version To Link Version

WebLogic 5.0.x/5.5.x/5.6.x 6.5.x Click here

6.0.x 6.5.x Click here

6.5.x 7.0.x Click here

3.4.1 Upgrade WebLogic Manually from 5.0.x/5.5.x / 5.6.x to 6.5.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 5.0.x/5.5.x / 5.6.x to 6.5.x (WebLogic). Assume that you have prior installation of Kony MobileFabric Integration Service.

3.4.1.1 Prerequisites

The following table displays the prerequisites for upgrading Kony MobileFabric Integration Service.

Refer to http://community.kony.com/downloads/manual to download the following artifacts of </Middleware/>:

Artifacts Type Purpose

Respective Database scripts Database Scripts To setup the required schema

l admin.war WAR and EAR To be deployed to Application files Server l middleware.ear

l metrics.ear (applicable only for metrics)

l middleware- TAR files bootconfig.tar

© 2016 by Kony, Inc. All rights reserved 109 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.4.1.2 Backup

To backup files, follow these steps:

1. Stop the application server.

2. Take a backup of the following files from your current server installation location.

a. The files:

l middleware.ear

l admin.war

l reports.war

b. middleware-bootconfig directory

Sample path for middleware -bootconfig \middleware\middleware-bootconfig>

c. After taking the backup, delete all the above files.

3.4.1.3 Database Upgrade for Legacy Reports

Download and run the upgrade scripts from http://developer.kony.com/KonyDBScripts to upgrade the database and enable legacy reports.

For example: If your database version is 5.0.3 Oracle, run the schemas in "Oracle_upgrade_5.0.3 to 5.0.6" folder in the numerical order.

Note: To enable the legacy reports, the database should be the latest 5.0.6. version. If your database is not latest, run the database scripts based on your database and upgrade to 5.0.6 version.

3.4.1.4 Execute Database Scripts

To execute the database scripts downloaded in the prerequisites step, follow these steps:

© 2016 by Kony, Inc. All rights reserved 110 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Execute the database scripts from downloaded artifacts and verify that new Admin and Reports schema created in the database.

Note: This is required for new metrics.

Note: Change the names of Kony Admin and Kony Reports as per your requirements in the SQL files downloaded in the Prerequisites step.

2. In Konyadmin DB, add the following entries into mobilefabric_configuration table

l management_server_hostname with your WebLogic administration console IP

l management_server_port with WebLogic administration console port

l management_server_username with WebLogic Username

l management_server_password with WebLogic Password

l management_server_groups with the name of the cluster or servers to which the apps should be deployed when published from IDE separated by comma.

3.4.1.5 Add New and Update Existing Property Files middleware-bootconfig of 6.5.x is bundled with few additional .properties files compared to earlier versions that are required during the upgrade process. You would also need few .properties files from your backup location.

To add new and update existing property files, follow these steps:

1. Download and extract the middleware-bootconfig.tar file downloaded in step 2b from Prerequisites section, to the \middleware directory.

The following new property files extracted are applicable only for metrics

© 2016 by Kony, Inc. All rights reserved 111 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

a. metrics-log4j.properties in the middleware-bootconfig folder that is available under middleware home.

b. admin-log4j.properties and serverconsole.properties in the admin folder available under middleware-bootconfig.

2. Retain deployment-config.properties from your backup location \admin to .

3. Retain the changes made to middleware.properties or middleware- log4j.properties files for previous version.

4. Update existing property files:

a. Update the middleware.properties file from \middleware\middleware-bootconfig with the following content as per your requirement.

b. Comment out the JBoss JMS Properties and uncomment the WebLogic JMS Properties.

5. Copy the appregistry folder of middleware-bootconfig from the previous version to the new extracted middleware-bootconfig folder.

Note: You must replace the credentials and IP addresses according to your environment.

################################################## #Metrics Topic Configuration (applicable only for metrics) ##################################################

#To enable/disable metrics #Make it true, if Kony Reports enabled and Metrics Topic is #configured

© 2016 by Kony, Inc. All rights reserved 112 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

metrics.logging=true

metrics.TopicName=jms/KonyMetricsTopic metrics.TopicConnectionFactoryName=jms/KonyConnectionFactory

#For JBOSS JMS

metrics.initialContextFactoryName=org.jboss.naming.remote.clien t. #InitialContextFactory #metrics.providerURL=remote://

#For Weblogic JMS #metrics.initialContextFactoryName=weblogic.jndi. WLInitialContextFactory #metrics.providerURL=remote://

#START- JBoss 6.2 EAP Additional Properties metrics.securityPrincipalName=admin metrics.securityCredentials=admin123 metrics.userName=admin metrics.password=admin123 #END- JBoss 6.2 EAP Additional Properties

#metrics.URLPkgPrefixes=jboss.naming:org.jnp.interfaces #NOTE: failoverDuration and failoverRetries introduced for kony middleware (not defined by log4j) #metrics.FailoverDuration=5000 #metrics.FailoverRetries=3

© 2016 by Kony, Inc. All rights reserved 113 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

Note: From 6.0.3.3 GA, metrics.logging flag is available and by default, it is set to true. Prior to that, below error is displayed (you can ignore this). ERROR- logservice.JMSLogService - Error while look up topic.

Note: If we set metrics.logging property to false, call the kony.license.disableMetricReporting() API in app init to disable “Maximum Offline Sessions Exceeded” alert.

6. Open serverconsole.properties file and make the following changes based on your database type.

Note: Uncomment the properties according to your database type and comment the else for hibernate Dialect properties. For Database type enter the db type as shown.

#Server Console configuration properties file #Hibernate Dialect related properties. #For SQL Server

#konyadmindb.dialect=com.kony.console.admin.dialect.CustomSQLSe rverDialect

#For MySQL

#konyadmindb.dialect=com.kony.console.admin.dialect.CustomMySQL Dialect

#For Oracle thin driver

#konyadmindb.dialect=com.kony.console.admin.dialect.CustomOracl eDialect

© 2016 by Kony, Inc. All rights reserved 114 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

#For DB2

#konyadmindb.dialect=com.kony.console.admin.dialect.CustomDB2Di alect

#konyadmindb.dialect=com.kony.console.admin.dialect.CustomMySQL Dialect

#Admin and Report Database JNDI Names admindb.jndi.name=jdbc/konyadmindb reportsdb.jndi.name=jdbc/konyreportsdb

#Database Type (mysql/oracle/sqlserver/db2) admindb.dbtype=mysql reportsdb.dbtype=mysql

7. Open middleware-log4j.properties file from middleware- home\middleware\middleware-bootconfig> and edit as following.

Note: You must replace the credentials and IP addresses according to your environment.

jms.logging=true (Change this value to false if old reports and JMS topic is configured or to be configured)

#Enable the below statements if reporting is enabled and JMS topic is configured.

#log4j.category.com.konylabs.middleware.connectors.logservice=I NFO,jms

© 2016 by Kony, Inc. All rights reserved 115 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

#log4j.additivity.com.konylabs.middleware.connectors.logservice =FALSE #Provide the location of the log file to be logged #LOG4J.appender.file.FILE=\logs\middleware.log

3.4.1.6 Update Data Source Configuration (Applicable Only For Metrics)

To update the data source configuration, follow these steps:

1. Setup Kony Admin Data Source

a. In Administration Console, select Services > Data Sources from the left menu.

b. Click New to add a new data source name.

c. Provide the following information:

l Data source name: konyadmindb

l JNDI Name: jdbc/konyadmindb

d. Click Next to continue.

e. Select the database driver.

f. Enter the following connection properties

l Database name

l Host Name

l Port

l Database Username and Password (Username is the Admin db name created after running the database scripts for new schema).

© 2016 by Kony, Inc. All rights reserved 116 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

g. Click Next to continue.

h. Select the appropriate cluster or server as the target of the data source.

i. Click Finish to create a data source for the given details.

2. Setup Kony Reports data source.

a. In Administration Console, select Services > Data Sources from the left menu.

b. Click New.

c. Enter the following information

l Data source name: konyreportsdb

l JNDI Name: jdbc/konyreportsdb

d. Click Next to continue.

e. Select the database driver.

f. Enter the following connection properties

l Database name

l Host name

l Port

l Database Username and Password (Username is the Reports DB created after running the database scripts for new schema)

g. Click Next to continue.

h. Select the appropriate cluster or server as the target of the data source.

i. Click Finish to create a data source for the given details.

© 2016 by Kony, Inc. All rights reserved 117 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.4.1.7 Update JMS Configuration (Applicable Only For Metrics)

Note: If JMS is already configured in the previous version, update the JMS configuration with the below update steps.

To update JMS Configuration, follow these steps:

1. In Administration Console, select Services > Messaging > JMS Modules from the left menu.

2. Open the System module created from the previous version.

3. Click New to create a new JMS System Module Resource.

4. Select the Topic option and click Next.

5. Enter the name and JNDI name as KonyMetricsTopic and click Next.

6. Select the sub-deployment created while configuring the previous version from the drop-down and click Finish.

7. Repeat the above steps for all the System Modules configured.

Note: To configure JMS Server and Module for Metrics (if not used previously), refer Configure JMS Server.

3.4.1.8 Deploy the latest .WAR Files

To deploy the latest WAR files, follow these steps:

1. Deploy the latest admin.war, middleware.ear and metrics.ear (applicable only for metrics) files to the application server from the Deployments tab of WebLogic Administration console and provide the target as the cluster or servers in which Kony MobileFabric Integration Service is configured.

© 2016 by Kony, Inc. All rights reserved 118 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

2. Extract the jar files available in libraries-MIDDLEWARE-QA-ver.tar to this location - \\install\lib\middleware.

Important: Start the server or cluster from the Servers tab under Environments in the left menu of the Administration Console.

3.4.1.9 Kony Report Portal Configuration

If you are using the Kony Reporting Portal for tracking sessions and users, then you must make the following changes so that you continue to see the reports in the new Admin Console (under the section Reports > Legacy Reports).

To track sessions and users, follow these steps:

1. Place the following files in \Konyreports\home. These files are available in the 5.x installation under reports_config folder:

l DbSpecificProcedureCall.properties

l konyreport.properties

l log4j.properties

2. In the Server Start tab of the server in WebLogic Administrator console, provide the location where the files are placed-Dkonyreports.home=.

3.4.1.10 Verification

Verify the upgrade process by logging into the console and look for Server Version and Health Check. Use version.html for verification.

To verify the upgrade process, follow these steps:

1. Navigate to the URL http://ipaddress:port/middleware/version.html and look for server version.

© 2016 by Kony, Inc. All rights reserved 119 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

2. Navigate to Settings and click Health Check and look for Report DB, Admin DB and Reporting Queue. Note that the status should be in PASSED state.

3. Navigate to Settings and click Configuration.

3.4.2 Upgrade WebLogic Manually from 6.0.x to 6.5.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 6.x to 6.5.x (WebLogic). Assume that you have prior installation of Kony MobileFabric Integration Service.

3.4.2.1 Prerequisites

The following table displays the prerequisites for upgrading Kony MobileFabric Integration Service.

Refer to http://community.kony.com/downloads/manual to download the following artifacts:

Artifacts Type Purpose

Respective Database Upgrade scripts Database Scripts To setup the required schema

l admin.war WAR and EAR To be deployed to Application files Server l middleware.ear

l metrics.ear (applicable only for metrics)

(Advantages)

© 2016 by Kony, Inc. All rights reserved 120 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

l libraries-MIDDLEWARE-GA- TAR files <6.x>.tar

l middleware- bootconfig.tar

3.4.2.2 Backup

To backup files, follow these steps:

1. Stop the application server.

2. Take a backup of the following files from your current server installation location.

a. These files are available at \user_ projects\domain\your_domain .

l middleware.ear

l admin.war

l metrics.ear (applicable only for metrics)

b. middleware-bootconfig directory available at \middleware\middleware-bootconfig>

c. middleware libraries (.JAR files) - The files are located at

d. After taking the backup, delete all the above files.

3.4.2.3 Execute Database Upgrade Scripts (Applicable Only For Metrics)

To execute the database upgrade scripts downloaded in the prerequisites step, follow these steps:

© 2016 by Kony, Inc. All rights reserved 121 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

1. Execute the database upgrade scripts of GA-6.5.0 from http://community.kony.com/downloads/manual.

Note: Run the scripts in given order. Replace the names of konyadmin and konyreports schema to your respective schemas.

2. In Konyadmin DB, add the following entries (if not available) into PROP_NAME and PROP_ VALUE columns of mobilefabric_configuration table:

l management_server_hostname with your WebLogic administration console IP

l management_server_port with WebLogic administration console port

l management_server_username with WebLogic Username

l management_server_password with WebLogic Password

l management_server_groups with the name of the cluster or servers to which the apps should be deployed when published from IDE separated by comma.

3.4.2.4 Add New and Update Existing Property Files middleware-bootconfig of 6.5.x is bundled with few additional .properties files compared to earlier versions that are required during the upgrade process. You would also need few .properties files from your backup location.

To add new and update existing property files, follow these steps:

1. Download and extract the middleware-bootconfig.tar file downloaded in step 2b from Backup section, to the \middleware directory.

The following new property files extracted are applicable only for metrics

a. metrics-log4j.properties in the middleware-bootconfig folder that is available under middleware home.

© 2016 by Kony, Inc. All rights reserved 122 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

b. admin-log4j.properties and serverconsole.properties in the admin folder available under middleware-bootconfig.

2. Retain admin-log4j.properties and deployment-config.properties from your backup location /admin to /middleware/middleware-bootconfig/admin>.

3. Retain the changes made to middleware.properties and middleware- log4j.properties files from previous version.

4. Open middleware-log4j.properties and edit the below path for device- payload.log and datasource-payload.log

log4j.appender.DEVICE.File = ${middleware.home} /../logs/middleware/device-payload.log log4j.appender.DATASOURCE.File=${middleware.home} /../logs/middleware/datasource-payload.log

5. Copy the appregistry folder of middleware-bootconfig from the previous version to the new middleware-bootconfig folder.

6. If metrics is not used, open middleware.properties and mark the property as false.

metrics.logging=false

Note: This property is introduced from version 6.0.3.3.

Note: If we set metrics.logging property to false, call the kony.license.disableMetricReporting() API in app init to disable “Maximum Offline Sessions Exceeded” alert.

7. Retain the metrics-log4j.properties in the middleware-bootconfig folder and serverconsole.properties in the middleware-bootconfig\admin from the previous version (applicable only for metrics).

© 2016 by Kony, Inc. All rights reserved 123 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.4.2.5 Deploy the latest .WAR Files

To deploy the latest WAR files, follow these steps:

1. Deploy the latest admin.war, middleware.ear and metrics.ear (applicable only for metrics) files to the application server from the Deployments tab of WebLogic Administration Console and provide the target as the cluster or servers in which Kony MobileFabric Integration Service is configured.

2. Extract the JAR files available in libraries-MIDDLEWARE-QA-ver.tar to this location - \\lib\middleware.

Important: Start the server or cluster from the Servers tab under Environments in the left menu of the Administration Console.

3.4.2.6 Verification

Verify the upgrade process by logging into the console and look for Server Version and Health Check. Use version.html for verification.

To verify the upgrade process, follow these steps:

1. Navigate to the URL http://ipaddress:port/admin/version.html and look for server version.

2. Navigate to Settings and click Health Check and look for Report DB, Admin DB and Reporting Queue.

Note: Status should be in PASSED state.

© 2016 by Kony, Inc. All rights reserved 124 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3. Navigate to Settings and click Configuration.

3.4.3 Upgrade WebLogic Manually from 6.5.x to 7.0.x

This section provides you the steps to upgrade Kony MobileFabric Integration Service manually from 6.5.x to 7.0.x on WebLogic application server.

3.4.3.1 Prerequisites

The following table displays the prerequisites for upgrading Kony MobileFabric Integration Service. Assuming that you have already installed Kony MobileFabric Integration Service and have setup the required Databases (Reports and Admin).

Artifacts Type Purpose

Flyway scripts Flyway To setup the required schema Scripts l Scripts to migrate from 6.5.x to 7.0.x

l admin.war WAR files To be deployed to Application Server

l middleware.war

l services.war

l Flyway tool version 3.2.1 https://flywaydb.org/getstarted/download.html

© 2016 by Kony, Inc. All rights reserved 125 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

3.4.3.2 Backup

1. Stop the application server.

1. Take a backup of the following files. These file are available at \user_projects\domain\your_domain

a. .WAR files

l middleware.war

l admin.war

l services.war

l metrics.ear (applicable only for metrics).

2. After taking the backup, delete or uninstall the above files.

3.4.3.3 Migrating Database from 6.5.x to 7.0.x

Migrating database from 6.5.x to 7.0.x is done using flyway tool.

l Download your Flyway tool from https://flywaydb.org/getstarted/download.html

l Download your DB specific migration scripts.

Migrating Admin Database

To migrate admin DB, follow these steps:

1. Open V3_konyadmin-xxxx-7.0.0.0.sql. xxxx is the type of DB you are using.

Example: MS-SQL V3__konyadmin-sqlserver-7.0.0.0.sql. Similarly for My SQL, V3__konyadmin-mysql-7.0.0.0.sql etc.

© 2016 by Kony, Inc. All rights reserved 126 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

2. In the V3_konyadmin-xxxx-7.0.0.sql, replace all KONY_SERVER place holders with the actual values from your middleware.properties file.

Example: ‘${KONY_SERVER_RICH_CLIENT_DEPLOY}' => ‘corresponding_ value_in_your_middleware.properties’

Note: If no values are assigned in middleware.properties, set those values to null in the SQL files. Example: In middleware.properties, if you have #Memcache configuration= #memcache.cluster= Then in SQL files, set the placeholders value as null.

Important: For null values, remove the colon ' '.

3. After editing, the V3-xxx.sql script, place all the scripts into SQL folder in flyway installation directory.

Example: \flyway-commandline-3.2.1-windows-x64\flyway-3.2.1\sql

4. Executing the scripts– Before executing the scripts, configure flyway to your database.

5. Open flyway.conf from \flyway-commandline-3.2.1-windows-x64\flyway- 3.2.1\conf

6. Edit the following variables. Un-comment them after editing

l flyway.url= example for MySQL, it is flyway.url=jdbc:mysql://:.

l flyway.driver=

l flyway.user

l flyway.password

© 2016 by Kony, Inc. All rights reserved 127 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

l flyway.schemas=

l flyway.baselineVersion=3

7. Open the command line and type cd to \flyway-commandline-3.2.1-windows- x64\flyway-3.2.1.

8. Execute the command flyway repair followed by flyway migrate.

9. You admin database is now migrated to 7.0.

Migrating Reports Database

To migrate your reports database, follow these steps:

1. Download the flyway scripts with respect to the type of database you are using (Oracle, MySQL, SQL) of 7.0.

2. Place the downloaded scripts in \flyway-commandline-3.2.1-windows- x64\flyway-3.2.1\sql.

3. Open flyway.conf from \flyway-commandline-3.2.1-windows-x64\flyway- 3.2.1\conf.

4. Edit the following variables. Un-comment them after editing and save the file.

l flyway.url= example for MySQL, it is flyway.url=jdbc:mysql://:.

l flyway.driver=

l flyway.user

l flyway.password

© 2016 by Kony, Inc. All rights reserved 128 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

l flyway.schemas=

l flyway.baselineVersion=3

5. Execute the flyway repair followed by flyway migrate as you have done with Admin Database.

6. Your Reports database in now migrated to 7.0.

3.4.3.4 Migrating WAR files

1. Download admin.war, middleware.war and services.war of 7.0.

2. Remove the old admin, middleware and services WAR files in deployments folder from \deployments after taking the backup by following these steps:

a. Go to Deployments page in WebLogic console.

b. Select the older admin, middleware and services WAR files and click Delete to delete them.

c. Deploy new admin.WAR, middleware.WAR and services.WAR files by following these steps:

l In Deployments page, click Install in the Deployments section.

l Click Upload your files.

l Click Choose file in Deployment Archive.

l Locate the WAR files to upload and click Next.

l Select Install this deployment as an application and click Next.

l Select the cluster or servers you want to deploy the WAR and click Next.

© 2016 by Kony, Inc. All rights reserved 129 of 130 Kony MobileFabric Integration Service - Manual Upgrade Version 1.3

l Click Next again and click Finish.

l Repeat the above steps to deploy all the WAR files.

3.4.3.5 Verification

Verify the upgrade process by logging into the console and look for Server Version and Health Check.

To verify the upgrade process

1. Access the URL http://ipaddress:port/middleware/version.html in a browser.

2. Navigate to the URL http://ipaddress:port/admin/version.html and look for server version.

3. Navigate to Settings and click Health Check and look for Report DB, Admin DB and Reporting Queue. Note that the status should be in PASSED state.

4. Navigate to Settings and click Configuration.

Note: Access to Reporting Queue will be green only if you have configured metrics and the JMS server is up and running.

© 2016 by Kony, Inc. All rights reserved 130 of 130