Sync Services. Developing Offline Applications

Transcription

1 Kony MobileFabric Sync Services Developing Offline Applications Release 6.5 Document Relevance and Accuracy This document is considered relevant to the Release stated on this title page and the document version stated on the Revision History page. Remember to always view and download the latest document version relevant to the software release you are using by Kony, Inc. All rights reserved 1 of 256

2 Kony MobileFabric Sync Services Developing Offline Apps Copyright 2014 Kony, Inc. All rights reserved. July, 2015 This document contains information proprietary to Kony, Inc., is bound by the Kony license agreements and may not be used except in the context of understanding the use and methods of Kony Inc, software without prior, express, written permission. Kony, Empowering Everywhere, Kony MobileFabric, Kony Modeler, and Kony Visualizer are trademarks of Kony, Inc. Microsoft, the Microsoft logo, Internet Explorer, Windows, and Windows Vista are registered trademarks of Microsoft Corporation. Apple, the Apple logo, itunes, iphone, ipad, OS X, Objective-C, Safari, Apple Pay, Apple Watch and Xcode are trademarks or registered trademarks of Apple, Inc. Google, the Google logo, Android, and the Android logo are registered trademarks of Google, Inc. Chrome is a trademark of Google, Inc. BlackBerry, PlayBook, Research in Motion, and RIM are registered trademarks of BlackBerry. All other terms, trademarks, or service marks mentioned in this document have been capitalized and are to be considered the property of their respective owners by Kony, Inc. All rights reserved 2 of 256

3 Kony MobileFabric Sync Services Developing Offline Apps Revision History Date Document Version Description of Modifications/Release 07/14/ Updated Kony Sync to Kony MobileFabric Sync for release /22/ Updated Operation Mapping section by adding content for BATCH_OFFSET 12/12/ Initial release 2015 by Kony, Inc. All rights reserved 3 of 256

4 Kony MobileFabric Sync Services Developing Offline Apps Table of Contents 1. Developing Offline Applications Prerequisites for Accessing Offline Data Sources Introduction to Kony MobileFabric Sync Creating a SkyMobile Data Source Introduction to SkyMobile Sky Data Object Explorer Viewing the Sky Data Explorer Connecting to a Sky Server Working with the Kony SyncConfiguration View Viewing the Kony SyncConfiguration View Creating a New SyncConfiguration Adding or Editing the Sync Object Using the Sky Objects in your Application Troubleshooting Sky Connectivity Issues Creating an Database Datasource Connecting to a Database Server Working with the Kony SyncConfiguration View Kony SyncConfiguration View Creating a New SyncConfiguration Importing Columns to SyncObjects by Kony, Inc. All rights reserved 4 of 256

5 Kony MobileFabric Sync Services Developing Offline Apps 9.4 Adding or Editing the Sync Object Using the Database Tables in your Application Troubleshooting Database Connectivity Issues Creating a WebService Datasource Working with the Kony SyncConfiguration View Kony SyncConfiguration View Creating a New SyncConfiguration Adding or Editing the Sync Object Using the WebServices in your Application Creating Sync Configuration using RESTful JSON Service Prerequisites Creating a REST JSON Service Creating a Sync Configuration Using RESTful JSON Services in your Application Creating Sync Configuration using RESTful XML DataSource Prerequisites Creating a REST XML Service Creating a Sync Configuration Using RESTful XML Services in your Application Creating a Sync Configuration using SAP NetWeaver DataSource Prerequisites by Kony, Inc. All rights reserved 5 of 256

6 Kony MobileFabric Sync Services Developing Offline Apps 16.2 Creating a REST XML Service in Enterprise Explorer Creating a Sync Configuration Using SAP NetWeaver Services in your Application Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Prerequisites Connecting to a SAP Server Creating a Sync Configuration file Using SAP BAPI Services in your Application Configuring the Custom Authentication Provider Configuring SAP JCO Connection Pool Configuring Single Sign-On (SSO) Using Auto Commit Feature Hierarchical Upload SAP BAPI Design Guidelines Handling Sync Configuration Schema Changes Walkthrough of Handling Schema Changes Checking if Schema is Changed Registering for Schema Change Callbacks Handling Application Upgrades Handling Pending Uploads Before a Schema Change by Kony, Inc. All rights reserved 6 of 256

7 Kony MobileFabric Sync Services Developing Offline Apps 19. Generate Application Forms Generating Offline Services Using the Offline Services in your application Configuring Interceptors Loading an Existing SyncConfiguration File by Kony, Inc. All rights reserved 7 of 256

8 1. Developing Offline Applications Kony MobileFabric Sync Services Developing Offline Apps 1. Developing Offline Applications Offline Applications enable you to access services on your device if it is not connected to a network (data). This basically provides you with the flexibility to define a service for your application which can be accessed by the user when the device is not connected to a network. You can access the following Data sources offline by using the Kony Sync tool chain View. Sky Data Objects Databases Web Services SAP Services Siebel Services 1.1 Prerequisites for Accessing Offline Data Sources To develop offline applications using Kony Sync tool chain, follow these steps: 1. Install Kony Studio. 2. Install the Kony MobileFabric Sync plugins by navigating to Help > Install New Softwares. Note: If you are using Kony Studio 5.6, ensure that you use Kony Sync 5.6 plugins. 3. Ensure that you configure the Sky Server such that the Data Objects can be fetched and explored by Kony, Inc. All rights reserved 8 of 256

9 1. Developing Offline Applications Kony MobileFabric Sync Services Developing Offline Apps 4. Ensure that you are connected to the Sky Server directly or either through VPN. 5. Please ensure that the Sky Gateway is setup with below SAP parameters gw/netstat - this needs to be set to blank gw/alternative_hostnames - This needs to be set to include the external IP address of the Enterprise firewall Please contact your SAP Administrator to set the above parameters by Kony, Inc. All rights reserved 9 of 256

10 1. Developing Offline Applications Kony MobileFabric Sync Services Developing Offline Apps If the Sky Gateway is not set with the appropriate SAP parameters, you might see the error below: 6. Minimum Sky MEAP Server installed in the SAP namespace should be or above. Follow these prerequisites if your Datasource is an RDBMS: 1. To connect to an RDBMS datasource, ensure that you have downloaded the required drivers for a particular database on your computer. 2. To allow SQL Server Express to accept remote connections, please follow these steps: 2015 by Kony, Inc. All rights reserved 10 of 256

11 1. Developing Offline Applications Kony MobileFabric Sync Services Developing Offline Apps a. Click Start and navigate to Programs > Microsoft SQL Server 2005/2008 and select SQL Server Configuration Manager. b. Select SQL Server Network Configuration. c. Double-click on Protocols for SQLEXPRESS. d. Enable TCP/IP Protocol if it is disabled. e. Right-click TCP/IP and select Properties. f. Scroll down to IP all make sure TCP Dynamic Ports is blank and that TCP Port is set to g. Click OK. h. Make sure that port: 1433 is enabled on your VDS firewall. i. Make sure that the SQL Browser is enabled and running. When using SQL Express you will also need to open UDP port Introduction to Kony MobileFabric Sync Kony MobileFabric Sync Framework is a comprehensive synchronization platform that enables developers to add synchronization capabilities to mobile applications. Kony MobileFabric Sync Framework solves the problem of how to synchronize any type of data in any relational database management store using any protocol over any topology. Fundamental to Kony MobileFabric Sync Framework is the ability to support offline and collaborative data between devices and the server by Kony, Inc. All rights reserved 11 of 256

12 1. Developing Offline Applications Kony MobileFabric Sync Services Developing Offline Apps Kony MobileFabric Sync Architecture For more information about Kony MobileFabric Sync, refer kony_mobilefabric_sync_getting_started_ guide.pdf in Kony Sync Library by Kony, Inc. All rights reserved 12 of 256

13 2. Creating a SkyMobile Data Source Kony MobileFabric Sync Services Developing Offline Apps 2. Creating a SkyMobile Data Source This chapter provides an introduction to SkyMobile and lists the procedures to import Sky data objects and using the SyncConfiguration view to import those data objects by Kony, Inc. All rights reserved 13 of 256

14 3. Introduction to SkyMobile Kony MobileFabric Sync Services Developing Offline Apps 3. Introduction to SkyMobile You can now access Sky Data Objects within your application using the Sky Data Explorer view which is integrated in Kony Studio. With Sky Technologies, Kony can immediately offer customers a significantly broader range of B2E solutions, including certified integration with SAP environments. SAP customers in particular benefit from Sky's ability to deploy from inside SAP and domain expertise in B2E environments. Meanwhile, Sky Technologies customers benefit from Kony's broad array of pre-built B2C and B2E applications, its broad and deep multi-channel application platform, and its mobile application management/mobile device management solutions. Sky Architecture 3.1 Sky Data Object Explorer Kony Studio allows you to access and use the Sky objects using the custom Sky Data Object Explorer by Kony, Inc. All rights reserved 14 of 256

15 3. Introduction to SkyMobile Kony MobileFabric Sync Services Developing Offline Apps A Sky Data Object typically has the following hierarchy: Data Objects: This is the first node available in Sky Data explorer, once the server is connected. Sky Data Object explorer allows you to refresh and view the Data Object. It allows you to view Data Object synchronization properties. It also offers an option for you to import the Data Objects to Kony project. A Data Object (DOB) enables linking of one or more local database (LDB) definitions together. Following are the primary advantages: Ability to process multiple LDB synchronization requests in a single request. Process complete transactions i.e. all inter-related data together. Enables the use of a data profile facility to automatically control the distribution of data to remote Application Servers. Incorporate Binary objects (BOBs) into a Data Object definition, using classification by Kony, Inc. All rights reserved 15 of 256

16 3. Introduction to SkyMobile Kony MobileFabric Sync Services Developing Offline Apps Tables: This is the next node for a Data Object tree. Sky Data Object explorer allows you to refresh, expand and collapse the Table tree node so as to display the underlying components. It allows you to view Table properties, Table definition and Table key relationships (field to field mapping between parent and child tables). You can also view all the columns and the column type of the table in the table tree node. Binary object: Sky Data Object explorer allows you to view binary objects attached/associated to a table/data Object. It allows user to refresh, expand and collapse the Binary object tree node so as to display the underlying components. It allows user to view Binary object properties and Binary object details. The Sky Data Object explorer allows the user to create and save new Sky server profiles and connect, edit or delete existing server profiles. It also allows user to connect to more than one Sky servers at the same time by Kony, Inc. All rights reserved 16 of 256

17 4. Viewing the Sky Data Explorer Kony MobileFabric Sync Services Developing Offline Apps 4. Viewing the Sky Data Explorer Sky Data Explorer is available as a tab, next to the Enterprise Explorer. If you cannot view the Sky Explorer, 1. Navigate to Window > Show View > Other. 2. In the filter text area, enter Sky Data Explorer. 3. Click OK. 4. The Sky Data Explorer View appears by Kony, Inc. All rights reserved 17 of 256

18 5. Connecting to a Sky Server Kony MobileFabric Sync Services Developing Offline Apps 5. Connecting to a Sky Server Before connecting to a Sky Server ensure that you: 1. Copy the following files from the SAP installation and place them in <JDK_Installation_ Path>/jre/ lib/ext folder: sapjco3.dll sapjco3.jar Note: If you have a Windows OS, copy the sapjco3.dll file. If you have a Linux or Unix environment, copy the sapjco3.so file. 2. Modify the config.ini file and add the following line at the end of the file: osgi.parentclassloader=ext This file is available at <Eclipse_Installation_Path>/configuration. 3. Restart Eclipse. To add a Sky Server, follow these steps: 1. Go to the Sky Data Explorer view. 2. Right-click the Sky Servers folder and select Add Server. The SAP Server Details screen appears by Kony, Inc. All rights reserved 18 of 256

19 5. Connecting to a Sky Server Kony MobileFabric Sync Services Developing Offline Apps 3. In the Connection tab, enter the following information: Server Name: Add the name of the SAP Server to be loaded. Connection Properties: You can choose either direct or load balanced. o Direct: When you select Direct, you establish a direct connection to a server without using a message server. Provide the following information: Application Server: Enter the host name of the provider system. System Number: Enter the port name of the provider system. o Load Balanced: When you select Load Balanced, you can use a message server. The message server processes the (Remote Function Call) RFC call and sends a request to a provider system which can process this request. Provide the following information: 2015 by Kony, Inc. All rights reserved 19 of 256

20 5. Connecting to a Sky Server Kony MobileFabric Sync Services Developing Offline Apps System ID: Enter the ID of the SAP system. Message Server: Enter the host name of the message server. Message Server Port: Enter the port number of the message server. Login Group: Enter the login group, if a log on group is defined for the URL. The message server searches for a definition in the list of log in groups and performs the load synchronization for this group. Login Details: Add the username, password, and the Client ID using which you will logon to the system by Kony, Inc. All rights reserved 20 of 256

21 5. Connecting to a Sky Server Kony MobileFabric Sync Services Developing Offline Apps 4. In the Advanced tab, enter the following: SAPRouter String: Enter the address of the SAP router that is used to connect to a provider system. Connection CPIC Trace Level: Enter the trace level which you want to set. Available options are: -1: Usage of the global CPIC trace level. 0: no CPIC trace. 1: minimal CPIC trace. 2: full CPIC trace. 3: full CPIC trace including data. To enable tracing on the RFC destination, select the RFC Trace checkbox. Peak Connection Limit: Enter the maximum number of simultaneous connections that should be active. Pool Capacity: Enter the maximum number of idle connections to be kept open by Kony, Inc. All rights reserved 21 of 256

22 5. Connecting to a Sky Server Kony MobileFabric Sync Services Developing Offline Apps 5. In the Security tab, enter the following: To enable Secure Network Connection, select the Enable SNC checkbox. sncnamer3: Enter the SNC name of the User Management Engine (UME). sncqopr3: Select a value between 1 and 9 to indicate the SNC level of security. snclib: Enter the path to library that provides the SNC service by Kony, Inc. All rights reserved 22 of 256

23 5. Connecting to a Sky Server Kony MobileFabric Sync Services Developing Offline Apps 6. Click Connect. You can view the added server and its corresponding Data Objects under the Sky Servers folder by Kony, Inc. All rights reserved 23 of 256

24 5. Connecting to a Sky Server Kony MobileFabric Sync Services Developing Offline Apps Important: Ensure that you configure the Sky Server such that the Data Objects can be fetched and explored. 7. Expand each node to view the child nodes of each Data Object. The child nodes of each parent node are loaded when you click on the node. The on-demand loading of each child prevents UI freeze. The Progress View displays the progress of each loading operation. 8. You can also perform the following additional actions: Right-click a created Sky server and Disconnect or view the Properties configured for that server. Right click and add additional Sky Servers by Kony, Inc. All rights reserved 24 of 256

25 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 6. Working with the Kony SyncConfiguration View After you have configured and connected to the Sky Server, you can import all the Sky Data Objects as Sync Objects using the Kony SyncConfiguration view. The sections below describe the procedures to use the SyncConfiguration view. 6.1 Viewing the Kony SyncConfiguration View The SyncConfiguration view is next to the Emulators. Using the SyncConfiguration View, you can map and use SOAP, SAP, Database tables, Siebel, or Sky Objects as offline services. To view the SyncConfiguration view, follow these steps: 1. Navigate to Window > Show View > Other. 2. In the filter text area, enter Sync. 3. Click OK. 4. The SyncConfiguration View appears. 6.2 Creating a New SyncConfiguration You can import the Sky Data Objects using the SyncConfiguration view. To create a new Sync configuration for Sky Data Objects, follow these steps: 2015 by Kony, Inc. All rights reserved 25 of 256

26 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 1. Navigate to the SyncConfiguration view. 2. To create a new Sync configuration, click. The Create SyncConfiguration dialog appears. 3. The SyncConfiguration Name, Application ID, and Application Name fields are pre populated based on the name of your application. You can change the name of the configuration created and ID of the application based on the ID created for the application. 4. Set a namespace for the Sync Configuration. The namespace you enter here will be used for the naming convention of the generated offline services. 5. Click Finish. The SyncConfiguration view appears Adding a DataSource After you add a Sync configuration, you need to add a Datasource. When you add a Datasource, you specify the source from which the objects/services will be imported and will be available as an offline service. To add a Datasource follow these steps: 2015 by Kony, Inc. All rights reserved 26 of 256

27 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 1. Right-click the DataSources icon, and select Add DataSource. 2. Specify a name for the DataSource configuration that you are creating. 3. Select the Type of DataSource from which the objects are imported from. For importing Sky Objects, set the Type as Sky. 4. Select the Server from which you want to import the objects from. If you have configured multiple servers for Sky in the Sky Data Explorer, a list of servers appears. Select any one of the servers for which you are creating a DataSource for by Kony, Inc. All rights reserved 27 of 256

28 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 5. Click Finish. The DataSource added appears as follows. 6. You can edit the details of a DataSource or delete a DataSource as well Adding a Sync Scope from Sky Data Objects After you define a DataSource for Sky, you can add a SyncScope using the created data source. Doing so enables you to create a SyncScope for each of the Sky Data Objects. When you create a SyncScope, you can create an application from the SyncScope objects and create offline services. 1. Right click SyncScopes and select Add SyncScope from Sky Data Objects by Kony, Inc. All rights reserved 28 of 256

29 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 2. Select the application for which you want to add a DataObject to a SyncScope. 3. Do any of the following: To create a SyncScope for the Data Object, select any one of the displayed Data Objects in the left pane and click. To remove a Data Object whose Sync Scope is added, select the Data Object from the right pane and click. To create a SyncScope for all the Data Objects, select any one of the displayed Data Objects in the left pane and click. To remove all the Data Object whose Sync Scope is added, select any Data Object from the right pane and click by Kony, Inc. All rights reserved 29 of 256

