Kony MobileFabric. Sync Server Tomcat Installation Manual. On-Premises

Transcription

1 Kony MobileFabric Sync Server Tomcat Installation Manual 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 by Kony, Inc. All rights reserved 1 of 24

2 Kony MobileFabric Sync Server Installation - Manual - Tomcat Copyright 2013 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 by Kony, Inc. All rights reserved 2 of 24

3 Kony MobileFabric Sync Server Installation - Manual - Tomcat Revision History Date Document Version Description of Modifications/Release 08/12/ Updated the manual installation instructions as per 6.5 release. 07/11/ Worked on re-branding of Kony Sync to Kony MobileFabric Sync for 6.5 release. 03/30/ DB2 support for Sync is updated for release /12/ Updated for release by Kony, Inc. All rights reserved 3 of 24

4 Kony MobileFabric Sync Server Installation - Manual - Tomcat Table of Contents 1. Preface Purpose Intended Audience Formatting conventions used in this guide Contact Us 7 2. Prerequisites Hardware Requirements (per physical instance) Software System Requirements (per physical instance) Necessary Setup Files 9 3. Setting Up Tomcat for Kony MobileFabric Sync Install Tomcat Add Driver Jars Creating SyncConsole Database Setting up Sync Home Directory Creating Datasource and Configuring JNDI and Hibernate Dialect Deploying SyncConsole Application Deploying SyncServices Application by Kony, Inc. All rights reserved 4 of 24

5 1. Preface Kony MobileFabric Sync Server Installation - Manual - Tomcat 1. Preface There are two important components of Kony MobileFabric Sync Framework - Sync Management Console and Sync Services. Sync Management Console provides a single point of control for monitoring and configures the Kony MobileFabric Sync console creation process, including data integration, storage, and analysis. By using web based user interface, the console requires less training time, reduces the number of steps involved in administration. The console provides an opportunity to uphold standard operating procedures and minimize manual work by enabling repeatable processes. Sync Services are the services that synchronize data between Client and Enterprise Data Source bidirectionally. 1.1 Purpose This document provides instructions for installing and configuring Kony MobileFabric Sync Server on Tomcat. 1.2 Intended Audience This document is intended for Administrators and Developers responsible for installing and configuring Kony MobileFabric Sync Server. It is assumed that the reader of this document is familiar with deploying software on Java application servers/weblogic application server and installing database software 1.3 Formatting conventions used in this guide The following formatting conventions are used throughout the document: Click here 2015 by Kony, Inc. All rights reserved 5 of 24

6 1. Preface Kony MobileFabric Sync Server Installation - Manual - Tomcat Convention Explanation Monospace User input text, system prompts and responses File Path Commands Program Code File Names 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 2015 by Kony, Inc. All rights reserved 6 of 24

7 1. Preface Kony MobileFabric Sync Server Installation - Manual - Tomcat 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 by Kony, Inc. All rights reserved 7 of 24

8 2. Prerequisites Kony MobileFabric Sync Server Installation - Manual - Tomcat 2. Prerequisites Read this section to understand the system requirements and necessary software before you install and configure Kony MobileFabric Sync Services. 2.1 Hardware Requirements (per physical instance) Specification per Instance Component Standard Development Environment Standard QA or Certification Environment Standard Production Environment Windows Windows Server 2008 Windows Server 2008 / Windows Server 2008 / Operating / Windows 8 Windows 8 Professional Windows 8 Professional System Professional / / Windows 7 / Windows 7 Windows 7 Professional, 64 bit, 4 Professional, 64 bit, 4 Professional, 64 bit, 4 Cores Cores Cores Linux Operating Red Hat Linux Red Hat Linux Red Hat Linux System Enterprise 6.0, 64 bit, Enterprise 6.0, 64 bit, 4 Enterprise 6.0, 64 bit, 4 4 Cores Cores Cores 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 2015 by Kony, Inc. All rights reserved 8 of 24

