49
Kony MobileFabric™ Sync Server Manual Installation - JBoss 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. © 2016 by Kony, Inc. All rights reserved 1 of 49

KonyMobileFabric™ SyncServerManualInstallation- JBossdocs.kony.com/6_5_PDFs/sync/kmf_sync_installation_manual_jboss.pdf · KonyMobileFabric™ SyncServerManualInstallation-JBoss

  • Upload
    lamcong

  • View
    213

  • Download
    0

Embed Size (px)

Citation preview

Kony MobileFabric™

Sync Server Manual Installation -JBoss

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.

© 2016 by Kony, Inc. All rights reserved 1 of 49

Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

Copyright © 2014 Kony, Inc.

All rights reserved.

January, 2016

This document contains information proprietary to Kony, Inc., is bound by the Kony license agreements, andmay not be used except in the context of understanding the use andmethods of Kony, Inc., software withoutprior, express, written permission. Kony, Empowering Everywhere, Kony Modeler, and Kony Visualizer aretrademarks of Kony, Inc. MobileFabric is a registered trademark of Kony, Inc. Microsoft, theMicrosoft logo,Internet Explorer, Windows, andWindows Vista are registered trademarks of Microsoft Corporation. Apple, theApple logo, iTunes, iPhone, iPad, OS X, Objective-C, Safari, Apple Pay, AppleWatch, and Xcode aretrademarks or registered trademarks of Apple, Inc. Google, the Google logo, Android, and the Android logo areregistered trademarks of Google, Inc. Chrome is a trademark of Google, Inc. BlackBerry, PlayBook, Researchin Motion, and RIM are registered trademarks of BlackBerry. SAP® and SAP® Business Suite® are registeredtrademarks of SAP SE in Germany and in several other countries. All other terms, trademarks, or servicemarksmentioned in this document have been capitalized and are to be considered the property of their respectiveowners.

© 2016 by Kony, Inc. All rights reserved 2 of 49

Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

Revision History

Date DocumentVersion

Description of Modifications/Release

08/19/2015 2.1 Updatedmanual installation steps for 6.5 release.

07/11/2015 2.0 Updated Kony Sync to Kony MobileFabric Sync for 6.5 release

03/30/2015 1.1 Updated prerequisites for Persistent Sync and added DB2 support for

release 6.0.3.

12/12/2014 1.0 Updated for release 6.0.

© 2016 by Kony, Inc. All rights reserved 3 of 49

Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

Table of Contents

1. Preface 6

1.1 Purpose 6

1.2 Intended Audience 6

1.3 Formatting conventions used in this guide 6

1.4 Contact Us 7

2. Prerequisites 9

2.1 Software 9

2.2 Server Operating Systems 9

2.3 Required Setup Files 10

2.4 Persistent Sync 12

3. Create SyncConsole Database for SQL Server 14

4. Setup JNDI for SyncConsole Database 20

4.1 SQL Server 20

4.2 MySQLServer 21

4.3 PostgreSQL Server 22

4.4 Oracle Server 22

4.5 DB2 Server 23

5. Configure standalone.xml 25

5.1 SQL Server 25

5.2 MySQLServer 26

© 2016 by Kony, Inc. All rights reserved 4 of 49

Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

5.3 Oracle Server 27

5.4 PostgreSQL Server 28

5.5 DB2 Server 29

6. Class Loading Changes 31

6.1 SAP and Siebel Libraries 32

7. Sync Home Setup 34

8. Deploy SyncConsole 35

9. Deploy SyncServices 37

10. Install and Configure Kony MobileFabric Sync Using JBoss 5.1 38

10.1 Setup JNDI for SyncConsole Database 38

10.2 SyncHomeSetup 39

10.3 Deploy SyncConsole 44

10.4 Deploy SyncServices 45

11. Appendix A: Creating Replica and UploadQueue schemas (for Persistent Sync) 47

11.1 Creating Replica and UploadQueue Schemas in Oracle 47

11.2 Creating Replica and UploadQueue Schemas in DB2 48

© 2016 by Kony, Inc. All rights reserved 5 of 49

1.  Preface Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

1. Preface

There are two important components of KonyMobileFabric Sync Framework - KonyMobileFabric

SyncManagement Console, and KonyMobileFabric Sync Services.

Kony MobileFabric Sync Management Console provides a single point of control for monitoring and

configuring the KonyMobileFabric SyncConsole creation process. It includes data integration,

storage, and analysis resulting in reduced training time, manual work, and upholding standard

operating procedures.

Kony MobileFabric Sync Services are the services that synchronize data between client and

enterprise data source bi-directionally.

1.1 Purpose

This document provides instructions for installing and configuring KonyMobileFabric Sync Services

using JBoss 6.2. For instructions to install and configure KonyMobileFabric Sync Services using

JBoss 5.1, refer Install and Configure Using JBoss 5.1 section.

1.2 Intended Audience

This document is intended for Administrators and Developers responsible for installing and configuring

KonyMobileFabric Sync. It is assumed that the reader of this document is familiar with deploying

software on Java application servers and installing database software.

1.3 Formatting conventions used in this guide

The following formatting conventions are used throughout the document:

© 2016 by Kony, Inc. All rights reserved 6 of 49

1.  Preface Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

Convention Explanation

Monospace n User input text, system prompts and responses