30 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 4. Click Finish. All the added SyncScopes are listed under the SyncScopes folder. 6.3 Adding or Editing the Sync Object In the Sync Configuration View, you can do the following: Add a SyncObject or a SyncAttribute Edit a SyncObject Important: You can add or edit attributes, relationships and objects that are present within the same SyncScope Adding a SyncObject In the SyncConfiguration view, after you have added a DataSource and then a SyncScope, add a SyncObject in the existing list of Objects. To do so, 1. Right-click the created SyncScope and cick Add Sync Object by Kony, Inc. All rights reserved 30 of 256

31 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 2. Specify the name for the SyncObject. 3. Click Finish. Important: It is mandatory to define a SyncAttribute for any new SyncObject that is created. If you do not do so, an error appears when you generate the application forms or offline services Adding a Sync Attribute Every SyncObject created has attributes. For example a SyncObject comprising the summary of a data can have attributes such as month, year, and owner of the object 2015 by Kony, Inc. All rights reserved 31 of 256

32 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 1. Right-click the SyncObject and click Add Sync Attribute. 2. Enter a name for the SyncAttribute, the datatype for the attribute, select whether the value can be set to null, the maximum length of the data in the field, select whether the field is an autogenerated field, such as customer id field like 1,2,3 which have counters and are autogenerated, and whether the attribute would be key of the SyncObject table by Kony, Inc. All rights reserved 32 of 256

33 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 3. Click Finish. The added SyncAttribute appears under the SyncObject Editing a SyncObject Every SyncObject can have multiple attributes, relationship with other SyncObjects Editing Attributes To edit attributes that are already part of a SyncObject, do the following: 1. Right click the SyncObject you for which you want to edit the attributes for and select Edit. The Edit SyncObject dialog appears by Kony, Inc. All rights reserved 33 of 256

34 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 2. All the attribute fields that are editable are enabled. You can do any of the following: Name: Name of the attribute in the SyncObject. Each attribute is automatically named when you import a Data Object, you can rename the attributes for a SyncObject using this field. Is Key: You can set the value in this field to true or false. Set this field to true to enable an attribute of an Object to be the key for that particular object. Once you set an attribute as a key its values have to be unique. Type: Specifies the datatype of an attribute. Choose an appropriate datatype for an attribute from the list of available. Is Nullable: You can set the value in this field to true or false. Set this field to true to specify whether a certain field can be left blank without any value specified in it by Kony, Inc. All rights reserved 34 of 256

35 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Max Length: Specifies the maximum number of characters an attribute can have. Autogenerated: Specifies whether a field is an auto generated field. Use the Filter field to filter the attributes of an Object and edit the fields accordingly. You can also add an attribute using the add ( ) button and fill the corresponding fields accordingly. To remove an attribute, select the attribute row or name and click the delete( ) button. You can change the order of the attributes by selecting the attribute and using the up or down arrows. To insert a new attribute before another attribute click. To insert an attribute after another attribute click. 3. Click Finish Editing Relationships When two entities (tables) are linked to each other, they have a column from each of the entity participating in a relationship. With typical foreign-key based relationships, one foreign key column can refer to only one parent entity. But with logical relationships, one foreign key can refer to multiple parent entities. Note that, this is not possible with RDBMS foreign key constraints. Logical relationship is supported for both client side and server side in the Sync Framework. And this is applicable to both OTA and Persistent Strategies, and all the existing data sources. For example, Attachment and Note entities can refer to multiple entities such as Account, Contact, Opportunity, etc., with ParentId foreign key. To edit relationships that are already part of a SyncObject or to add a new relationship between SyncObjects, do the following: 1. Right-click the SyncObject for which you want to edit the relationships for and click Edit. The Edit SyncObject dialog appears by Kony, Inc. All rights reserved 35 of 256

36 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 2015 by Kony, Inc. All rights reserved 36 of 256

37 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 2. Select Relationships from the left pane. The following dialog appears. 3. You can edit the existing relationships between SyncObjects. Target Object: Target SyncObject to which thecurrent SyncObject creates a relationship with. Click the list and click OK. button, to change the Target Object. Select a Target Object from the Relationship: Specify the type of relationship between the Source attribute (record) in the SyncObject to the Target attribute(child record) of another SyncObject. It can be One to Many or Many to One. Target Attribute: Specifies the attribute of the other SyncObject with which you want to relate your Source Attribute to. Source Attribute: Specify the attribute of the SyncObject you want to link the Target Attribute to by Kony, Inc. All rights reserved 37 of 256

38 6. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Cascade: Set this value to true or false. Setting this to true implies that when you delete a record in the parent table, it will subsequently delete all the records in the child table as well. 4. You can also add a relationship using the add ( ) button and fill out the corresponding fields accordingly. To remove a relation, select the attribute row or name and click the delete( ) button. You can change the order of the relationships by selecting the relationship and using the up or down arrows. To insert a new relationship before another relationship click. To insert a relationship after another relationship click by Kony, Inc. All rights reserved 38 of 256

39 7. Using the Sky Objects in your Application Kony MobileFabric Sync Services Developing Offline Apps 7. Using the Sky Objects in your Application You can import and use the Sky Objects in your application. For an application you can do the following: Generating Application Forms. Generating and using offline services by Kony, Inc. All rights reserved 39 of 256

40 Kony MobileFabric Sync Services Developing Offline Apps 7.1 Troubleshooting Sky Connectivity Issues If I face errors while connecting to the Sky SAP Server, what do I do? 1. Check whether all the required jars are present under the java ext folder used by eclipse. To know the version used by eclipse, navigate to Help > About Eclipse> Installation Details > Configurations and check the -vm parameter. For example: -vm C:/Program Files (x86)/java/jdk1.6.0_27/jre/bin/client/jvm.dll 2015 by Kony, Inc. All rights reserved 40 of 256

41 Kony MobileFabric Sync Services Developing Offline Apps 2. Ensure that you are connected to the Sky Server directly or either through VPN. 3. If the Sky Gateway is not set with the appropriate SAP parameters, you might see the error below: Please ensure that the Sky Gateway is setup with below SAP parameters gw/netstat - this needs to be set to blank gw/alternative_hostnames - This needs to be set to include the external IP address of the 2015 by Kony, Inc. All rights reserved 41 of 256

42 Kony MobileFabric Sync Services Developing Offline Apps Enterprise firewall Please contact your SAP Administrator to set the above parameters. 4. Minimum Sky MEAP Server installed in the SAP namespace should be or above. I am unable to view or import the Data Objects from the Sky Server, what do I do? Ensure that you configure the Sky Server such that the Data Objects can be fetched and explored by Kony, Inc. All rights reserved 42 of 256

43 8. Creating an Database Datasource Kony MobileFabric Sync Services Developing Offline Apps 8. Creating an Database Datasource You can access tables, system tables, and view tables created on your database server and import the tables using the SyncConfiguration view. You can use the data ported in the SyncConfiguration view and map them to widgets or fields in your application and create an offline application. 8.1 Connecting to a Database Server To add a Database Server, follow these steps: 1. Go to the Enterprise Explorer view. 2. Right-click the Databases folder and click Add Database. The Database Details screen appears by Kony, Inc. All rights reserved 43 of 256

44 8. Creating an Database Datasource Kony MobileFabric Sync Services Developing Offline Apps 3. Enter the following information: Display Name: Enter the name for the database server. After the database details are added, a connection to the server is created with the name entered in this field. In the Database Details area, do the following: o Vendor: Select the type of the Database you want to connect to. o URL: Specify the URL where the Database is hosted. For MY SQL, replace $HOST with the IP address of the machine where the server is hosted, replace $PORT with the port number on which the server is 2015 by Kony, Inc. All rights reserved 44 of 256

45 8. Creating an Database Datasource Kony MobileFabric Sync Services Developing Offline Apps running, and replace $DATABASE_NAME with the name of the database from which you want to port the tables from. For Oracle, replace $HOST with the IP address of the machine where the server is hosted, replace $PORT with the port number on which the server is running, and $SID with the SID of the database from which you want to port the tables from. For MSSQL, replace $HOST with the IP address of the machine where the server is hosted, replace $PORT with the port number on which the server is running, and replace $DATABASE_NAME with the name of the database from which you want to port the tables from. For POSTGRESQL, replace $HOST with the IP address of the machine where the server is hosted, replace $PORT with the port number on which the server is running, and replace $DATABASE_NAME with the name of the database from which you want to port the tables from. For DB2, replace $HOST with the IP address of the machine where the DB2 server is installed. Replace $PORT with the DB2 server port number, and then replace $DATABASE_NAME with the DB2 database name (ex: SYNCDB). Add currentschema with use your enterprise database schema name as following: jdbc:db2://localhost:50000/syncdb: currentschema=konysyncsample; To create datasource in Sync Configuration view using DB2 from IDE (that is, to load DB2 driver JAR in IDE for Sync plugin), follow these steps: 2015 by Kony, Inc. All rights reserved 45 of 256

46 8. Creating an Database Datasource Kony MobileFabric Sync Services Developing Offline Apps 1. Create a ENV variable named JAVA_HOME (if not already defined.) 2. Place DB2 driver JAR directly under JAVA_HOME directory. Note: Name of the driver JAR has to be db2jcc.jar. o Enter the user credentials for the server where the database is hosted. Note: Enter the credentials only when the user and password details are not given in the URL. In the Driver Details area, do the following: o Driver jar: Browse and select the appropriate database drivers based on the database vendor selected. o Driver Class Name: Browse and select the driver class name from the jar selected in the above step. Specify Optional connection parameters to the server if any. To specify an additional optional connection parameter, click Add. In the Key column, specify the additional key in the URL. For example: maxconns, ldapver, and timeout. Specify the value of the key in the right column. To delete a connection parameter select the key and click Delete. Use the up or down arrows to change the order of the connection parameters. Click Test Connection. The progress can be viewed in the Progress View. A dialog that the connection is successful appears. Click OK. 4. Click Finish. 5. The database configuration you create appears under the Database folder. Right-click the configuration that you created and click Connect by Kony, Inc. All rights reserved 46 of 256

47 8. Creating an Database Datasource Kony MobileFabric Sync Services Developing Offline Apps 6. Expand each node to view the child nodes of each Data Object. The child nodes of each parent node are loaded when you click on the node. The on-demand loading of each child prevents UI freeze. The Progress View displays the progress of each loading operation. 7. You can also perform the following additional actions: Right-click a created Database server and Disconnect or view the Properties configured for that server. Right-click and add additional Database Servers by Kony, Inc. All rights reserved 47 of 256

48 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 9. Working with the Kony SyncConfiguration View After you have configured and connected to the database, you can import all the RDBMS tables as Sync Objects using the Kony SyncConfiguration view. The sections below describe the procedure to use the SyncConfiguration view. 9.1 Kony SyncConfiguration View The SyncConfiguration view is available as a tab, next to the Emulators. Using the SyncConfiguration view, you can map and use Database, SOAP, SAP, Siebel, or Sky Objects as offline services. To view the SyncConfiguration view, follow these steps: 1. Navigate to Window > Show View > Other. 2. In the filter text area, enter Sync. 3. Click OK. 4. The SyncConfiguration View appears by Kony, Inc. All rights reserved 48 of 256

49 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 9.2 Creating a New SyncConfiguration To create a new Sync configuration for Databases, follow these steps: 1. Navigate to the SyncConfiguration view. 2. To create a new Sync configuration, click Add. The Create SyncConfiguration dialog appears. 3. The SyncConfiguration Name, Application ID, and Application Name fields are prepopulated based on the name of your application. You can change the name of the configuration created and ID of the application based on the ID created for the application. 4. If the Sync configuration has any persistent scope, select the appropriate database type from the Persistent Database Type. Note: The intermediate persistent sync store (Replica and Upload Databases) scripts are created based on the Persistent Database Type selected by Kony, Inc. All rights reserved 49 of 256

50 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 5. Enter a Namespace for the Sync Configuration. This namespace will be used for the naming convention of the client side generated code. 6. Click Finish. The SyncConfiguration view appears Adding a DataSource After you add a Sync configuration, you must add a datasource. When you add a datasource, you specify the source from where the objects/services will be imported. To add a datasource, follow these steps: 1. Right-click DataSources and click Add DataSource. 2. Enter a name for the DataSource configuration that you are creating. 3. Select the Type of DataSource from the list. For importing Database Objects, set the Type as Database. 4. Select the server from which you want to import the objects from. If you have configured multiple database servers in the Enterprise Explorer, a list of servers appear. Select the specific server for which you are creating a datasource for by Kony, Inc. All rights reserved 50 of 256

51 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 5. Click Finish. The DataSource added appears as follows. 6. You can edit or delete the details of a DataSource Adding a Sync Scope After you define a datasource, you can add a SyncScope using the created data source. Doing so enables you to create SyncObjects comprising required tables from the datasource. You can create multiple SyncScopes and have required SyncObjects within the scope. When you create a SyncScope, you can create an application from the SyncScope objects and create offline services by Kony, Inc. All rights reserved 51 of 256

52 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 1. Right-click SyncScopes and click Add SyncScope. The Add SyncScope dialog appears. 2. Enter name for the SyncScope. 3. Enter a Namespace for the SyncScope. The namespace can be of any format, for example, com.kony. 4. Select the appropriate Data Source from the list. 5. Click the type of Sync Strategy. It can be OTA Sync or Persistent Sync. For more information about the types of Sync Strategies refer the Kony Sync Framework Getting Started Guide. 6. Click the Change Tracking Policy(CTP) if you want to track the changes happening in the server database. Click CTP as Kony Sync Server, if you want the SyncServer to track the changes. Click Provided by Datasource if you have a provision where changes made to the 2015 by Kony, Inc. All rights reserved 52 of 256

53 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps database can be notified to SyncServer. For Database, this would be like a timestamp column that updates for any changes made to the row. 7. If CTP is provided by datasource, then select the Change Tracking Columns supported by the Database. Select the Last Updated Timestamp check box when you have column which represents the incremental changes. Select the Soft Delete Flag check box when the database has the column which represents soft deletes. 8. In case of conflicts between the data at the client and server end, click any of the following under Conflict Resolution Policy: Client Wins: The changes on the client side take precedent over the changes on the server side. Server Wins: The changes on the server side take precedent over the changes on the client side. Custom: Enables you to upload an Interceptor class which comprises the logic or policy for conflict resolution. 9. Conflict Interceptor Class: Enables you to browse and upload an interceptor class which comprises the logic or policy for conflict resolution. For more information about interceptors and the types of interceptors, refer Kony Sync Framework Getting Started Guide by Kony, Inc. All rights reserved 53 of 256

54 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 10. Click Finish. The created SyncScope appears below the SyncScopes folder. 9.3 Importing Columns to SyncObjects Each SyncObject is created from existing tables in a database schema. Using the SyncConfiguration view, you can import SyncAttributes(columns) from one SyncObjects(tables) to another SyncObject. To import columns to SyncObjects, do the following: 1. Right-click the SyncObject and click Import Columns. The Import Columns dialog appears by Kony, Inc. All rights reserved 54 of 256

55 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 2. Specify the table from which you want to import the columns from. 3. To filter the columns by name, enter a filter for the column. This step is optional. 4. Click Query. 5. Do any of the following: To add a column to a SyncObject, select any one of the displayed columns in the left pane and click. To remove a column added, select the column from the right pane and click. To add multiple or all the columns, select the required columns in the left pane and click. To remove multiple or all the columns added, select the required columns from the right pane and click. 6. Click Finish. All the additional columns are added under the SyncObject. 9.4 Adding or Editing the Sync Object In the Sync Configuration View, you can do the following: Add a SyncObject or a SyncAttribute Edit a SyncObject Create Relationships Create Filters. Important: You can add, edit, or create relationships/attributes that are present within the same SyncScope by Kony, Inc. All rights reserved 55 of 256

56 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Adding a SyncObject from Tables After you have added a Sync datasource and a SyncScope, you can add SyncObjects from tables of the configured Database server. To add a SyncObject and SyncAttributes from Tables: 1. Right-click the SyncScope and click Add SyncObject from Tables. 2. Select the Schema from which you want to import the tables from. 3. The following steps are optional: Set a filter for querying the database. Doing so saves computation time since all the tables from a schema are not fetched. Set the type of table that you want to fetch. The types of tables are, System tables, Tables, and View tables. View tables are nothing but tables that have join data from several tables thus creating a new view of it. Say you have a database with salaries and you need to do some complex statistical queries on it. Once you have set the Table Type filter, you can also set filters based on the name of the table. For example, entering a Name Filter %categories% will display only the Categories table by Kony, Inc. All rights reserved 56 of 256

57 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 4. Click Query. The Available tables are listed in the left pane. 5. Do any of the following: To create a SyncScope for a table, select any one of the displayed table in the left pane and click. To remove a Table whose Sync Scope is added, select the table from the right pane and click by Kony, Inc. All rights reserved 57 of 256

58 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps To create a SyncScope for multiple or all the tables, select the required tables in the left pane and click. To remove multiple or all the tables whose Sync Scope is added, select the required tables from the right pane and click. 6. If you want to Import Attributes from the Table columns as well, select the Import Attributes from Column Names check box. 7. Click Finish. All the added Tables are listed under the SyncScopes folder. 8. Once the SyncAttributes are imported, they must be edited to select the Autogenerated fields and to map the change tracking columns if selected. For more explanation, see Editing SyncObject > Editing Attributes Adding a SyncObject In the SyncConfiguration view, after you have added a datasource and then a SyncScope, add a SyncObject in the existing list of Objects by Kony, Inc. All rights reserved 58 of 256

