kony kony fabric installation guide mac

Kony Fabric

Installation Guide - Mac

On-Premises

Release V8 SP4 FP1Document 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.

© 2019 by Kony, Inc. All rights reserved 1 of 37

Kony Fabric Installation Guide - MacVersion1.3

Copyright © 2017 by Kony, Inc.

All rights reserved.

March, 2019

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 without prior, express, written permission. Kony, Empowering Everywhere, Kony

Fabric, KonyNitro, and Kony Visualizer are trademarks of Kony, Inc. MobileFabric is a registered

trademark of Kony, Inc. Microsoft, theMicrosoft logo, Internet Explorer, Windows, andWindowsVista

are registered trademarks of Microsoft Corporation. Apple, the Apple logo, iTunes, iPhone, iPad, OS

X, Objective-C, Safari, Apple Pay, AppleWatch, 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 inMotion, and

RIM are registered trademarks of BlackBerry. SAP® and SAP® Business Suite® are registered

trademarks 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 respective owners.



Revision History

Date Document Version Description of Modifications/Release

02/27/2018 1.3 Document updated for V8 SP4 FP1

04/23/2018 1.2 Document updated for V8 SP2

12/18/2017 1.1 Document updated for V8 SP1

09/18/2017 1.0 Document updated for V8GA Release



Table of Contents

1. Preface 6

1.1 Purpose 7

1.2 Intended Audience 8

1.3 Formatting ConventionsUsed in ThisGuide 8

1.4 Related Documents 9

1.5 Contact Us 9

2. Prerequisites 10

2.1 Software Requirements 10

2.2 Hardware Requirements 10

2.3 Limitations 10

3. Kony Fabric Topology and Components 12

4. Pre-Installation Tasks 16

4.1 Download Kony Fabric Installer 16

4.2 Prerequisites for Kony Fabric with MySQL 16

4.3 Prerequisites for Kony Fabric with MariaDB 17

4.3.1 Increase the table_definition_cache and table_open_cache values 17

5. Installing Kony Fabric 18

6. Uninstalling Kony Fabric 29

7. Post-installation Tasks 33

7.1 IncreasingMaxAllowed Packet Size for MySQL 33



8. Frequently Asked Questions 35


1. Preface Kony Fabric Installation Guide - MacVersion1.3

1. Preface

Kony Fabric is aMobile Back-end as a Service (MBaaS) provider that helps developers build native

and web apps for mobile. Kony Fabric allows you to define the back-end to build nativemobile apps for

iOS, Android, and HTML5-based apps for modern browsers. Kony Fabric ensures that developers

build mobile applications quickly by focusing on core areas and obtaining secured back-end services

instantly. Kony Fabric hasmultiple features that can be used - Identity, Integration, Orchestration, and

Engagement Services. These features can be accessed through a common, centralized console.

For successful authentication with users, and to access the centralized features of Kony Fabric, Kony

recommends that you install the following Kony Fabric features on premises:

l Kony Fabric Identity and Console

l API Developer Portal

l Kony Fabric Integration

l Kony Fabric Engagement Services

Kony Fabric supports the following back-end services for your applications:

l Identity: This feature allows you to define the type of authentication used for granting access to

your application. Kony Fabric supports the following authentication services:

o Enterprise Identity: Microsoft Active Directory, Open LDAP, Salesforce, Security

AssertionMarkup Language (SAML), Kony SAP Gateway, OAuth 2.0, Okta, Custom,

andOAuth Provider.

o Social Identity: Google, Instagram, Microsoft, BOX, Facebook, LinkedIn, Amazon, and

Yahoo.

l API Developer Portal: This feature allows you create a Portal for exposing APIs created using

Kony Fabric. Developers from internal and external partner teams can access the portal created

to explore and test the APIs



l Integration: This feature allows you to define various back-end services for your application.

You can define the following integration services:

o Technology Adapters: XML, SOAP, JSON, Java, JavaScript, and APIProxy.

