Kony MobileFabric Sync Windows Installation Manual - WebSphere On-Premises Release 6.5 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. 2015 by Kony, Inc. All rights reserved 1 of 90
Copyright 2014 by Kony, Inc. All rights reserved. August, 2015 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 Modeler,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-C, 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. 2015 by Kony, Inc. All rights reserved 2 of 90
Revision History Date Document Version Description of Modifications/Release 08/14/2015 2.1 Updated the sections Deploying Sync Service WAR file and Deploying Sync Console WAR file. 07/11/2015 2.0 Included a section Upgrade Kony MobileFabric Sync Manually for 6.5 release 03/31/2015 1.1 Added steps for Creating Datasource for DB2 SyncConsole Schema 12/12/2014 1.0 Updated for release 6.0 2015 by Kony, Inc. All rights reserved 3 of 90
Table of Contents 1. Preface 6 1.1 Purpose 6 1.2 Intended Audience 6 1.3 Formatting conventions 6 1.4 Contact Us 7 2. Prerequisites 8 2.1 Hardware Requirements (per physical instance) 8 2.2 Software System Requirements (per physical instance) 9 3. Deploying Kony MobileFabric Sync Server 10 3.1 Download Files 11 3.2 Creating Sync Console Database 12 3.3 Setting up Sync Home Directory 13 3.4 Setting up Shared Libraries Directory 13 3.5 Configuring Sync Home and Middleware Home as JVM Property 15 3.6 Creating Shared Library for Sync JAR Files 18 3.7 Creating a Data Source for SyncConsole 22 3.8 Configuring Sync Console JNDI and Hibernate Dialect 58 3.9 Deploying SyncConsole WAR File 60 3.10 Deploying syncservice WAR File 69 4. Upgrade WebSphere Manually from 5.5.x / 5.6.x to 6.5.x 79 2015 by Kony, Inc. All rights reserved 4 of 90
4.1 How to upgrade Kony MobileFabric Sync 79 5. Import Root Authority Certificates 83 5.1 Exporting a Root Authority Certificate from Salesforce Login Page 83 5.2 Importing a Certificate to the Application Server Trust Store 87 2015 by Kony, Inc. All rights reserved 5 of 90
1. Preface Kony MobileFabric Sync Installation Windows Manual - WebSphere 1. Preface Kony MobileFabric Sync product comes with two applications - Sync Management Console and Sync Services. These two applications and corresponding database schema run on various platforms like Tomcat Apache, WebLogic and WebSphere and the databases like MS SQL Server, Oracle, MySQL, PostgreSQL and DB2. 1.1 Purpose This document provides instructions for installing and configuring Kony MobileFabric Sync Server and supporting software packages on Windows and WebSphere. 1.2 Intended Audience This document is intended for developers or system administrators who are responsible for installing and deploying Kony MobileFabric Sync Application Server. It is assumed that the reader of this document is familiar with deploying software on Java application servers / WebSphere application server. The reader must understand how to install the database software. 1.3 Formatting conventions The following typographical conventions are used throughout the document: Convention Explanation Monospace User input text, system prompts, and responses File path Commands Program code File names 2015 by Kony, Inc. All rights reserved 6 of 90
1. Preface Kony MobileFabric Sync Installation Windows Manual - WebSphere Convention Explanation Italic Emphasis Names of books and documents New terminology Bold Windows Menus Buttons Icons Fields Tabs URL Active link to a URL Note: Provides helpful hints or additional information Important: Highlights actions or information that might cause problems to systems or data 1.4 Contact Us We welcome your feedback on our documentation. Write to us at techpubs@kony.com. For technical questions, suggestions, comments or to report problems on Kony product line, contact prodsupport@kony.com. 2015 by Kony, Inc. All rights reserved 7 of 90
2. Prerequisites Kony MobileFabric Sync Installation Windows Manual - WebSphere 2. Prerequisites Read this information to understand the system requirements before you install and configure Kony MobileFabric Sync Server. You must ensure that the below software is installed on the machine on which you want to install Kony MobileFabric Sync. 2.1 Hardware Requirements (per physical instance) Component Specification per Instance Standard Development Environment Standard QA or Certification Environment Standard Production Environment Windows Windows Server 2008 Windows Server 2008 Windows Server 2008 Operating R2/ Windows 8 R2/ Windows 8 R2/ Windows 8 System Professional / Windows Professional / Windows Professional / Windows 7 Professional, 64-bit, 4 7 Professional, 64-bit, 4 7 Professional, 64-bit, 4 Core Core Core Linux Red Hat Linux Red Hat Linux Red Hat Linux Operating Enterprise 6.0, 64-bit, 4 Enterprise 6.0, 64-bit, 4 Enterprise 6.0, 64-bit, 4 System Core Core Core Minimum Recommended RAM 8 GB or more 16 GB or more 32 GB or more Minimum Recommended Hard Disk Space 40 GB or more 40 GB or more 80 GB or more For detailed information on hardware requirements, refer Kony MobileFabric Sync Server Installation Options section of Kony MobileFabric Sync On-Premises Server Planning Guide. 2015 by Kony, Inc. All rights reserved 8 of 90
2. Prerequisites Kony MobileFabric Sync Installation Windows Manual - WebSphere 2.2 Software System Requirements (per physical instance) For software system requirements, click here. 2015 by Kony, Inc. All rights reserved 9 of 90
3. Deploying Kony MobileFabric Sync Server Kony MobileFabric Sync Installation Windows Manual - WebSphere 3. Deploying Kony MobileFabric Sync Server You have to do the following to deploy Kony MobileFabric Sync Server (Sync Console and Sync Services) on default WebSphere server node (server1): Note: To deploy in a cluster environment, you must point your server scope to cluster cell name instead of server node name in all the steps. 1. Downloading Files 2. Creating SynConsole Database 3. Setting up Kony MobileFabric Sync Home Directory 4. Setting up Shared Library Directory 5. Configuring Sync Home as JVM Property 6. Creating Shared Library for Sync Jar Files 7. Creating Data Source for Sync Console Schema 8. Configuring Sync Console JNDI and Hibernate Dialect 9. Deploying Synconsole War File 10. Deploying Syncservice War File 2015 by Kony, Inc. All rights reserved 10 of 90
3.1 Download Files Download the following files from Kony Developer Portal: WAR files o syncconsole.war o syncservice.war Properties-files (zip file contains the following files) o syncconsole.properties o syncservice.properties o console-log4j.properties o services-log4j.properties o synclicense.properties o middleware.properties Console Schema file o console-schema-sqlserver.sql (for MSSQL database) o console-schema-oracle.sql (for Oracle database) o console-schema-mysql.sql (for MySQL database) o console-schema-postgresql.sql (for Postgre SQL database) Sync shared libraries zip file o SyncSharedLib.zip 2015 by Kony, Inc. All rights reserved 11 of 90
3.2 Creating Sync Console Database Run console-schema-sqlserver.sql file from your SQL Server Management studio. A syncconsole database is created. Note: If you use database other than SQL Server, download respective console schema file from Kony Developer Portal and use database specific client (GUI based or command line) to create syncconsole schema. 2015 by Kony, Inc. All rights reserved 12 of 90
3.3 Setting up Sync Home Directory To set up Sync home directory, follow these steps: 1. Create a folder in your directory structure (For example, D:\Kony\KonySync). 2. Create a conf directory under it. 3. Extract PropertyFiles.zip to the conf directory. The following files appear: console-log4j.properties services-log4j.properties synclicense.properties syncconsole.properties syncservice.properties middleware.properties 4. Create the directory structure, middleware/middleware-bootconfig under sync.home, and place an empty file with name middleware.properties. 3.4 Setting up Shared Libraries Directory You can setup the following shared libraries directory 1. Shared Libraries 2. Shared Libraries for WAS 8.x and above Note: If you are using shared libraries for WAS 8.x and above, you have to perform steps both in Shared Libraries and Shared Libraries for WAS 8.x sections. 2015 by Kony, Inc. All rights reserved 13 of 90
3.4.1 Shared Libraries To set up shared libraries directory, follow these steps: 1. Create a folder anywhere in your directory structure (For example: D:\Kony\KonySync\sharedlib). 2. Extract downloaded SyncSharedLib.zip files under the above directory, and ensure that all the JAR files are available directly under this directory and not in one of its sub directory. 3.4.2 Shared Libraries for WAS 8.x To set up shared libraries directory for WAS 8.x and above, follow these steps: 1. Create a folder anywhere in your directory structure (For example: D:\Kony\KonySync\sharedlib-was8). 2. Extract downloaded SyncSharedLib-WAS8.x.zip files under the above directory, and ensure that all the jar files are available directly under this directory and not in one of its sub directory. 2015 by Kony, Inc. All rights reserved 14 of 90
3.5 Configuring Sync Home and Middleware Home as JVM Property You have to configure Sync home as JVM property. To configure Sync home and Middleware home as JVM properties, follow these steps: 1. Start WebSphere Server. 2. Open the WebSphere Administration Console. 3. Go to Servers > Server Types > WebSphere application servers. 4. Click the Application Server. (For example, server1, it is the default server created with WebSphere installation). 5. Go to Server Infrastructure section, expand Java and Process Management and click 2015 by Kony, Inc. All rights reserved 15 of 90
Process definition. 2015 by Kony, Inc. All rights reserved 16 of 90
6. Go to Additional Properties, click Java Virtual Machine. 7. Enter 512 as initial heap size and 1024 as maximum heap size. 8. Under Generic JVM arguments section, add the sync.home and middleware.home properties with your Sync home path as below (you must prefix -D). 2015 by Kony, Inc. All rights reserved 17 of 90
9. Click OK. A screen appears to save the master configuration. 10. Click Save. 3.6 Creating Shared Library for Sync JAR Files You have to create the following shared libraries for Sync JAR files. 2015 by Kony, Inc. All rights reserved 18 of 90
1. For WebSphere 2. For WebSphere 8.x Note: If you are using WebSphere 8.x, you have to perform steps both in WebSphere and WebSphere 8.x sections. 3.6.1 For WebSphere To create a shared library for Sync JAR files, follow these steps: 1. Open the WebSphere Administration Console. 2. Go to Environment > Shared libraries. 3. Select your server Scope. The scope name may appear as Node=XXXXNode01, Server=server1. 2015 by Kony, Inc. All rights reserved 19 of 90
4. Click New. 5. Provide name of the shared library in Name. For example, SynchSharedLib. 6. Provide description of the shared library in Description. For example, Sync Shared libraries (Optional). 7. Provide the classpath in Classpath. This should be the folder path to the directory where all Sync jar files are extracted to. It is D:\Kony\KonySync\Sharedlib. 8. Clear the Class Loading check box. 9. Click OK. A screen appears to save the master configuration. 2015 by Kony, Inc. All rights reserved 20 of 90
10. Click Save to save in master configuration. Note: If you are using WebSphere 8.x, you have to perform steps both in WebSphere and WebSphere 8.x sections. 3.6.2 For WebSphere 8.x Note: Ensure you have performed the steps in WebSphere section before performing the steps in this section. To create a shared library for Sync JAR files, follow these steps: 1. Open the WebSphere Administration Console. 2. Go to Environment > click Shared libraries. 3. Select your server Scope, scope name may appear as Node=XXXXNode01, Server=server1. 4. Click New. 5. Provide name of the shared library in Name. For example, SynchShared_WAS. 6. Provide description of the shared library in Description. (Optional) 7. Provide the classpath in Classpath. This should be the folder path to the directory where all Sync jar files are extracted to. It is E:\Websphere8.5.5\sync_ home\syncsharedlib_was8.x. 8. Select the Class Loading check box. 9. Click OK. A screen appears to save in the master configuration 10. Click Save to save in master configuration. 2015 by Kony, Inc. All rights reserved 21 of 90
3.7 Creating a Data Source for SyncConsole You must create a data source for Sync console: Creating a Data Source for SyncConsole Schema (SQL Server) Creating a Data Source for SyncConsole Schema (Oracle) Creating a Data Source for SyncConsole Schema (MySQL) Creating a Data Source for SyncConsole Schema (PostgreSQL) Creating a Data Source for SyncConsole Schema (DB2) 2015 by Kony, Inc. All rights reserved 22 of 90
3.7.1 Creating a Data Source for SyncConsole Schema (SQL Server) To create a data source in WebSphere, you must create a Java Application and Authorization Service (JAAS) JAAS-J2C Authentication Data and JDBC Provider. Important: Use this section if you want to configure a data source for SyncConsole schema on SQL Server. Creating a data source involves the following processes: 1. Creating a JAAS J2C Authentication 2. Creating a JDBC Provider 3. Creating a Data source 3.7.1.1 Creating a JAAS J2C Authentication To create a JAAS J2C authentication, follow these steps: 2015 by Kony, Inc. All rights reserved 23 of 90
1. Go to WebSphere Administration Console > Security > click Global Security. 2. Expand Java Authentication and Authorization Service > click J2C authentication data. A screen appears to create a new JAAS - J2C authentication data. 3. Click New. 2015 by Kony, Inc. All rights reserved 24 of 90
4. Provide your database user details shown below: You must enter your SQL Server Sync Console database alias name, user name and password in Alias, User ID and Password (not the system user details). 5. Click OK. A screen appears to save the master configuration. 6. Click Save. 3.7.1.2 Creating a JDBC Provider To create a JDBC provider, follow these steps: 1. Go to Resources > JDBC, and click JDBC providers. 2. Select your server scope. the scope name may appear as Node=XXXXNode01, Server=server1. 3. Click New. 2015 by Kony, Inc. All rights reserved 25 of 90
4. Select SQL Server from the Database Type drop-down to create a SQL Server JDBC Provider. 5. Select Microsoft SQL Server JDBC Provider (any meaningful name that you shall use in Creating Datasource) from the Provider Type drop-down. 6. Click Next. 7. Provide directory location for sqljdbc4.jar that is available in Sync shared libraries. Give the path to SyncSharedLib directory, D:\Kony\KonySync\SyncSharedLib (you can give any directory that contains the sqljdbc4.jar file). 2015 by Kony, Inc. All rights reserved 26 of 90
Note: Native library path is optional. 8. Click Next and review your inputs. 9. Click Finish. 3.7.1.3 Creating a Data Source To create a data source, follow these steps: 1. Go to Resources > JDBC, click Data sources. 2. Select you server Scope. The scope name looks like Node=XXXXNode01, Server=server1. 3. Click New. 4. Provide ConsoleDBDS as Datasource Name. 2015 by Kony, Inc. All rights reserved 27 of 90
5. Provide jdbc/consoledb as JNDI Name (you must configure the same JNDI name in the syncconsole.properties file). 6. Click Next. 7. Select an existing JDBC provider, for example, Microsoft SQL Server JDBC Provider (created in Creating a JDBC Provider), and click Next. 8. Provide syncconsole (the syncconsole database that is created using console schema script, initially) as Database Name 1433 (your database port number) as Port Number 10.10.8.20 (Your database host name or IP address) as Server Name. 9. Click Next. The Setup security aliases screen appears. 10. Setup security aliases shown below, choose already created JAAS J2C Authentication Data here: Component-managed authentication alias: XXXNode01/sa Mapping configuration alias: DefaultPrincipalMapping Container-managed authentication alias: XXXNode01/sa. 2015 by Kony, Inc. All rights reserved 28 of 90
11. Click Next, review changes, and then click Finish. 12. Restart the WebSphere application server for the changes to take effect. 2015 by Kony, Inc. All rights reserved 29 of 90
3.7.2 Creating a Data Source for SyncConsole Schema (Oracle) To create a data source in WebSphere, you need to create a JAAS-J2C Authentication Data and JDBC Provider. Important: Use this section if you need to configure a data source for SyncConsole schema on Oracle. Creating a data source involves the following processes: 1. Creating a JAAS J2C Authentication 2. Creating a JDBC Provider 3. Creating a Data source 3.7.2.1 Creating a JAAS J2C Authentication To create a JAAS J2C authentication, follow these steps: 1. Go to WebSphere Administration Console > Security > Global Security. 2. Expand Java Authentication and Authorization Service > click J2C authentication data > click New. 2015 by Kony, Inc. All rights reserved 30 of 90
3. Provide your syncconsole database user details as shown below: You must enter your Oracle syncconsole database alias, user name and password in Alias, User ID and Password (not the system user details). 2015 by Kony, Inc. All rights reserved 31 of 90
4. Click OK. A screen appears to save the master configuration. 5. Click Save. 3.7.2.2 Creating a JDBC Provider To create a JDBC provider, follow these steps: 1. Go to Resources > JDBC, and click JDBC Provider. 2. Select your server scope, scope name may appear as Node=XXXXNode01, Server=server1. 3. Click New. 4. Select Oracle from the Database Type drop-down to create Oracle JDBC Provider. 5. Select Oracle JDBC Driver (any meaningful name that you use in Creating a Data Source) from the Provider Type drop-down. 6. Select Connection pool data source as Implementation type. 7. Provide Oracle JDBC Provider (any meaningful name that you use in Creating a Data Source) as Name. 2015 by Kony, Inc. All rights reserved 32 of 90
8. Click Next. 9. Provide directory location for ojdbc6.jar that is available in Sync shared libraries. Give the path to SyncSharedLib directory, D:\Kony\KonySync\SyncSharedLib (you can give any directory that contains the ojdbc6.jar file). 2015 by Kony, Inc. All rights reserved 33 of 90
10. Click Next and review your inputs. 11. Click Finish. 3.7.2.3 Creating a Data Source To create a Data source, follow these steps: 1. Go to Resources > JDBC, click Data sources. 2. Select your server Scope. the scope name may appear as Node=XXXXNode01, Server=server1. 3. Click New. 4. Provide ConsoleDBDS as Datasource Name. 2015 by Kony, Inc. All rights reserved 34 of 90
5. Provide jdbc/consoledb as JNDI Name (you must configure the same JNDI name in the syncconsole.properties file). 6. Click Next. 7. Select an existing JDBC provider, for example, JDBC Provider (created in Creating a JDBC Provider). 8. Click Next. 9. Provide JDBC URL for Oracle database in URL as below: jdbc:oracle:thin:@localhost:1521:xe where, localhost Oracle database host (can be IP address or host name) 1521 - Oracle port number XE - Oracle SID. 10. Choose data store helper class name from the Data store helper class name drop-down. It depends on Oracle <version>. 11. Click Next. The Setup security aliases screen appears. 12. Set up the security aliases shown below, choose already created JAAS J2C Authentication Data here: 2015 by Kony, Inc. All rights reserved 35 of 90
Component-managed authentication alias: XXXNode01/syncconsole Mapping configuration alias: DefaultPrincipalMapping Container-managed authentication alias: XXXNode01/syncconsole. 13. Click Next, review changes, and then click Finish. 14. Restart the WebSphere application server for the changes to take effect. 2015 by Kony, Inc. All rights reserved 36 of 90
3.7.3 Creating a Data Source for SyncConsole Schema (MySQL) MySQL is not a certified JDBC driver on WebSphere. Therefore, you must configure a user-defined JDBC provider when you configure your data source to point to a MySQL database. To create a data source in WebSphere, you must create a JAAS - J2C Authentication Data and JDBC Provider. Important: Use this section if you need to configure a data source for SyncConsole schema on MySQL. Creating a data source involves the following processes: 1. Creating a JAAS J2C Authentication 2. Creating a JDBC Provider 3. Creating a Data Source 4. Setting Custom Properties of Data Source 3.7.3.1 Creating a JAAS J2C Authentication To create a JAAS J2C authentication, follow these steps: 1. Go to WebSphere Administration Console > Security > Global Security. 2. Expand Java Authentication and Authorization Service > click J2C authentication data > click New. 2015 by Kony, Inc. All rights reserved 37 of 90
3. Provide your MySQL database user details shown below: You must enter your MySQL database alias, user name and password in Alias, User ID and Password. 4. Click OK. A screen appears to save the master configuration. 5. Click Save. 3.7.3.2 Creating a JDBC Provider To create a JDBC provider, follow these steps: 1. Go to Resources > JDBC, and click the JDBC Provider. 2. Select your server scope. The sope name may appear as Node=XXXXNode01, Server=server1. 3. Click New. 4. Create a JDBC provider with name MySQL JDBC Provider. 2015 by Kony, Inc. All rights reserved 38 of 90
5. Set User defined as Database type. 6. Set com.mysql.jdbc.jdbc2.optional.mysqlconnectionpooldatasource as Implementation class name. 7. Click Next. 8. Set Database class path to the location of MySQL JDBC connector jar file. MySQL JDBC connector jar is available in Sync shared libraries. Provide path as D:\Kony\KonySync\SyncSharedLib\mysql-connector-java-5.1.26- bin.jar. 2015 by Kony, Inc. All rights reserved 39 of 90
9. Click Next and review your inputs. 10. Click Finish. 3.7.3.3 Creating a Data Source To create a Data source, follow these steps: 1. Go to Resources > JDBC, and click Data sources. 2. Select you server Scope. The scope name may appear as Node=XXXXNode01, Server=server1. 3. Click New. 4. Provide ConsoleDBDS as Datasource Name. 5. Provide jdbc/consoledb as JNDI Name (you must configure the same JNDI name in the syncconsole.properties file). 6. Click Next. 2015 by Kony, Inc. All rights reserved 40 of 90
7. Select an existing JDBC provider, for example, MySQL JDBC Provider (created in Creating a JDBC Provider). 8. Click Next. 9. Choose the data store helper class name. Retain the default values. 10. Click Next. 11. Setup security aliases shown below, choose already created JAAS J2C Authentication Data here: Component-managed authentication alias: XXXNode01/mysqlroot Mapping configuration alias: DefaultPrincipalMapping Container-managed authentication alias: XXXNode01/mysqlroot. 12. Click Next, review changes, and then click Finish. 3.7.3.4 Setting Custom Properties of Data Source For user defined data sources, you must provide database details (Server Name, Port, Database Name, User and Password) under custom properties of a data source. To set the custom properties of a data source, follow these steps: 1. Click MySQL Data source to open it. 2. Click Custom Properties under Additional Properties section. 3. Click New and set the following properties. If Customer property already exists with the below names, edit them and provide values. servername = localhost (the host name or IP address of the MySQL server) port = 3306 (MySQL database port) 2015 by Kony, Inc. All rights reserved 41 of 90
databasename = syncconsole (the name of the syncconsole database) user = root (the user name of the MySQL server) password = rootpassword (the password associated with the user name) Note: You can use the URL property to specify complete JDBC URL of syncconsole database shown below instead of above all properties: URL = jdbc:mysql://localhost:3306/syncconsole?user=root&password=root password 4. Restart the WebSphere application server for the changes to take effect. 2015 by Kony, Inc. All rights reserved 42 of 90
3.7.4 Creating a Data Source for SyncConsole Schema (PostgreSQL) PostgreSQL is not a certified JDBC driver on WebSphere. Therefore, you must configure a userdefined JDBC provider when you configure your data source to point to a PostgreSQL database. To create a data source in WebSphere, you must create a JAAS - J2C Authentication Data and JDBC Provider. Important: Use this section if you need to configure a data source for SyncConsole schema on PostgreSQL. Creating a data source involves the following processes: 1. Creating a JAAS J2C Authentication 2. Creating a JDBC Provider 3. Creating a Data Source 4. Setting Custom Properties of Data Source 3.7.4.1 Creating a JAAS J2C Authentication To create a JAAS J2C authentication, follow these steps: 2015 by Kony, Inc. All rights reserved 43 of 90
1. Go to WebSphere Administration Console > Security > Global Security. 2. Expand Java Authentication and Authorization Service > click J2C authentication data. A screen appears to create a new JAAS - J2C authentication data. 3. Click New. 2015 by Kony, Inc. All rights reserved 44 of 90
4. Provide your PostgreSQL database user details shown below: You must enter your PostgreSQL alias, database user name and password in Alias, User ID and Password. 5. Click OK. A screen appears to save the master configuration. 6. Click Save. 3.7.4.2 Creating a JDBC Provider To create a JDBC provider, follow these steps: 1. Go to Resources > JDBC, and click JDBC Provider. 2. Select your server scope. The scope name may appear as Node=XXXXNode01, Server=server1. 3. Click New. 4. Create a JDBC provider with name PostgreSQL JDBC Provider. 5. Set User defined as Database type. 2015 by Kony, Inc. All rights reserved 45 of 90
6. Type org.postgresql.ds.pgconnectionpooldatasource in Implementation class name. 7. Provide a name and description for your user-defined JDBC provider in Name and Description respectively, and then click Next. 8. Provide the path and name of the PostgreSQL JDBC connector jar file, and click Next. PostgreSQL JDBC connector jar is available in Sync shared libraries. For example, provide path as D:\Kony\KonySync\SyncSharedLib\postgresql-9.2-1000.jdbc4.jar. 2015 by Kony, Inc. All rights reserved 46 of 90
9. Click Next and review your inputs. 10. Click Finish. 3.7.4.3 Creating a Data Source To create a data source, follow these steps: 1. Go to Resources > JDBC, click Data sources. 2. Select you server Scope. The scope name may appear as Node=XXXXNode01, Server=server1. 3. Click New. 4. Provide ConsoleDBDS as Datasource Name. 5. Provide jdbc/consoledb as JNDI Name (you must configure the same JNDI name in the syncconsole.properties file). 6. Click Next. 7. Select an existing JDBC provider, for example, PostgreSQL JDBC Provider (created in Creating a JDBC Provider). 2015 by Kony, Inc. All rights reserved 47 of 90
8. Click Next. 9. Choose the data store helper class name. Retain the default values. 10. Click Next. The Setup security aliases screen appears. 11. Setup security aliases shown below, choose already created JAAS J2C Authentication Data here: Component-managed authentication alias: XXXNode01/postgres Mapping configuration alias: DefaultPrincipalMapping Container-managed authentication alias: XXXNode01/postgres. 12. Click Next, review changes, and then click Finish. 3.7.4.4 Setting Custom Properties of Data Source After you create a user-defined JDBC provider for your PostgreSQL data source, there are several properties you must set manually. To set the custom properties of the data source, follow these steps: 1. Click PostgreSQL Data source to open it. 2. Click Custom Properties under Additional Properties section. The Custom properties page appears. 3. You must add values for the database name, server name, database port number, connecting user, user password, one at a time, from the Configuration tab. Click New under Preferences. The Configuration tab appears. 4. Provide values for the following configuration properties: Click New and set the following properties. If Customer property already exists with the below names, edit them and provide values. 2015 by Kony, Inc. All rights reserved 48 of 90
Name databasename servername portnumber User Value Name of your syncconsole database used for the data source, for example, Syncconsole Host name / IP address of the PostgreSQL database server, for example, localhost Port through which the PostgreSQL database communicates, for example, 5432 Login role name used for connections, for example, postgres Password Password for the login role, for example, ******* Note: You can use the URL property to hold complete JDBC URL of syncconsole database below instead of above properties: URL=jdbc:postgresql://localhost:5432/syncconsole?user=postgres& password=password 5. Restart the WebSphere application server for the changes to take effect. 2015 by Kony, Inc. All rights reserved 49 of 90
3.7.5 Creating a Data Source for SyncConsole Schema (DB2) To create a data source in WebSphere, you must create a JAAS - J2C Authentication Data and JDBC Provider. Important: Use this section if you need to configure a data source for SyncConsole schema on DB2. Creating a data source involves the following processes: 1. Creating a JAAS J2C Authentication 2. Creating a JDBC Provider 3. Creating a Data Source 4. Setting Custom Properties of Data Source 3.7.5.1 Creating a JAAS J2C Authentication To create a JAAS J2C authentication, follow these steps: 2015 by Kony, Inc. All rights reserved 50 of 90
1. Go to WebSphere Administration Console > Security > Global Security. 2. Expand Java Authentication and Authorization Service > click J2C authentication data. A screen appears to create a new JAAS - J2C authentication data. 3. Click New. 4. Provide your DB2 database user details shown below: 2015 by Kony, Inc. All rights reserved 51 of 90
You must enter your DB2 alias, database user name and password in Alias, User ID and Password. 5. Click OK. A screen appears to save the master configuration. 6. Click Save. 3.7.5.2 Creating a JDBC Provider To create a JDBC provider, follow these steps: 1. Go to Resources > JDBC, and click JDBC Provider. 2. Select your server scope. The scope name may appear as Node=XXXXNode01, Server=server1. 3. Click New. 4. Select DB2 as Database type drop-down to create DB2 JDBC Provider. 5. Select DB2 Universal JDBC Driver Provider from the Provider Type drop-down. 6. Select Connection pool data source as Implementation type. 7. Provide DB2 Universal JDBC Driver Provider (any meaningful name that you use in Creating a Data Source) as Name. 2015 by Kony, Inc. All rights reserved 52 of 90
8. Click Next. 9. Provide directory location for db2jcc.jar. Note: Please make sure that DB2 driver jars are downloaded in the location provided in Class Path. 2015 by Kony, Inc. All rights reserved 53 of 90
10. Click Next and review your inputs. 11. Click Finish. 3.7.5.3 Creating a Data Source To create a data source, follow these steps: 1. Go to Resources > JDBC, click Data sources. 2. Select you server Scope. The scope name may appear as Node=XXXXNode01, Server=server1. 3. Click New. 4. Provide ConsoleDBDS as Datasource Name. 5. Provide jdbc/consoledb as JNDI Name (you must configure the same JNDI name in the syncconsole.properties file). 6. Click Next. 2015 by Kony, Inc. All rights reserved 54 of 90
7. Select an existing JDBC provider, for example, DB2 Universal JDBC Driver Provider (created in Creating a JDBC Provider). 8. Click Next. 9. Provide the database specific properties for the datasource. Driver type: 4 Database name: SYNCDB (your DB2 database instance name) Server Name: 10.10.8.20 (Your database host name or IP address) Port Number: 50000 (Your DB2 port number) 10. Click Next. The Setup security aliases screen appears. 11. Setup security aliases shown below, choose already created JAAS J2C Authentication Data here: Component-managed authentication alias: XXXNode01/dbclient Mapping configuration alias: DefaultPrincipalMapping Container-managed authentication alias: XXXNode01/dbclient. 12. Click Next, review changes, and then click Finish. 2015 by Kony, Inc. All rights reserved 55 of 90
3.7.5.4 Setting currentschema in Custom Properties of Data Source To set the custom properties of the data source, follow these steps: 1. Click DB2 Data source to open it. 2. Click Custom Properties under Additional Properties section. The Custom properties page appears. 3. Search for currentschema properties and click on it. 4. Enter your Sync Console database name (sync console) as a property value. 5. Click OK to apply the changes and click Save to save the changes directly to master configuration. 2015 by Kony, Inc. All rights reserved 56 of 90
6. Restart the WebSphere application server for the changes to take effect. 2015 by Kony, Inc. All rights reserved 57 of 90
3.8 Configuring Sync Console JNDI and Hibernate Dialect Configure SyncConsole Datasource JNDI name and Hibernate dialect class name in synccosole.properties under <Sync Home>\conf directory. 1. The JNDI name should match the JNDI name that you created. 2. You must configure the dialect name for SQL Server shown below: #Sync Console configuration properties file ######################################## #Hibernate Dialect related properties. # #For SQL Server #hibernate.dialect=com.kony.sync.console.dialect.customsqlserve rdialect # #For MySQL #hibernate.dialect=com.kony.sync.console.dialect.custommysqldia lect # #For Oracle thin driver #hibernate.dialect=com.kony.sync.console.dialect.customoracledi alect # #For PostgreSQL #hibernate.dialect=com.kony.sync.console.dialect.custompostgres QLDialect 2015 by Kony, Inc. All rights reserved 58 of 90
# #For DB2 #hibernate.dialect=com.kony.sync.console.dialect.customdb2diale ct # ############################################################### ######### hibernate.dialect= com.kony.sync.console.dialect.customsqlserverdialect #SyncConsole JNDI Name syncconsole.jndi.name=jdbc/consoledb 3. Retain other properties with default values. Note: For other database types (MySQL, Oracle, PostgreSQL and DB2), you must configure a corresponding dialect class name as explained in the properties file. 2015 by Kony, Inc. All rights reserved 59 of 90
3.9 Deploying SyncConsole WAR File To deploy the syncconsole.war file, follow these steps: 1. Go to Applications and click New Application. The New Application page appears. 2. Click New Enterprise Application. 3. Select local file system and browse to the syncconsole.war file. 4. Click Next. The Preparing for the application installation page appears. 5. Select the Detailed - Show all installation options and parameters option and click Next. 6. If the Application Security Warnings page appears, click Continue. The Select installation options page appears. 2015 by Kony, Inc. All rights reserved 60 of 90
7. Retain the default values and click Next. The Map modules to servers page appears. 8. The syncconsole module is mapped to the selected server, by default. Map the syncconsole module to your selected server, if not mapped by default, and click Next. The Provide JSP reloading options for Web modules page appears. 2015 by Kony, Inc. All rights reserved 61 of 90
9. Retain the default values and click Next. The Map shared libraries page appears. 10. Map previously created shared library SyncSharedLib to both Application (syncconsole_ war) and Module (syncconsole). a. Select the check box against syncconsole_war application, and click Reference shared libraries. The Map libraries page appears. b. Select your shared library under Available and move it to Selected using the right arrow key. 2015 by Kony, Inc. All rights reserved 62 of 90
c. Click OK. Repeat the same steps for syncconsole to map to the shared library. Note: For WebSphere 8.x, select SyncSharedLib_WAS shared library under Available scroll box and move it to Selected using the right arrow key. Note: You cannot map both syncconsole_war and syncconsole in one step. The Map shared library relationships page appears. 11. Retain the default values and click Next. The Map virtual hosts for Web modules page appears. 12. Map your virtual host (default_host) to module, if not mapped by default, and click Next. The Map context roots for Web modules page appears. 2015 by Kony, Inc. All rights reserved 63 of 90
13. Type the context root value as /syncconsole in Context Root, and click Next. The Map JASPI provider page appears. 2015 by Kony, Inc. All rights reserved 64 of 90
14. Retain the default values and click Next. The Metadata for modules page appears. 15. Retain the default values and click Next. The Display module build Ids page appears. 16. Retain the default values and click Next. The Summary page appears. 17. Review summary and click Finish. Wait till you get a message conveying that the application is installed successfully. 2015 by Kony, Inc. All rights reserved 65 of 90
18. Click Save to save the master configuration. 19. You may have to restart the WebSphere Application Server. 20. Go to Applications > Application Types, click WebSphere enterprise applications. 2015 by Kony, Inc. All rights reserved 66 of 90
21. Select the syncconsole_war application, and click Start. 22. Restart the WebSphere application server for the changes to take effect. 23. In a new browser, use your host name, port (default port for server1 is 9080) and your context root given above (/syncconsole) to open Sync Management Console login screen. 2015 by Kony, Inc. All rights reserved 67 of 90
2015 by Kony, Inc. All rights reserved 68 of 90
3.10 Deploying syncservice WAR File To deploy syncservice.war file, follow these steps: 1. Go to Applications and click New Application. The New Application page appears. 2. Click New Enterprise Application. 3. Select local file system and browse to the syncservice.war file. 4. Click Next. The Preparing for the application installation page appears. 5. Select the Detailed - Show all installation options and parameters option and click Next. 6. If the Application Security Warnings page appears, click Continue. The Select installation options page appears. 2015 by Kony, Inc. All rights reserved 69 of 90
7. Retain the default values and click Next. The Map modules to servers page appears. 8. The syncservice module is mapped to the selected server, by default. Map the syncservice module to your selected server, if not mapped by default and click Next. 2015 by Kony, Inc. All rights reserved 70 of 90
The Provide JSP reloading options for Web modules page appears. 9. Retain the default values and click Next. The Map shared libraries page appears. 10. Map previously created shared library SyncSharedLib to both applications (syncservice_ war) and Module (syncservice). a. Select the check box against syncservice_war application, and click Reference shared libraries. The Map libraries page appears. 2015 by Kony, Inc. All rights reserved 71 of 90
b. Select your shared library under Available and move it to Selected using the right arrow key. c. Click OK. Repeat the same steps for syncservice to map to the shared library. Note: For WebSphere 8.x, select SyncSharedLib_WAS shared library under Available scroll box and move it to Selected using the right arrow key. Note: You cannot map both syncservice_war and syncservice in one step. The Map shared library relationships page appears. 11. Retain the default values and click Next. The Initialize parameters for servlets page appears. 2015 by Kony, Inc. All rights reserved 72 of 90
12. Retain the default values and click Next. The Map virtual hosts for Web modules page appears 13. The virtual host (default_host) is mapped to the syncservice module. Map your virtual host (default_host) to module, if not mapped by default, and click Next. The Map context roots for Web modules page appears. 2015 by Kony, Inc. All rights reserved 73 of 90
14. Type the context root value as /syncservice in Context Root and click Next. The Map JASPI provider page appears. 15. Click Next. The Metadata for modules page appears. 2015 by Kony, Inc. All rights reserved 74 of 90
16. Retain the default values and click Next. The Display module build Ids page appears 17. Retain the default values and click Next. The Summary page appears. 18. Review summary and click Finish. Wait till you get a message conveying that the application is installed successfully. 2015 by Kony, Inc. All rights reserved 75 of 90
19. Click Save to save the master configuration. 20. You may need to restart the WebSphere Application Server here. 21. Go to Applications > Application Types, and click WebSphere enterprise applications. 2015 by Kony, Inc. All rights reserved 76 of 90
22. Select the syncservice_war application and click Start. 23. Go to a new browser, use your host name, port (default port for server1 is 9080) and your context root given above (/syncservice) to open the Sync Services Test Page. 2015 by Kony, Inc. All rights reserved 77 of 90
2015 by Kony, Inc. All rights reserved 78 of 90
4. Upgrade WebSphere Manually from 5.5.x / 5.6.x to 6.5.x Kony MobileFabric Sync Installation Windows Manual - WebSphere 4. Upgrade WebSphere Manually from 5.5.x / 5.6.x to 6.5.x Kony MobileFabric Sync Framework is a comprehensive synchronization platform that enables developers to add synchronization capabilities to mobile applications. This topic talks about manually upgrading Kony MobileFabric Sync Framework without an installer. 4.1 How to upgrade Kony MobileFabric Sync The manual upgrade of Kony MobileFabric Sync includes the following steps: 1. Download the Required Files 2. Upgrade Sync Console Database 3. Upgrade Property Files 4. Upgrade WAR Files 5. Verify Sync Version 4.1.1 Download the Required Files 1. Log on to Kony developer portal http:/developer.kony.com/sync. 2. Scroll down to Kony MobileFabric Sync GA <version> area. You can download the respective DB scripts from the download link provided. 2015 by Kony, Inc. All rights reserved 79 of 90
4. Upgrade WebSphere Manually from 5.5.x / 5.6.x to 6.5.x Kony MobileFabric Sync Installation Windows Manual - WebSphere 3. Download Sync Console WAR and Sync Services WAR files. a. Under Sync Console WAR, click Download. A file named syncconsole_<version> is downloaded to your machine. b. Under Sync Services WAR, click Download. A file named syncservice- <version> is downloaded to your machine. 4. Download Properties Files and Alter Scripts. a. Under Property Files, click Download. A file named properties-filesx.x.x.x.ga is downloaded to your machine. b. Under Alter Scripts, click Download. A file named alter_scripts is downloaded to your machine. c. Under Shared Lib, click Download. A file named SyncSharedLib is downloaded to your machine. 4.1.2 Upgrade Sync Console Database 1. Extract the alter_scripts zip file. 2. The extracted folder contains the alter scripts for the respective databases used. For example: If you are using MS SQL Server, use the script file names such as consoleschema-alter-sqlserver-x.x.x.sql, the version of the script is x.x.x. 4.1.2.1 Execute Alter Scripts Files If you are upgrading Sync Server from version x to y, execute available alter scripts from version x to y. If there are no alter scripts in between two versions, then there is no need to upgrade the database. Example: 2015 by Kony, Inc. All rights reserved 80 of 90
4. Upgrade WebSphere Manually from 5.5.x / 5.6.x to 6.5.x Kony MobileFabric Sync Installation Windows Manual - WebSphere If you are upgrading Sync Server from version 6.0 to 6.5, use the following alter scripts. o console-schema-alter-mysql-6.0.0.sql o console-schema-alter-mysql-6.5.0.sql 4.1.3 Upgrade Property Files To upgrade property files in Sync server: 1. Extract the properties zip file extracted in step 4.a from the section Download the Required Files. 2. Navigate to <sync.home>\conf directory and compare the existing syncconsole.properties file with downloaded property files. If there are any modifications in the files, copy the modifications to the existing property files. Note: Do not change any path in existing property files installed through installer (for example, logs file path in log4j properties files). 3. Delete the existing sharedlib folder and copy the new sharedlib files SyncSharedLib- WAS8.x and SyncSharedLib. 4.1.4 Upgrade WAR files To upgrade WAR files: 1. Setup a backup of old WAR files. 2. Uninstall the existing WAR files and install the new WAR files. 2015 by Kony, Inc. All rights reserved 81 of 90
4. Upgrade WebSphere Manually from 5.5.x / 5.6.x to 6.5.x Kony MobileFabric Sync Installation Windows Manual - WebSphere 4.1.5 Verify Sync Version To verify if you have upgraded the Kony MobileFabric Sync version correctly, log on to Sync Console and click Configuration. The Configuration Details screen appears. The MobileFabric Sync version upgrade details will be updated against the property value of Kony Sync version. 2015 by Kony, Inc. All rights reserved 82 of 90
5. Import Root Authority Certificates Kony MobileFabric Sync Installation Windows Manual - WebSphere 5. Import Root Authority Certificates Follow the below procedures to import root authority certificate of Salesforce into WebSphere application server: 1. Exporting Root Authority Certificate from Salesforce Login Page 2. Importing Certificate to the Application Server Trust Store 5.1 Exporting a Root Authority Certificate from Salesforce Login Page To export the Salesforce certificate, follow these steps: 1. Open https://login.salesforce.com in a browser, and click the Security Report icon as highlighted. Note: Here, you consider Internet Explorer as the browser. The below steps may slightly vary in other browsers. A Website Identification dialog appears. 2015 by Kony, Inc. All rights reserved 83 of 90
5. Import Root Authority Certificates Kony MobileFabric Sync Installation Windows Manual - WebSphere 2. Click View certificates. The Certificate dialog appears. 3. On the Certification Path tab, click the root path VeriSign > View Certificate. The Certificate window appears. 2015 by Kony, Inc. All rights reserved 84 of 90
5. Import Root Authority Certificates Kony MobileFabric Sync Installation Windows Manual - WebSphere 4. On the Details tab > click Copy to File, and click OK. The Certificate Export Wizard appears. 2015 by Kony, Inc. All rights reserved 85 of 90
5. Import Root Authority Certificates Kony MobileFabric Sync Installation Windows Manual - WebSphere 5. Select the DER encoded Binary option and click Next. The Certificate Export Wizard appears. 6. Browse and provide path of the certificate file. 7. Click Next and click Finish. 2015 by Kony, Inc. All rights reserved 86 of 90
5. Import Root Authority Certificates Kony MobileFabric Sync Installation Windows Manual - WebSphere 5.2 Importing a Certificate to the Application Server Trust Store To add a certificate to the application server trust store, follow these steps: 1. Log on to the application server administration console. 2. In the navigation panel, select Security > SSL certificate and key management. The SSL certificate and key management page appears. 3. Under Related Items, click Key stores and certificates. The SSL certificates and key management dialog appears. 2015 by Kony, Inc. All rights reserved 87 of 90
5. Import Root Authority Certificates Kony MobileFabric Sync Installation Windows Manual - WebSphere 4. Select the check box corresponding to NodeDefaultTrustStore. The General Properties page for NodeDefaultTrustStore appears. 2015 by Kony, Inc. All rights reserved 88 of 90
5. Import Root Authority Certificates Kony MobileFabric Sync Installation Windows Manual - WebSphere 5. Under Additional Properties > click Signer certificates. A table that includes a list of signer certificates appears. 6. In the table, click Add to add your signed certificate. 2015 by Kony, Inc. All rights reserved 89 of 90
5. Import Root Authority Certificates Kony MobileFabric Sync Installation Windows Manual - WebSphere 7. You may have to restart the WebSphere application server for the changes to take effect. References: http://www-01.ibm.com/support/docview.wss?uid=swg21592616 http://www-01.ibm.com/support/docview.wss?uid=swg21588966 2015 by Kony, Inc. All rights reserved 90 of 90