59 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps To add a Sync Object, follow these steps: 1. Right-click the created SyncScope and click Add SyncObject. 2. Enter the name of the SyncObject. 3. Click Finish. Important: It is mandatory to define a SyncAttribute for any new SyncObject that is created. If you do not do so, an error appears when you generate the application forms or offline services Adding a Sync Attribute Every SyncObject created has attributes. For example, a SyncObject comprising the summary of a data can have attributes such as month, year, and owner of the object by Kony, Inc. All rights reserved 59 of 256

60 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 1. Right-click the SyncObject and click Add SyncAttribute. 2. The Add SyncAttribute dialog appears. 3. Enter a Name for the SyncAttribute, Select the data Type from the list, select the Is Nullable check box to denote the value can be null, the Max Length of the data in the field, select whether the field is an Autogenerated field (Customer ID field that have counters are auto-generated), and select the Is Key check box if the attribute will be a key of the SyncObject table. 4. Click Finish. The added SyncAttribute appears under the SyncObject by Kony, Inc. All rights reserved 60 of 256

61 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Editing a SyncObject Every SyncObject can have multiple attributes and relationships with other SyncObjects Editing Attributes To edit attributes that are already part of a SyncObject, do the following: 1. Right-click the SyncObject you want to edit the attributes for and clickedit. The Edit SyncObject dialog appears. 2. All the editable attribute fields are enabled. You can modify any of the following: Name: Name of the attribute in the SyncObject. Each attribute is automatically named when you import a Data Object. You can rename the attributes for a SyncObject using this field. Database Column: Denotes the column in the database by Kony, Inc. All rights reserved 61 of 256

62 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Is Key: You can set the value to true or false. Set to true to enable an attribute of an Object to be the key for that particular object. While setting an attribute as a key, ensure that its value is unique. Type: Specifies the datatype of an attribute. Select an appropriate datatype from the list. Is Nullable: You can set the value to true or false. Set to true to specify that the field can be left blank without any value specified in it. Max Length: Specifies the maximum number of characters an attribute can have. Autogenerated: Specifies whether a field is auto generated. Filter the attribute that you want to edit by using the Filter box and filter criteria. If Change Tracking columns are selected while creating the SyncScope, map them to the corresponding Attributes You can also do the following: To add an attribute, click Add and fill the required details. To remove an attribute, select the attribute row or name and click Delete. You can change the order of the attributes by selecting the attribute and using the up or down arrows. To insert a new attribute before another attribute, click. To insert an attribute after another attribute, click. 3. Click Finish by Kony, Inc. All rights reserved 62 of 256

63 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Editing Relationships When two entities (tables) are linked to each other, they have a column from each of the entity participating in a relationship. With typical foreign-key based relationships, one foreign key column can refer to only one parent entity. But with logical relationships, one foreign key can refer to multiple parent entities. Note that, this is not possible with RDBMS foreign key constraints. Logical relationship is supported for both client side and server side in the Sync Framework. And this is applicable to both OTA and Persistent Strategies, and all the existing data sources. For example, Attachment and Note entities can refer to multiple entities such as Account, Contact, Opportunity, etc., with ParentId foreign key. To edit relationships that are already part of a SyncObject or to add a new relationship between SyncObjects, do the following: 1. Right-click the SyncObject for which you want to edit the relationship for and clickedit. The Edit SyncObject dialog appears by Kony, Inc. All rights reserved 63 of 256

64 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 2015 by Kony, Inc. All rights reserved 64 of 256

65 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 2. Click Relationships from the left pane. The following dialog appears. 3. You can edit the existing relationships between SyncObjects. Target Object: Target SyncObject to which the current SyncObject creates a relationship with. Click the list and click OK. button, to change the Target Object. Select a Target Object from the Relationship: Specify the type of relationship between the Source attribute (record) in the SyncObject to the Target attribute (child record) of another SyncObject. It can be One to Many or Many to One. Target Attribute: Specifies the attribute of the other SyncObject with which you want to relate your Source Attribute to. Source Attribute: Specify the attribute of the SyncObject you want to link the Target Attribute to by Kony, Inc. All rights reserved 65 of 256

66 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Cascade: Set this value to true or false. Setting this to true implies that when you delete a record in the parent table, it will subsequently delete all the records in the child table as well. This applies only to client side or device database. 4. You can also add a relationship using the add ( ) button and fill out the corresponding fields accordingly. To remove a relation, select the attribute row or name and click the delete( ) button. You can change the order of the relationships by selecting the relationship and using the up or down arrows. To insert a new relationship before another relationship click. To insert a relationship after another relationship click Editing Filters To add additional filters that for a SyncObject or to edit any existing filters for a SyncObject, do the following: 1. Right-click the SyncObject for which you want to edit the filters for and click Edit. The Edit SyncObject dialog appears by Kony, Inc. All rights reserved 66 of 256

67 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 2. Click Filters from the left pane. There are two types of filters, a Client Side Filter and a Server Side Filter. Apply a server side filter when you want to filter the data fetched from the Enterprise Datasource to a replicated database. Apply a Client side filter when you want data to be filtered while downloading the data to the client database. Basically client side filters are to be used when filter values have to be changed dynamically from the client side code. Based on the strategy of the scope client side filter are applied either on Enterprise datasource(ota)r on Replica database(persistent Strategy). For example if you want only Customer ID's which are greater than 10 but less than 20 to be fetched, apply a server side filter. To set a filter do the following: Filter Attribute: Set the SyncAttribute using which you filter the data. Using the example stated above the SyncAttribute would be CustomerID. Condition: Set a condition using which the data will be filtered. Specify the Values using which you want to filter the data in Value1 and Value 2 Columns by Kony, Inc. All rights reserved 67 of 256

68 9. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Important: For mathematical conditional operators you can just specify one value in the Value1 column. 3. Click Finish. 4. You can also add a filters using the add ( ) button and fill out the corresponding fields accordingly. To remove a filter, select the attribute row or name and click the delete( ) button. You can change the order of the filters by selecting the filter and using the up or down arrows. To insert a new filter before another filter click. To insert a filter after another filter click. Note: All filters will be applied with AND composite. We can use EXPRESSION filter for OR composites by Kony, Inc. All rights reserved 68 of 256

69 10. Using the Database Tables in your Application Kony MobileFabric Sync Services Developing Offline Apps 10. Using the Database Tables in your Application You can import and use the Database Tables in your application. For an application you can do the following: Generating Application Forms. Generating and using offline services by Kony, Inc. All rights reserved 69 of 256

70 Kony MobileFabric Sync Services Developing Offline Apps 10.1 Troubleshooting Database Connectivity Issues If I am "unable to connect to the configured Database Server" what to do? 1. To connect to an RDBMS Datasource, ensure that you have downloaded the required drivers for a particular database on your computer. 2. To allow SQL Server Express to accept remote connections, please follow these steps: a. Click Start, Programs, Microsoft SQL Server 2005/2008 and select SQL Server Configuration Manager. b. Select SQL Server Network Configuration. c. Double click on Protocols for SQLEXPRESS. d. Enable TCP/IP Protocol if it is disabled. e. Right click TCP/IP and select Properties. f. Scroll down to IP all make sure TCP Dynamic Ports is blank and that TCP Port is set to g. Click OK. h. Make sure that port: 1433 is enabled on your VDS firewall (instructions for enabling firewall ports can be found here). i. Make sure that the SQL Browser is enabled and running. When using SQL Express you will also need to open UDP port by Kony, Inc. All rights reserved 70 of 256

71 11. Creating a WebService Datasource Kony MobileFabric Sync Services Developing Offline Apps 11. Creating a WebService Datasource Services imported through Enterprise Explorer can be used to in the sync configuration as a datasource. You can use the data ported in the SyncConfiguration view and map them to widgets or fields in your application and create an offline application. Using the Enterprise Explorer View 1. To add a WSDL service, follow these steps: a. Right-click on Web Services, and select Add Web Service WSDL. The WSDL Service dialog appears. b. Enter a name for the WSDL service. c. In the WSDL URL field, click to add an *.wsdl file. d. Enter the Basic Credentials for the service(if applicable). e. Click OK 2015 by Kony, Inc. All rights reserved 71 of 256

72 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 12. Working with the Kony SyncConfiguration View After you have added the WSDL, you can import all the web services as Sync Objects using the Kony SyncConfiguration view. The sections below describe the procedures to use the SyncConfiguration view Kony SyncConfiguration View Using the SyncConfiguration View, you can map and use SOAP, SAP, Siebel, Database, or Sky Objects as offline services. To view the SyncConfiguration view, follow these steps: 1. Navigate to Window > Show View > Other. 2. In the filter text area, enter Sync. 3. Click OK. 4. The SyncConfiguration View appears Creating a New SyncConfiguration You can create or load sync configuration file using the the SyncConfiguration view. To create a new Sync configuration for Databases, follow these steps: 2015 by Kony, Inc. All rights reserved 72 of 256

73 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 1. Navigate to the SyncConfiguration view. 2. To create a new Sync configuration, click. The Create SyncConfiguration dialog appears. 3. The SyncConfiguration Name, Application ID, and Application Name fields are pre populated based on the name of your application. You can change the name of the configuration created and ID of the application based on the ID created for the application. 4. If the Sync configuration has any persistent scope, select the appropriate database type. Note: The intermediate persistent sync store(replica and Upload Databases) scripts are created based on the Persistent Database Type selected. 5. Set a namespace for the Sync Configuration. The namespace you enter here will be used for the naming convention of the generated offline services by Kony, Inc. All rights reserved 73 of 256

74 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 6. Click Finish. The Sync Configuration structure appears in SyncConfiguration view Adding a DataSource After you add a Sync configuration, you need to add a Datasource. When you add a Datasource, you specify the source from which the services will be imported. To add a Datasource follow these steps: 1. Right-click the DataSources icon, and select Add DataSource. 2. Specify a name for the DataSource configuration that you are creating. 3. Select the Type of DataSource from which the services are imported from. For importing Web Services, set the Type as Web Service. 4. Click Finish. The DataSource added appears as follows. 5. You can edit the details of a DataSource or delete a DataSource as well. To add specific services from a WSDL to a DataSource, do the following: 2015 by Kony, Inc. All rights reserved 74 of 256

75 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 1. Right click the created Datasource and select Edit. The Import Services dialog appears. 2. Expand the WSDL and select the specific services that you want to import. 3. Click Finish. All the selected services appear under the created DataSource. 4. You have to specify input and output parameters for each of the services you have added for a DataSource. To do so, double click a service that is present under a created DataSource. The service definition dialog appears by Kony, Inc. All rights reserved 75 of 256

76 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 5. Information associated with the service is populated into the Service and Request tab of the Response/Request pane in the Service Definition Tool. Since we are not aware of the parameters that the end user provides as an input in the application, we provide a substitute parameter in the code of the request pane and provide appropriate input parameters in the Input Parameters pane. 6. In the Service pane, enter the following information: i. Soap Action - This is auto populated from the WSDL. ii. User ID and Password - Provide this information if the external web service requires form/basic authentication. iii. URL Provider - Enter the URL Provider file name. Note: URL Provider is a Java class that manipulates the URL or the parameters of the URL for the external data source. Click here to view a sample code for the URL Provider. iv. Timeout (in ms) - Specifies the maximum time (in milli seconds) the service waits for a response, before terminating the connection to the external data source. v. In the Server Authentication field, provide the authentication details of the server from which the service will be fetched. To enable NTLM and Proxy authentication configuration, refer Appendix Proxy and NTLM Authentication Configuration by Kony, Inc. All rights reserved 76 of 256

77 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps vi. Select appropriate Response encoding scheme. The default value is UTF-8. For more information about different encoding schemes supported by Kony Studio, see Response Encoding Schemes. 7. Add HTTP Header (Optional). Add HTTP Header if you need to add a custom http header as required by the external data source. i. Select HTTP Headers tab in the screen shown below: ii. Click Add. A row gets added to the table. iii. Enter the value for ID. iv. Enter a Test Value. Test Value is the value that is used for testing the service. This is the value that is substituted during the service call while testing the service. v. Select a value for Scope from the drop-down list. Scope denotes whether the value for the header is taken from the http request or a http session. 8. Add Input Parameters to the Service. Input parameters are the parameters that you pass to the service and are used during a service call. All the services do not have input parameters. We provide the input parameters based on the elements that are present in the Request pane by Kony, Inc. All rights reserved 77 of 256

78 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps i. Select Input Parameters tab in the screen shown below: ii. Click Add. A row gets added to the table. iii. Enter the value for ID as the parameter name in the request pane. iv. Enter a Test Value. Test Value is the value of the parameter that is used for testing the service. This is the value that is substituted in place of the actual parameter during a service call.. v. Select a value for Scope from the drop-down list. Scope denotes the scope of the parameter, if it is limited to request or a session. vi. Select a value for Datatype from the drop-down list. Datatype denotes the type of the parameter. You can add an additional datatype ; collection. For more information about collections, refer Collection. vii. Select True or False for Encode. Specifies if the URL needs to be encoded or not viii. If you need to delete a parameter row, select the parameter row you want to delete and click Delete. This action removes the parameter row from the list of service parameters. 9. Test the Service. After you configure a service, you have the option to test the service from the IDE itself. When you click Get Response in the Service pane, a service call is made with the input parameters. The service call returns data, that is, output parameters. By testing the service in the IDE, you know if the service call is fetching the data from the server as per your requirement by Kony, Inc. All rights reserved 78 of 256

79 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps i. Request pane shows the request code that is passed to the URL as a service call. ii. The response fetched is shown in the Response tab. iii. Select the XML code in the window, right-click and select Format to present the code in a readable format. 10. Add Output Parameters to the Service response. We format the output parameters based on the response we get from the tested service call, that is displayed in the Response pane. a. Select Output Parameters tab in the screen shown below: i. Click Add. A row gets added to the table. ii. Enter values for ID. It is advisable to create an ID that easily identifies the elements that we would like to capture from the response. iii. Apply XPath for extracting the required elements from the response of the service call. XPath is used to navigate through elements and attributes in an 2015 by Kony, Inc. All rights reserved 79 of 256

80 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps XML document. For more information about XPath, see iv. Select a value for Scope from the drop-down list. Scope denotes the scope of the parameter, if it is limited to response or session. v. Select a value for Datatype from the drop-down list. Datatype denotes the type of the parameter. vi. Collection ID - Groups data elements under the specified parameter as a collection. Collection is created to assign grouped data to segment or a table in the UI. vii. Record ID - Groups data elements under the specified parameter as a record. Typically we use this to provide metadata to the segment. viii. Format - Can be set to None, currency, number or date. ix. Format Value - Provide the conversion standard for the selected format. x. If you need to delete a parameter row, select the parameter row you want to delete and click Delete. This action removes the parameter row from the list of service parameters. ii. Check the result of the output parameter by clicking the Results radio button. It displays the desired element configured in the output parameter. In this example, we got the following output: iii. Click Save icon on the toolbar by Kony, Inc. All rights reserved 80 of 256

81 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Do this for each of the Web Services for the WSDL Adding a Sync Scope After you define a DataSource for Webservice, you can add a SyncScope using the created data source. When you create a SyncScope, you can create an application from the SyncScope objects and create offline services. 1. Right-click SyncScopes and select Add SyncScope. The Add SyncScope dialog appears. 2. Specify any name for the SyncScope. 3. Specify a namespace for the SyncScope. The namespace can be of any format, for example com.kony. 4. Select the appropriate datasource from the drop-down by Kony, Inc. All rights reserved 81 of 256

82 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 5. Select the type of Sync Strategy. For more information about the types of Sync Strategies refer the kony_mobilefabric_sync_getting_started_guide. 6. Set the Change Tracking Policy(CTP) if you want to track the changes happening in the server database. Set CTP as Kony Sync Server, if you want to SyncServer to track the changes. Select Provided by Datasource if you have a provision to track changes in the Datasource. For Database this would be like a timestamp column which updates for any change made to the row. 7. If CTP is provided by Datasource, then select the Change Tracking Columns. Select the Last Updated Timestamp check box when you have column which represents the incremental changes. Select the Soft Delete Flag check box when the database has the column which represents soft deletes. 8. In case of conflicts between the data at the client and server end, specify any of the following: Client Wins: The changes on the client side take precedent over the changes on the server side. Server Wins: The changes on the server side take precedent over the changes on the client side. Custom: Enables you to upload an Interceptor class which comprises the logic or policy for conflict resolution. 9. Conflict Interceptor Class: Enables you to browse and upload an interceptor class which comprises the logic or policy for conflict resolution. For more information about interceptors and the types of interceptors, refer the kony_mobilefabric_sync_getting_started_guide.pdf. 10. Click Finish. The created SyncScope appears below the SyncScopes folder Adding or Editing the Sync Object In the Sync Configuration View, you can do the following: 2015 by Kony, Inc. All rights reserved 82 of 256

83 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Add a SyncObject or a SyncAttribute Edit a SyncObject Adding a SyncObject In the SyncConfiguration view, after you have added a DataSource and then a SyncScope, add a SyncObject in the existing list of Objects. To do so, 1. Right-click the created SyncScope and select Add Sync Object. 2. Specify the name for the SyncObject. 3. Click Finish. Important: It is mandatory to define a SyncAttribute for any new SyncObject that is created. If you do not do so, an error appears when you generate the application forms or offline services Adding a Sync Attribute Every SyncObject created has attributes. For example a SyncObject comprising the summary of a data can have attributes such as month, year, owner of the object 2015 by Kony, Inc. All rights reserved 83 of 256

