Installation Guide - Mac

Size: px

Start display at page:

Download "Installation Guide - Mac"

Douglas Perkins
6 years ago
Views:

1 Kony Fabric Installation Guide - Mac On-Premises Release V8 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 36

2 Kony Fabric Installation Guide - Mac Copyright 2017 by Kony, Inc. All rights reserved. September, 2017 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 Fabric, Kony Nitro, and Kony Visualizer are trademarks of Kony, Inc. MobileFabric is a registered trademark 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. SAP and SAP Business Suite are registered trademarks of SAP SE in Germany and in several other countries. 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 36

3 Kony Fabric Installation Guide - Mac Revision History Date Document Version Description of Modifications/Release 09/18/ Document updated for V8 GA Release 2017 by Kony, Inc. All rights reserved 3 of 36

4 Kony Fabric Installation Guide - Mac Table of Contents 1. Preface Purpose Intended Audience Formatting Conventions Used in This Guide Related Documents Contact Us 8 2. Prerequisites Software Requirements Hardware Requirements Limitations 9 3. Kony Fabric Topology and Components Preinstallation Tasks Prerequisites for Kony Fabric with MySQL Download Kony Fabric Installer Installing Kony Fabric Uninstalling Kony Fabric Post-installation Tasks Increasing Max Allowed Packet Size for MySQL Frequently Asked Questions by Kony, Inc. All rights reserved 4 of 36

5 1. Preface Kony Fabric Installation Guide - Mac 1. Preface Kony Fabric is a Mobile 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 native mobile 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 has multiple features that can be used - Identity, Integration, Orchestration, Sync, 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: Kony Fabric Identity and Console Kony Fabric Integration Kony Fabric Engagement Services Kony Fabric Sync Kony Fabric supports the following back-end services for your applications: Identity: The feature helps you to define the type of authentication used for granting access to your application. Kony Fabric supports the following authentication services: Microsoft Active Directory, Salesforce, Security Assertion Markup Language (SAML), Kony SAP Gateway, Kony Facebook, and Kony User Repository. Integration: The feature helps you to define various back-end services for your application. You can define the service in XML, SOAP, JSON, Java, Salesforce, and Kony SAP Gateway. Orchestration: The feature helps you to create two types of orchestration services: Composite: Allows you to run two or more services concurrently or sequentially. Looping: Allows you to run a single service in a loop until the loop ends or an exit criteria is met by Kony, Inc. All rights reserved 5 of 36

6 1. Preface Kony Fabric Installation Guide - Mac Synchronization: The feature helps you to define the synchronization services for your application. Sync supports only Web Services, except SAP Sky. Engagement Services: The feature helps you to define and configure push messaging services for your application. 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 users must 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 a Mac OS X environment. 1.3 Formatting Conventions Used in This Guide The following formatting conventions are used throughout the document: Convention Explanation Monospace User input text, system prompts, and responses File path Commands Program code File names 2017 by Kony, Inc. All rights reserved 6 of 36

7 1. Preface Kony Fabric Installation Guide - Mac 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 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 by Kony, Inc. All rights reserved 7 of 36

8 1. Preface Kony Fabric Installation Guide - Mac 1.5 Contact Us We welcome your feedback on our documentation. us at techpubs@kony.com. For technical questions, suggestions, and comments or to report problems on Kony's product line, contact support@kony.com by Kony, Inc. All rights reserved 8 of 36

9 2. Prerequisites Kony Fabric Installation Guide - Mac 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 Hardware Requirements Component Requirement Processor Dual-core processor Memory 8 GB Internal Storage 150 GB Network 100 Mbps Ethernet interface card 2.3 Limitations Kony Fabric for Mac OS X has the following limitations: Only static IPs are supported. If your IP changes, Kony Fabric will not work. Only HTTP connection protocol is supported. MySQL database is the only database supported. The MySQL database server must be installed locally on the Mac where Kony Fabric is installed. By default, all Kony Fabric components (Console, Identity Services, Integration Services, 2017 by Kony, Inc. All rights reserved 9 of 36

10 2. Prerequisites Kony Fabric Installation Guide - Mac Engagement Services, and Sync Services) are installed. Only the development environment is supported. The production environment is not supported. Prefix values for the databases will be kony. The sufix value is generated with the timestamp when the installation procedure starts. The sufix value follows the format DDMMYYHHMM by Kony, Inc. All rights reserved 10 of 36

11 3. Kony Fabric Topology and Components Kony Fabric Installation Guide - Mac 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 apps with services, and publish them to a developer environment. An overview of the Kony Fabric developer environment architecture and components follows: 2017 by Kony, Inc. All rights reserved 11 of 36