o Business Adapters: Kony SAP Gateway, MuleSoft, AWSAPIGateway, Relational

Database, MongoDB, RAML, OpenAPI (Swagger), Salesforce, and IBMMQ.

l Orchestration: Service orchestration is the coordination or integration of several services and

exposing them as a single service. This feature allows you to create two types of orchestration

services. They are:

o Composite: Allows you to run two or more services concurrently or sequentially.

o Looping: Allows you to run a single service in a loop until the loop ends or an exit criteria is

met.

l Objects: Allows you to create appmodels for LOB objects, storage objects, and Service-Driven

Objects.

l Offline sync: This feature allows you to define the synchronization services for your application.

Sync supports onlyWeb Services, except SAP Sky.

l Logic: The logic services feature in Kony Fabric helps you import and integrate Node.js services

(APIs) directly into Kony Fabric for developing server-side and networking applications.

l Engagement: This feature allows you to send push notifications, email, SMS and passes to

subscribed applications.

1.1 Purpose

This document explains how to install the Kony Fabric console. This document is divided into three

major sections. The prerequisites section provides information on the prerequisites, software

requirements, hardware requirements, and limitations of the product. The Installation section covers

the pre-installation and installation procedures. The post-installation section covers all the tasks the

usersmust perform after installing Kony Fabric.



1.2 Intended Audience

The document is intended for engineers or developers who are responsible for installing and

configuring Kony Fabric. We assume that the reader of this document is familiar with installing

applications in aMacOS X environment.

1.3 Formatting Conventions Used in This Guide

The following formatting conventions are used throughout the document:

Convention Explanation

Monospace l User input text, system prompts, and responses

l File path

l Commands

l Program code

l File names

Italic l Emphasis

l Names of books and documents

l New terminology



Convention Explanation

Bold l Windows

l Menus

l Buttons

l Icons

l Fields

l 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 Related Documents

Document Purpose

Kony Fabric User

Guide

This guide helps you understand how to create a Kony Fabric account, add

services, and publish apps.

1.5 Contact Us

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

For technical questions, suggestions, and comments or to report problems on Kony's product line,

contact [email protected].


mailto:[email protected]?subject=Documentation Feedback

mailto:[email protected]

2. Prerequisites Kony Fabric Installation Guide - MacVersion1.3

2. Prerequisites

The following sections explain the software and hardware required to install Kony Fabric.

2.1 Software Requirements

Operating System OS X EL Capitan

Database MySQL 5.7

2.2 Hardware Requirements

Component Requirement

Processor Dual-core processor

Memory 8GB

Internal Storage 150GB

Network 100Mbps Ethernet interface card

2.3 Limitations

Kony Fabric for MacOS X has the following limitations:

l Only static IPs are supported. If your IP changes, Kony Fabric will not work.

l Only HTTP connection protocol is supported.

l MySQL database is the only database supported. TheMySQL database server must be

installed locally on theMacwhere Kony Fabric is installed.

l By default, all Kony Fabric components (Console, Identity Services, Integration Services, and


2. Prerequisites Kony Fabric Installation Guide - MacVersion1.3

Engagement Services) are installed.

l Only the development environment is supported. The production environment is not supported.

l Prefix values for the databaseswill be kony. The sufix value is generated with the timestamp

when the installation procedure starts. The sufix value follows the format DDMMYYHHMM.


3. Kony Fabric Topology and Components Kony Fabric Installation Guide - MacVersion1.3

3. Kony Fabric Topology and Components

Kony Fabric topology explains the logical arrangement of various components, such as console,

identity services, and developer environment. In design time you configure appswith services, and

publish them to a developer environment. An overview of the Kony Fabric developer environment

architecture and components follows:



An overview of the Kony Fabric developer environment deployment architecture follows:

The following table describes the components of Kony Fabric:

Convention Description

Identity The component validates user accounts and applications for authentication

and authorization.

l Authentication identifies log-on credentials of a user.