84 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 1. Right click the SyncObject and select Add Sync Attribute. 2. Enter a name for the SyncAttribute, the datatype for the attribute, select whether the value can be set to null, the maximum length of the data in the field, select whether the field is an autogenerated field, such as customer id field like 1,2,3 which have counters and are autogenerated, and whether the attribute would be key of the SyncObject table. 3. Click Finish. The added SyncAttribute appears under the SyncObject Editing a SyncObject Every SyncObject can have multiple attributes, relationship with other SyncObjects by Kony, Inc. All rights reserved 84 of 256

85 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Editing Attributes To edit attributes that are already part of a SyncObject, do the following: 1. Right click the SyncObject you for which you want to edit the attributes for and select Edit. The Edit SyncObject dialog appears. 2. All the attribute fields that are editable are enabled. You can do any of the following: Name: Name of the attribute in the SyncObject. Each attribute is automatically named when you import a Data Object, you can rename the attributes for a SyncObject using this field. Is Key: You can set the value in this field to true or false. Set this field to true to enable an attribute of an Object to be the key for that particular object. Once you set an attribute as a key its values have to be unique by Kony, Inc. All rights reserved 85 of 256

86 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Type: Specifies the datatype of an attribute. Choose an appropriate datatype for an attribute from the list of available. Is Nullable: You can set the value in this field to true or false. Set this field to true to specify whether a certain field can be left blank without any value specified in it. Max Length: Specifies the maximum number of characters an attribute can have. Autogenerated: Specifies whether a field is auto generated when you build a project. Use the Filter field to filter the attributes of an Object and edit the fields accordingly. You can also add an attribute using the add ( ) button and fill the corresponding fields accordingly. To remove an attribute, select the attribute row or name and click the delete( ) button. You can change the order of the attributes by selecting the attribute and using the up or down arrows. To insert a new attribute before another attribute click. To insert an attribute after another attribute click. 3. Click Finish Editing Relationships When two entities (tables) are linked to each other, they have a column from each of the entity participating in a relationship. With typical foreign-key based relationships, one foreign key column can refer to only one parent entity. But with logical relationships, one foreign key can refer to multiple parent entities. Note that, this is not possible with RDBMS foreign key constraints. Logical relationship is supported for both client side and server side in the Sync Framework. And this is applicable to both OTA and Persistent Strategies, and all the existing data sources. For example, Attachment and Note entities can refer to multiple entities such as Account, Contact, Opportunity, etc., with ParentId foreign key. To edit relationships that are already part of a SyncObject or to add a new relationship between SyncObjects, do the following: 2015 by Kony, Inc. All rights reserved 86 of 256

87 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 1. Right click the SyncObject for which you want to edit the relationships for and select Edit. The Edit SyncObject dialog appears. 2. Select Relationships from the left pane. 3. You can edit the existing relationships between SyncObjects. Target Object: Target SyncObject to which the current SyncObject creates a relationship with. Click the list and click OK. button, to change the Target Object. Select a Target Object from the Relationship: Specify the type of relationship between the Source attribute (record) in the SyncObject to the Target attribute(child record) of another SyncObject. It can be One to Many or Many to One. Target Attribute: Specifies the attribute of the other SyncObject with which you want to relate your Source Attribute to. Source Attribute: Specify the attribute of the SyncObject you want to link the Target Attribute to. Cascade: Set this value to true or false. Setting this to true implies that when you delete a record in the parent table, it will subsequently delete all the records in the child table as well. 4. You can also add a relationship using the add ( ) button and fill out the corresponding fields accordingly. To remove a relation, select the attribute row or name and click the delete( ) button. You can change the order of the relationships by selecting the relationship and using the up or down arrows. To insert a new relationship before another relationship click. To insert a relationship after another relationship click Operation Mapping You can map the operations Create/Update etc. with the corresponding web service which are added under the Datasources by Kony, Inc. All rights reserved 87 of 256

88 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Create/Update/Delete: These operations are used when an entity is created/updated/deleted by the application. Get: Used in conflict resolution. Get Updated/Get Deleted: Used to get the incremental changes from the enterprise to the application. GetAll: Used in unprovisioned DataSources to get all the data from the enterprise to the application. To map operations, follow these steps: 1. Right click the SyncObject for which you want to edit or create the operations for and choose Edit. The Edit SyncObject dialog appears. 2. Select Operations from the left pane by Kony, Inc. All rights reserved 88 of 256

89 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps 3. Map the Input parameters. 4. Select the Service Input parameter from the dialog and corresponding source type and source value from the drop-downs. The following are the source types for input parameters: Attribute: To map the service input parameter from the sync attribute. Collection: To map the child sync object rows as a collection to the service. MobileFabric Sync server internally creates the child rows as JSON string for each child sync object and passes to the corresponding service collection input parameter. Follow these guidelines while defining the service request template: o You have to use the sync attribute names from the child sync object in the request template inside the forloop. o For nested child sync objects, you need to use sync object s global name as the identifier for the nested for loop. For example, following is the service request template for three level sync object upload: o S1 sync object has P1 and P2 sync attributes and S2 as child sync object. o S2 sync object has A1 and A2 sync attributes and S3 as child sync object. o S3 sync object has B1and B2 sync attributes. Constant: To map the service input parameters to the constant value by Kony, Inc. All rights reserved 89 of 256

90 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps Context: To map the service input parameters from the context variables. o USER_ID: This variable will be set into the context by the sync engine. This variable contains the user id of the user who initiated the sync. o LAST_SYNC_TIMESTAMP: This variable will be set into the context by the sync engine. Last updated time stamp will be sent from the device for each sync. Server will send the updated last sync time in the response. This has to be mapped in 'getupdated' operation to get incremental updates. o CURRENT_TIMESTAMP: The current time of the server. If 'getservertime' is defined in the sync configuration, then this value will contain the datasource current time as returned by the 'getservertime' service, otherwise value will contain the sync server local current time. o MORE_CHANGES_AVAILABLE: This context parameter has to be mapped in the 'getupdated' operation output mapping for batch processing. If the value is evaluated to true, then 'getbatch' operation will be invoked for the next batch. If this context variable is not mapped, then more changes available will be considered as false. o PENDING_BATCHES:This context parameter can be mapped to indicate the pending number of batches. This is an optional parameter, if it is not mapped, then pending batches will be '0'. o BATCH_SIZE: This is set by the sync engine into the context for the input mapping. Operations like 'getupdated' and 'getbatch' can map this in the input mapping. Batch size value will be sent from device request. o BATCH_OFFSET: Sync engine sets this context parameter into the context for the input mapping. This value contains an integer value indicating the number of rows downloaded so far in the current sync object. This parameter can be mapped when backend services are using pagination based batching (for example, batching with LIMIT and OFFSET). In case of pagination batching you can map the BATCH_ SIZE to LIMIT and BATCH_OFFSET to OFFSET by Kony, Inc. All rights reserved 90 of 256

91 12. Working with the Kony SyncConfiguration View Kony MobileFabric Sync Services Developing Offline Apps o SESSION_ID: This context variable can be set in the custom authentication manager class for session based batches. If SESSION_ID is set in the context, the user will be authenticated in the batch processing only for the first time, subsequent calls just verify whether the SESSION_ID is valid. Once batch processing is over, SESSION_ID is cleared. Filter: Use this source type for mapping the service input parameter with the filter value passed from the device side. You can map one sync object s filter in another sync object s operation mapping as long as they are belong to same Sync Scope. Please note that, filter condition(ex: EQ, LT etc..) is not relevant in operation mapping. Template: You can use this source type and define the velocity template. At runtime, sync framework evaluate the velocity template and result will be passed as input to the service input parameter. You can use attribute, filter and context variables in the velocity template. For example, $CONTEXT.VAR1, $FILTER.VAR1 and $ATTRIBUTE.VAR1 etc.. 5. Select the Service Output parameter from the dialog and corresponding source type and source value from the drop-downs.the following are the source types for output parameters: Attribute: To map the service output to the sync attribute. Relationship: To map the service output to the relationship sync object's sync attribute (You can define the relationships in syncobject dialog window). 6. You can also add an operation parameter using the add ( ) button and fill out the corresponding fields accordingly. To remove an operation parameter, select the operation row or name and click the delete( ) button. You can change the order of the operations by selecting the operation and using the up or down arrows. To insert a new operation before another operation click. To insert a operation after another operation click by Kony, Inc. All rights reserved 91 of 256

92 13. Using the WebServices in your Application Kony MobileFabric Sync Services Developing Offline Apps 13. Using the WebServices in your Application You can import and use the Web Services in your application. For an application you can do the following: Generating Application Forms. Generating and using offline services by Kony, Inc. All rights reserved 92 of 256

93 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 14. Creating Sync Configuration using RESTful JSON Service The RESTful JSON connector helps you to connect to JSON services. Also, the RESTful JSON connector handles JSON Service calls. Services imported through Enterprise Explorer can be used in the sync configuration as a DataSource. Connecting to a RESTful JSON DataSource includes the following steps: 1. Creating a REST JSON Service. 2. Creating a Sync Configuration. 3. Adding Services to the DataSource. 4. Generating Application Forms. 5. Generating Offline Services. 6. Building the application by Kony, Inc. All rights reserved 93 of 256

94 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 14.1 Prerequisites The prerequisites for connecting to a REST JSON Datasource is: You need access to a RESTful JSON source. The following sections in the document show an example of creating a Sync Configuration for that you need to: Log on to the server and invoke Salesforce RESTful services and you need a valid session ID by using SOAP log on service. Session ID is needed for authentication purposes and this is processed through header information in the service definition file Creating a REST JSON Service You can create a REST JSON service from the Enterprise Explorer in Kony Studio by Kony, Inc. All rights reserved 94 of 256

95 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps To create a REST JSON service in the Enterprise Explorer, follow these steps: 1. Launch Kony Studio. 2. Navigate to the Enterprise Explorer view, expand RESTful Services. 3. Right-click JSON Services and click Add REST JSON Service. The REST/JSON Service dialog appears. 4. Type Id of the service. 5. Type the end-point URL of the service in JSON format. 6. Type a Group name for the service by Kony, Inc. All rights reserved 95 of 256

96 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 7. Click OK. The REST JSON service appears in the JSON Services area. After creation of a JSON Service, you have to create a Sync Configuration Creating a Sync Configuration To create a Sync Configuration, follow these steps: 1. Navigate to SyncConfiguration view. Note: Ensure you have selected an application before creating a Sync Configuration. 2. To create a new Sync Configuration, click Create. The Create SyncConfiguration dialog appears by Kony, Inc. All rights reserved 96 of 256

97 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 3. The fields SyncConfiguration Name, Application ID, and Application Name are prepopulated based on the name of your application. You can change the name of the Sync Configuration and Application ID as per your requirement. 4. Enter a namespace for the Sync Configuration. The namespace you enter here will be used for the naming convention of the generated offline services. 5. Click Finish. The Sync Configuration is created in the SyncConfiguration view by Kony, Inc. All rights reserved 97 of 256

98 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps Adding a DataSource After you add a Sync configuration, you need to add a Datasource. When you add a Datasource, you specify the source from which the services will be imported. To add a DataSource, follow these steps: 1. Right-click the DataSources icon, and click Add DataSource. The Add DataSource dialog appears. The following dialog appears. 2. Enter a Name for the DataSource configuration by Kony, Inc. All rights reserved 98 of 256

99 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 3. Select the Type of DataSource from which the services are imported. For importing REST JSON, set the Type as REST JSON. 4. Click Finish. The DataSource is created in SyncConfiguration view. After adding the DataSource, you have to import services. 5. Right-click the DataSource and click Edit. The Import JSON Services dialog appears. This JSON service is added to the RESTful Services in Enterprise Explorer view. 6. Select the Services from Import JSON Services dialog and click Finish. After the services are added, they appear under the DataSource by Kony, Inc. All rights reserved 99 of 256

100 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps After you have added a DataSource, you must define services to the DataSource Configuring Services in Service Definition Editor After importing the service to a DataSource, you need to add Http Headers, Input Parameters, Output Parameters to the service. You can also add a request to the service in JSON format and then get response. To add the required parameters to a service, follow these steps: 2015 by Kony, Inc. All rights reserved 100 of 256

101 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 1. Double-click a service in the Sync Configuration view. The Service Editor screen appears. 2. Enter information in Define Service section. 3. In the Request/Response area, enter the Request. An example request in JSON format is illustrated in the following picture. 4. Add Http Headers. The following picture shows Http Headers defined for the Accounts_Create service. Here a session ID (one of the prerequisite) is passed through the Http Header. For the Authorization ID, Session ID is given as test value by Kony, Inc. All rights reserved 101 of 256

102 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 5. Add Input Parameters. The following picture shows Input Parameters defined for the service. These input parameters are used during Mapping Operations. 6. Add Output Parameters. The following picture shows Output Parameters defined for the service. a. In the Output Parameters screen, you need to set the JSON path as shown in the above picture. 7. Click Get Response and test the result. The response appears in the Response tab of Request/Response section. 8. After the response is fetched, you can view results based on input and output parameters by clicking on Test link in Output Parameters tab. In Output Parameters tab, click Test to view the results by Kony, Inc. All rights reserved 102 of 256

103 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps The results appear in the Results tab. Based on the Input Parameters and Output Parameters the results are fetched from the response. After you define services for the DataSource, you must add a Sync Scope Adding a Sync Scope To add a Sync Scope, follow these steps: 1. Right-click SyncScopes and select Add SyncScope. The Add SyncScope dialog appears by Kony, Inc. All rights reserved 103 of 256

104 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 2. Enter a name for the SyncScope. 3. Enter a namespace for the SyncScope. The namespace can be of any format, for example com.kony. 4. Select the appropriate Data Source from the list. 5. Select the type of Sync Strategy. For more information about the types of Sync Strategies, refer Kony Sync Framework Getting Started Guide in Kony Sync Documentation Library by Kony, Inc. All rights reserved 104 of 256

105 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 6. Set the Change Tracking Policy(CTP) if you want to track changes. If CTP is provided by Datasource, then select Change Tracking Columns. 7. Select the Last Updated Timestamp check box if you have column which represents the incremental changes. 8. Select the Soft Delete Flag check box if the database contains the column which represents soft deletes. 9. In case of conflicts between the data at the client and server end, select one of the following options: Client Wins: The changes on the client side take precedence over the changes on the server side. Server Wins: The changes on the server side take precedence over the changes on the client side. Custom: Enables you to upload an Interceptor class which comprises the logic or policy for conflict resolution. 10. Conflict Interceptor Class: Enables you to browse and upload an interceptor class which comprises the logic or policy for conflict resolution. For more information about interceptors and the types of interceptors, refer the Kony Sync Framework Getting Started Guide in Kony Sync Documentation Library. 11. Click Finish. The created Sync Scope appears under the SyncScopes folder. Note: Setting the values for Last Updated Timestamp and Soft Delete Flag 2015 by Kony, Inc. All rights reserved 105 of 256

106 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps If you select Last Updated Timestamp and Soft Delete Flag in Add Sync Scope dialog, then you have to set the following values: Last Update Timestamp value by editing the Sync Object. Otherwise, you may get errors while generating the application forms. SoftDeleteFlag value by editing the Sync Object. Otherwise, you may get errors while syncing Adding a Sync Object In the SyncConfiguration view, after you have added a DataSource and then a Sync Scope, add a Sync Object. To add a Sync Object, follow these steps: 1. Right-click the created SyncScope and select Add Sync Object. 2. Type a name for the SyncObject by Kony, Inc. All rights reserved 106 of 256

107 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 3. Click Finish. In the above example, two Sync Objects are added for creating relationships. Important: It is mandatory to define a Sync Attribute for any new Sync Object created. If you do not create a Sync Attribute, an error appears when you generate the application forms or offline services Adding a Sync Attribute A Sync Object created must have attributes. For example, a Sync Object comprising the summary of a data can have attributes such as month, year, and owner of the object Alternatively, you can double-click on the Sync Object and then add attributes in the Edit Sync Object dialog by Kony, Inc. All rights reserved 107 of 256

108 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 1. Right-click the SyncObject and select Add Sync Attribute. The Add Sync Attribute dialog appears. 2. Enter a name for the SyncAttribute. 3. Select the datatype for the attribute. 4. Select Is Nullable check box if the value can be set to null. 5. Enter the maximum length of the data in Max Length check box by Kony, Inc. All rights reserved 108 of 256

109 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 6. Select the Autogenerated check box if the field is an auto-generated field. For example, customer id fields like 1,2,3 which have counters and are auto-generated. 7. Select the Is Key check box f the attribute would be key of the SyncObject table. 8. Click Finish. The added SyncAttribute appears under the SyncObject. To establish a relationship, add another Sync Object Contactsand add the attributes accordingly. Note: You can verify if the attributes are added correctly by double-clicking the Sync Object by Kony, Inc. All rights reserved 109 of 256

110 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps Adding Relationships When two entities (tables) are linked to each other, they have a column from each of the entity participating in a relationship. With typical foreign-key based relationships, one foreign key column can refer to only one parent entity. But with logical relationships, one foreign key can refer to multiple parent entities. Note that, this is not possible with RDBMS foreign key constraints. Logical relationship is supported for both client side and server side in the Sync Framework. And this is applicable to both OTA and Persistent Strategies, and all the existing data sources. For example, Attachment and Note entities can refer to multiple entities such as Account, Contact, Opportunity, etc., with ParentId foreign key. To add a new relationship between Sync Objects, follow these steps: 1. Right-click the Sync Object for which you want to edit the relationships and select Edit. The Edit SyncObject dialog appears. 2. Select Relationships from the left pane. 3. You can edit the existing relationships between SyncObjects: Target Object: Target SyncObject to which the current SyncObject creates a relationship with. Click the list and click OK. button, to change the Target Object, select a Target Object from the 2015 by Kony, Inc. All rights reserved 110 of 256