3. Kony Fabric Topology and Components Kony Fabric Installation Guide - Mac An overview of the Kony Fabric developer environment deployment architecture follows: The following table describes the

12 3. Kony Fabric Topology and Components Kony Fabric Installation Guide - Mac 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. Authentication identifies log-on credentials of a user. 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 by Kony, Inc. All rights reserved 12 of 36

13 3. Kony Fabric Topology and Components Kony Fabric Installation Guide - Mac Convention Description 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, synchronization, 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, Sync Services, Integration Services) The component adds runtime capabilities to apps, such as engagement services, synchronization 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 using metrics module. This is an optional component. For more details, refer Integration Services Admin Console User Guide by Kony, Inc. All rights reserved 13 of 36

14 3. Kony Fabric Topology and Components Kony Fabric Installation Guide - Mac Convention Description Middleware Milldeware is a software that helps connect a mobile device and an endpoint server. It receives a request from a mobile device and sends the request to an endpoint server. The middleware fetches the response from the backend and provides the required information to the device in the JSON format. Services Services component is used only when Kony Fabric is integrated. The services component has the same runtime capabilities as the middleware. Note: To use the Kony Sever with Kony Fabric integrated, you can ignore the middleware.war. Similarly, when you use only the standalone Kony Server, you can ignore the services.war. For more details, refer to by Kony, Inc. All rights reserved 14 of 36

15 4. Preinstallation Tasks Kony Fabric Installation Guide - Mac 4. Preinstallation Tasks Before you install Kony Fabric Console Installer, you must perform the following tasks: Ensure access to a database server. A database user should be granted all required permissions as required. 4.1 Prerequisites for Kony Fabric with MySQL For installing Kony Fabric Database for MySQL, complete the following steps: Note: You must be experienced with MySQL to handle the MySQL Database setup and complete the Kony Fabric database deployment. MySQL software must 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 during MySQL installation. You can execute the following command in the Mac terminal to change the password. mysql> ALTER USER 'username'@'localhost' IDENTIFIED BY 'password@123 ; Once you change the password successfully, restart your MySQL server by Kony, Inc. All rights reserved 15 of 36

16 4. Preinstallation Tasks Kony Fabric Installation Guide - Mac 4.2 Download Kony Fabric Installer Download Kony Fabric Mac installer KonyFabricSetup.zip from and extract the file. To download Kony Fabric installer from the community portal, follow these steps: 1. Log in to 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 releaserelated files you want to download. For example, if you want to download Kony Fabric installer for X.x GA release, click the Kony vx.x GA tab, select the X.X.0.0 GA version from the dropdown list, and then click the Installer_Mac button. The KonyFabricSetup-x.x.x.x_GA.zip file contain an app file. KonyFabricInstaller.app 2017 by Kony, Inc. All rights reserved 16 of 36

17 5. Installing Kony Fabric Kony Fabric Installation Guide - Mac 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 Apple Mac. Important: You need the required hardware and access to the supporting software noted in the Prerequisites section and must 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. To make problem identification easier, provide the log files to Kony when reporting an issue. To install Kony Fabric Console using the installer, follow these steps: 1. Unzip the KonyFabricSetup-x.x.x.x_GA.zip file. 2. Double-click KonyFabricInstaller application to launch the installer. A dialog with the Kony logo appears by Kony, Inc. All rights reserved 17 of 36

18 5. Installing Kony Fabric Kony Fabric Installation Guide - Mac 3. The Welcome to Kony Fabric windows appears. Read the instructions carefully before installing Kony Fabric Console by Kony, Inc. All rights reserved 18 of 36

19 5. Installing Kony Fabric Kony Fabric Installation Guide - Mac 4. Read the instructions carefully, and click Next. The LICENSE AGREEMENT window 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 by Kony, Inc. All rights reserved 19 of 36

20 5. Installing Kony Fabric Kony Fabric Installation Guide - Mac 6. Click Next. The Install Type window appears. The selected path appears in the Please choose a destination folder for this installation field by Kony, Inc. All rights reserved 20 of 36

21 5. Installing Kony Fabric Kony Fabric Installation Guide - Mac 7. Click Choose to browse the required folder from your system. 8. Click Next. The Configuration Parameters window appears. Some fields may already have default values. You can leave them as is if your Mac has the same default values. Enter the following details: Hostname/IP Address: Enter the host name or IP address of the Mac. Service User Password: Enter the password of the current user logged in on the Mac. HTTP Port: Enter the port number for HTTP communication. Java Messaging Service Port: Enter the port number for Java Messaging Service for 2017 by Kony, Inc. All rights reserved 21 of 36

5. Installing Kony Fabric Kony Fabric Installation Guide - Mac licensing and reporting. Tomcat Shutdown Port: Enter the port number for Tomcat shutdown. 9. Click Next. The next page appears.