l Authorization allows or denies access to resources based on a user's

role.

Identity is used to authenticate and authorize runtime and design-time users.




Accounts The accounts component contains information about what a user can do,

such as create other users, delete users, create environments, delete

environments, and publish apps to an environment.

The component uses auth service for authorizing requests based on user

roles.

Workspace

(WaaS)

Workspace configures MBaaS services (applications, identity, integration,

orchestration, and engagement services). After the services are configured,

they must be published to respective clouds/environments so that the

services are available for runtime use.

Console/Portal The console/portal is the user interface for configuring services for an

application.

Environments

(Engagement

Services,

Integration

Services)

The component adds runtime capabilities to apps, such as engagement

services, and integration services.

Admin Admin helps you to list down the set of services published and test the

services shown in Admin Console. Also, you can view the list of published

apps and provides the delete apps functionality. In Kony Cloud, changing the

log levels and checking the logs features are available as the cloud is

managed by Kony. You can also view reports if you are usingmetrics module.

This is an optional component.

For more details, refer Integration Services Admin Console User Guide.

Middleware Milldeware is a software that helps connect amobile device and an endpoint

server. It receives a request from amobile device and sends the request to an

endpoint server. Themiddleware fetches the response from the backend and

provides the required information to the device in the JSON format.


http://docs.kony.com/konylibrary/integration/kmf_integrationservice_admin_console_userguide/Default.htm



Services Services component is used only when Kony Fabric is integrated. The

services component has the same runtime capabilities as themiddleware.

Note: To use the Kony Sever with Kony Fabric integrated, you can

ignore themiddleware.war. Similarly, when you use only the standalone

Kony Server, you can ignore the services.war.

For more details, refer to

http://community.kony.com/documentation/integrate-data


http://community.kony.com/documentation/integrate-data

4. Pre-Installation Tasks Kony Fabric Installation Guide - MacVersion1.3

4. Pre-Installation Tasks

Before you install Kony Fabric Console Installer, youmust perform the following tasks:

l Ensure access to a database server.

l A database user should be granted all required permissions as required.

4.1 Download Kony Fabric Installer

Download Kony FabricMac installer KonyFabricSetup.zip from

http://community.kony.com/downloads and extract the file. To download Kony Fabric installer from the

community portal, follow these steps:

1. Log in to http://community.kony.com/downloads. You can obtain a user name and password

from your sales representative or partner.

2. Navigate to the Kony Fabric section, and click the Kony vX.X GA version tab.

3. Select the specific release from the Version drop-down list, and click on the specific release-

related files you want to download. For example, if you want to download Kony Fabric installer

for X.xGA release, click the Kony vX.x GA tab, select the X.X.0.0 GA version from the drop-

down list, and then click the Installer_Mac button.

TheKonyFabricSetup-x.x.x.x_GA.zip file contain an app file.

n KonyFabricInstaller.app

4.2 Prerequisites for Kony Fabric with MySQL

For installing Kony Fabric Database for MySQL, complete the following steps:


http://community.kony.com/downloads

http://community.kony.com/downloads

4. Pre-Installation Tasks Kony Fabric Installation Guide - MacVersion1.3

Note: Youmust be experienced with MySQL to handle theMySQLDatabase setup and complete

the Kony Fabric database deployment. MySQL softwaremust be installed, and basic database

must be created before continuing with Kony Fabric database schema setup.

Note: If you install MySQL just before installing Kony Fabric, ensure that you change the default

password setup duringMySQL installation. You can execute the following command in theMac

terminal to change the password.

mysql> ALTER USER 'username'@'localhost' IDENTIFIED BY

'password@123’;

Once you change the password successfully, restart your MySQL server.

4.3 Prerequisites for Kony Fabric with MariaDB

4.3.1 Increase the table_definition_cache and table_open_cache values

To increase the values of table_definition_cache and table_open_cache inMariaDB, execute the

following commands or update the ini or cnf file with:

set GLOBAL table_definition_cache=4000; //For table_definition_cache;

4000 is the minimum value

set GLOBAL table_open_cache=2000; //For table_open_cache; 2000 is the

minimum value


5. Installing Kony Fabric Kony Fabric Installation Guide - MacVersion1.3

5. Installing Kony Fabric

The section of the document helps you install and configure Kony Fabric components. The primary

purpose of Kony Fabric installer user interface displays information to a user, and prompts the user for

information needed to install and configure Fabric components on the system. Kony Fabric installer

user interface also displays information about the progress of system changes as they are installed.

This section explains a new installation on the AppleMac.

Important: You need the required hardware and access to the supporting software noted in the

Prerequisites section andmust perform the steps noted in the Pre-installation Tasks section.

Make sure that you have proper administrative rights to install Kony Fabric on your computer.

The <Install Location> directory contains the log files documenting each invocation of the installer or

uninstaller. Tomake problem identification easier, provide the log files to Konywhen reporting an

issue.

To install Kony Fabric Console using the installer, follow these steps:

1. Unzip theKonyFabricSetup-x.x.x.x_GA.zip file.

2. Double-clickKonyFabricInstaller application to launch the installer.

A dialog with the Kony logo appears.



3. TheWelcome to Kony Fabric windows appears.

Read the instructions carefully before installing Kony Fabric Console.



4. Read the instructions carefully, and click Next.

The LICENSE AGREEMENTwindow appears.

5. Scroll until the end of the screen, and select the "I accept the terms of the License Agreement"

option.

Note: To activate the License Agreement option, read carefully the whole agreement text.



6. Click Next. The Install Type window appears. The selected path appears in the Please choose

a destination folder for this installation field.



7. Click Choose to browse the required folder from your system.

8. Click Next. The Configuration Parameters window appears. Some fieldsmay already have

default values. You can leave them as is if your Mac has the same default values. Enter the

following details:

l Hostname/IP Address: Enter the host name or IP address of theMac.

Note: If you are installing Kony Fabric on amachine where the IP addressmay

change, for example, development boxes that connect to the network viaWi-Fi, it is

preferred to provide the Hostname instead of IP address during installation.

l Service User Password: Enter the password of the current user logged in on theMac.



l HTTP Port: Enter the port number for HTTP communication.

l Tomcat Shutdown Port: Enter the port number for Tomcat shutdown.

9. Click Next. The next page appears.

l Database Port:: Enter the database port of theMySQLServer. By default, the field is set

to 3306 for MySQL.

l Database User: Enter the user name used while creating the database user - for

example, dbclient.



l Database Password: Enter the user password used while creating the database user.



10. Click Next. The Administrator Account Details window appears.

The Administrator Account Details window helps you to configure your super administrator

account.

11. Under the Create Kony Fabric Administrator Account now section, enter the following details

to create the super-administrator account.

l First Name: Enter the first name of the user.

l Last Name: Enter the last name of the user.

l Email: Enter the email address of the user. It can include alphanumeric and special

characters that follow the standard email address form.

l Password: Enter the password for the user. It can be a combination of alphanumeric and



special characters.

l Confirm Password: Retype the password to ensure the user's identity.

12. Click Next. The Summary window appears.



13. Click Install. The Installing Kony Fabric window appears.

Once the installation completes, the Install Complete window appears with the confirmation

message.



14. Click Done to close the window.


6. Uninstalling Kony Fabric Kony Fabric Installation Guide - MacVersion1.3

6. Uninstalling Kony Fabric

To uninstall the Kony Fabric Console using the installer, follow these steps:

1. Navigate to Applications > Kony Fabric and double-click Uninstall. The Uninstall Kony

Fabric pane appears.

If you have changed the default installation folder, navigate to the folder where you have

installed Kony Fabric.



2. Click Next. Delete Database choices appear.

3. Select the option button asDelete all data or Retain all data. By default, Retain all data is

selected.

Note: If you select the Delete all data option, the database is deleted from your system. If