111 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps Relationship: Specify the type of relationship between the Source attribute (record) in the SyncObject to the Target attribute (child record) of another SyncObject. It can be One to Many or Many to One. Target Attribute: Specifies the attribute of the other SyncObject with which you want to relate your Source Attribute to. Source Attribute: Specify the attribute of the SyncObject you want to link the Target Attribute to. Cascade: Set this value to true or false. Setting this to true implies that when you delete a record in the parent table, it will subsequently delete all the records in the child table as well. 4. You can also add a relationship using the Add button and fill out the corresponding fields accordingly. To remove a relation, select the attribute row or name and click the Delete button. To insert a new relationship before another relationship click. To insert a relationship after another relationship click by Kony, Inc. All rights reserved 111 of 256

112 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps Defining Filters Note: If filters are added in the RESTful JSON, the same filters must be provided in the Input Parameters of the Service Definition Editor to be consumed. To add additional filters for a SyncObject, do the following: 1. Right-click the Sync Object and select Edit. The Edit SyncObject dialog appears. 2. Select Filters from the left pane. There are two types of filters, Client Side Filters and Server Side Filters. 3. Apply a server side filter if you want to filter the data fetched from the Enterprise DataSource to a replicated database. 4. Apply a client side filter if you want to filter data while downloading the data to the client database by Kony, Inc. All rights reserved 112 of 256

113 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 5. To set a filter do the following: Filter Attribute: Set the SyncAttribute. Using the example stated above the SyncAttribute would be Id. Condition: Set a condition using which the data will be filtered. Specify the Values using which you want to filter the data in Value1 and Value 2 Columns. Important: For mathematical conditional operators you can just specify one value in the Value1column. 6. Click Finish. 7. You can also add a filters using the add ( ) button and fill out the corresponding fields accordingly. To remove a filter, select the attribute row or name and click the delete( ) button. You can change the order of the filters by selecting the filter and using the up or down arrows. To insert a new filter before another filter click. To insert a filter after another filter click by Kony, Inc. All rights reserved 113 of 256

114 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps Note: All filters will be applied with AND composite. We can use EXPRESSION filter for OR composites Mapping Operations You can map the operations like Create/Update etc. with the corresponding REST JSON service that are added under the DataSources. Create/Update/Delete: These operations are used when an entity is created or updated or deleted by the application. Get: Used in conflict resolution. Get Updated or Get Deleted: Used to get the incremental changes from the enterprise to the application. GetAll: Used in un-provisioned DataSources to get all the data from the enterprise to the application. To map operations, follow these steps: 1. Right-click the SyncObject for which you want to edit or create the operations for and click Edit. The Edit SyncObject dialog appears by Kony, Inc. All rights reserved 114 of 256

115 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps 2. Select an Operation from the left pane. For example, Create operation is selected in this case. 3. Select a service from the Service list. The Accounts_create is selected in the picture. 4. Expand Header Mapping pane. a. Click inside Service Header Params cell and click. The Select Header Param dialog appears. Select Header Parameters from the dialog and click OK by Kony, Inc. All rights reserved 115 of 256

116 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps b. Select Source Typefrom the list. c. Select or Enter a Source Value in the Source Value cell. 5. Expand Input Mapping pane. a. Click inside Service Input Params cell and click. The Select Input Param dialog appears. b. Select Input Parameters from the dialog and click OK. These input parameters are defined in the Service Definition Editor of the Accounts_create service. c. Select Source Typefrom the list. d. Select the Source Value from list. The Source Value is the attributes defined for the service in Attributes section. For example, the following image shows Service Input Parameters, Source Type, and 2015 by Kony, Inc. All rights reserved 116 of 256

117 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps Source Value defined. 6. Expand Output Mapping pane. a. Click inside Service Output Params cell and click. The Select Output Param dialog appears by Kony, Inc. All rights reserved 117 of 256

118 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps b. Select Output Parameters from the dialog and click OK. c. Select Source Typefrom the list. d. Select the Target Value from list. For example, the following image shows Service Output Parameters, Source Type, and Source Value defined.. 7. After you have entered all the information in the mapping panes, click Finish. The operations are mapped and you can generate application forms by Kony, Inc. All rights reserved 118 of 256

119 14. Creating Sync Configuration using RESTful JSON Service Kony MobileFabric Sync Services Developing Offline Apps Note: Additional Actions in the Sync Object Parameters dialog You can also add an operation parameters using the add ( ) button. To remove an operation parameter, select the operation row or name and click delete( ) button. You can change the order of the operations by selecting the operation and using the up or down arrows. To insert a new operation before another operation click Insert After. To insert a operation after another operation click Insert Before Using RESTful JSON Services in your Application You can import and use the RESTful JSON services in your application by generating application forms and offline services. Click on the following links to view more information. Generating Application Forms. Generating and using offline services by Kony, Inc. All rights reserved 119 of 256

120 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 15. Creating Sync Configuration using RESTful XML DataSource The RESTful XML connector helps you to connect to XML services. Services imported through Enterprise Explorer can be used to in the sync configuration as a DataSource. Connecting to a RESTful XML DataSource includes the following steps: 1. Creating a REST XML Service. 2. Creating a Sync Configuration. 3. Adding Services to the DataSource. 4. Generating Application Forms. 5. Generating Offline Services. 6. Building the application by Kony, Inc. All rights reserved 120 of 256

121 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 15.1 Prerequisites The prerequisites for connecting to a REST XML DataSource is: You need access to a RESTful XML source. The following sections in the document show an example of creating a Sync Configuration for that you need to: To log on to the server and invoke Salesforce RESTful services, you need a valid session ID by using SOAP log on service. Session ID is needed for authentication purposes and this is processed through header information in the service definition file Creating a REST XML Service You can create a REST XML service from the Enterprise Explorer in Kony Studio. To create a REST XML Service in the Enterprise Explorer, follow these steps: 1. Launch Kony Studio. 2. Navigate to the Enterprise Explorer view, expand RESTful Services. The following dialog appears by Kony, Inc. All rights reserved 121 of 256

122 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 3. Type Id of the service. 4. Type the end-point URL of the service. 5. Type a Group name for the service. 6. Click OK. The REST XML service appears in the XML Services area. After you have created a service, you must create a Sync Configuration Creating a Sync Configuration To create a Sync Configuration, follow these steps: 2015 by Kony, Inc. All rights reserved 122 of 256

123 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 1. Navigate to SyncConfiguration view. 2. To create a new Sync Configuration, click Create. The Create SyncConfiguration dialog appears. 3. The fields SyncConfiguration Name, Application ID, and Application Name are prepopulated based on the name of your application. You can change the name of the Sync Configuration and Application ID. 4. Set a namespace for the Sync Configuration. The namespace you enter here will be used for the naming convention of the generated offline services. 5. Click Finish. The newly created Sync Configuration appears in the SyncConfiguration view Adding a DataSource After you add a Sync configuration, you need to add a DataSource. When you add a DataSource, you specify the source from which the services will be imported by Kony, Inc. All rights reserved 123 of 256

124 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps To add a DataSource, follow these steps: 1. Right-click the DataSources icon, and click Add DataSource. The Add DataSource dialog appears. 2. Specify a Name for the DataSource configuration. 3. Select the Type of DataSource from which the services are imported from. For importing REST XML, set the Type as REST XML. 4. Click Finish. The DataSource is created in SyncConfiguration view. After adding the DataSource, you have to import services. 5. Right-click the DataSource and click Edit. The Import XML Service DataSource dialog appears by Kony, Inc. All rights reserved 124 of 256

125 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 6. Select required services from the dialog. 7. Click Finish. After the services are added, they appear under the DataSource Configuring Services to the DataSource 1. Double-click a service in the Sync Configuration view. The Service Editor screen appears. a. Add a Request at the Request/Response area. An example request in XML format is illustrated in the following picture by Kony, Inc. All rights reserved 125 of 256

126 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps b. Add Http Headers. The following picture shows Http Headers defined for the Accounts_ Create service. Here a session ID (one of the prerequisite) is passed through the Http Header. c. Add Input Parameters. The following picture shows Input Parameters defined for the service. These input parameters are used during Mapping Operations by Kony, Inc. All rights reserved 126 of 256

127 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps d. Add Output Parameters. The following picture shows Output Parameters defined for the service. 2. Click Get Response and test the result. The response appears in the Response tab of Request/Response section. 3. After the response is fetched, you can view results based on input and output parameters by clicking on Test link in Output Parameters tab. In Output Parameters tab, click Test to view the results. The results appear in the Results tab. Based on the Input Parameters and Output Parameters the results are fetched from the response. 4. After you define services for the DataSource, you must add a Sync Scope by Kony, Inc. All rights reserved 127 of 256

128 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps Adding a Sync Scope To add a Sync Scope, follow these steps: 1. Right-click SyncScopes and select Add SyncScope. The Add SyncScope dialog appears by Kony, Inc. All rights reserved 128 of 256

129 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 2. Enter a name for the SyncScope. 3. Enter a namespace for the SyncScope. The namespace can be of any format, for example com.kony. 4. Select the appropriate Data Source from the list. 5. Select the type of Sync Strategy. For more information about the types of Sync Strategies, refer Kony Sync Framework Getting Started Guide in Kony Sync Library by Kony, Inc. All rights reserved 129 of 256

130 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 6. Set the Change Tracking Policy(CTP) if you want to track changes. If CTP is provided by Datasource, then select Change Tracking Columns. 7. Select the Last Updated Timestamp check box if you have column which represents the incremental changes. 8. Select the Soft Delete Flag check box if the database contains the column which represents soft deletes. 9. In case of conflicts between the data at the client and server end, specify any of the following: Client Wins: The changes on the client side take precedent over the changes on the server side. Server Wins: The changes on the server side take precedent over the changes on the client side. Custom: Enables you to upload an Interceptor class which comprises the logic or policy for conflict resolution. 10. Conflict Interceptor Class: Enables you to browse and upload an interceptor class which comprises the logic or policy for conflict resolution. For more information about interceptors and the types of interceptors, refer the kony_mobilefabric_sync_getting_started_guide. 11. Click Finish. The created Sync Scope appears below the SyncScopes folder. Note: Setting the values for Last Updated Timestamp and Soft Delete Flag 2015 by Kony, Inc. All rights reserved 130 of 256

131 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps If you select Last Updated Timestamp and Soft Delete Flag in Add Sync Scope dialog, then you have to set the values of: Last Update Timestamp value by editing the Sync Object. Otherwise, you may get errors while generating the application forms. SoftDeleteFlag value by editing the Sync Object. Otherwise, you may get errors while syncing Adding a Sync Object In the SyncConfiguration view, after you have added a DataSource and then a Sync Scope, add a Sync Object. To add a Sync Object, follow these steps: 1. Right-click the created SyncScope and select Add Sync Object by Kony, Inc. All rights reserved 131 of 256

132 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 2. Type the name for the SyncObject. 3. Click Finish. Important: It is mandatory to define a Sync Attribute for any new Sync Object created. If you do not create a Sync Attribute, an error appears when you generate the application forms or offline services Adding a Sync Attribute A Sync Object created must have attributes. For example, a Sync Object comprising the summary of a data can have attributes such as month, year, owner of the object 2015 by Kony, Inc. All rights reserved 132 of 256

133 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 1. Right-click the SyncObject and select Add Sync Attribute. The Add Sync Attribute dialog appears. Alternatively, you can double-click on the Sync Object and then add attributes in the Edit Sync Object dialog. 2. Enter a name for the SyncAttribute. 3. Select the datatype for the attribute. 4. Select Is Nullable check box if the value can be set to null. 5. Enter the maximum length of the data in Max Length check box by Kony, Inc. All rights reserved 133 of 256

134 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 6. Select the Autogenerated check box if the field is an auto-generated field. For example, customer id fields like 1,2,3 which have counters and are auto-generated. 7. Select the Is Key check box f the attribute would be key of the SyncObject table. 8. Click Finish. The added SyncAttribute appears under the SyncObject. In the above example, a new Sync Object Contacts is added and Sync Attributes are added. Note: You can verify if the attributes are added correctly by double-clicking the Sync Object Adding Relationships When two entities (tables) are linked to each other, they have a column from each of the entity participating in a relationship. With typical foreign-key based relationships, one foreign key column can refer to only one parent entity. But with logical relationships, one foreign key can refer to multiple parent entities. Note that, this is not possible with RDBMS foreign key constraints. Logical relationship is supported for both client side and server side in the Sync Framework. And this is applicable to both OTA and Persistent Strategies, and all the existing data sources by Kony, Inc. All rights reserved 134 of 256

135 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps For example, Attachment and Note entities can refer to multiple entities such as Account, Contact, Opportunity, etc., with ParentId foreign key. To add a new relationship between Sync Objects, follow these steps: 1. Right-click the Sync Object for which you want to edit the relationships and select Edit. The Edit SyncObject dialog appears. 2. Select Relationships from the left pane. 3. You can edit the existing relationships between SyncObjects: Target Object: Target SyncObject to which the current SyncObject creates a relationship with. Click the list and click OK. button, to change the Target Object. Select a Target Object from the Relationship: Specify the type of relationship between the Source attribute (record) in the SyncObject to the Target attribute (child record) of another SyncObject. It can be One to Many or Many to One by Kony, Inc. All rights reserved 135 of 256

136 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps Target Attribute: Specifies the attribute of the other SyncObject with which you want to relate your Source Attribute to. Source Attribute: Specify the attribute of the SyncObject you want to link the Target Attribute to. Cascade: Set this value to true or false. Setting this to true implies that when you delete a record in the parent table, it will subsequently delete all the records in the child table as well. Note: For Create operation, it is not required to define relationships and filters. 4. You can also add a relationship using the add ( ) button and fill out the corresponding fields accordingly. To remove a relation, select the attribute row or name and click the delete( ) 2015 by Kony, Inc. All rights reserved 136 of 256

137 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps button. To insert a new relationship before another relationship click. To insert a relationship after another relationship click Defining Filters Note: If filters are added in the RESTful XML, the same filters must be provided in the Input Parameters of the Service Definition Editor to be consumed. To add additional filters that for a SyncObject or to edit any existing filters for a SyncObject, do the following: 1. Right-click the SyncObject for which you want to edit the filters for and select Edit. The Edit SyncObject dialog appears. 2. Select Filters from the left pane. There are two types of filters, Client Side Filters and a Server Side Filters. For Create operation, it is not required to define a filter. 3. Apply a server side filter if you want to filter the data fetched from the Enterprise DataSource to a replicated database by Kony, Inc. All rights reserved 137 of 256

138 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 4. Apply a client side filter if you want to filter data while downloading the data to the client database. 5. To set a filter do the following: Filter Attribute: Set the SyncAttribute. Using the example stated above the SyncAttribute would be Id. Condition: Set a condition using which the data will be filtered. Specify the Values using which you want to filter the data in Value1 and Value 2 Columns. Important: For mathematical conditional operators you can just specify one value in the Value1column. Note: For Create operation, it is not required to define relationships and filters. 6. Click Finish. 7. You can also add a filters using the add ( ) button and fill out the corresponding fields accordingly. To remove a filter, select the attribute row or name and click the delete( ) button. You can change the order of the filters by selecting the filter and using the up or down arrows. To insert a new filter before another filter click. To insert a filter after another filter click. Note: All filters will be applied with AND composite. We can use EXPRESSION filter for OR composites Operation Mapping You can map the operations like Create or Update etc. with the corresponding REST XML service that are added under the DataSources by Kony, Inc. All rights reserved 138 of 256

139 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps Create/Update/Delete: These operations are used when an entity is created/updated/deleted by the application. Get: Used in conflict resolution. Get Updated/Get Deleted: Used to get the incremental changes from the enterprise to the application. GetAll: Used in un-provisioned DataSources to get all the data from the enterprise to the application. To map operations, follow these steps: 1. Right-click the SyncObject for which you want to edit or create the operations for and click Edit. The Edit SyncObject dialog appears. 2. Select an Operation from the left pane. For example, Create, Update, Delete, Get, GetUpdated etc. 3. Select a service from the Service list. The Accounts_create is selected in the picture by Kony, Inc. All rights reserved 139 of 256

140 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps 4. Expand Header Mapping pane. a. Click inside Service Header Params cell and click. The Select Header Param dialog appears. Select Header Parameters from the dialog and click OK. b. Select Source Typefrom the list. c. Select or Enter a Source Value in the Source Value cell. 5. Expand Input Mapping pane. a. Click inside Service Input Params cell and click. The Select Input Param dialog appears by Kony, Inc. All rights reserved 140 of 256

141 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps b. Select Input Parameters from the dialog and click OK. These input parameters are defined in the Service Definition Editor of the Accounts_create service. c. Select Source Typefrom the list. d. Select the Source Value from list. The Source Value is the attributes defined for the service in Attributes section. For example, the following image shows Service Input Parameters, Source Type, and 2015 by Kony, Inc. All rights reserved 141 of 256

142 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps Source Value defined. 6. Expand Output Mapping pane. a. Click inside Service Output Params cell and click. The Select Output Param dialog appears by Kony, Inc. All rights reserved 142 of 256