22 5. Installing Kony Fabric Kony Fabric Installation Guide - Mac licensing and reporting. Tomcat Shutdown Port: Enter the port number for Tomcat shutdown. 9. Click Next. The next page appears. Database Port:: Enter the database port of the MySQL Server. By default, the field is set to 3306 for MySQL. Database User: Enter the user name used while creating the database user - for example, dbclient by Kony, Inc. All rights reserved 22 of 36

24 5. Installing Kony Fabric Kony Fabric Installation Guide - Mac 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. First Name: Enter the first name of the user. Last Name: Enter the last name of the user. Enter the address of the user. It can include alphanumeric and special characters that follow the standard address form. Password: Enter the password for the user. It can be a combination of alphanumeric and 2017 by Kony, Inc. All rights reserved 24 of 36

25 5. Installing Kony Fabric Kony Fabric Installation Guide - Mac special characters. Confirm Password: Retype the password to ensure the user's identity. 12. Click Next. The Summary window appears by Kony, Inc. All rights reserved 25 of 36

26 5. Installing Kony Fabric Kony Fabric Installation Guide - Mac 13. Click Install. The Installing Kony Fabric window appears. Once the installation completes, the Install Complete window appears with the confirmation message by Kony, Inc. All rights reserved 26 of 36

5. Installing Kony Fabric Kony Fabric Installation Guide - Mac 14.

28 6. Uninstalling Kony Fabric Kony Fabric Installation Guide - Mac 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 by Kony, Inc. All rights reserved 28 of 36

6. Uninstalling Kony Fabric Kony Fabric Installation Guide - Mac 2. Click Next. Delete Database choices appear. 3. Select the option button as Delete all data or Retain all data.

29 6. Uninstalling Kony Fabric Kony Fabric Installation Guide - Mac 2. Click Next. Delete Database choices appear. 3. Select the option button as Delete 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 by Kony, Inc. All rights reserved 29 of 36

30 6. Uninstalling Kony Fabric Kony Fabric Installation Guide - Mac Once the uninstallation is complete, the Uninstall Complete window appears. It informs that all items are successfully uninstalled by Kony, Inc. All rights reserved 30 of 36

31 6. Uninstalling Kony Fabric Kony Fabric Installation Guide - Mac 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 to manually delete them by Kony, Inc. All rights reserved 31 of 36

32 7. Post-installation Tasks Kony Fabric Installation Guide - Mac 7. Post-installation Tasks 7.1 Increasing Max Allowed Packet Size for MySQL If the size of your application is more than the variable size of the server database, an error occurs. Ensure the variable max_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. To modify the max_allowed_packet_size for your MySQL server on a Mac (OS X), you must first create a.cnf file called my.cnf in a folder (documents folder is recommended), add some properties to the file, and then move my.cnf file to the etc folder. To create my.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 the my.cnf file, copy it, navigate to /etc and paste the my.cnf file there by Kony, Inc. All rights reserved 32 of 36

33 7. Post-installation Tasks Kony Fabric Installation Guide - Mac 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 the max allowed packet size is 20M, then the innodb log file size should be 200M minimum by Kony, Inc. All rights reserved 33 of 36

34 8. Frequently Asked Questions Kony Fabric Installation Guide - Mac 8. Frequently Asked Questions Is it possible to change my Kony 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, follow these steps: 1. In your Macintosh terminal, execute the below commands sudo launchctl unload /Library/LaunchDaemons/KonyFabric.plist sudo launchctl unload /Library/LaunchDaemons/KonyFabricJMS.plist Important: Ensure that you have MySQL Workbench 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 the MySQL_changeHostDetails_script.sql file. The file will open in your MySQL Workbench by Kony, Inc. All rights reserved 34 of 36

8. Frequently Asked Questions Kony Fabric Installation Guide - Mac 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.

35 8. Frequently Asked Questions Kony Fabric Installation Guide - Mac 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 MySQL Workbench, 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. WAAS_BASE_URL KONY_ACCOUNT_API_BASE_URL 2017 by Kony, Inc. All rights reserved 35 of 36

36 8. Frequently Asked Questions Kony Fabric Installation Guide - Mac 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, follow these steps: 1. In your Macintosh terminal, execute the below commands sudo launchctl load /Library/LaunchDaemons/KonyFabric.plist sudo launchctl load /Library/LaunchDaemons/KonyFabricJMS.plist 2017 by Kony, Inc. All rights reserved 36 of 36

Engagement Services. Database Setup Guide - SQL Server

Engagement Services. Database Setup Guide - SQL Server Kony MobileFabric Engagement Services Database Setup Guide - SQL Server Release 7.2.5 Document Relevance and Accuracy This document is considered relevant to the Release stated on this title page and the