9 2. Prerequisites Kony MobileFabric Sync Server Installation - Manual - Tomcat For detailed information on hardware requirements, refer to Kony MobileFabric Sync Server Installation Options section of Kony MobileFabric Sync On-Premises Server Planning Guide. 2.2 Software System Requirements (per physical instance) For software system requirements, click here. 2.3 Necessary Setup Files File syncconsole.war syncservice.war Download On Kony developer portal, under KonyOne Sync GA <version> (for manual installation on Tomcat) section > SyncConsole WAR > click Download to access the file. On Kony developer portal, under KonyOne Sync GA <version> (for manual installation on Tomcat) section > SyncServices WAR > click Download to access the file. On Kony developer portal, under KonyOne Sync GA <version> (for manual installation on Tomcat) section >SyncConsole Scripts-MSSQL > click Download to access the file. Property Files ojdbc6_g.jar postgresql-9.2- console-schemasqlserver-mssql.zip mysql-connectorjava bin.jar html jdbc4.jar 2015 by Kony, Inc. All rights reserved 9 of 24

10 2. Prerequisites Kony MobileFabric Sync Server Installation - Manual - Tomcat File sqljdbc4.jar DB2 driver jars (version: ) Download ibm.com/support/fixcentral/swg/selectFixes?parent=ibm%2FInformation % 2BManagement&product=ibm/Information+Management/IBM+Data+Server+Client+ Packages&release=10.5.*&platform=All&function=fixId&fixids=*jdbc*FP001& includesupersedes= by Kony, Inc. All rights reserved 10 of 24

11 3. Setting Up Tomcat for Kony MobileFabric Sync Kony MobileFabric Sync Server Installation - Manual - Tomcat 3. Setting Up Tomcat for Kony MobileFabric Sync To set up Tomcat for Kony MobileFabric Sync, follow these steps: 1. Install Tomcat 2. Add Driver Jars 3. Creating SyncConsole Database 4. Setting up Sync Home Directory 5. Creating Datasource and Configuring JNDI and Hibernate Dialect 3.1 Install Tomcat To install Tomcat, follow these steps: 1. Download apache-tomcat from 2. Extract and save the files at a required location on your system (for example, D:\tomcat 7.0). 3.2 Add Driver Jars To add driver jars, follow this step: 1. Download and add a jar file under <Tomcat_Installation>/lib folder. 2. Based on your database server, you can select one of the following jar files for connecting databases (Console Database, Persistent Database, and Enterprise Database). mysql-connector-java bin.jar ojdbc6_g.jar 2015 by Kony, Inc. All rights reserved 11 of 24

12 3. Setting Up Tomcat for Kony MobileFabric Sync Kony MobileFabric Sync Server Installation - Manual - Tomcat postgresql jdbc4.jar sqljdbc4.jar db2jcc4.jar and db2jcc_license_cisuz.jar For information on where to download the jar files, click here. 3.3 Creating SyncConsole Database To create SyncConsole Database, follow this step: Download and run.sql file from your Server Management studio. Sync console database is created. For example: For SQL Server: console-schema-sqlserver.sql For MySQL: console-schema-mysql.sql For Oracle: console-schema-oracle.sql For Postgre SQL: console-schema-postgresql.sql For DB2: console-schema-db2.sql 3.4 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 in Windows, /Kony/KonySync in Linux) and assume it as sync.home. 2. Create a conf directory under it by Kony, Inc. All rights reserved 12 of 24

13 3. Setting Up Tomcat for Kony MobileFabric Sync Kony MobileFabric Sync Server Installation - Manual - Tomcat 3. Extract the PropertyFiles.zip to the conf directory. The following files appear: a. console-log4j.properties b. services-log4j.properties c. synclicense.properties d. syncconsole.properties e. syncservice.properties f. middleware.properties 4. Create the directory structure, middleware/middleware-bootconfig under sync.home, and move middleware.properties from conf to middleware/middleware-bootconfig. 5. Configure sync.home and middleware.home as JVM argument below including memory settings. a. Open catalina.bat in <Tomcat_Installation>/bin directory. b. Add the following code at the beginning: set JAVA_OPTS=%JAVA_OPTS% -Dsync.home="D:\Kony\KonySync" - Dmiddleware.home="D:\Kony\KonySync" -Xms512m -Xmx1024m - XX:PermSize=256m -XX:MaxPermSize=256m -Dfile.encoding=UTF8 3.5 Creating Datasource and Configuring JNDI and Hibernate Dialect To create DataSource and Configure JNDI and Hibernate Dialect, follow these steps: 2015 by Kony, Inc. All rights reserved 13 of 24