143 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps b. Select Output Parameters from the dialog and click OK. c. Select Source Typefrom the list. d. Select the Target Value from list by Kony, Inc. All rights reserved 143 of 256

144 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps For example, the following image shows Service Output Parameters, Source Type, and Source Value defined.. 7. After you have entered all the information in the mapping panes, click Finish. The operations are mapped and you can generate application forms. Note: Additional Actions in the Sync Object Parameters dialog You can also add an operation parameters using the add ( ) button. To remove an operation parameter, select the operation row or name and click delete( ) button. You can change the order of the operations by selecting the operation and using the up or down arrows by Kony, Inc. All rights reserved 144 of 256

145 15. Creating Sync Configuration using RESTful XML DataSource Kony MobileFabric Sync Services Developing Offline Apps To insert a new operation before another operation click Insert After. To insert a operation after another operation click Insert Before Using RESTful XML Services in your Application You can import and use the RESTful XML services in your application by generating application forms and offline services. Click on the following links to view more information. Generating Application Forms. Generating and using offline services by Kony, Inc. All rights reserved 145 of 256

146 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 16. Creating a Sync Configuration using SAP NetWeaver DataSource Using the SAP NetWeaver DataSource you can connect to SAP services. SAP NetWeaver exposes services to connect to SAP Database. SAP Authenticates the user as per the encryption Prerequisites Access to a SAP NetWeaver Application Server 7.4 version (with Application Component SAP_GWFND 740) of SAP instance. A valid sample like Flight Data model already exists Creating a REST XML Service in Enterprise Explorer You can create a REST XML service from the Enterprise Explorer in Kony Studio. To create a REST XML service in the Enterprise Explorer, follow these steps: 1. Launch Kony Studio. 2. Navigate to the Enterprise Explorer view, expand RESTful Services. 3. Right-click the XML Services folder in Enterprise Explorer. The REST/XML Service dialog appears by Kony, Inc. All rights reserved 146 of 256

147 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 4. Type Id of the service. 5. Type the end-point URL of the service in XML format. 6. Type a Group name for the service. The following code is entered in the URL box. llection?$filter=carrid%20eq%20%27qf%27&$top=50 7. Create another XML service The following code is entered in the URL box. ngcollection 8. Click OK. The services are created under the XML Services folder. After creation of a XML Service, you have to create a Sync Configuration file by Kony, Inc. All rights reserved 147 of 256

148 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 16.3 Creating a Sync Configuration To create a Sync Configuration, follow these steps: 1. Navigate to SyncConfiguration view. 2. To create a new Sync Configuration, click Create. The Create SyncConfiguration dialog appears. Note: Ensure you have selected an application before creating a Sync Configuration. 3. The fields SyncConfiguration Name, Application ID, and Application Name are prepopulated based on the name of your application. You can change the name of the Sync Configuration and Application ID as per your requirement. 4. Enter a namespace for the Sync Configuration. The namespace you enter here will be used for the naming convention of the generated offline services by Kony, Inc. All rights reserved 148 of 256

149 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 5. Click Finish. The Sync Configuration is created in the SyncConfiguration view Adding a DataSource After you add a Sync configuration, you need to add a Datasource. When you add a Datasource, you specify the source from which the services will be imported. To add a DataSource, follow these steps: 1. Right-click the DataSources icon, and click Add DataSource. The Add DataSource dialog appears. 2. Enter a Name for the DataSource configuration. 3. Select the Type of DataSource from which the services are imported. For importing REST XML, set the Type as REST XML by Kony, Inc. All rights reserved 149 of 256

150 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 4. Click Finish. The DataSource is created in SyncConfiguration view. After adding the DataSource, you have to import services. 5. Right-click the DataSource and click Edit. The Import XML Services dialog appears. This XML service is added to the RESTful Services in Enterprise Explorer view. 6. Select the Services from Import XML Services dialog and click Finish. After the services are added, they appear under the DataSource Configuring Services in Service Definition Editor After importing the service to a DataSource, you need to add Http Headers, Input Parameters, Output Parameters to the service. You can also add a request to the service in XML format and then get the response by Kony, Inc. All rights reserved 150 of 256

151 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 1. Double-click SAPNW_BookingCollection service, the service definition editor screen appears. 2. Select a Http Method from the list. In the above figure, POST is selected. 3. Enter the Server Authentication details: a. Enter the User ID. b. Enter the Password by Kony, Inc. All rights reserved 151 of 256

152 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 4. Enter the request in the Request/Response area. The following example shows the request in XML format. 5. Add Http Headers. The following example shows Http Headers configured. To get the x-csrf-token and Cookie value, do the following steps: 6. Open the SAPNW_GET service by Kony, Inc. All rights reserved 152 of 256

153 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 7. Enter the User ID. 8. Enter the Password. 9. Add Http Headers. 10. Click Get Response. The response appears in the Kony Studio Console. The Console area displays Cookies returned and x-csrf-token values by Kony, Inc. All rights reserved 153 of 256

154 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 11. Copy the Cookies returned value from the Console and paste in your text editor application. and make the following changes to the cookies returned value: a. Call the value making sap-xsrf_dev_100 as a variable. b. Add two more parameters, path=/; HttpOnly;. The following code shows sap-xsrf_dev_100 is calling the code and two more parameters are added. sap-xsrf_dev_100=7pwnjlf3ifoaq6wckqe_ 3A%3d%3d X7Lw8dGFbBLM1SR8TymqwVYpczP6iLkg0KrLWLX ZETg%3d; path=/; HttpOnly; 12. Open the SAPNW_BookingCollection service. 13. Add the x-csrf-token and Cookie value in Http Headers by Kony, Inc. All rights reserved 154 of 256

155 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 14. Add Input Parameters. The following example shows Input Headers configured. 15. Add Output Parameters. The following example shows Output Parameters configured. 16. Click Get Response by Kony, Inc. All rights reserved 155 of 256

156 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 17. Click Output Parameters tab, and click Test. The results are displayed in the Results tab Add a Sync Scope To add a Sync Scope, follow these steps: 2015 by Kony, Inc. All rights reserved 156 of 256

157 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 1. Right-click Sync Scope and click Add Sync Object. 2. Double-click the Sync Object. The Edit Sync Object dialog appears. 3. Enter a name for the SyncScope. 4. Enter a namespace for the SyncScope. The namespace can be of any format, for example com.kony. 5. Select the appropriate Data Source from the list. 6. Select the type of Sync Strategy. For more information about the types of Sync Strategies, refer Kony Sync Framework Getting Started Guide in Kony Sync Documentation Library. 7. Set the Change Tracking Policy(CTP) if you want to track changes. If CTP is provided by Datasource, then select Change Tracking Columns by Kony, Inc. All rights reserved 157 of 256

158 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps 8. Select the Last Updated Timestamp check box if you have column which represents the incremental changes. 9. Select the Soft Delete Flag check box if the database contains the column which represents soft deletes. 10. In case of conflicts between the data at the client and server end, select one of the following options: Client Wins: The changes on the client side take precedence over the changes on the server side. Server Wins: The changes on the server side take precedence over the changes on the client side. Custom: Enables you to upload an Interceptor class which comprises the logic or policy for conflict resolution. 11. Conflict Interceptor Class: Enables you to browse and upload an interceptor class which comprises the logic or policy for conflict resolution. For more information about interceptors and the types of interceptors, refer the kony_mobilefabric_sync_getting_started_guide in Kony Sync Documentation Library. 12. Click Finish. The created Sync Scope appears under the SyncScopes folder. Note: Setting the values for Last Updated Timestamp and Soft Delete Flag If you select Last Updated Timestamp and Soft Delete Flag in Add Sync Scope dialog, then you have to set the following values: Last Update Timestamp value by editing the Sync Object. Otherwise, you may get errors while generating the application forms. SoftDeleteFlag value by editing the Sync Object. Otherwise, you may get errors while syncing by Kony, Inc. All rights reserved 158 of 256

159 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps Adding a Sync Object In the SyncConfiguration view, after you have added a DataSource and then a Sync Scope, add a Sync Object. To add a Sync Object, follow these steps: 1. Right-click the created SyncScope and select Add Sync Object. 2. Type the name for the SyncObject. 3. Click Finish. Important: It is mandatory to define a Sync Attribute for any new Sync Object created. If you do not create a Sync Attribute, an error appears when you generate the application forms or offline services Add Attributes to the Sync Object A Sync Object created must have attributes. For example, a Sync Object comprising the summary of a data can have attributes such as month, year, and owner of the object Alternatively, you can double-click on the Sync Object and then add attributes in the Edit Sync Object dialog. 1. Right-click the SyncObject and select Add Sync Attribute. 2. Enter the attributes information. The following figure shows attributes added to the Sync Object by Kony, Inc. All rights reserved 159 of 256

160 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps The attributes added appear under the Sync Object by Kony, Inc. All rights reserved 160 of 256

161 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps Mapping Operations You can map the operations like Create/Update etc. with the corresponding REST XML service that are added under the DataSources. Create/Update/Delete: These operations are used when an entity is created or updated or deleted by the application. Get: Used in conflict resolution. Get Updated or Get Deleted: Used to get the incremental changes from the enterprise to the application. GetAll: Used in un-provisioned DataSources to get all the data from the enterprise to the application. To map operations, follow these steps: 1. Right-click the SyncObject for which you want to edit or create the operations for and click Edit. The Edit SyncObject dialog appears. 2. Select an operation from the Operations area and configure Header mapping. In the following figure, Create operation is selected. 3. Select a service from the Service list. The SAPNW_BookingCollection is selected in the picture. 4. Expand Header Mapping pane. a. Click inside Service Header Params cell and click. The Select Header Param dialog appears. b. Select Header Parameters from the dialog and click OK. c. Select Source Typefrom the list by Kony, Inc. All rights reserved 161 of 256

162 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps d. Select or Enter a Source Value in the Source Value cell. 5. Expand Input Mapping pane. a. Click inside Service Input Params cell and click. The Select Input Param dialog appears. b. Select Input Parameters from the dialog and click OK. These input parameters are defined in the Service Definition Editor of the SAPNW_BookingCollection service. c. Select Source Typefrom the list. d. Select the Source Value from list. The Source Value is the attributes defined for the service in Attributes section. For example, the following image shows Service Input Parameters, Source Type, and 2015 by Kony, Inc. All rights reserved 162 of 256

163 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps Source Value defined. 6. Expand Output Mapping pane. a. Click inside Service Output Params cell and click. The Select Output Param dialog appears. b. Select Output Parameters from the dialog and click OK. c. Select Source Type from the list by Kony, Inc. All rights reserved 163 of 256

164 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps d. Select the Target Value from list. 7. After you have entered all the information in the mapping panes, click Finish. The operations are mapped and you can generate application forms. Note: Additional Actions in the Sync Object Parameters dialog You can also add an operation parameters using the add ( ) button. To remove an operation parameter, select the operation row or name and click delete( ) button. You can change the order of the operations by selecting the operation and using the up or down arrows by Kony, Inc. All rights reserved 164 of 256

165 16. Creating a Sync Configuration using SAP NetWeaver DataSource Kony MobileFabric Sync Services Developing Offline Apps To insert a new operation before another operation click Insert After. To insert a operation after another operation click Insert Before Using SAP NetWeaver Services in your Application You can import and use the RESTful XML services in your application by generating application forms and offline services. Click on the following links to view more information. Generating Application Forms. Generating and using offline services by Kony, Inc. All rights reserved 165 of 256

166 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) The SAP BAPI DataSource (Java Connector) helps you to connect to SAP services Prerequisites 1. Access to SAP R/3 Release 3.1, 4.x and higher versions of SAP instance. 2. The SAP instance must support JCo 3.0 protocol. 3. A valid sample like the Flight Data model already exists Connecting to a SAP Server To connect to a SAP Server, follow these steps: 1. Right-click SAP Server folder in the Enterprise Explorer area. The Server Details dialog appears by Kony, Inc. All rights reserved 166 of 256

167 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 2. In the Connection tab, enter the Server Details. a. Enter the Server Name. b. Select a connection property. You can select Direct or Load Balanced. c. Type the name of the Application Sever. d. Type the name of System Number. e. Type the name of Client ID. f. Select a Language. g. Select the type of login information. You can select a Non-SSO Login or a SSO Login by Kony, Inc. All rights reserved 167 of 256

168 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps h. Enter your User Name. i. Enter your Password. 3. Click Connect. If the information provided is correct, a connecting dialog appears. After the sever is added, it appears below the SAP Servers folder. 4. Right-click the SAP Sever under the SAP Servers, and click Connect. The SAP Server connects to the main server and displays the folder directory. 5. After the server is added, right-click the server and click Connect by Kony, Inc. All rights reserved 168 of 256

169 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 6. Expand to the following folder structure Creating a Sync Configuration file To create a Sync Configuration, follow these steps: 1. Navigate to SyncConfiguration view. 2. To create a new Sync Configuration, click Create. The Create SyncConfiguration dialog appears by Kony, Inc. All rights reserved 169 of 256

170 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 3. The fields SyncConfiguration Name, Application ID, and Application Name are prepopulated based on the name of your application. You can change the name of the Sync Configuration and Application ID. 4. Set a namespace for the Sync Configuration. The namespace you enter here will be used for the naming convention of the generated offline services. 5. Click Finish. The newly created Sync Configuration appears in the SyncConfiguration view Adding a DataSource After you add a Sync configuration, you need to add a DataSource. When you add a DataSource, you specify the source from which the services will be imported. To add a DataSource, follow these steps: 1. Right-click the DataSources icon, and click Add DataSource. The Add DataSource dialog appears by Kony, Inc. All rights reserved 170 of 256

171 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 2. Specify a Name for the DataSource configuration. 3. Select the Type of DataSource from which the services are imported from. For importing SAP services, set the Type as SAP. 4. Click Finish Adding Services to the DataSource To add services to the DataSource, follow these steps: 1. Double-click the DataSource. The SAP Editor screen appears. 2. Right-click the required service in the screen and click Reload the shortcut menu by Kony, Inc. All rights reserved 171 of 256

172 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 3. Again, right-click the required BAPI object and select Add to DataSource by Kony, Inc. All rights reserved 172 of 256

173 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps The service added appears at the DataSource by Kony, Inc. All rights reserved 173 of 256

174 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps Adding a Sync Scope To add a Sync Scope, follow these steps: 1. Right-click the SyncScopes folder in Sync Configuration view. The following dialog appears. 2. Click Add SyncObject. The following dialog appears by Kony, Inc. All rights reserved 174 of 256

175 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 3. Enter a name for the SyncScope. 4. Enter a namespace for the SyncScope. The namespace can be of any format, for example com.kony. 5. Select the appropriate Data Source from the list. 6. Select the type of Sync Strategy. For more information about the types of Sync Strategies, refer Kony Sync Framework Getting Started Guide in Kony Sync Documentation Library. 7. Set the Change Tracking Policy(CTP) if you want to track changes. If CTP is provided by Datasource, then select Change Tracking Columns. 8. Select the Last Updated Timestamp check box if you have column which represents the incremental changes. 9. Select the Soft Delete Flag check box if the database contains the column which represents soft deletes by Kony, Inc. All rights reserved 175 of 256

176 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 10. In case of conflicts between the data at the client and server end, select one of the following options: Client Wins: The changes on the client side take precedence over the changes on the server side. Server Wins: The changes on the server side take precedence over the changes on the client side. Custom: Enables you to upload an Interceptor class which comprises the logic or policy for conflict resolution. 11. Conflict Interceptor Class: Enables you to browse and upload an interceptor class which comprises the logic or policy for conflict resolution. For more information about interceptors and the types of interceptors, refer the kony_mobilefabric_sync_getting_started_guide in Kony Sync Documentation Library. 12. Click Finish. The created Sync Scope appears under the SyncScopes folder. Note: Setting the values for Last Updated Timestamp and Soft Delete Flag If you select Last Updated Timestamp and Soft Delete Flag in Add Sync Scope dialog, then you have to set the following values: Last Update Timestamp value by editing the Sync Object. Otherwise, you may get errors while generating the application forms. SoftDeleteFlag value by editing the Sync Object. Otherwise, you may get errors while syncing Adding a Sync Object In the SyncConfiguration view, after you have added a DataSource and then a Sync Scope, add a Sync Object. To add a Sync Object, follow these steps: 2015 by Kony, Inc. All rights reserved 176 of 256

177 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 1. Right-click the created SyncScope and select Add Sync Object. 2. Type the name for the SyncObject. 3. Click Finish. Important: It is mandatory to define a Sync Attribute for any new Sync Object created. If you do not create a Sync Attribute, an error appears when you generate the application forms or offline services Adding Attributes to the Sync Object A Sync Object created must have attributes. For example, a Sync Object comprising the summary of a data can have attributes such as month, year, and owner of the object Alternatively, you can double-click on the Sync Object and then add attributes in the Edit Sync Object dialog. 1. Double-click the Sync Object. The Edit Sync Object dialog appears. 2. Add the attributes information in the Edit Sync Object dialog by Kony, Inc. All rights reserved 177 of 256

178 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 3. Click Finish. The attributes are added to the Sync Object Mapping Operations You can map the operations like Create/Update etc. with the corresponding REST JSON service that are added under the DataSources. Create/Update/Delete: These operations are used when an entity is created or updated or deleted by the application. Get: Used in conflict resolution. Get Updated or Get Deleted: Used to get the incremental changes from the enterprise to the application by Kony, Inc. All rights reserved 178 of 256