n File Path

n Commands

n Program Code

n File Names

Italic n Emphasis

n Names of Books and Documents

n New Terminology

Bold n Windows

n Menus

n Buttons

n Icons

n Fields

n 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

Wewelcome your feedback on our documentation.Write to us at [email protected].

© 2016 by Kony, Inc. All rights reserved 7 of 49

1.  Preface Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

For technical questions, suggestions, comments or to report problems on Kony product line, contact

[email protected].

© 2016 by Kony, Inc. All rights reserved 8 of 49

2.  Prerequisites Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

2. Prerequisites

2.1 Software

For software system requirements, click here.

2.2 Server Operating Systems

l WindowsServer 2008

l Windows 7 andWindows 8

© 2016 by Kony, Inc. All rights reserved 9 of 49

2.  Prerequisites Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

2.3 Required Setup Files

File Location

syncconsole.war and

syncservice.war

1. On Kony community portal, community.kony.com, go to

Resources > Products Downloads.

The Kony Cloud page appears.

2. Login with your Kony account credentials.

The Downloads page appears.

3. Click Kony MobileFabric.

The Kony MobileFabric section appears.

4. Click the Kony <ver> GA tab > Kony Sync.

5. Select the version from the Version drop-down.

6. Click Manual Installation.

The Downloads Manual installers page appears.

7. Click Kony MobileFabric.

The Kony MobileFabric section appears.

8. Click the Kony <ver> GA tab > Kony Sync Application

Server.

9. Select the version from the Version drop-down.

10. Click the Download for JBoss <ver> button to download

thesync-jboss-<ver> zip file .

The files namedsyncconsole<ver>.war and

syncservice<ver>.war are downloaded to your

machine.

© 2016 by Kony, Inc. All rights reserved 10 of 49

2.  Prerequisites Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

File Location

console-schema-

sqlserver.sql

1. On Kony community portal, community.kony.com, go to

Resources > Products Downloads.

The Kony Cloud page appears.

2. Login with your Kony account credentials.

The Downloads page appears.

3. Click Kony MobileFabric.

The Kony MobileFabric section appears.

4. Click the Kony <ver> GA tab > Kony Sync.

5. Select the version from the Version drop-down.

6. Click Manual Installation.

The Downloads Manual installers page appears.

7. Click Kony MobileFabric.

The Kony MobileFabric section appears.

8. Click the Kony <ver> GA tab > Kony Sync Database

Scripts.

9. Select the version from the Version drop-down.

10. Click the Download for SQL Server button to download

thesync-sqlserver-<ver> zip file.

The files namedconsole-schema-

sqlserver-<ver>GA.zip, andupgrade-

scripts-sqlserver-<ver>GA.zip are

downloaded to your machine.

© 2016 by Kony, Inc. All rights reserved 11 of 49

2.  Prerequisites Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

File Location

Property Files 1. On Kony community portal, community.kony.com, go to

Resources > Products Downloads.

The Kony Cloud page appears.

2. Login with your Kony account credentials.

The Downloads page appears.

3. Click Kony MobileFabric.

The Kony MobileFabric section appears.

4. Click the Kony <ver> GA tab > Kony Sync.

5. Select the version from the Version drop-down.

6. Click Manual Installation.

The Downloads Manual installers page appears.

7. Click Kony MobileFabric.

The Kony MobileFabric section appears.

8. Click the Kony <ver> GA tab > Kony Sync Properties

and Jars.

9. Select the version from the Version drop-down.

10. Click the Download for Property Files button to

download the property files.

A file namedproperties-files-x.x.x.x.GA is

downloaded to your machine.

2.4 Persistent Sync

Weassume that you have already created Replica and UploadQueue schemas in Oracle or DB2.

© 2016 by Kony, Inc. All rights reserved 12 of 49

2.  Prerequisites Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

Note: If you have not created the schemas, refer to section Creating Replica and UploadQueue

schemas (for Persistent Sync) for steps to create the schemas.

© 2016 by Kony, Inc. All rights reserved 13 of 49

3.  Create SyncConsole Database for SQL

Server

Kony MobileFabric Sync Manual Installation

Guide - JBossVersion2.1

3. Create SyncConsole Database for SQL Server

To create Sync Console Database, follow these steps: 

1. Navigate to Start > All Programs > Microsoft SQL Server 2008 R2.

2. Click SQL Server Management Studio.

© 2016 by Kony, Inc. All rights reserved 14 of 49

3.  Create SyncConsole Database for SQL

Server

Kony MobileFabric Sync Manual Installation

Guide - JBossVersion2.1

3. Enter login credentials in the Connect to Server dialog.

© 2016 by Kony, Inc. All rights reserved 15 of 49

3.  Create SyncConsole Database for SQL

Server

Kony MobileFabric Sync Manual Installation

Guide - JBossVersion2.1

4. Click Connect.

5. Double-click console-schema-sqlserver.sql file

6. Select Databases folder and click on the script window, the Execute option appears.

7. Click Execute to run the script.

© 2016 by Kony, Inc. All rights reserved 16 of 49

3.  Create SyncConsole Database for SQL

Server

Kony MobileFabric Sync Manual Installation

Guide - JBossVersion2.1

8. Check if themessageQuery executed successfully appears at the bottom of the screen.

© 2016 by Kony, Inc. All rights reserved 17 of 49