14 3. Setting Up Tomcat for Kony MobileFabric Sync Kony MobileFabric Sync Server Installation - Manual - Tomcat 1. Configure the above JNDI name and hibernate dialect class name by following these steps: a. To configure console database details, include the following Resource tag in between <Context> </Context> tags in the context.xmlfile under <Tomcat_ Installation>\confdirectory. The following are the sample database JNDI resource code: My SQL Server: <Resource name="jdbc/consoledb" auth="container" type="javax.sql.datasource" factory="org.apache.tomcat.jdbc.pool.datasourcefactory" driverclassname="com.mysql.jdbc.driver" username="root" password="kony123" url="jdbc:mysql://localhost:3306/syncconsole" driverclassname="com.mysql.jdbc.driver" username="root" password="kony123" url="jdbc:mysql://localhost:3306/syncconsole" 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"/> SQL Server: <Resource name="jdbc/consoledb" auth="container" type="javax.sql.datasource" factory="org.apache.tomcat.jdbc.pool.datasourcefactory" driverclassname="com.microsoft.sqlserver.jdbc.sqlserverdriver" username="sa" password="kony123" 2015 by Kony, Inc. All rights reserved 14 of 24

15 3. Setting Up Tomcat for Kony MobileFabric Sync Kony MobileFabric Sync Server Installation - Manual - Tomcat url="jdbc:sqlserver://localhost:1433;databasename=syncconsole" 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"/> Oracle Server <Resource name="jdbc/consoledb" auth="container" type="javax.sql.datasource" factory="org.apache.tomcat.jdbc.pool.datasourcefactory" driverclassname="oracle.jdbc.driver.oracledriver" username="syncconsole" password="kony123" url="jdbc:oracle:thin:@localhost:1521:xe" 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"/> PostgreSQL Server <Resource name="jdbc/consoledb" auth="container" type="javax.sql.datasource" factory="org.apache.tomcat.jdbc.pool.datasourcefactory" driverclassname="org.postgresql.driver" username="postgres" password="kony123" 2015 by Kony, Inc. All rights reserved 15 of 24

16 3. Setting Up Tomcat for Kony MobileFabric Sync Kony MobileFabric Sync Server Installation - Manual - Tomcat url="jdbc:postgresql://localhost:5432/syncconsole" 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"/> DB2 Server <Resource name="jdbc/consoledb" auth="container" type="javax.sql.datasource" factory="org.apache.tomcat.jdbc.pool.datasourcefactory" driverclassname="com.ibm.db2.jcc.db2driver" username="dbclient" password="kony123" url="jdbc:db2://localhost:50000/konydb:currentschema=syncconsol e;" testwhileidle="true" testonborrow="true" testonreturn="false" validationquery="select 1" validationinterval="30000" timebetweenevictionrunsmillis="30000" initialsize="5" maxactive="10" minidle="5" maxwait="10000" maxidle="10" removeabandonedtimeout="600" removeabandoned="true" logabandoned="true" minevictableidletimemillis="30000" jmxenabled="true"/> Note: Contact your database administrator to get the user name and password by Kony, Inc. All rights reserved 16 of 24

17 3. Setting Up Tomcat for Kony MobileFabric Sync Kony MobileFabric Sync Server Installation - Manual - Tomcat b. Place syncconsole.properties file under <sync.home>\conf directory, where the syncconsole.properties file should have the following properties. #Sync Console configuration properties file ########################################### #Hibernate Dialect related properties. # # #For MySQL # #hibernate.dialect=com.kony.sync.console.dialect.custommysqldiale ct # # # #For Oracle # #hibernate.dialect=com.kony.sync.console.dialect.customoracledial ect # # # #For PostgreSQL # #hibernate.dialect=com.kony.sync.console.dialect.custompostgresql Dialect# ## #For DB2# #hibernate.dialect=com.kony.sync.console.dialect.customdb2dialect # # # ################################################################# ######## hibernate.dialect=com.kony.sync.console.dialect.customsqlserverdi alect Based on the database, you need to update the custom server dialect. ################################################################# ######## #SyncConsole JNDI Name 2015 by Kony, Inc. All rights reserved 17 of 24

18 3. Setting Up Tomcat for Kony MobileFabric Sync Kony MobileFabric Sync Server Installation - Manual - Tomcat # #For JBoss, #syncconsole.jndi.name=java:/consoledb # #For Tomcat, Weblogic, Websphere, #syncconsole.jndi.name=jdbc/consoledb # ################################################################# ######## syncconsole.jndi.name=jdbc/consoledb Based on the database, you need to update the custom server dialect. ################################################################# ######## ################################################################# ######## ## # Quartz related Properties # # # ################################################################# ######## #instance name org.quartz.scheduler.instancename=syncscheduler #Job store class name - Setting The Scheduler's JobStore to JobStoreTX org.quartz.jobstore.class=org.quartz.impl.jdbcjobstore.jobstoretx #Thread pool class name org.quartz.threadpool.class=org.quartz.simpl.simplethreadpool #This parameter determines number of jobs that run simultaneously org.quartz.threadpool.threadcount=12 #This parameter determines thread priority org.quartz.threadpool.threadpriority= by Kony, Inc. All rights reserved 18 of 24