179 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps GetAll: Used in un-provisioned DataSources to get all the data from the enterprise to the application. To map operations, follow these steps: 1. Right-click the SyncObject for which you want to edit or create the operations for and click Edit. The Edit SyncObject dialog appears. 2. Select an operation from the Operations area and configure Header mapping. In the following figure, Get operation is selected. 3. Select a service from the Service list. The SAPNW_BookingCollection is selected in the picture by Kony, Inc. All rights reserved 179 of 256

180 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 4. Expand Input Mapping pane. a. Click inside Service Input Params cell and click. The Select Input Param dialog appears. b. Select Input Parameters from the dialog and click OK. These input parameters are defined in the Service Definition Editor of the SAPNW_BookingCollection service. c. Select Source Typefrom the list. d. Select the Source Value from list. The Source Value is the attributes defined for the service in Attributes section. For example, the following image shows Service Input Parameters, Source Type, and Source Value defined by Kony, Inc. All rights reserved 180 of 256

181 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 5. Expand Output Mapping pane. a. Click inside Service Output Params cell and click. The Select Output Param dialog appears. b. Select Output Parameters from the dialog and click OK. c. Select Source Type from the list. d. Select the Target Value from list. 6. After you have entered all the information in the mapping panes, click Finish. The operations are mapped and you can generate application forms by Kony, Inc. All rights reserved 181 of 256

182 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps Note: Additional Actions in the Sync Object Parameters dialog You can also add new mapping using the add ( ) button. To remove an operation parameter, select the operation row or name and click delete( ) button. You can change the order of the operations by selecting the operation and using the up or down arrows. To insert a new operation before another operation click Insert After. To insert a operation after another operation click Insert Before Using SAP BAPI Services in your Application You can import and use the SAP BAPI services in your application by generating application forms and offline services. Click on the following links to view more information. Generating Application Forms. Generating and using offline services Configuring the Custom Authentication Provider While the application need to authenticate the user credentials with SAP NetWeaver service, then you can use the following code as a Custom Authentication Manager. Note: Change the <<LOGIN_URL>> with the login service URL of the SAP NetWeaver by Kony, Inc. All rights reserved 182 of 256

183 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 2015 by Kony, Inc. All rights reserved 183 of 256

184 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps Custom Authentication Manager for Sky HTTP Services If the application needs to authenticate the user credentials with Sky HTTP service, then you can use the following code as a Custom Authentication Manager. Note: Change the <<LOGIN_URL>> with the login service URL of the Sky HTTP services by Kony, Inc. All rights reserved 184 of 256

185 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps Custom Authentication Manager for SAP SSO When application need to authenticate the user credentials with SAP SSO service, then you can use the below code as a Custom Authentication Manager by Kony, Inc. All rights reserved 185 of 256

186 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps Note: Change the <<SSO_HOST>>, <<SSO_PORT>> with the host and port of the SAP SSO system by Kony, Inc. All rights reserved 186 of 256

187 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 17.6 Configuring SAP JCO Connection Pool Connection pooling is a way of speeding up the connection process. By setting the Connection Limit and Pool Capacity time to live for the connection helps keeping the connection up to date. This does not improve data processing but only speeds up the connection and log in processing to the back end server. Required Software: 1. SUP or higher. 2. JCO connection to a SAP Backend. 3. SAP Mobile Server (runtime) SAP Java Connector Kony Studio provides an option to specify the Peak Connection Limit and Pool Capacity in the Advanced tab of the Server Details dialog. This information is sufficient for establishing the connection Pool for SAP JCo. If the user wishes to fine tune the connection pooling behavior, the following entries are to be added manually in the generated Sync Configuration file by specifying the appropriate values. 1. Specify the Peak Connection Limit. 2. Specify the Pool Capacity by Kony, Inc. All rights reserved 187 of 256

188 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 3. Click OK. 4. Open the Sync Configuration file, it appears like as shown in the figure below by Kony, Inc. All rights reserved 188 of 256

189 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 5. Add the following parameters <ConfigParam Value="" Name="jco.destination.max_get_client_ time"/> <ConfigParam Value="" Name="jco.destination.expiration_time"/> <ConfigParam Value="" Name=" jco.destination.expiration_check_ period"/> 6. After you add the parameters, the Sync Configuration file looks like the figure below. The Connection pooling is established. Note: For more information on Connection pooling, visit Configuring Single Sign-On (SSO) SAP Single Sign-On feature allows you to authenticate once and subsequently access SAP and non- SAP applications in a secure and user-friendly way. It can be used to meet company and regulatory requirements and improve security measures to protect your company by Kony, Inc. All rights reserved 189 of 256

190 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 1. Connect to a new instance of SAP server. 2. The user needs to enter a new line in the Sync Configuration File and enter a new line to enable the SSO feature by Kony, Inc. All rights reserved 190 of 256

191 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 3. The user has to enter the following line manually to the Config file: <ConfigParam Value="" Name="jco.client.mysapsso2"/> Note: The duration before which the token gets expired is governed by SAP implementation and upon expiry the user might have to re-login Using Auto Commit Feature Setting auto commit feature to True invokes the commit for the SAP BAPI being executed. The auto commit feature is applicable only for a single BAPI transaction. This feature does not support committing of transaction of multiple BAPIs as a single transaction. To get the auto commit feature enabled in Kony Studio, include the following configuration parameter in the Sync Configuration file: <ConfigParam Value="true" Name="isAutoCommitEnabled"/> 2015 by Kony, Inc. All rights reserved 191 of 256

192 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 17.9 Hierarchical Upload Hierarchical upload is used in scenarios where one row of data may need to be described as multiple related sync objects. The sync objects may be in the form of parent-child relationship. In Kony Sync 5.6.2, hierarchical object relationships which support multiple child objects to any level is implemented. In the following example, four objects hierachobject, measuringpointtable, assetobject, and classobject are used to explain the hierarchical upload feature. The hierachobject is the parent object and has assetobject as the child object. The assetobject has measureingpointtable and classobject as its child objects. To generate Sync Configuration file, follow these steps: 1. Create a Sync Configuration file. For more information on creating a sync configuration file, see Creating a Sync Configuration File section. 2. Add a DataSource. For more information to add a DataSource, see Add DataSource. 3. Create a Sync Scope. 4. Add Sync Objects. 5. Add Sync Attributes for all the Sync Objects by Kony, Inc. All rights reserved 192 of 256

193 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps a. Configure attributes for hierchobject: 2015 by Kony, Inc. All rights reserved 193 of 256

194 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps b. Configure attributes for assetobject: 2015 by Kony, Inc. All rights reserved 194 of 256

195 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps c. Configure attributes for measuringpointtable: 2015 by Kony, Inc. All rights reserved 195 of 256

196 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps d. Configure attributes for classobject: 6. Double-click hierachobject in Sync Configuration view. 7. Click Relationships in the left pane. 8. In Target Object field, click Browse. The Select Target Sync Object dialog appears by Kony, Inc. All rights reserved 196 of 256

197 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 9. Select an object and click OK. 10. In the Relationship column, select the type of relationship. The available values are One to Many and Many to One. 11. In the Target Attribute column, select a target attribute from the list. In this case assetnum attribute of the assetobj is selected by Kony, Inc. All rights reserved 197 of 256

198 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 12. Select Source Attribute from the list by Kony, Inc. All rights reserved 198 of 256

199 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 13. Similarly, define the relationships for the assetobject which contains two children measuringpointtable and classobject by Kony, Inc. All rights reserved 199 of 256

200 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 14. Select an Operation from the left pane and select a Service from the list. Note: You can enter information in both Input mapping and Output mapping panes. In this example, information is entered in Input mapping pane. 15. Select Service Input Parameters. For more information, see Operations in Input Mapping. 16. Select Source Type from the list. 17. Select Source Value from list. As Attribute is selected as Source Type, you can select attributes of the current sync object (hierchobject) by Kony, Inc. All rights reserved 200 of 256

201 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 18. Select Relationship as the Source Type for a Service Input Parameter. This is to assign the Source Value of one of the child objects by Kony, Inc. All rights reserved 201 of 256

202 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 19. In Source Value column, click Browse. The Relationship SyncAttribute dialog appears. In this dialog you can see attributes of the child objects by Kony, Inc. All rights reserved 202 of 256

203 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 20. Select an attribute in Relationship SyncAttribute dialog and click OK. 21. Similarly, you can enter information in Output mapping pane. 22. After you have entered information in the mapping panes, click Finish. The operations are mapped and you can generate application forms SAP BAPI Design Guidelines Services: Each entity (Sync object) needs to have CRUD operation defined as below. There is no constraint on the Service/BAPI name and well on the request/response field names by Kony, Inc. All rights reserved 203 of 256

204 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 1. Create: This Service takes all the filed level data in the request and creates the row in the enterprise data source and returns the auto generated primary key information in the response if key is auto generated. Service Name: YBAPI_SALESORDER_CREATE Input Parameters: Output Parameters: Table (Input/Output) Parameters: 2015 by Kony, Inc. All rights reserved 204 of 256

205 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 2. Update: This Service takes all the field level data along with primary key in the request and updates the row in the enterprise Datasource. Service Name: YBAPI_SALESORDER_CHANGE Input Parameters: Output Parameters: 2015 by Kony, Inc. All rights reserved 205 of 256

206 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps None Table (I/O) Parameters: 3. Delete: This Service takes the primary key of the row and deletes the row from the data source. Service Name: YBAPI_SALESORDER_DELETE Input Parameters: Output Parameters: None Table (I/O) Parameters: 2015 by Kony, Inc. All rights reserved 206 of 256

207 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 4. Get: This Service takes the primary key of the row in the input and gives all the field level data in the response. Service Name: YBAPI_SALESORDER_GET Input Parameters: Output Parameters: Table (I/O) Parameters: None 2015 by Kony, Inc. All rights reserved 207 of 256

208 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps 5. Get Updated: This Service takes the date time value in the request and returns all the rows (with all the field data) changed after that date time. This will be used to get the delta changes. Service Name: YBAPI_SALESORDER_GETLOG Input Parameters: Output Parameters: Table (I/O) Parameters: 2015 by Kony, Inc. All rights reserved 208 of 256

209 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps Note: Go through the Other Datasources section in the "Kony Sync Framework Getting Started Guide" document to understand the service requirements in detail and the batching support. This document is available at Provisional Columns Along with these services, we need to make sure that there are provisional columns in each of the entity. 1. SoftDeleteFlag: This column represents whether row is deleted. SoftDeleteFlag is optional when entity doesn't have to deal with delete functionality. 2. LastUpdateTime: This is the Datetime column which indicates when the row is created/modified/deleted. Note: If there are any errors then either SOAP fault or 'errmsg' parameter is in service output is expected by Kony, Inc. All rights reserved 209 of 256

210 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps Mapping Input or Output Parameters For example: Consider an example of 'Contact' object based on Salesforce model. Create Input Mapping: 2015 by Kony, Inc. All rights reserved 210 of 256

211 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps Service need to accept all or subsets of fields from the sync attributes. Create Output Mapping: 2015 by Kony, Inc. All rights reserved 211 of 256

212 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps If there is an auto generated key, then we need to map the auto generated value in output mapping. Update Input Mapping 2015 by Kony, Inc. All rights reserved 212 of 256

213 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps This service needs to accept all or subsets of fields from the sync attributes. Update Output Mapping 2015 by Kony, Inc. All rights reserved 213 of 256

214 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps This does not require output mapping. Delete Input Mapping 2015 by Kony, Inc. All rights reserved 214 of 256

215 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps This Service needs to accept the primary key of the row. Delete Output Mapping 2015 by Kony, Inc. All rights reserved 215 of 256

216 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps This do not require output mapping. Get Input Mapping 2015 by Kony, Inc. All rights reserved 216 of 256

217 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps This Service needs to accept the primary key of the row. Get Output Mapping 2015 by Kony, Inc. All rights reserved 217 of 256

218 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps This Service should return all the field level data for that particular primary key. GetUpdated Input Mapping 1. Service can accept last sync time (lower bound), and current time stamp (upper bound) and return the rows which are added/changed/deleted between these two date time values. 2. For batching, service need to take batch size as input parameter and return the batch size number of rows. (Number rows in the output can be different from batch size) by Kony, Inc. All rights reserved 218 of 256

219 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps GetUpdated Output Mapping This Service should return list of rows containing all the field level data. For batching support, service need to return one parameter flag which indicates whether there are more batches available. Service can also return some identifier like 'QueryLocator' which can be stored in context and can be sent in the 'GetBatch' input by Kony, Inc. All rights reserved 219 of 256

220 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps GetUpdated Output Mapping This Service should return list of rows containing all the field level data. For batching support, service need to return one parameter flag which indicates whether there are more batches available. Service can also return some identifier like 'QueryLocator' which can be stored in context and can be sent in the 'GetBatch' input by Kony, Inc. All rights reserved 220 of 256

221 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps GetBatch Input Mapping This operation will be invoked when the more changes available flag from the 'GetUpdated' service is true. This operation will be invoked by sync server recursively until more changes available flag is false by Kony, Inc. All rights reserved 221 of 256

222 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps GetBatch Output Mapping 2015 by Kony, Inc. All rights reserved 222 of 256

223 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps This Service output should be same as 'GetUpdated' service output GetUpdated or GetBatch Service Approaches There are several ways in which we can provide batching/chunking. One of the simple and efficient approach is mentioned below. If you do not have a delta service already, then you can implement the service for each entity by following the below algorithm and map the same service with both GetUpdated and GetBatch operation. KonySync server will invoke this service to get the delta changes in batches. Data will be sent to device in batches to avoid memory & network issues when there are more rows in initial sync/delta sync. Algorithm <entity>_getupdated(datetime, batchsize) Algorithm to fetch the batch size number of rows from the backend 2015 by Kony, Inc. All rights reserved 223 of 256

224 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps datasource cursor Open a cursor on <entity> where lastupdatetime > datetime recordcount 0 prevlastupdatetime 0 row cursor.firstrow() while recordcount < batchsize or row.lastupdatetime == prevlastupdatetime do recordcount recordcount + 1 prevlastupdatetime row.lastupdatetime list.add(row) row cursor..nextrow() end-while lastrowdatetime row.lastupdatetime cursor.close() if recordcount >= batchsize then moredataavailable true else moredataavailable false end-if Return list, moredataavailable, lastrowdatetime Operation mappings with the above implementation: In GetUpdated operation input mapping, you need to map LAST_SYNC_TIMESTAMP from the context to the datetime and BATCH_SIZE from context to batchsize. In GetUpdated output mapping, you need to map the fields from list into the corresponding sync attributes, moredataavailable to MORE_CHANGES_AVAILABLE in context and lastrowdatetime to any temporary variable in context( let say to QueryLocator). In GetBatch operation input mapping, you need to map temporary context variable 2015 by Kony, Inc. All rights reserved 224 of 256

225 17. Creating Sync Configuration using SAP BAPI Datasource (using SAP Java Connector) Kony MobileFabric Sync Services Developing Offline Apps (QueryLocator) from the context to the datetime and BATCH_SIZE from context to batchsize. In GetBatch operation output mapping will be same as GetUpdated operation output mapping 2015 by Kony, Inc. All rights reserved 225 of 256

226 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps 18. Handling Sync Configuration Schema Changes This topic talks about handling Sync Configuration changes after the application is deployed in a device. For a proper sync, schema changes made in the Enterprise DataSource need to be applied to the schema in the device database. Earlier, if a sync configuration is changed to new schema, the user needed to reset the device database and upgrade the application. After the application is upgraded the user needed to do a full synchronization which may involve huge amount of data. This process consumed considerable amount of time for the user. Currently, with better handling of schema changes, the whole process is streamlined and need to sync the whole data again is avoided. Upgrading schema on device is done faster and easier to the user. With the new enhanced features, following schema changes are supported: 1. Addition/Deletion of a new sync object. 2. Addition/Deletion of a new column. 3. Addition/Deletion of a new Scope. 4. Modify Column Name. 5. Modify Attribute Types. 6. Deletion of a table Walkthrough of Handling Schema Changes The following scenario walks you through adding a new Attribute to a Sync Object and adding a new Sync Object to an existing application by Kony, Inc. All rights reserved 226 of 256

227 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps 1. Creating a Simple Sync Application. 2. Updating Application for Dynamic Schema Changes. 3. Handling Dynamic Schema Changes on Device Creating a Simple Sync Application 1. Create a New Application in Kony Studio. 2. Create a new Sync Configuration file in Sync Configuration view. 3. Add a DataSource. 4. Add a Sync Scope. 5. Add Sync Objects. 6. Add Sync Object Parameters like Attributes, Relationships, and Filters. 7. Configure an operation from the Operations area.. 8. Right-click the Sync Configuration file and Generate Application Forms by Kony, Inc. All rights reserved 227 of 256

228 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps 9. Right-click the Sync Configuration file and Generate Offline Services. 10. Build the application for a single platform. 11. Log on to Sync Console. 12. From the Sync Console, click Application in the left pane. 13. Click Add Application by Kony, Inc. All rights reserved 228 of 256

229 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps 14. Click Choose File and navigate to the sync folder in the Resource Location folder and select the XML file of the application. a. The Resource Location folder can be opened from Kony Studio by clicking on icon, 15. Click Groups and assign the application to a group. Click Administrator group name. Click > to assign the group by Kony, Inc. All rights reserved 229 of 256

230 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps 16. Click Save. 17. In the device, install the application and perform a sync. 18. In Kony Studio, add a new column (attribute) to the Sync Object by Kony, Inc. All rights reserved 230 of 256