3.  Create SyncConsole Database for SQL

Server

Kony MobileFabric Sync Manual Installation

Guide - JBossVersion2.1

9. Check if syncconsole database is listed under the Databases tab.

10. After the script runs successfully, following tables are created in the syncconsole database:

© 2016 by Kony, Inc. All rights reserved 18 of 49

3.  Create SyncConsole Database for SQL

Server

Kony MobileFabric Sync Manual Installation

Guide - JBossVersion2.1

Note: Using the above steps, you can use respective console schema script to create Sync

Console database in other database servers using respective DB clients such as (MySQL,

Oracle, and DB2.)

© 2016 by Kony, Inc. All rights reserved 19 of 49

4.  Setup JNDI for SyncConsole Data-

base

Kony MobileFabric Sync Manual Installation Guide -

JBossVersion2.1

4. Setup JNDI for SyncConsole Database

To setup JNDI for SyncConsole Database, follow these steps: 

1. Create amodule under $JBOSS_HOME/modules folder. To create a new module, do the

following:

o Create a folder hierarchy for files.

o Copymodule jar files.

o Createmodule configuration file – module.xml.

2. Follow the steps depending on the database that is used.

Note: XML configuration file (module.xml) should be in readable XML format.

4.1 SQL Server

1. mkdir -p $JBOSS_HOME/modules/com/microsoft /main

2. cp sqljdbc4.jar $JBOSS_HOME/modules/com/microsoft/main/sqljdbc4.jar

3. Createmodule.xml under $JBOSS_HOME/modules/com/microsoft/main with

the following xml code.

4.1.1 module.xml

<?xml version="1.0" encoding="UTF-8"?>

<module xmlns="urn:jboss:module:1.1" name="com.microsoft">

<resources>

<resource-root path="sqljdbc4.jar"/>

</resources>

© 2016 by Kony, Inc. All rights reserved 20 of 49

4.  Setup JNDI for SyncConsole Data-

base

Kony MobileFabric Sync Manual Installation Guide -

JBossVersion2.1

<dependencies>

<module name="javax.api"/>

</dependencies>

</module>

4.2 MySQL Server

1. mkdir -p $JBOSS_HOME/modules/com/mysql /main

2. cpmysql-connector-java-5.1.35-bin.jar $JBOSS_HOME/modules/com/ mysql /main/ mysql-

connector-java-5.1.35-bin.jar

3. Createmodule.xml under $JBOSS_HOME/modules/com/ mysql /main/ file with

the following code.

4.2.1 module.xml

<?xml version="1.0" encoding="UTF-8"?>

<module xmlns="urn:jboss:module:1.1" name="com.mysql">

<resources>

<resource-root path=" mysql-connector-java-5.1.35-bin.jar"/>

</resources>

<dependencies>

<module name="javax.api"/>

</dependencies>

</module>

© 2016 by Kony, Inc. All rights reserved 21 of 49

4.  Setup JNDI for SyncConsole Data-

base

Kony MobileFabric Sync Manual Installation Guide -

JBossVersion2.1

4.3 PostgreSQL Server

1. mkdir -p $JBOSS_HOME/modules/com/ postgresql /main

2. cp postgresql-9.2-1000.jdbc4.jar $JBOSS_HOME/modules/com/ postgresql /main/ postgresql-

9.2-1000.jdbc4.jar

3. Createmodule.xml under $JBOSS_HOME/modules/com/ postgresql

/main/.

4.3.1 module.xml

<?xml version="1.0" encoding="UTF-8"?>

<module xmlns="urn:jboss:module:1.1" name="com.postgresql">

<resources>

<resource-root path="postgresql-9.2-1000.jdbc4.jar"/>

</resources>

<dependencies>

<module name="javax.api"/>

</dependencies>

</module>

4.4 Oracle Server

1. mkdir -p $JBOSS_HOME/modules/com/oracle/main.

2. cp ojdbc6_g.jar $JBOSS_HOME/modules/com/oracle/main/ojdbc6_g.jar

3. touch $JBOSS_HOME/modules/com/oracle/main/module.xml.

© 2016 by Kony, Inc. All rights reserved 22 of 49

4.  Setup JNDI for SyncConsole Data-

base

Kony MobileFabric Sync Manual Installation Guide -

JBossVersion2.1

4.4.1 module.xml

<?xml version="1.0" encoding="UTF-8"?>

<module xmlns="urn:jboss:module:1.1" name="com.oracle">

<resources>

<resource-root path="ojdbc6_g.jar"/>

</resources>

<dependencies>

<module name="javax.api"/>

</dependencies>

</module>

4.5 DB2 Server

Note: Pleasemake sure that DB2 driver jars are downloaded in the following location.

1. mkdir -p $JBOSS_HOME/modules/com/ibm/main.

2. cp db2jcc4.jar $JBOSS_HOME/modules/com/ibm/main/db2jcc4.jar

3. cp db2jcc_license_cisuz.jar $JBOSS_HOME/modules/com/ibm/main/db2jcc_license_cisuz.jar.

4. touch $JBOSS_HOME/modules/com/ibm/main/module.xml.

4.5.1 module.xml

<?xml version="1.0" encoding="UTF-8"?>

<module xmlns="urn:jboss:module:1.1" name="com.ibm">