19 3. Setting Up Tomcat for Kony MobileFabric Sync Kony MobileFabric Sync Server Installation - Manual - Tomcat #Determines whether the server is in clustered mode or not org.quartz.jobstore.isclustered=false #The number of milliseconds the scheduler will 'tolerate' a trigger to pass its next-fire-time by, before being considered "misfired" org.quartz.jobstore.misfirethreshold=60000 ################################################################# ############## #Quartz Dialect related property # # The below property is used by quartz to do any JDBC work required for its implementation to access syncconsole # # database.so this is based on the driver that is being used while defining syncconsole database # # # #For Microsoft SQLServer driver # #org.quartz.jobstore.driverdelegateclass=org.quartz.impl.jdbcjobs tore.mssqldelegate # # # #For PostgreSQL driver # #org.quartz.jobstore.driverdelegateclass=org.quartz.impl.jdbcjobs tore.postgresqldelegate # # # #For Oracle Drivers used in Weblogic ##org.quartz.jobstore.driverdelegateclass=org.quartz.impl.jdbcjob store.oracle.weblogic.weblogicoracledelegate # # # #For Oracle driver # #org.quartz.jobstore.driverdelegateclass=org.quartz.impl.jdbcjobs tore.oracle.oracledelegate # # # #For DB2 driver # 2015 by Kony, Inc. All rights reserved 19 of 24

20 3. Setting Up Tomcat for Kony MobileFabric Sync Kony MobileFabric Sync Server Installation - Manual - Tomcat #org.quartz.jobstore.driverdelegateclass=org.quartz.impl.jdbcjobs tore.db2v8delegate # # # #For Weblogic JDBC drivers # #org.quartz.jobstore.driverdelegateclass=org.quartz.impl.jdbcjobs tore.weblogicdelegate # # # #When the driver doesn't match above specified category # #org.quartz.jobstore.driverdelegateclass=org.quartz.impl.jdbcjobs tore.stdjdbcdelegate # ################################################################# ############# org.quartz.jobstore.driverdelegateclass=org.quartz.impl.jdbcjobst ore.mssqldelegate Based on the database, you need to update the custom server dialect. #SyncService context root name to access Sync Services Logs. syncservice.context=syncservice 2015 by Kony, Inc. All rights reserved 20 of 24

21 4. Deploying SyncConsole Application Kony MobileFabric Sync Server Installation - Manual - Tomcat 4. Deploying SyncConsole Application To deploy SyncConsole application, follow these steps: 1. Copy syncconsole.war file and paste it into webapps folder of Tomcat. 2. Start Tomcat server from Tomcat Installation. Double-click startup.bat for windows in <Tomcat_Installation>\bin folder. 3. Access console application from browser using the login URL, 4. On successful deployment, you can view the following page: 5. Enter super user credentials for the first time to login to the application: a. Username: syncadmin b. Password: SyncAdmin123 After successful login, the following screen appears: 2015 by Kony, Inc. All rights reserved 21 of 24

22 4. Deploying SyncConsole Application Kony MobileFabric Sync Server Installation - Manual - Tomcat 2015 by Kony, Inc. All rights reserved 22 of 24

23 5. Deploying SyncServices Application Kony MobileFabric Sync Server Installation - Manual - Tomcat 5. Deploying SyncServices Application You have to deploy the SyncServices application that you configured. To deploy the Sync Services application, follow these steps: 1. Copy SyncService.war file and paste it into webapps folder of Tomcat. 2. Double-click startup.bat for windows in <Tomcat_Installation>\bin folder to start the Tomcat server from Tomcat Installation. 3. After successful deployment, the tomcat console displays the below message: 4. Access service application from browser using below login URL: by Kony, Inc. All rights reserved 23 of 24

24 5. Deploying SyncServices Application Kony MobileFabric Sync Server Installation - Manual - Tomcat 5. On successful deployment, you can view the following page by Kony, Inc. All rights reserved 24 of 24