Android Build Guidelines

Transcription

1 Kony Visualizer Android Build Guidelines Release 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 10

2 Copyright 2016 by Kony, Inc. All rights reserved. December, 2016 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 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 10

3 Revision History Date Document Version Description of Modifications/Release 12/19/ Documented Android Build Guidelines 2016 by Kony, Inc. All rights reserved 3 of 10

4 Kony Visualizer Enterprise provides complete support for Android N. This enables you to build apps targeted for Android N. Following are a few guidelines and mandatory requirements: If you are upgrading from Kony Visualizer Enterprise to using the plugins on update site, make the following changes: 1. Install Android Build Tools For Windows, download jdk1.8.0_112, and place the file at the following location: <VizInstalledLocation>\KonyVisualizerEnterprise\Java folder. Final Java path in Windows looks like <VizInstalledLocation>\KonyVisualizerEnterprise\Java\jdk1.8.0_112\bin For Mac, download jdk 1.8.0_112, and place the file at the following location: <VizInstalledLocation>/KonyVisualizerEnterprise/jdk 1.x folder Final Java path looks like <VizInstalledLocation>/KonyVisualizerEnterprise/jdk1.8.0_112.jdk/Contents/ Home/bin 3. For Windows, download or copy jre folder from your java folder and place it in the installation folder. The final path looks like: <VizInstalledLocation>\Kony_Visualizer_Enterprise\jre For Mac, make the following changes. a. To change the Java home in eclipse executable file, follow these steps: i. Go to the following location: <VizInstalledLocation>/KonyVisualizerEnterprise/Kony_Visuali zer_enterprise/kony Visualizer Enterprise.app/Contents/MacOS/ ii. Open the eclipse file, and change the Java home path to the latest version by Kony, Inc. All rights reserved 4 of 10

5 b. To change the Java path in vm args in eclipse-orig.ini file, follow these steps: i. Go to the following location: <VizInstalledLocation>/KonyVisualizerEnterprise/Kony_Visualizer _Enterprise/Kony Visualizer Enterprise.app/Contents/MacOS/ folder ii. Open the eclipse-orig.ini file, and change the java path to the latest version. 4. Download Gradle version, and place the file at the following location: <VizInstalledLocation>\KonyVisualizerEnterprise\gradle Final Gradle path look like <VizInstalledLocation>\KonyVisualizerEnterprise_build\gradle\bin 5. Upgrade the Google play services repository to latest version (at least version 40 or later). If you miss any one of the above steps, the Android build will display appropriate alert messages to inform you about the missing step. Make appropriate changes in your setup to proceed further with the build. Note: If you are performing a fresh installation of Kony Visualizer Enterprise, the above steps are not required. If you are performing a fresh installation of Visualizer Enterprise version, follow these steps: 1. Kony Visualizer Enterprise7.2.1 installer comes packed with the latest Java 8 and Gradle to support the latest version of Android. 2. To use the latest version of Android, install the following Android libraries for a successful build: 2016 by Kony, Inc. All rights reserved 5 of 10

6 a. Android Target 24.(This is required only if target SDK is chosen as 24) b. Google play services repo should be greater than or equal to 40.0 c. Upgrade Android Build tools to version. d. Upgrade Android SDK tools to or above version. e. Upgrade Android SDK Platform-tools to or above version. The items marked in red in the screenshot below are mandatory to install by Kony, Inc. All rights reserved 6 of 10

7 2016 by Kony, Inc. All rights reserved 7 of 10

8 Most common errors noticed during the build process and their solutions a. Error com.android.builder.internal.aapt.aaptexception: Failed to crunch file OR ERROR: Unable to open PNG file Solution: This error occurs if the absolute file path length of an image or bundled resource file from a third party lib exceeds 240 characters. Note: This is a Windows OS limitation. Windows supports a max file path length of 240 characters. In-order to circumvent this error, make sure that the file paths should not exceed 240 characters by keeping Kony workspace in root drive, and reducing the name length of the workspace folder. b. Error ERROR: 9-patch image malformed Solution: This error occurs if an image is not a nine-patch image, but is saved as nine-patch image. To resolve this issue, rename.9.png image as plain.png image (or) create a proper nine-patch image. If you have two different versions of Kony Visualizer Enterprise, you need to follow few guidelines: Example : A Computer has Kony Visualizer Enterprise version and at the same time you also want to use any of the previous versions of Kony Visualizer Enterprise 2016 by Kony, Inc. All rights reserved 8 of 10

9 (5.x, 6.x, 7.1, 7.2.0) parallely on same computer, take the following into consideration. If your Android projects built on Kony Visualizer or previous versions, you need to install Android Build tools However, if you want to use Kony Visualizer as well, you need to install Android Build tools as well. Having both versions together will lead to build issues. Here are a few guidelines: 1. Remove and add the required folders at the <Android-Setup>\androidsdk\build-tools location according to the Kony Visualizer Enterprise version. 2. To build a project using Kony Visualizer Enterprise 7.2.1, you need to have Android Build tools and to build a project using previous Kony Visualizer Enterprise versions(5.0, 5.5, 5.6, 6.0, 6.5, 7,1, 7.2.0) remove Android Build tools folder and place Android Build tools folder. 3. For Kony Visualizer Enterprise 6.0 and 6.5 versions, you can have both and build tools installed, but you need to specify the Android build to use a specific build-tool version by adding the below snippet in the androidprecompiletask.xml file. <concatdestfile="${app.dir}/project.properties"append="true">sdk.buildtools= </concat> To know more about androidprecompiletask.xml and its usage, refer puts_to_android_application_developers.htm#android Following are the changes that you need to make in the Headless/ Command line build doc. There are few mandatory requirements for Command Line build. These requirements apply when you are upgrading plugins from or previous versions to version. 1. Make sure that the Gradle and Java/JDK folders are placed in the Kony 2016 by Kony, Inc. All rights reserved 9 of 10

10 Visualizer Enterprise installation directory. o Use the Gradle version or later. Final path looks like: <VizInstalledLocation>\KonyVisualizerEnterprise_build\gradle\bin o Use the Java 1.8 version. Final Java path on the Windows looks like: <VizInstalledLocation>\KonyVisualizerEnterprise\Java\jdk1.8.0_112\bin Final Java path on the Mac looks like: <VizInstalledLocation>/KonyVisualizerEnterprise/jdk 1.x folder 2016 by Kony, Inc. All rights reserved 10 of 10