<resources>

<resource-root path="db2jcc4.jar"/>

<resource-root path="db2jcc_license_cisuz.jar"/>

</resources>

© 2016 by Kony, Inc. All rights reserved 23 of 49

4.  Setup JNDI for SyncConsole Data-

base

Kony MobileFabric Sync Manual Installation Guide -

JBossVersion2.1

<dependencies>

<module name="javax.api"/>

<module name="javax.transaction.api"/>

<module name="javax.servlet.api" optional="true"/>

</dependencies>

</module>

© 2016 by Kony, Inc. All rights reserved 24 of 49

5.  Configure standalone.xml Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

5. Configure standalone.xml

Configure standalone.xml under $JBOSS_

HOME/standalone/configuration/standalone.xml depending on the database type.

Note: XML configuration file (standalone.xml) should be in readable XML format.

5.1 SQL Server

<subsystem xmlns="urn:jboss:domain:datasources:1.1">

<datasources>

<datasource jndi-name="java:jboss/datasources/YourProjectDS"

pool-name="YourProjectDS">

<connection-url>jdbc:sqlserver://localhost:1433;

DatabaseName=MyDatabase</connection-url>

<driver>sqlserver</driver>

<security>

<user-name>admin</user-name>

<password>admin</password>

</security>

</datasource>

<drivers>

<driver name="sqlserver" module="com.microsoft"/>

</drivers>

</datasources>

</subsystem>

<subsystem xmlns="urn:jboss:domain:ee:1.1">

<global-modules>

<module name="com.microsoft" slot="main"/>

</global-modules>

<spec-descriptor-property-replacement>false</spec-descriptor-

© 2016 by Kony, Inc. All rights reserved 25 of 49

5.  Configure standalone.xml Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

property-replacement>

<jboss-descriptor-property-replacement>true</jboss-descriptor-

property-replacement>

</subsystem>

5.2 MySQL Server

<subsystem xmlns="urn:jboss:domain:datasources:1.1">

<datasources>

<datasource jndi-name="java:jboss/datasources/YourProjectDS"

pool-name="YourProjectDS">

<connection-

url>jdbc:mysql://localhost:3306/YourProjectDB</connection-url>

<driver>mysql</driver>

<security>

<user-name>admin</user-name>

<password>admin</password>

</security>

</datasource>

<drivers>

<driver name="mysql" module="com. mysql"/>

</drivers>

</datasources>

</subsystem>

<subsystem xmlns="urn:jboss:domain:ee:1.1">

<global-modules>

<module name="com.mysql" slot="main"/>

</global-modules>

<spec-descriptor-property-replacement>false</spec-descriptor-

property-replacement>

© 2016 by Kony, Inc. All rights reserved 26 of 49

5.  Configure standalone.xml Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

<jboss-descriptor-property-replacement>true</jboss-descriptor-

property-replacement>

</subsystem>

5.3 Oracle Server

<subsystem xmlns="urn:jboss:domain:datasources:1.1">

<datasources>

<datasource jndi-name="java:/OracleDS" pool-name="OracleDS ">

<connection-url>jdbc:oracle:thin:@localhost:1521:XE</connection-

url>

<driver>oracle</driver>

<security>

<user-name>admin</user-name>

<password>admin</password>

</security>

</datasource>

<drivers>

<driver name="oracle" module="com. oracle "/>

</drivers>

</datasources>

</subsystem>

<subsystem xmlns="urn:jboss:domain:ee:1.1">

<global-modules>

<module name="com.oracle" slot="main"/>

</global-modules>

<spec-descriptor-property-replacement>false</spec-descriptor-

property-replacement>

<jboss-descriptor-property-replacement>true</jboss-descriptor-

property-replacement>

</subsystem>

© 2016 by Kony, Inc. All rights reserved 27 of 49

5.  Configure standalone.xml Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

5.4 PostgreSQL Server

<subsystem xmlns="urn:jboss:domain:datasources:1.1">

<datasources>

<datasource jndi-name="java:jboss /PostgresDS" pool-

name="PostgresDS">

<connection-url>jdbc:postgresql://localhost:5432/postgresdb

</connection-url>

<driver>postgresql</driver>

<security>

<user-name>admin</user-name>

<password>admin</password>

</security>

</datasource>

<drivers>

<driver name="postgresql" module="com. postgresql"/>

</drivers>

</datasources>

</subsystem>

<subsystem xmlns="urn:jboss:domain:ee:1.1">

<global-modules>

<module name="com.postgresql" slot="main"/>

</global-modules>

<spec-descriptor-property-replacement>false</spec-descriptor-

property-replacement>

<jboss-descriptor-property-replacement>true</jboss-descriptor-

property-replacement>

</subsystem>

© 2016 by Kony, Inc. All rights reserved 28 of 49

5.  Configure standalone.xml Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

5.5 DB2 Server

<subsystem xmlns="urn:jboss:domain:datasources:1.1">

<datasources>

<datasource jndi-name="java:jboss/datasources/ConsoleDB"

Spool-name="ConsoleDB" enabled="true" use-java-

context="true">

<connection-

url>jdbc:db2://10.11.12.182:50000/KONYDB:currentSchema=syncconsolejb

1;</connection-url>

<driver>db2</driver>

<security>

<user-name>dbclient</user-name>