you select the Retain all data option, then the database is not deleted, and you can access

the database later.

4. Click Uninstall to continue.

The Uninstall Kony Fabric Console window displays a list of features and informs a user that the

uninstaller removes the following features.



Once the uninstallation is complete, the Uninstall Complete window appears. It informs that all

items are successfully uninstalled.



Note: The Uninstaller cannot remove the files or folders that were not installed or copied by the

installer. These include files or folders created as you use Kony Fabric (for example, log files). You

need tomanually delete them.


7. Post-installation Tasks Kony Fabric Installation Guide - MacVersion1.3

7. Post-installation Tasks

7.1 Increasing Max Allowed Packet Size for MySQL

If the size of your application ismore than the variable size of the server database, an error occurs.

Ensure the variablemax_allowed_packet_size is set to a higher value than the application

size.

To avoid the error, increase the global variable in the server database.

Tomodify themax_allowed_packet_size for your MySQL server on aMac (OS X), youmust first

create a .cnf file calledmy.cnf in a folder (documents folder is recommended), add some properties to

the file, and thenmovemy.cnf file to the etc folder.

To createmy.cnf file, follow these steps:

1. On your MAC, open your terminal and navigate to your documents folder.

2. Once you are in your documents folder, execute the following command.

cat > my.cnf

my.cnf file is created.

3. Double-click the file to open it.

4. In the file, paste the following parameters.

[mysqld]

max_allowed_packet = 20M

innodb_log_file_size = 200M

sql_mode = NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES

5. Save and close the file.

6. Select themy.cnf file, copy it, navigate to /etc and paste themy.cnf file there.


7. Post-installation Tasks Kony Fabric Installation Guide - MacVersion1.3

Important: In the my.cnf file, the innodb_log_file_size = <value should be greater than

10 times of max_allowed_packet>. For example, if themax allowed packet size is 20M, then the

innodb log file size should be 200Mminimum.


8. Frequently Asked Questions Kony Fabric Installation Guide - MacVersion1.3

8. Frequently Asked Questions

Is it possible to changemyKony Fabric hostname or IP address after it is installed?You can change the IP address of your existing Kony Fabric server by executing a script file that is available in

your Kony Fabric installation folder. The process involves stopping the Kony Fabric server, making required

changes to the SQL file, executing the SQL file, and restarting the Kony Fabric server.

Stop Kony Fabric Server

To Stop Kony Fabric server, execute the following command on your Macintosh terminal:

sudo launchctl unload /Library/LaunchDaemons/KonyFabric.plist

Important: Ensure that you haveMySQLWorkbench installed on your Macintosh computer.

Change Hostname or IP Address

To change the host name or IP address, follow these steps:

1. In your Macintosh computer, navigate to your scripts folder in your Kony Fabric installation folder. For

example, applications/Kony Fabric_GA/scripts

2. Open theMySQL_changeHostDetails_script.sql file. The file will open in your MySQLWorkbench.



3. Change your hostname in the NEW_HOST key.

4. If you want to change your port also, change the port number in the NEW_PORT key. If you do not want

to change the port number, enter your previous port details.

5. To run the SQL script, in your MySQLWorkbench, navigate to File > Run SQL Script.

6. Navigate to the classes folder in mfconsole.war in your Kony Fabric installation root folder. For example,

MF_Installation_Dir/tomcat/webapps/mfconsole.war//WEB-INF/classes.

7. Open the file config.properties file in a text editor.

8. Replace the old hostname/IP address and the old port for the properties below.

l WAAS_BASE_URL

l KONY_ACCOUNT_API_BASE_URL



9. Change the values of the hostname/IP address and the port number with new host name and new port

number. Leave the rest of the values as they are.

10. Save the file and close it.

Start Kony Fabric Server

To Start Kony Fabric server, execute the following command on your Macintosh terminal:

sudo launchctl load /Library/LaunchDaemons/KonyFabric.plist