231 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps Updating Application for Dynamic Schema Changes 1. Generate Offline Services for the Sync Configuration file. 2. Navigate to Sync Console > Applications > Applications > Edit Application > Choose File. 3. Navigate to the sync folder in the Resource Location folder and select the XML file of the application. 4. Before clicking Upload, select Keep existing Sync Config in application history box by Kony, Inc. All rights reserved 231 of 256

232 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps 5. Click Upload. 6. From the device, perform a Sync without upgrading the code base. Note: The following error may occur if you try to Sync without upgrading the client Handling Dynamic Schema Changes 1. From the Kony Studio, build the new application (with new column added). 2. Install the application in device. 3. Perform Sync from the device. Note: There are two options for the user. You can either do a Normal Sync which performs the upgrade internally or you can manually upgrade by using the functionsync.performupgrade by Kony, Inc. All rights reserved 232 of 256

233 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps 18.2 Checking if Schema is Changed You can use IsUpgradeRequired function to check if schema is upgraded or not. Input Parameters Config - Mandatory The configuration related to the sync cycle (can be user-defined as per the requirement). The following code snippet checks for any schema changes and notifies you: function IsUpgradeRequired(){ var config = {}; config.userid = <userid>; config.password = ; config.appid = ; config.serverhost = ; config.serverport = ; config.isupgraderequiredstart = isupgraderequiredstartcallback; config.isupgraderequiredsuccess = isupgraderequiredsuccesscallback; config.isupgraderequirederror = isupgraderequirederrorcallback; sync.isupgraderequired(config); } You can use the following callbacks as per the requirement: isupgraderequiredstart - This callback does not provide any parameters isupgraderequiredsuccess - This callback returns a UpgradeRequired parameter which can be true or false depending on if upgrade is required or not. isupgraderequirederror - This callback gives the approripate error and/or reason for failure by Kony, Inc. All rights reserved 233 of 256

234 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps 18.3 Registering for Schema Change Callbacks To register for schema change callbacks, follow these steps: Define the following callbacks to do relevant changes: 1. onupgradescriptsdownloadstart - This callback is called before the upgrade scripts are downloaded. The user can modify the following parameters or add new ones and return: userid password appid clientid appversion dbversion criptsrequired parameter which can be false/true. function onupgradescriptsdownloadstart(res){ } kony.print("~~~~~onupgrade Scripts Download Start Callback"); for(i in res){ kony.print(i + " " + res[i]); } 2015 by Kony, Inc. All rights reserved 234 of 256

235 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps 2. onupgradescriptsdownloadsuccess - This callback is called on successfully downloading the upgrade scripts. This callback contains a upgradescripts parameter which contains the alter scripts which get executed. function onupgradescriptsdownloadsuccess(res){ kony.print("~~~~~onupgrade Scripts Download Success Callback"); kony.print("upgrade Scripts Download Success"); } 3. onupgradescriptsdownloaderror - This callback is called during an error while downloading the upgrade scripts. This callback gives the appropriate error and/or reason for failure. function onupgradescriptsdownloaderror(res){ } kony.print("~~~~~onupgrade Scripts Download Error Callback"); alert("upgrade Scripts Download Error" + JSON.stringify(res)); 4. onupgradescriptsexecutionstart - This callback is called before upgrade script execution starts. This callback contains a upgradescripts parameter which contains the alter scripts which get executed. function onupgradescriptsexecutionstart (res){ kony.print("~~~~~onupgrade Scripts Execution Start Callback"); //user can add their own upgrade scripts here and push it with the downloaded scripts using //res.upgradescripts.push(your_query); } 5. onupgradescriptsexecutionsuccess - This callback is called after successful execution of upgrade scripts. This callback does not provide any parameters by Kony, Inc. All rights reserved 235 of 256

236 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps function onupgradescriptsexecutionsuccess (res){ kony.print("~~~~~onupgrade Scripts Execution Success Callback"); kony.print("upgrade script execution success"); } 6. onupgradescriptsexecutionerror - This callback is called on error during execution of upgrade scripts. This callback gives the appropriate error and/or reason for failure. function onupgradescriptsexecutionerror (res){ kony.print("~~~~~onupgrade Scripts Execution Error Callback"); alert("upgrade script execution error" + JSON.stringify(res)); } 7. onupgraderequired - This callback is called when client detects a schema change on the server. In this callback you can specify any of the following four policies to handle pending uploads before schema change. This callback provides a contextparams parameter which contains oldapplicationversion and newapplicationversion parameters. The user can return any of the schema upgrade policy parameters to specify the type of action to be performed. Before upgrading the application, following policies can be used: a. ABORT - In this policy the sync cycle will be aborted if there are pending uploads before schema change. b. UPLOAD_AND_ABORT - In this policy, first the pending uploads will be uploaded to the server and then the sync cycle will be aborted. Note: In the above two policies, no schema upgrade will happen. After upgrading the application, following policies can be used: 2015 by Kony, Inc. All rights reserved 236 of 256

237 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps a. UPGRADE - In this policy only the schema will get upgraded. b. UPLOAD_AND_UPGRADE - In this policy first the pending uploads will be uploaded to the server and then the schema will get upgraded. Note: To use UPLOAD_AND_UPGRADE and UPLOAD_AND_ABORT your schema needs to be backward compatible. Example Code Snippet function onupgraderequired (res){ kony.print("on Upgrade Required Callback"); return //specify policy name E.g. : "UPLOAD_AND_UPGRADE" } Note: All the callbacks mentioned above are user-defined as per the requirement Handling Application Upgrades You can perform upgrade using the function sync.performupgrade. This function performs the upgrade operation by downloading the upgrade scripts from the server and executes them. After upgrading the function it will call the download operation. For changed attributes, if a new column is added, it will download data for a new column. It takes all the parameters which are applicable to sync.startsession except some callbacks(onsyncstart). function PerformUpgrade(){ var config = {}; //Insert parameters like userid, password, appid, batchsize from sync.start session config.onscopestart = onscopestartcallback; config.onscopeerror = onscopeerrorcallback; 2015 by Kony, Inc. All rights reserved 237 of 256

238 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps config.onscopesuccess = onscopesuccesscallback; config.onuploadstart = onuploadstartcallback; config.onuploadsuccess = onuploadsuccesscallback; config.ondownloadstart = ondownloadstartcallback; config.ondownloadsuccess = ondownloadsuccesscallback; config.onbatchprocessingstart = onbatchprocessingstartcallback; config.onbatchprocessingsuccess = onbatchprocessingsuccesscallback; config.onperformupgradesuccess = onperformupgradesuccesscallback; config.onupgradescriptsdownloadstart = onupgradescriptsdownloadstartcallback; config.onupgradescriptsdownloadsuccess = onupgradescriptsdownloadsuccesscallback; config.onupgradescriptsdownloaderror = onupgradescriptsdownloaderrorcallback; config.onupgradescriptsexecutionstart = onupgradescriptsexecutionstartcallback; config.onupgradescriptsexecutionsuccess = onupgradescriptsexecutionsuccesscallback; config.onupgradescriptsexecutionerror = onupgradescriptsexecutionerrorcallback; config.onperformupgradeerror = onperformupgradeerrorcallback; config.onperformupgradestart = onperformupgradestartcallback; config.onupgraderequired = onupgraderequiredcallback; } sync.performupgrade(config); onperformupgradestart - This callback does not provide any parameters. onperformupgradesuccess - provides a upgraderequired parameter whose value is false since at this point no upgrade is required. Note: All the callbacks are user-defined as per the requirement by Kony, Inc. All rights reserved 238 of 256

239 18. Handling Sync Configuration Schema Changes Kony MobileFabric Sync Services Developing Offline Apps 18.5 Handling Pending Uploads Before a Schema Change If there are pending uploads from client before a schema change then the following two policies can be used to specify how to handle the pending uploads: 1. To upload before upgrading the application, use the following policy: UPLOAD_AND_ABORT - Before uploading, if the client makes any change in the old app (Version 1) and the server is upgraded (Version 2). Client can use this policy and upload the changes before upgrading the application. (Version 1 to Version 2) Thereby saving the client data. 2. To upload after upgrading the application, use the following policy: UPLOAD_AND_UPGRADE - If the client makes some changes in the old app (Version 1) and unintentionally updates the application (Version 2) from app store. Client can use this policy to upload the changes first and then upgrade the schema thereby saving the data. Note: To use UPLOAD_AND_UPGRADE and UPLOAD_AND_ABORT your schema needs to be backward compatible by Kony, Inc. All rights reserved 239 of 256

240 19. Generate Application Forms Kony MobileFabric Sync Services Developing Offline Apps 19. Generate Application Forms With the 5.5 release, the application generation capabilities have been vastly improved. From a SyncConfiguration now you can generate a fully functional offline application within minutes. Given a SyncConfiguration it would generate the following assets: Application forms : They represent the User Experience presented to the end user Model files (part of the modules) : They represent the ORM APIs used for accessing the offline data Controller files: Act as the glue between the Model and Application forms To generate application forms, follow these steps: 1. Navigate to the SyncConfiguration view. 2. Right-click the Sync icon and select Generate Application Forms. A confirmation message appears if you have already generated a Sync Configuration XML file. Click Yes to override the file and proceed with the application generation. Click No to proceed with the Application generation without overriding the existing file by Kony, Inc. All rights reserved 240 of 256

241 19. Generate Application Forms Kony MobileFabric Sync Services Developing Offline Apps 3. Click Yes to continue. The following dialog appears. 4. Enter the following: Application Logo: Image for the application logo. Application Splash Screen: Specifies the splash screen image to be displayed. Splash Screen is the initial screen that appears when you launch an application. Application Home Screen Layout: All the forms that are generated are listed on the Home Screen of the application. The forms in the application can appear as follows: List Type Icon Type 2015 by Kony, Inc. All rights reserved 241 of 256

242 19. Generate Application Forms Kony MobileFabric Sync Services Developing Offline Apps Application Theme: This field lists themes you can apply to your application. Channels Selected for Application Generation: Select the channels you want to generate the application for by Kony, Inc. All rights reserved 242 of 256

243 19. Generate Application Forms Kony MobileFabric Sync Services Developing Offline Apps 5. Click Next. The Generate Application Forms dialog appears. 6. Select the Sync objects for which you want to generate forms. Do the following: To create a form for the Data Object, select any one of the displayed Data Objects in the left pane and click. To remove a Data Object whose form is added, select the Data Object from the right pane and click. To create forms for all the Data Objects, select any one of the displayed Data Objects in the left pane and click by Kony, Inc. All rights reserved 243 of 256

244 19. Generate Application Forms Kony MobileFabric Sync Services Developing Offline Apps To remove all the Data Object whose forms are added, select the Data Object from the right pane and click. If you click, then the selected application object in Selected list box will be moved to top of the list. If you click either the up or down arrows, then the selected application object in 'Selected' list box will be moved one level up or down. If you click, then the selected application object in 'Selected' list box will be moved to bottom of the list. 7. Click Next. The Display Configuration tab is selected and the following screen appears. The fields in the Display Configuration tab enable you to set the values for an object (and its fields) you want the end user to view when they traverse a form created for a particular object by Kony, Inc. All rights reserved 244 of 256

245 19. Generate Application Forms Kony MobileFabric Sync Services Developing Offline Apps 8. Select the Data Object whose display configuration you want to set. 9. Display Name: Set a label for display name of the selected application object. This label appears in the form created for a Data Object. 10. Show in Main Menu: Shows the selected application object in the application main menu. Selected by default. 11. Object Icon: Choose the Icon which will be displayed for the application object in List view or icon view. This icon must be in the.png format. 12. Layout Type: Set the layout type for the fields of a selected Data Object. Based on the layout type selected the fields are displayed as follows: 2015 by Kony, Inc. All rights reserved 245 of 256

246 19. Generate Application Forms Kony MobileFabric Sync Services Developing Offline Apps List Screen with Search Bar List Screen without Search Bar Grid View 13. In the Display Properties Area, do the following: Field Id: Specifies the field id for a field of a Data Object. Display Name: Specifies the display name for a field. You can change the field name to a user friendly name. Select the fields that are to be displayed in specific views. Specify the datatype for each field in the Field Type Column. In the Validations column, click a field for which you want to add a validation. Specify a validation for a field. For example, if the user is supposed to enter only fifty characters for a field, write an appropriate validation code for the same. If you click, then the selected field will be moved to top of the list. If you click either the up or down arrows, then the selected field will be moved one level up or down. If you click, then the selected field will be moved to bottom of the list by Kony, Inc. All rights reserved 246 of 256

247 19. Generate Application Forms Kony MobileFabric Sync Services Developing Offline Apps 14. Using the Actions tab you can, do the following: Select the Data Object whose Action configurations you want to set. Select the corresponding checkboxes that allow you to select the create, update, delete and display relationships actions for the selected application objects. Note: After you set the configuration for one data object, you can select another data object and set the configurations. 15. Click Finish. An application is created. You can view all the forms created for your Data Objects under Application Name> forms> mobile. JavaScript Controller modules are generated under the modules folder which comprises information and the logic for creation, retrieval, and modification about a Data Object instance and its fields. Build the application and view the subsequent forms by Kony, Inc. All rights reserved 247 of 256

248 20. Generating Offline Services Kony MobileFabric Sync Services Developing Offline Apps 20. Generating Offline Services Offline Services provide an API to access data within the Sky DataObjects, Database Tables, and WebServices or the Kony Sync device database depending upon the DataSource. These services differ from the regular services defined using the Service definition editor in the following ways: 1. Offline Services need not be deployed to a Kony Server 2. Most of the Offline Services are available even when the Device offline. When the developer uses "Generate the Offline Services" option from the SyncConfiguration View, Model files are generated within the module folder of the application. These Model Files provide ORM APIs to access the underlying data. You can generate offline services for Data Objects in an application. Using these offline services you can invoke ORM APIs using the Mapping Editor. To generate an offline service, do the following: 1. Navigate to the SyncConfiguration view. 2. Right-click the Sync icon and select Generate Offline Services. A confirmation message appears if you have already generated a Sync modules by Kony, Inc. All rights reserved 248 of 256

249 20. Generating Offline Services Kony MobileFabric Sync Services Developing Offline Apps 3. Click Yes to override the existing modules and proceed with the offline services generation. Click No to proceed with the offline services generation without overriding the existing file. All the offline services that are generated are listed under your application by Kony, Inc. All rights reserved 249 of 256

250 20. Generating Offline Services Kony MobileFabric Sync Services Developing Offline Apps When you expand each offline service generated for a Data Object, you can view the methods associated with each Data Object of that Service Using the Offline Services in your application You can leverage the create, update, delete, and other operations of a Data Objects in your application. To demonstrate how to do so, we have a sample application which has been created using the procedures stated above Invoking an Offline Service using the Mapping Editor You can invoke an offline service on a button click or populate data in a segment or within a label using the Mapping Editor. To invoke an offline service using the mapping editor, do the following: 1. Open Event Editor. 2. Right-click Action Sequence and select Invoke Offline Service (Asynchronous) by Kony, Inc. All rights reserved 250 of 256

251 20. Generating Offline Services Kony MobileFabric Sync Services Developing Offline Apps 3. Select a service from the drop-down list or click to open Select Service window as shown below: i. Select a service from the list available. ii. When you type few letters of a service under Search, all the service names that begin with the characters entered are listed. iii. Select a service from the list and click OK. 4. Click Open Mapping Editor. The Mapping Editor opens. 5. Map the service parameters to variables, data store keys, or widgets on the form from which the service was invoked by Kony, Inc. All rights reserved 251 of 256

252 20. Generating Offline Services Kony MobileFabric Sync Services Developing Offline Apps 6. Click Finish on the Mapping Editor. An action sequence is defined for invoking a synchronous service Invoking an Offline Service using an ORM API: As an example we will consider a form whose contents you want to delete on the onclick of a button. To do so, define an onclick function for that button. A sample function defined on an onclick event for a button is as follows: //Object level ORMs products = new com.kony.sync.products(); products.productid = 3; product.name = "sample Product"; // Define a successcallback that will be invoked when the object instance is created in the local database function successcallback() { alert("product created successfully") } // Define a errorcallback that will be invoked incase there is an error creating a instance in the local database function errorcallback (res) { alert("some problem occurred while creating Product. Code=" + res.errorcode + " Error Message=" + res.errormessage + " Error Info=" + JSON.stringify(res.errorInfo) ); } //Create a new instance 2015 by Kony, Inc. All rights reserved 252 of 256

253 20. Generating Offline Services Kony MobileFabric Sync Services Developing Offline Apps product.create(successcallback, errorcallback); 2015 by Kony, Inc. All rights reserved 253 of 256

254 21. Configuring Interceptors Kony MobileFabric Sync Services Developing Offline Apps 21. Configuring Interceptors The Interceptor interface provides callbacks capability from the MobileFabric Sync Framework to the application, allowing the application to inspect and/or manipulate properties of a sync object before it is inserted, updated, deleted or loaded. Interceptors can execute code before and after an Action (Upload, Download, and Merge) is invoked. Interceptor classes contain methods that are invoked in conjunction with the methods or life cycle events of the sync services. For more information about interceptors, refer the kony_mobilefabric_ sync_getting_started_guide. 1. Right-click the Sync icon and select Configure Interceptors. 2. Add the jar files which have the Interceptor implementation classes (You need to create the jar file from the interceptor implementation separately). To add the jar file, click in the left pane. 3. Click to add the Interceptor row. Select the Interceptor type from the drop down, and select 2015 by Kony, Inc. All rights reserved 254 of 256