<password>kony369</password>

</security>

<pool>

<min-pool-size>10</min-pool-size>

<max-pool-size>30</max-pool-size>

<flush-strategy>IdleConnections</flush-strategy>

</pool>

<new-connection-sql>SELECT 1 FROM SYSIBM.SYSDUMMY1</new-connection-

sql>

<validation>

<validate-on-match>true</validate-on-match>

<check-valid-connection-sql>SELECT 1 FROM SYSIBM.SYSDUMMY1</check-

valid-connection-sql>

</validation>

</datasource>

<drivers>

<driver name="db2" module="com.ibm">

<!--<xa-datasource-class>org.h2.jdbcx.JdbcDataSource</xa-datasource-

© 2016 by Kony, Inc. All rights reserved 29 of 49

5.  Configure standalone.xml Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

class>--></driver>

</drivers>

</datasources>

</subsystem>

<subsystem xmlns="urn:jboss:domain:ee:1.1">

<global-modules>

<module name="com.ibm" slot="main"/>

</global-modules>

<spec-descriptor-property-replacement>false</spec-descriptor-

property-replacement>

<jboss-descriptor-property-replacement>true</jboss-descriptor-

property-replacement>

</subsystem>

Restart the JBoss server after the updates.

© 2016 by Kony, Inc. All rights reserved 30 of 49

6.  Class Loading Changes Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

6. Class Loading Changes

The boot loading of libraries has been changed from JBoss5.x to JBoss6.2 EAP. By default, the class

loading checks all the jars in <app>/WEB-INF/lib.To havemultiple applications sharing the same

jars or libraries, it is required to create custom libraries. Do the following to create Sync custom

libraries tomake CustomCodework in JBoss6.2 EAP.

1. Create JBOSS_HOME\modules\com\kony\sync\main location.

2. Go to the location and copy any custom code jars (for

example,CustomAuthentication.jar, CustomDatasource.jar).

3. Create module.xml file with the resources tag containing the jars as shown below:

<?xml version="1.0" encoding="UTF-8"?>

<module xmlns="urn:jboss:module:1.1" name="com.kony.sync">

<resources>

<resource-root path=" CustomAuthentication.jar"/>

<resource-root path=" CustomDatasource.jar "/>

</resources>

<dependencies>

<module name="javaee.api"/>

</dependencies>

</module>

4. Add the abovemodule name in globalmodules tag of the standalone.xml file to configure

the custommodule with the JBOSS 6.2 as shown below.

<subsystem xmlns="urn:jboss:domain:ee:1.1">

<global-modules>

<module name="com.kony.sync" slot="main"/>

------------

-------------

</global-modules>

© 2016 by Kony, Inc. All rights reserved 31 of 49

6.  Class Loading Changes Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

<spec-descriptor-property-replacement>false</spec-descriptor-

property-replacement>

<jboss-descriptor-property-replacement>true</jboss-descriptor-

property-replacement>

</subsystem>

6.1 SAP and Siebel Libraries

Towork with SAP, Siebel and few other external systems in JBoss 6.2 EAP, it is necessary to add

their respective jars in a custommodule and add this custommodule dependency in the profile

configuration. These jars are similar to the changes that aremadefor JDBC drivers.

For example, in SAP, you have to add the jars asmodule and update themodule.xml file with these

entries.

1. Copy sapjco3.jar at the following location: JBOSS_HOME\modules\com\kony\sync\main

2. Createmodule.xml file at JBOSS_HOME\modules\com\kony\sync\main location with

content as given below:

<module xmlns="urn:jboss:module:1.1" name=" com.kony.sync">

<resources>

<resource-root path="sapjco3.jar"/>

</resources>

</module>

3. Add the com.kony.sync module under globalmodules tag of standalone.xml file located at

JBOSS_HOME/standalone/configuration.

<subsystem xmlns="urn:jboss:domain:ee:1.1">

<global-modules>

<module name="com.kony.sync" slot="main"/>

© 2016 by Kony, Inc. All rights reserved 32 of 49

6.  Class Loading Changes Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

</global-modules>

<spec-descriptor-property-replacement>false</spec-descriptor-

property-replacement>

<jboss-descriptor-property-replacement>true</jboss-descriptor-

property-replacement>

</subsystem>

© 2016 by Kony, Inc. All rights reserved 33 of 49

7.  Sync Home Setup Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

7. Sync Home Setup

1. Configure sync.home directory, create a folder for your directory structure (for

example: D:\Kony\KonySync) and create a directory with name "conf" under above directory.

2. Download PropertiesFile.zip fromKony community portal, community.kony.com, extract all

properties files under sync.home\conf. Refer to Required Setup Files for more

information on how to download.

o console-log4j.properties

o services-log4j.properties

o synclicense.properties

o syncconsole.properties

o syncservice.properties

3. Configure sync.home and middleware.home in standalone.bat asmentioned below: 

set JAVA_HOME=D:\Kony\KonySync\jreset JBOSS_

HOME=D:\Kony\KonySyncset JAVA_OPTS=%JAVA_OPTS%

-Dsync.home="D:\Kony\KonySync" -

Dmiddleware.home="D:\Kony\KonySync" -Xms512m -Xmx1024m

-XX:PermSize=256m -XX:MaxPermSize=256mset "JAVA_OPTS=%JAVA_

OPTS%

-Djboss.bind.address=0.0.0.0"set "JAVA_OPTS=%JAVA_OPTS% -

Dfile.encoding=UTF8"

4. Configure the JNDI name and hibernate dialect class name in syncconsole.properties file

5. Set syncconsole.jndi.name property to java: jboss/datasources/ConsoleDB asmentioned

below for JBoss: 

© 2016 by Kony, Inc. All rights reserved 34 of 49

8.  Deploy SyncConsole Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

8. Deploy SyncConsole

To deploy syncconsole.war file, follow the below steps.

1. Make sure that JBoss Server is stopped.

2. Copy syncconsole.war (rename after download) under $JBOSS_

HOME/standalone/deployments folder:

3. Start JBoss server from JBoss Installation folder.

4. Double-Click standalone.bat for windows in<JBoss_Installation>\bin folder.

5. Access the console application from browser using the URL -

http://localhost:8080/syncconsole.

6. After successful deployment, the following page appears.

7. Enter super user credentials for the first time to login into the application:

a. Username: syncadmin

b. Password: SyncAdmin123

© 2016 by Kony, Inc. All rights reserved 35 of 49

8.  Deploy SyncConsole Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

8. After successful login, the following screen appears:

© 2016 by Kony, Inc. All rights reserved 36 of 49

9.  Deploy SyncServices Kony MobileFabric Sync Manual Installation Guide - JBossVersion2.1

9. Deploy SyncServices

To deploy syncservice.war file, follow the below steps.

1. Make sure that JBoss Server is stopped.

2. Copy syncservice.war (rename after download) under $JBOSS_

HOME/standalone/deployments folder:

3. Start JBoss server from JBoss Installation folder.

4. Double-Click standalone.bat for windows in<JBoss_Installation>\bin folder.

5. Access the service application from browser using below syncservice URL

http://localhost:8080/syncservice.

6. After successful deployment, the following page appears: 

© 2016 by Kony, Inc. All rights reserved 37 of 49

10.  Install and Configure Kony MobileFabric

Sync Using JBoss 5.1

Kony MobileFabric Sync Manual Install-

ation Guide - JBossVersion2.1

10. Install and Configure Kony MobileFabric Sync Using JBoss

5.1

This part provides instructions for installing and configuring KonyMobileFabric Sync Services using

JBoss 5.1.

10.1 Setup JNDI for Sync Console Database

This section is applicable if you are using JBoss 5.1.

1. Place driver jar file (for example: sqljdbc4.jar for SQL Server) in server > default > lib folder of

JBoss.

2. To configure JNDI for SyncConsole Database, create syncconsole-ds.xml under server

> default > deploy folder of JBosswith following configuration:

<?xml version="1.0" encoding="UTF-8"?>

<datasources>

<local-tx-datasource><jndi-name>ConsoleDB</jndi-name>

<use-java-context>true</use-java-context>

<connection-

url>jdbc:sqlserver://localhost:1433;databaseName=syncconsole</c

onnection-url>

<driver-

class>com.microsoft.sqlserver.jdbc.SQLServerDriver</driver-

class>

<user-name>sa</user-name>

<password>kony123!</password>

<min-pool-size>5</min-pool-size>

<max-pool-size>100</max-pool-size>

</local-tx-datasource>

</datasources>

© 2016 by Kony, Inc. All rights reserved 38 of 49

10.  Install and Configure Kony MobileFabric

Sync Using JBoss 5.1

Kony MobileFabric Sync Manual Install-

ation Guide - JBossVersion2.1

10.2 Sync Home Setup

This section is applicable if you are using JBoss 5.1.

To set up Sync, follow these steps: 

1. Configure sync.home directory, create a folder in your directory structure (for example:

D:\Kony\KonySync)

2. Create a directory with name conf under the created directory.

3. Download PropertiesFile.zip fromKony community portal, community.kony.com, extract all

property files under sync.home\conf. Refer to Required Setup Files for more information on

how to download.

o console-log4j.properties

o services-log4j.properties

o synclicense.properties

o syncconsole.properties

o syncservice.properties

4. Configure sync.home in run.bat.

set JBOSS_HOME= D: \Kony\KonySync

set JAVA_OPTS=%JAVA_OPTS% -Dsync.home="D: \Kony\KonySync"

-Dmiddleware.home="D:\ Kony\KonySync" -Xms512m -Xmx1024m -

XX:PermSize=256m

5. Configure JNDI name and hibernate Dialect Class Name in syncconsole.properties file.

6. Set syncconsole.jndi.name property to java:/ConsoleDB asmentioned in the code snippet

below for JBoss: 

© 2016 by Kony, Inc. All rights reserved 39 of 49

10.  Install and Configure Kony MobileFabric

Sync Using JBoss 5.1

Kony MobileFabric Sync Manual Install-

ation Guide - JBossVersion2.1

#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 #

###############################################################

##########

hibernate.dialect=com.kony.sync.console.dialect.CustomSQLServer

Dialect

#SyncConsole JNDI Name

syncconsole.jndi.name=java:/ConsoleDB

7. In syncservice.properties file, configure Sync Services Databases asmentioned below: 

#Services configuration properties file 

#This property can have sqlserver/oracle/mysql

database.type=sqlserver

###############################################################

###############

# DATABASE AND CONNECTION POOL RELATED PROPERTIES #

# The following properties are only necessary if atleast one of

© 2016 by Kony, Inc. All rights reserved 40 of 49

10.  Install and Configure Kony MobileFabric

Sync Using JBoss 5.1

Kony MobileFabric Sync Manual Install-

ation Guide - JBossVersion2.1

the SyncScopes

in the application has "Persistent" SyncStrategy

#

###############################################################

###############

#JBosspool or jndidatasource

# if its mentioned as jndidatasource,the sync services looks

for a JNDI URLs for each

app jdbc/<appid>_UploadQueue and jdbc/<appid>_Replica

jdbc.connectionProviderType=JBosspool

#The below property is required when above property is set to

jndidatasource.

#For JBoss,

#syncservices.jndi.prefix=java:comp/env/

#For Weblogic and WebSphere, it must be empty

#syncservices.jndi.prefix= 

syncservices.jndi.prefix=java:comp/env/

##The below properties are necessary only when the above

property is set to JBosspool 

replicadatabase.host=localhost

replicadatabase.port=1433

# Instance name for SQLServer(blank in case of no instance),

service name in case of Oracle

replicadatabase.instance=sqlexpress

replicadatabase.user=sa

replicadatabase.password=kony123! 

uploaddatabase.host=localhost

uploaddatabase.port=1433

# Instance name for SQLServer(blank in case of no instance),

service name in case of Oracle

uploaddatabase.instance=sqlexpress

uploaddatabase.user=sa

© 2016 by Kony, Inc. All rights reserved 41 of 49

10.  Install and Configure Kony MobileFabric

Sync Using JBoss 5.1

Kony MobileFabric Sync Manual Install-

ation Guide - JBossVersion2.1

uploaddatabase.password=kony123! 

###############################################################

###############

#These properties are common to both ReplicaDB and

UploadQueueDB

#Database connection related properties.

#For SQL Server on JBoss

#database.driverName=com.microsoft.sqlserver.jdbc.SQLServerDriv

er

#database.jdbcurl.prefix=jdbc:sqlserver

#For SQL Server on Weblogic

#database.driverName=weblogic.jdbc.sqlserver.SQLServerDriver

#database.jdbcurl.prefix=jdbc:weblogic:sqlserver

#For MySQL

#database.driverName=com.mysql.jdbc.Driver

#database.jdbcurl.prefix=jdbc:mysql

#For Oracle thin driver

#database.driverName=oracle.jdbc.driver.OracleDriver

#database.jdbcurl.prefix=jdbc:oracle:thin

###############################################################

############### 

database.driverName=com.microsoft.sqlserver.jdbc.SQLServerDrive

r

database.jdbcurl.prefix=jdbc:sqlserver 

#JBoss Connection Pool standard properties

cp.jmxEnabled=true

cp.testWhileIdle=false

cp.testOnBorrow=true

cp.testOnReturn=false

cp.validationInterval=30000

cp.timeBetweenEvictionRunsMillis=50000

cp.maxActive=100

cp.initialSize=10

© 2016 by Kony, Inc. All rights reserved 42 of 49

10.  Install and Configure Kony MobileFabric

Sync Using JBoss 5.1

Kony MobileFabric Sync Manual Install-

ation Guide - JBossVersion2.1

cp.maxWait=10000

cp.removeAbandonedTimeout=60

cp.minEvictableIdleTimeMillis=30000

cp.minIdle=10

cp.logAbandoned=true

cp.removeAbandoned=true

cp.numTestsPerEvictionRun=3 

#Property to enable or disable connection pooling in services

for all DB connections.

sync.enable.connectionpool=true

8. Configure log4j properties in console-log4j.properties and services-log4j.properties. Set logs

directory to existing directory in system directory structure.

log4j.rootLogger=ERROR,stdout,FA

log4j.logger.com.kony=ERROR

log4j.logger.com.konylabs=ERROR

log4j.logger.org.springframework=off

log4j.logger.org.hibernate=off

log4j.logger.org.hibernate.jdbc.ConnectionManager=off

log4j.logger.org.hibernate.type=off

log4j.logger.org.hibernate.hql.ast.QueryTranslatorImpl=off

log4j.logger.org.quartz=off 

log4j.appender.stdout=org.apache.log4j.ConsoleAppender

log4j.appender.stdout.layout=org.apache.log4j.PatternLayout

log4j.appender.stdout.layout.ConversionPattern=%n[syncconsole]

[%p][%d{dd MMM yyyy HH:mm:ss,SSS}]:[%c:%M:%L]: %m

log4j.appender.FA= org.apache.log4j.RollingFileAppender

log4j.appender.FA.maxFileSize=10240KB

log4j.appender.FA.maxBackupIndex=50

log4j.appender.FA.File=D:/Kony/KonySync/synclogs/syncconsole.lo

g

log4j.appender.FA.layout=org.apache.log4j.PatternLayout

© 2016 by Kony, Inc. All rights reserved 43 of 49

10.  Install and Configure Kony MobileFabric

Sync Using JBoss 5.1

Kony MobileFabric Sync Manual Install-

ation Guide - JBossVersion2.1

log4j.appender.FA.layout.ConversionPattern=%n[syncconsole][%p]

[%d{dd MMM yyyy HH:mm:ss,SSS}]:[%c:%M:%L]: %m

10.3 Deploy SyncConsole

This section is applicable if you are using JBoss 5.1.

To Deploy Sync Console, follow these steps:

1. Download syncconsole.war file and place it into server > default > deploy folder of JBoss.

2. Start JBoss Server from JBoss Installation folder.

3. Double-click run.bat for windows in <JBoss_Installation>\bin folder.

4. Access the console application from browser using the URL http://localhost:8080/syncconsole.

5. After successful deployment, the following page appears.

6. Enter super user credentials for the first time to logon:

© 2016 by Kony, Inc. All rights reserved 44 of 49

10.  Install and Configure Kony MobileFabric

Sync Using JBoss 5.1

Kony MobileFabric Sync Manual Install-

ation Guide - JBossVersion2.1

l Username: syncadmin

l Password: SyncAdmin123

7. After successful login, the following home screen appears:

10.4 Deploy SyncServices

This section is applicable if you are using JBoss 5.1.

To Deploy Sync Services, follow these steps:

1. Download SyncService.war file and place in server > default > deploy folder.

2. Start JBoss server from JBoss Installation folder.

3. Double-click run.bat for windows in <JBoss_Installation>\bin folder.

4. Access the service application from browser using the URL http://localhost:8080/syncservice.

© 2016 by Kony, Inc. All rights reserved 45 of 49

10.  Install and Configure Kony MobileFabric

Sync Using JBoss 5.1

Kony MobileFabric Sync Manual Install-

ation Guide - JBossVersion2.1

5. After successful deployment, the following page appears: 

© 2016 by Kony, Inc. All rights reserved 46 of 49

11.  Appendix A: Creating Replica and UploadQueue

schemas (for Persistent Sync)

Kony MobileFabric Sync Manual

Installation Guide - JBossVersion2.1

11. Appendix A: Creating Replica and UploadQueue schemas (for

Persistent Sync)

In this section, we provides steps for:

l Creating Replica and UploadQueue Schemas in Oracle

l Creating Replica and UploadQueue Schemas in DB2

11.1 Creating Replica and UploadQueue Schemas in Oracle

Important: A user with DBA privileges runs the following commands.

To create Replica and Upload Schemas in Oracle, follow these steps:

1. Using the following command, create a Tablespace with the name Konysync:

CREATE TABLESPACE konysync

DATAFILE D:/oracle/konysync.dat' SIZE 100M REUSE

AUTOEXTEND ON NEXT 100M MAXSIZE 1G

2. Using the following command, create a role with the name konysyncrole:

CREATE ROLE konysyncrole

3. Using the following command, assign the role konysyncrole:

GRANT konysyncrole to syncuser

Note: The role konysyncrole is granted to the users given in syncservice.properties for

the following properties:

replicadatabase.user= <syncuser>

uploaddatabase.user= <syncuser>

© 2016 by Kony, Inc. All rights reserved 47 of 49

11.  Appendix A: Creating Replica and UploadQueue

schemas (for Persistent Sync)

Kony MobileFabric Sync Manual

Installation Guide - JBossVersion2.1

11.2 Creating Replica and UploadQueue Schemas in DB2

Important: A user with DBA privileges runs the following commands.

To create Replica and Upload Schemas in DB2, follow these steps:

1. Using the following command, create a database with default Tablespace that has standard

buffer pool of 32,000 page size:

CREATE DATABASE <dbname> ON '<path>’ DBPATH ON ‘<path>' ALIAS

<dbname> USING CODESET UTF-8 TERRITORY US COLLATE USING IDENTITY

PAGESIZE 32768 NUMSEGS 100 DFT_EXTENT_SZ 10 CATALOG TABLESPACE

MANAGED BY AUTOMATIC STORAGE EXTENTSIZE 4 PREFETCHSIZE -1 OVERHEAD

-1 TRANSFERRATE -1 NO FILE SYSTEM CACHING AUTORESIZE YES

INITIALSIZE 32 M USER TABLESPACE MANAGED BY AUTOMATIC STORAGE

EXTENTSIZE 10 PREFETCHSIZE -1 OVERHEAD -1 TRANSFERRATE -1 NO FILE

SYSTEM CACHING AUTORESIZE YES INITIALSIZE 32 M TEMPORARY

TABLESPACE MANAGED BY AUTOMATIC STORAGE EXTENTSIZE 10 PREFETCHSIZE

-1 OVERHEAD -1 TRANSFERRATE -1 FILE SYSTEM CACHING

2. Using the following command, create a role with the name konysyncrole:

CREATE ROLE konysyncrole

3. Using the following command, assign CONNECT andDATAACCESS permissions to a user:

GRANT CONNECT,DATAACCESS ON DATABASE to konysyncrole

4. Using the following command, assign the role konysyncrole:

GRANT konysyncrole to syncuser

© 2016 by Kony, Inc. All rights reserved 48 of 49

11.  Appendix A: Creating Replica and UploadQueue

schemas (for Persistent Sync)

Kony MobileFabric Sync Manual

Installation Guide - JBossVersion2.1

Note: The role konysyncrole is granted to the users given in syncservice.properties for

the following properties:

replicadatabase.user= <syncuser>

uploaddatabase.user= <syncuser>

© 2016 by Kony, Inc. All rights reserved 49 of 49