Integration Service. Admin Console User Guide. On-Premises

Transcription

1 Kony Fabric Integration Service Admin Console User Guide On-Premises Release V8 SP1 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 5

2 Kony Integration Service Admin Console User Guide Copyright 2014 Kony, Inc. All rights reserved. December, 2017 This document contains information proprietary to Kony, Inc., is bound by the Kony license agreements, and may not be used except in the context of understanding the use and methods of Kony, Inc., software without prior, express, written permission. Kony, Empowering Everywhere, Kony Fabric, Kony Nitro, and Kony Visualizer are trademarks of Kony, Inc. MobileFabric is a registered trademark of Kony, Inc. Microsoft, the Microsoft logo, Internet Explorer, Windows, and Windows Vista are registered trademarks of Microsoft Corporation. Apple, the Apple logo, itunes, iphone, ipad, OS X, Objective-C, Safari, Apple Pay, Apple Watch, and Xcode are trademarks or registered trademarks of Apple, Inc. Google, the Google logo, Android, and the Android logo are registered trademarks of Google, Inc. Chrome is a trademark of Google, Inc. BlackBerry, PlayBook, Research in Motion, and RIM are registered trademarks of BlackBerry. SAP and SAP Business Suite are registered trademarks of SAP SE in Germany and in several other countries. All other terms, trademarks, or service marks mentioned in this document have been capitalized and are to be considered the property of their respective owners by Kony, Inc. All rights reserved 2 of 5

3 Kony Integration Service Admin Console User Guide Revision History Date Document Version of Modifications/Release 12/18/ Document updated for Release V8 SP1. Appended Downloading Swagger API file in Integration, Orchestration and Object Service and Configurable Parameters sections. 09/15/ Document updated for release V8. Worked on rebranding MobileFabric to Kony Fabric. Appended Notifications and Authentication field information in Jobs section by Kony, Inc. All rights reserved 3 of 5

4 Kony Integration Service Admin Console User Guide Table of Contents 1. Preface Purpose Intended Audience Formatting Conventions Contact Us 3 2. Launching the Admin Console 4 3. Web Apps View List of Services Delete an Application 7 4. Integration Services Testing a Service Downloading a Swagger API File Object Services Testing a Service Orchestration Services Testing a Service Jobs Searching for an existing job Adding a new job Health Check by Kony, Inc. All rights reserved 4 of 5

5 Kony Integration Service Admin Console User Guide 9. Reports Basic Reports Reports Legacy Reports Configuring Report Settings Report Display Settings Report MetaData Mapping Form MetaData Mapping Settings Logging Configurable Parameters Runtime Configuration Environment Details by Kony, Inc. All rights reserved 5 of 5

6 1. Preface Kony Integration Service Admin Console User Guide 1. Preface Kony Fabric Integration Service Admin Console portal helps you to test different services created in Kony Fabric Console, generate application reports, delete an application and application's services, and configure settings. Different services available in Admin console are Web Apps, Integration Services, Object Services and Orchestration services. The services are created and published in Kony Fabric Console. The published services are displayed in Admin Console under the respective tabs. The displayed services are tested in Admin Console before publishing to the website. You can perform a health check to validate the performance of the server and generate different types of reports. You can trace the logging of the server and find the environment details on which the Kony server is installed. Kony Fabric Integration Service The existing on-premises Kony Fabric Integration Service supports the feature of outputting a message to a JMS queue for each service request. Kony provides a log deamon Java process which will read from the JMS queue and insert the data into the Kony Fabric Integration Service database. A customer can query the data directly or use a reporting.war file provided by Kony which connects to the data and provides a visual representation of the data. One key feature added for Kony Cloud analytics is a client side library which resides in the app binary that manages the sessionid of the application. The library contains the business logic to generate a sessionid and rotate the sessionid if the app is closed or if the app is idle for more than thirty minutes. Another key feature added for Kony Cloud analytics is a client side API to set the Kony User ID. This value is then set to the Kony Fabric Integration Service and associated to the session. This enabled the Kony Cloud analytics to also accurately track unique users based on userid defined by the developer. This enables extremely accurate user tracking for apps running on the Kony Cloud that aligns with your business definition and charging definition of app users by Kony, Inc. All rights reserved 1 of 80

7 1. Preface Kony Integration Service Admin Console User Guide 1.1 Purpose This document explains the terms and concepts in the Kony Fabric Integration Service Admin Console, the procedure to test the services created and published in Kony Fabric Console and also provides procedural information to perform various tasks in the Kony Visualizer. The document describes the different types of reports that can be generated and the settings that can be done to the logs. 1.2 Intended Audience The document is targeted to the Admin who wants to test the services created in the Kony Fabric Console and the developers who will use the IDE to write and develop applications. 1.3 Formatting Conventions The following are the formatting conventions used throughout the document: Conventions Explanation Monospace User input text, system prompts, and responses File path Commands Program code File names. Italic Emphasis Names of books and documents New terminology by Kony, Inc. All rights reserved 2 of 80

8 1. Preface Kony Integration Service Admin Console User Guide Conventions Explanation Bold Windows Menus Buttons Icons Fields Tabs Folders. URL An active link to an URL. Note: Provides helpful hints or additional information. Important: Highlights actions or information that might cause problems to systems or data. 1.4 Contact Us We welcome your feedback on our documentation. Write to us at For technical questions, suggestions, comments, or to report problems on Kony's product line, contact 2014 by Kony, Inc. All rights reserved 3 of 80

9 2. Launching the Admin Console Kony Integration Service Admin Console User Guide 2. Launching the Admin Console Prior to accessing the admin console, you need to launch the console and log in with your credentials. You can launch the admin console in two ways: From Kony Fabric Console Through Admin Console URL From Kony Fabric Console If you have the Admin Console server configured in Kony Fabric Console under the Environments section, you can access the Admin Console from Kony Fabric Console. To access the Admin Console from Kony Fabric Console, follow these steps: 1. Log in to Kony Fabric Console by entering the URL and providing your valid login credentials. For more information on accessing Kony Fabric Console, refer How to log in to Kony Fabric Console. 2. Upon successful login, the apps page of the Kony Fabric Console is displayed. 3. Click Environments from the left pane of Kony Fabric Console. 4. Click Server to access the Admin Console. The Admin Console is displayed in another tab of the web browser. By default, the Web Apps page is displayed. Through an Admin Console URL To access the Admin Console directly from the URL, follow these steps: 1. Enter the URL in the web browser and press Enter. For example, The Login page of the Admin Console is displayed by Kony, Inc. All rights reserved 4 of 80

10 2. Launching the Admin Console Kony Integration Service Admin Console User Guide 2. Enter the user name and password to login to the system. User name: Enter the default user name received after the installation of Admin Console. For example, admin Password: Enter the valid password received after the installation of Admin Console. For example, admin123 Upon successful authentication, you are redirected to Web Apps page. Note: You can find the logged in user name displayed on the top right corner of the page. Version: You can find the version number of the Admin Console accessed from the bottom of the left pane. Logout: At any point of time, you can log out of the Admin Console by clicking on the Logout option displayed on the top right corner of the page by Kony, Inc. All rights reserved 5 of 80

11 3. Web Apps Kony Integration Service Admin Console User Guide 3. Web Apps The Web Apps page displays the apps deployed to the server and the services associated with the application. The following details are displayed for the web apps deployed: Column App Name Name of the web app deployed Services List of the services associated with the web app Version The version number of the web app displayed. You can perform the following actions in this screen: View the list of services associated with each web app Search for a particular service from the configured services for the selected web app Delete a web app 3.1 View List of Services You can view the list of services associated with the web app displayed. To view the list of services, click the drop-down list under the services column of the selected web app. The list of services associated with the selected web app is displayed in the drop-down list by Kony, Inc. All rights reserved 6 of 80

12 3. Web Apps Kony Integration Service Admin Console User Guide Search for a Service You can search for a particular service from the list of services displayed in the drop-down list. To search for a particular service for the selected web app, follow these steps: 1. Enter a part or the complete service name in the text box provided. 2. Click the Search icon. The service(s) matching the search criteria are displayed. 3.2 Delete an Application From the list of web applications displayed in the Web Apps page, you can delete an application from the environment. To delete a web application from the environment, follow these steps: 1. Log in to the Admin Console and click Web Apps from the left pane of the screen. 2. From the list of web application displayed in the Web Apps page, select an application by clicking on the radio button provided across each web app by Kony, Inc. All rights reserved 7 of 80

13 3. Web Apps Kony Integration Service Admin Console User Guide 3. Click Delete button to delete the selected web application. A confirmation message appears asking Are you sure you want to permanently delete the <<App name>> application from this environment? The application cannot be recovered once you delete it.. 4. Click OK.The application is deleted by Kony, Inc. All rights reserved 8 of 80

14 4. Integration Services Kony Integration Service Admin Console User Guide 4. Integration Services The Integration Services is used to test the service defined with its associated operations. The services defined and published in the Integration tab of Kony Fabric Console are displayed in the page. You can test an integration service using different operations available for each service. To know more on integration service, refer Integration. Click the Integration Services from the left pane of the admin console to view a list of Integration services which are available across the applications within your Kony Fabric environment. The following fields are displayed for each integration service: Column Service Name Name of the service deployed. Service Type Type of the service. To know the different types of services available, refer Kony Fabric Support end points 2014 by Kony, Inc. All rights reserved 9 of 80

15 4. Integration Services Kony Integration Service Admin Console User Guide Column Version Version number selected while creating the service. Click the drop-down list to view the different versions of the selected service. For more information on versioning, refer API Versioning. Operations The operations configured for each service. Click the drop-down list and select an operation to test a service. Throttling Throttling is an interim state, and is used to control the rate of requests which clients can make to an API. Documentation Download the Swagger API file using the download link provided across each service. For more information, refer Downloading a Swagger API file. 4.1 Testing a Service Select an operation from the drop-down list under the Operations column for a service. The selected operation displays the page with two toggles: Request Input Response Output Request Input The Request Input page displays the input parameters for the operation selected. You must provide the values across the parameters displayed in the page to get the response from the server by Kony, Inc. All rights reserved 10 of 80

16 4. Integration Services Kony Integration Service Admin Console User Guide The following fields are displayed in the Request Input page: Field Server URL The middleware URL under which the request is posted. The operation selected from the drop-down list is automatically encoded in the server URL. Target URL The back-end server URL to which the response is filtered based on the requested parameter. Body Displays the Parameter Name and Parameter Value editor. Set a parameter value for the parameter name displayed 2014 by Kony, Inc. All rights reserved 11 of 80

17 4. Integration Services Kony Integration Service Admin Console User Guide Field Header Displays the field name and value editor. You can give any string as the header name. - Click Add icon displayed above the table in Header toggle to add a new field and value. - Click Delete button across the row displayed to delete a field. Get Response Encodes the parameter name and field name with their values provided Response Output The response received for the input request sent is displayed in the Response Output page. The page contains two sections: Response Header Response Body Response Header: The response header section displays the header values for the request sent by Kony, Inc. All rights reserved 12 of 80

18 4. Integration Services Kony Integration Service Admin Console User Guide Response Body: The Response Body for the request sent is displayed in the code format. To test an integration service, follow these steps: 1. Log in to the Admin Console and click Integration services from the left pane of the screen. 2. Select an operation from the drop-down list of a service from the list of services displayed by Kony, Inc. All rights reserved 13 of 80

19 4. Integration Services Kony Integration Service Admin Console User Guide 3. In the Request Input page, perform the following actions: i. In the Body section, provide the Parameter Value across the parameter names. ii. In the Header toggle, provide the Field Name and Field Value. 4. Click Get Response. The response for the input parameters provided is displayed in the Response Header and Response Body sections of the Response Output screen. 4.2 Downloading a Swagger API File Kony provided an option to download the Swagger API files for each service. Swagger is a standard way of defining and documenting the APIs. An option to download the Swagger files is provided in Admin Console. To download the Swagger file, follow these steps: Log in to the Admin Console and click Integration Services from the left pane of the screen. The list of available services are displayed by Kony, Inc. All rights reserved 14 of 80

20 4. Integration Services Kony Integration Service Admin Console User Guide Click Download for a selected service provided in the Documentation column. A JSON file for the selected service is downloaded to your local system. The downloaded JSON file can be invoked into a third-party interface and view(or) invoke the downloaded code in UI format by Kony, Inc. All rights reserved 15 of 80

21 5. Object Services Kony Integration Service Admin Console User Guide 5. Object Services The object services are used test the defined app data model in Kony Fabric Console. The services defined and published in the Object Services tab of Kony Fabric Console are displayed in the page. You can test the app data model objects of each service defined using different operations available. To know more, refer Object Services. The following fields are displayed in the page: Column Service Name The name of the service created Service Type The type of the service created. For more information on different types of services, refer Kony Fabric Support End Points. Versions The version number selected while creating the service. For more information on versioning, refer API Versioning. App Data Model Objects The list of predefined objects configured in Kony Fabric Console. You can test a service by selecting an object from the drop-down list by Kony, Inc. All rights reserved 16 of 80

22 5. Object Services Kony Integration Service Admin Console User Guide Column Documentation Download the Swagger API file using the download link provided across each service. For more information, refer Downloading a Swagger API file. 5.1 Testing a Service To test an object service, select an App Data Model Object from the drop-down list of a selected service. Note: Object services has two types of Operations, General and Binary. Based on the selected object the operations can be either general or binary. Click the drop-down list of an app data model and select an object for a service. The selected data model object displays the page with two toggles by Kony, Inc. All rights reserved 17 of 80

23 5. Object Services Kony Integration Service Admin Console User Guide Request Input Response Output Request Input The Request Input page displays the input parameters for the selected services. Field Operation Select a method from the drop-down list to send the request. The available methods are: - Create - Update - Delete - Get For more information on Methods Mapping, refer Configure Methods Mapping to the Fields in the Background. Server URL Displays the middleware URL under which the request is posted. (this is a non editable field) Query Params Enter the query parameter for the request to be sent. Body The Body section displays the field names defined for the selected service. The field names are defined while creating the service in Kony Fabric Console. Enter the field value across the field name for the request to be sent. Header The Header section displays the table with the field name and field value as the headers. Enter the required field name as the header and provide the value for the field name entered. - You can add more than one header field by clicking on the Add button above the header table. - You can delete the existing fields by clicking the Delete button across each field. Get Response Encodes the parameter name and field name with their values provided by Kony, Inc. All rights reserved 18 of 80

24 5. Object Services Kony Integration Service Admin Console User Guide Field Download You can download the request input records in CSV and JSON formats Response Output You can view the response for the request parameters sent in the Response Output toggle. This page displays the following fields: Section Response Header Displays the header values of the response received for the request sent. Response Body Displays the response for the given request parameters in the code format. To test an object service, follow these steps: 1. Login to Admin Console and click Object Services from the left pane of the screen. 2. Click the drop-down list of an App Data Model Objects for a service and select an object. 3. In the Request Input screen, perform the following actions i. Select the method from the drop-down list and enter the parameter value. ii. In the Body section, enter the field value across the field name. iii. Click the Header toggle and enter the field name and field value by Kony, Inc. All rights reserved 19 of 80

25 5. Object Services Kony Integration Service Admin Console User Guide 4. Click Get Response. The response for the given input parameters is displayed in the Response Header and Response Body sections of Response Output page by Kony, Inc. All rights reserved 20 of 80

26 6. Orchestration Services Kony Integration Service Admin Console User Guide 6. Orchestration Services Orchestration Services is the coordination of more than one service and exposing them as a single service. The services defined and published in Kony Fabric Console under Orchestration Servicesare displayed in the tab. The services displayed in the tab are tested using different predefined operations in Admin Console. For more information, refer Orchestration Services. The operations in Orchestration services are classified as Concurrent Operation Sequential Operation Concurrent Operation: Passing a parameter to more than one back-end server at the same time is considered as a Concurrent operation. Sequential Operation: Parameters in a Sequential operation are processed in an ordered queue. The parameters are passed in a sequential order by Kony, Inc. All rights reserved 21 of 80

27 6. Orchestration Services Kony Integration Service Admin Console User Guide Note: An Orchestration service created can be a combination of both Concurrent and Sequential operations. The Orchestration services page displays the following fields: Column Service Name The name of the service provided while creating the service in Kony Fabric Console. Version The version the number of the service provided while creating the service in Kony Fabric Console. For more information on versioning, refer API Versioning. Operations The predefined operations used to pass the service to the back-end. You can view and select different operations defined for a service by clicking on the drop-down list. Documentation Download the Swagger API file using the download link provided across each service. For more information, refer Downloading a Swagger API file. Search Search for a service by entering the service name in the text box provided 6.1 Testing a Service You can test a service using the predefined operations configured while creating the service. Select an operation from the drop-down list of a service. The selected operation displays a page with two toggles Request Input Request Output Request Input The Request Input page displays the input parameters for the selected services by Kony, Inc. All rights reserved 22 of 80

28 6. Orchestration Services Kony Integration Service Admin Console User Guide Field Input Method and URL By default, the input method of Orchestration service is considered as Post method and based on the method the input URL is predefined. Body The Body section displays the configured parameters. Enter the parameter values across each parameter name displayed. Header The header toggle displays the table with Field Name and Field Value as the headers. Enter the field name and provide the value for the header. - You can add rows to the table and enter the field name and values by clicking on Add icon. - You can delete the existing rows by clicking the Delete icon displayed across each row. Get Response Encodes the parameter name and field name with their values provided Response Output Once the request is passed to the back-end server, the response is displayed in the following sections: Section Response Header Based on the field name and values provided the header values are displayed in the Response Header section in the table format. Response Body Based on the configured parameters and the values provided. The response in Body section is displayed in the code format. To test a service, perform the following actions: 2014 by Kony, Inc. All rights reserved 23 of 80

29 6. Orchestration Services Kony Integration Service Admin Console User Guide 1. Login to Admin Console and click Orchestration Services from the left pane of the screen. 2. Click the drop-down list and select an operation of a service. 3. In the Request Input page, perform the following actions: i. Enter the parameter value across the parameter names displayed in the Body section. ii. In the Header toggle, enter the Field Name and Field Value. 4. Click Get Response. The response for the provided input parameters is displayed in the Response Header and Response Body sections of Response Output page by Kony, Inc. All rights reserved 24 of 80

30 7. Jobs Kony Integration Service Admin Console User Guide 7. Jobs A Kony Fabric user has an option to invoke published APIs with defined input through a definite schedule as a job. The scheduled jobs run on the server and send s automatically before the user s renewals expire. To access Kony Fabric Jobs in Admin Console, follow these steps: 1. Log on to Kony Fabric Console and click Environments. Under Environments, you can find all the consoles available for the cloud account. 2. Click Server to access the Admin Console. The Admin Console UI appears. 3. Click Jobs from the left pane of the screen. The new window appears with the list of jobs created. You can perform the following actions from the screen: Searching for an existing job Adding a new job The Jobs screen displays the following UI elements: 2014 by Kony, Inc. All rights reserved 25 of 80

31 7. Jobs Kony Integration Service Admin Console User Guide UI Eleme nt Name Name of the job. Updat ed by Name of the logged in user (provided at the time of registration). Succe ss Rate The rate of success and failure over the total number of scheduled intervals. Last run status Status of the last run performed by Kony, Inc. All rights reserved 26 of 80

32 7. Jobs Kony Integration Service Admin Console User Guide UI Eleme nt Job Status Current status of the job. This includes: Active/Inactive Status Scheduled Date and Time of the next run More options: An icon with a circle and three dots is displayed across each row. You can perform the following actions by clicking the icon: Field Name Edit Edit the selected job. View Job History View the history of the selected job. For detailed information on Job History page, refer <<>>. Inactive Deactivate an active job. Delete Delete the selected job. Run Once Now Ability to run the job immediately. 7.1 Searching for an existing job You can search for a job from the existing list of jobs displayed on the Jobs screen. To perform a search, follow these steps: 1. On the Jobs page, click the text field provided at the upper left corner. 2. Type a keyword by Kony, Inc. All rights reserved 27 of 80

33 7. Jobs Kony Integration Service Admin Console User Guide 3. Click the Search icon provided beside the text box. The page displays the list of jobs matching the entered search criteria. Job History You can view the history of a created job by clicking the More Options (a circle with three dots) and selecting View Job History option. Click the option to open a new window displaying the history of jobs. The Job History page displays the following UI elements: 7.2 Adding a new job You can create a new job for the Integration, Object, and Orchestration Services. To create a new job, click Add New from the upper right corner of the Jobs screen. The New Job windows displays the following three tabs: Job Info Define Schedule 2014 by Kony, Inc. All rights reserved 28 of 80

34 7. Jobs Kony Integration Service Admin Console User Guide Job Info The Job Info window displays the fields required to create a new job. Enter the required details in the fields provided: Field Name Name Enter the name of the job by Kony, Inc. All rights reserved 29 of 80

35 7. Jobs Kony Integration Service Admin Console User Guide Field Name Service Type Select the service type from the list: Integration Orchestration Object Services Service Name Select the service name from the displayed list. The service name displays the list of available services for the selected service type. Note: Based on the service type selected, the service name field displays the services created and published in Kony Fabric Console. Service Version Select the version number of the service. By default, the service version list displays the version number 1.0. The service version is predefined during the process of creating a service in Kony Fabric Console. Objects Select the objects for the selected service. The Objects list displays the predefined objects for the selected service. The objects field displays the services in Kony Fabric Console during the process of creating a service. Note: The Objects field is displayed only when the user selects the service type as Object Services. Operations Select the operation from the list. The operations are predefined while creating the service in Kony Fabric Console. Important: Public, Anonymous App User and Authenticated App User operations are available under Operations list while creating the Jobs by Kony, Inc. All rights reserved 30 of 80

36 7. Jobs Kony Integration Service Admin Console User Guide Field Name Service Security Level Based on the selected operation, the security level (Public, Anonymous App User or Authenticated App User) is displayed by Kony, Inc. All rights reserved 31 of 80

37 7. Jobs Kony Integration Service Admin Console User Guide Field Name Authentication For Anonymous App User and Authenticated App User operations, you have two options. You can select any option and provide your login credentials for authenticating the selected operation. Admin: If you are an admin, select the option and perform the following actions: Enter your login credentials Click Test to validate the login details. Note: Admin credentials are used only for the services which does not require the backend authentication. App User: App Users are considered as two types: Authenticated App User and Anonymous App User. Authenticated App User: On selecting a private operation, you are considered as an Authenticated App User. Anonymous App User: On selecting a protected operation, you are considered as an Anonymous App User. If you are an Authenticated App User (for Private operation), click the App User option and perform the following actions: App: Select the app to which the service is associated. Identity: Select the identity associated with the selected service. Username and Password: Provide the login credentials. Test: Click Test to validate the provided details. If you are an Anonymous App User (for Protected operation), click the App User option and select the app to which the service is associated. Note: Login credentials are not required for an Anonymous App User by Kony, Inc. All rights reserved 32 of 80

38 7. Jobs Kony Integration Service Admin Console User Guide Field Name History Strategy Displays the following options to view the job history. No History: History will not be tracked. Audit History: The history related to the audits is saved and displayed. Note: The history of request and response of the job run is not logged. Full History for Failed Runs: The complete history of failed runs is displayed. Full History for All Runs: The complete history of all the runs is displayed. History Retention Period Enter the period of history maintenance in the server. By default, the field displays 30 days as the retention period. Note: The server removes the history after the retention period expires. Enter the description of the new job created by Kony, Inc. All rights reserved 33 of 80

39 7. Jobs Kony Integration Service Admin Console User Guide Field Name notifications on Failure notifications are automatically sent by the server on the failure of the created jobs. The notifications contains the job failure information. You can select any of the following options for the notifications to be sent: All Account Owners: notifications are sent to all the owners of the logged in account. All Account Admins: notifications are sent to all the administrators of the logged in account. All Users with Full Access on this Environment: notifications are sent to all the users having full access to the environment associated to the logged in account. Custom Users List: You can customize the list of users by entering their address to receive the notifications. Cancel Abort the operation or cancel creating a new job. Next Proceed to the next screen. To create a new job, perform the following steps: 1. Click the Add New button from the top right corner of the Jobs screen. The Job Info window appears. 2. Enter/select the mandatory fields to create a new job. 3. Click Next to move to the next screen by Kony, Inc. All rights reserved 34 of 80

40 7. Jobs Kony Integration Service Admin Console User Guide Define In the process of creating a new job, you need to define the request input parameters. To access the Define window, perform the following actions: 1. Click Add New from the upper right corner of the Jobs screen. The New Job window displays the following three tabs: Job Info Define Schedule 2. Enter the required information in the fields displayed in the Job Info window and click Next. The Define window appears by Kony, Inc. All rights reserved 35 of 80

41 7. Jobs Kony Integration Service Admin Console User Guide The Request Input window displays the following fields: Field Operation The selected operation in the Add New window is displayed. URL The server URL for the selected service and operation is displayed. Query Params Enter the query parameter for the selected operation by Kony, Inc. All rights reserved 36 of 80

42 7. Jobs Kony Integration Service Admin Console User Guide Field Field Name All the field names provided while creating the service are displayed. Field Value Enter the field values across the field names. Get Response Select to parse the input values and get the response. To get the response parameters for the new job added, follow these steps: 1. In the Add New Job window, fill all the mandatory fields and click Next. The Define window appears. 2. Enter the query parameters against the selected operation. 3. Provide the field values against the field names displayed. 4. Click Get Response. The Response Output tab displays the response for the request parameters provided. The Response Header and Response Body sections display the response for the input parameters provided. Note: When user sets the string, it acts as a criteria for a job success or failure. If the specified string is present in the response output the job is considered as success, else the job is considered as a failure. After entering the success criteria, you can click Test to check the number of matches for the string in response. Note: Success criteria can be set only for the responses whose opstatus is Click Next. The Schedule window appears by Kony, Inc. All rights reserved 37 of 80

43 7. Jobs Kony Integration Service Admin Console User Guide Note: The job might fail with an error Internal error during job execution, if the service does not return proper JSON response or if the service is modified/deleted after creating the job Schedule You can schedule the next run of an active job by setting the timer in the Schedule page. The scheduler displays the date and time fields to set the timer. To access the Schedule window, perform the following actions: 1. Click the Add New button from the top right corner of the Jobs screen. The New Job window appears with three tabs. Job Info Define Schedule 2. In the Job Info window, fill the required fields and click Next. The Define window appears. 3. Enter the request parameters to receive the response parameters. 4. Once you receive the response output, click Next. The Schedule window appears by Kony, Inc. All rights reserved 38 of 80

44 7. Jobs Kony Integration Service Admin Console User Guide The Schedule window displays the following fields: Field Name Every The time frame displays: Hour Minute Day Week Month Hour Select the time (in hours) to run the job. You need to select the hour and minute to schedule the time to run a job. Note: This field is inactive when you select Hour from the Every list 2014 by Kony, Inc. All rights reserved 39 of 80

45 7. Jobs Kony Integration Service Admin Console User Guide Field Name Minute Select the minute field to schedule the next run of the selected job. Day Displays the hour and minute fields. Select the time frame to schedule the run for the job, Note: By default, the Day option displays the current date. Week Determines the specific day of a week to run the job. Selecting this option displays the day (with the names of days of a week), hour and minute. Select the day of a week and the time frame to schedule the run. Month Displays the Date and Time fields. Select the date in a month and the time frame to schedule the run for the selected job. To schedule the run of an active job, follow these steps: 1. Click Add New in the Jobs page. 2. On the Add Jobs page, enter the required information in all the fields in Job Info window and click Next. 3. Enter the required information in all the fields in Define page and click Next. 4. In the Schedule window, click the Every field list and select a time frame. The selected time frame displays the remaining fields depending on the field selected. 5. Select the time frame and click Save and Schedule by Kony, Inc. All rights reserved 40 of 80

46 7. Jobs Kony Integration Service Admin Console User Guide Limitations Only identities that have username and password are supported to authorize. Oauth logins such as Facebook, Google etc. are not supported. You may also not see these oauth identities under identity drop-down. API Proxy services and response pass-through services are not supported by Kony, Inc. All rights reserved 41 of 80

47 8. Health Check Kony Integration Service Admin Console User Guide 8. Health Check Health check of Admin Console displays the access status of the different databases. The databases displayed in the page are responsible for retrieving the data to be displayed in the Admin Console. A list of four databases with their status is displayed. The databases listed in the page are: Access to Reports DB Access to Admin DB Access to Reporting Queue Access to Storage DB The status of the connection to the database is displayed in the health check screen. If the connection to access a particular database is lost, the status across that database is displayed as FAILED by Kony, Inc. All rights reserved 42 of 80

48 9. Reports Kony Integration Service Admin Console User Guide 9. Reports As a part of Admin Console, a standard set of application metrics are gathered and made available to end users as reports. These reports are generated based on few parameters such as the application usage, service duration, number of requests received and legacy details such as traffic reports for service, for visitors and more. You have two different types of reports such as Basic reports and Legacy reports. Basic Reports: A basic report is generated to filter the data such as application usage, service duration, Requests per service and more. You can configure the data using the basic authentication to generate a basic report. For detailed information, refer Basic Reports. Legacy Reports: To generate a legacy report you must configure the konyreports.home environment in your system. A legacy report can be generated to filter the traffic of various applications/platforms. For detailed information, refer Legacy reports. Reports Settings: Different types of report settings are displayed in the Settings page. Using the report settings you can modify the displays of the reports, change the timezone and modify the meta data mapping. For detailed information, refer Reports Settings. 9.1 Basic Reports A basic report is generated after the application is deployed. You can view the following statistics of an app from the Report drop-down: 2014 by Kony, Inc. All rights reserved 43 of 80

49 9. Reports Kony Integration Service Admin Console User Guide Statistics App Usage Displays the usage of an app in used sessions and users. Users are based on the developers using the setkonyuserid() method. If the method is not used, the report counts the unique Device IDs and considers each device as a unique user. Requests per Service A total number of requests to each serviceid associated with the application. Requests per Form Total requests to form in the application. Sessions per Device Total sessions categorized by platform, channel and app type. Service Duration A total number of calls per application service including the min, average and max time taken. Service Duration Detail View average service call duration as a stacked bar showing the time taken for each phase of the service call. To generate a basic report, perform the following actions: 1. Select a report type from the Report drop-down list. 2. Set the date range (Start Date and End Date) for which the report is to be generated. 3. Select the application name from Application drop-down list. The list of applications deployed is displayed. 4. Select the platform from the Platform drop-down list. 5. Select a channel from the Channel drop-down list by Kony, Inc. All rights reserved 44 of 80

50 9. Reports Kony Integration Service Admin Console User Guide 6. Select an application type from the Application Type drop-down list. The available values include Hybrid, Mixed Mode, Mobile Web, Native, and SPA. 7. Select the aggregation of the report from the Aggregation list. The available aggregation values are Day, Month, and Week. 8. Click Generate. A basic report is generated with the selected parameters by Kony, Inc. All rights reserved 45 of 80

51 Kony Integration Service Admin Console User Guide 9.2 Reports As a part of Admin Console, a standard set of application metrics are gathered and made available to end users as reports. These reports are generated based on few parameters such as the application usage, service duration, number of requests received and legacy details such as traffic reports for service, for visitors and more. You have two different types of reports such as Basic reports and Legacy reports. Basic Reports: A basic report is generated to filter the data such as application usage, service duration, Requests per service and more. You can configure the data using the basic authentication to generate a basic report. For detailed information, refer Basic Reports. Legacy Reports: To generate a legacy report you must configure the konyreports.home environment in your system. A legacy report can be generated to filter the traffic of various applications/platforms. For detailed information, refer Legacy reports. Reports Settings: Different types of report settings are displayed in the Settings page. Using the report settings you can modify the displays of the reports, change the timezone and modify the meta data mapping. For detailed information, refer Reports Settings Basic Reports A basic report is generated after the application is deployed. You can view the following statistics of an app from the Report drop-down: 2014 by Kony, Inc. All rights reserved 46 of 80

52 Kony Integration Service Admin Console User Guide Statistics App Usage Displays the usage of an app in used sessions and users. Users are based on the developers using the setkonyuserid() method. If the method is not used, the report counts the unique Device IDs and considers each device as a unique user. Requests per Service A total number of requests to each serviceid associated with the application. Requests per Form Total requests to form in the application. Sessions per Device Total sessions categorized by platform, channel and app type. Service Duration A total number of calls per application service including the min, average and max time taken. Service Duration Detail View average service call duration as a stacked bar showing the time taken for each phase of the service call. To generate a basic report, perform the following actions: 1. Select a report type from the Report drop-down list. 2. Set the date range (Start Date and End Date) for which the report is to be generated. 3. Select the application name from Application drop-down list. The list of applications deployed is displayed. 4. Select the platform from the Platform drop-down list. 5. Select a channel from the Channel drop-down list by Kony, Inc. All rights reserved 47 of 80

53 Kony Integration Service Admin Console User Guide 6. Select an application type from the Application Type drop-down list. The available values include Hybrid, Mixed Mode, Mobile Web, Native, and SPA. 7. Select the aggregation of the report from the Aggregation list. The available aggregation values are Day, Month, and Week. 8. Click Generate. A basic report is generated with the selected parameters by Kony, Inc. All rights reserved 48 of 80

54 Kony Integration Service Admin Console User Guide 9.3 Legacy Reports The legacy reports tab will point to legacy data source and you can generate reports on them. Note: To access the legacy reports database, ensure that you have configured konyreports.home environment property points to a valid directory and a JNDI entry for konyadminreports.jndi.name exists to access the Legacy reports database. Legacy Reports is only needed if you have upgraded from a 5.x Kony Server instance and need to run reports on data captured before the 6.x upgrade. You can generate the following legacy reports in Kony Fabric Integration Service Admin Console portal: Report Traffic Report Service Requests (Native/SPA) Traffic report for the service requests received. Traffic Report Visitors (Native/SPA) Traffic report for the session invoked by visitors by Kony, Inc. All rights reserved 49 of 80

55 Kony Integration Service Admin Console User Guide Report Device Summary Report (Thin client) Summary report of the page views per thin client platform with date aggregation modes day, week, and the month. Traffic Report-TC-Page Views Traffic report of the page view per thin client platform. Traffic Report TC - Visitors Traffic report of the session invoked by visitors per thin client platform. To generate a legacy report, perform the following actions: 1. Log in to the Admin Console and click Reports from the left pane of the screen. By default, the Basic Reports screen is displayed. 2. In the Basic Reports screen, click Legacy Reports tab from the top pane. The Legacy Reports screen is displayed. 3. Click the Report drop-down list and select the appropriate report to be generated. 4. Click the Application drop-down list and select an application. All applications deployed are available in the list. 5. Select the Data Range for which the report should be generated. 6. Select the Platform under which the report should be generated. 7. Select the Channel under which the report should be generated. 8. Select the Start Date and End Date for the report to be generated. 9. Select the Application Type from the drop-down list by Kony, Inc. All rights reserved 50 of 80

56 Kony Integration Service Admin Console User Guide 10. Click Generate to generate a legacy report based on the criteria selected. A legacy report with the provided criteria is displayed on the screen. 11. You can download the generated report by clicking on Download as CSV option by Kony, Inc. All rights reserved 51 of 80

57 Kony Integration Service Admin Console User Guide 9.4 Configuring Report Settings You can configure the report display settings for the following areas: 1. Report Display Settings: Configure report display settings, application types, channel types, and time zones. 2. Report MetaData Mapping: Reports can display additional metadata about each service to enhance the readability of the report. The Service ID is returned from the data warehouse and you can specify a service friendly name, an associated menu which is related to the service call and/or an associated user event name which triggers at service call. 3. Form MetaData Mapping: Reports can display additional metadata about each page or form within the app to enhance the readability of the report. The Form ID is returned from the data warehouse and you can specify a form friendly name, an associated menu which is related to viewing that form and/or an associated user event name that triggers the form to load. 9.5 Report Display Settings Add or remove the platform types, application types, and channel types in the Report Display Settings area by Kony, Inc. All rights reserved 52 of 80

58 Kony Integration Service Admin Console User Guide Add or Delete Platform Type Set the platform type names you require to be displayed in the platform aggregation selection box while creating a report. 1. To add a platform type, click Add. 2. To delete a platform type, click Delete across each row displayed Add or Delete Application Types Set the application type strings which you require to be displayed in the platform aggregation selection box while creating a report. 1. To add an application type, click Add. 2. To delete an application type, click Delete Channel Types Set the channel type names you require to be displayed in the platform aggregation selection box while creating a report. 1. To add a channel type, click Add. 2. To delete a channel type, click Delete Time Zone The time zone offset feature is used to calculate the delta of the timezone in which the customer wants to view the reports from UTC. The timezone offset feature is used in all queries to convert data from UTC to user s timezone. Default will be UTC by Kony, Inc. All rights reserved 53 of 80

59 Kony Integration Service Admin Console User Guide 9.6 Report MetaData Mapping The Report meta data mapping feature helps you add, edit, and delete the meta data mappings. To add or delete a service meta data mapping, follow these steps 1. Click Add to add a new row. 2. Select an application ID from the Application ID drop-down list. 3. Enter the service ID in the Service ID text box. 4. Enter a service friendly name in Service Friendly Name box. 5. Enter the associated menu in Associate Menu box. 6. Enter the associated user event in Associated User Event box. : 7. Click Save. The mapping is created. 8. To edit an existing mapping, select the mapping and click Edit. 9. To delete a service meta data mapping, select the mapping and click Delete. 9.7 Form MetaData Mapping The Form meta data mapping helps you add, edit, and delete the meta data mappings of a form by Kony, Inc. All rights reserved 54 of 80

60 Kony Integration Service Admin Console User Guide To add or delete a form meta data mapping, follow these steps: 1. Click Add to add a new row in form metadata mapping. 2. Select the application ID from the Application ID drop-down list. 3. Enter the form ID in the Form ID text box. 4. Type the form friendly name in Form Friendly Name text box. 5. Enter the menu associated in Associate Menu text box. 6. Type the associated user event in Associated User Event text box. 7. Click Save. The form metadata mapping is created. 8. To edit an existing mapping, select the mapping and click Edit. 9. To delete a service meta data mapping, select the mapping and click Delete by Kony, Inc. All rights reserved 55 of 80

61 10. Settings Kony Integration Service Admin Console User Guide 10. Settings The Settings page of Admin Console consists of four modules. Logging Configurable Parameters Runtime Configuration Environment Details Logging: In the process of managing the admin console, we need to track the performance of the server and other client filters. Admin console provides a comprehensive and flexible way of logging. The logging feature explains different types of logs and ways of tracking the logs. For detailed information, refer Logging. Configurable Parameters: Configurable parameters allows you to configure a set of key value pairs that can be accessed by all the services in Kony Fabric and client applications. For more information, refer Configurable Parameters. Runtime Configuration: Runtime configuration enables you to view the configuration settings in the Kony Fabric Integration Server. For more information, refer Runtime Configuration. Environment Details: The section is used to record the details of the environment on which the Kony server is used. For detailed information, refer Environment Details Logging A log file is automatically created and maintained by the server. The log file displays the list of activities performed by the device and the server. The Logging page in the Settings displays the ways of tracking different types of logs which are displayed in Admin Console by Kony, Inc. All rights reserved 56 of 80

62 10. Settings Kony Integration Service Admin Console User Guide Request and Response Trace Logs: The request and respond trace logs allow you to trace all the incoming requests and response payloads from the client to middleware and middleware to the backend server. Trace All Client Request and Response: Click the check box to trace all the incoming requests and response payload from clients. Trace All Back-end Request and Response: Click the check box to trace all the incoming requests and response payload from the back-end. Note: Enabling full request and response trace logs will impact the server performance. So, do not enable the trace for long periods or during the high traffic Log Level by Class In the Log Level by class, we can set the default root log level for a particular class/package by Kony, Inc. All rights reserved 57 of 80

63 10. Settings Kony Integration Service Admin Console User Guide To configure log level for class/package 1. Provide the class/package name in the text box provided under the Log level by class section. 2. Set the log level for each class/package by selecting the type of log level from the drop-down. The various types of log levels are: TRACE: The trace log level displays the detailed information of the server and the service operations. The information in the file includes operations performed by the client, middleware and the back-end server. DEBUG: The debug log level displays the detailed information which is useful to debug the incoming requests or response payloads in different log files. INFO: Displays the log level informational messages which highlight the progress of the application. WARN: Displays the warning messages which occur while capturing incoming requests and response payloads. ERROR: Displays the error messages which occur while capturing incoming requests and response payloads but still allows the application to continue running. FATAL: Displays the severe error messages which leads the application to abort. OFF: Turns off the logging.. 3. Click Save after completing all the configurations Log Level by Client Filter The log level by client filter displays the server side log level for the specific request based on the user ID, client IP and service name by Kony, Inc. All rights reserved 58 of 80

64 10. Settings Kony Integration Service Admin Console User Guide To filter the log level by client, follow these steps: 1. Select the parameter by clicking the drop-down menu. The parameter values are: o IP address o Login ID o Service ID 2. IP Address: Select the IP Address option in Select Parameter drop-down and provide the client IP address in the adjacent text box. 3. Similarly for Login ID and Service ID, select the option from the Select Parameter drop-down and provide the required details. 4. Click Enable Log Level Override from Client checkbox to enable the log level override from client. The feature helps the client to send a request header named X-Kony-Log-Level- Override to the server during a service invocation. The feature further sets the server side log level for the specific request allowing the client to turn on and off debug for their session. Click Save to save the changes done in the Logging page. Click Cancel to abort the changes by Kony, Inc. All rights reserved 59 of 80

65 10. Settings Kony Integration Service Admin Console User Guide 10.2 Configurable Parameters Admin Console provides an interface to define a set of key value pairs at the server and the client level. You can access the configured server and client properties from the custom code. The configured properties are available to custom code such as preprocessor, postprocessor and Java services at run time. Any updates made to the configured properties are reflected in the custom code. Click Settings from the left pane of the Admin Console and click Configurable Parameters tab, to define the key value pairs. You can configure the parameters at the server level and the client level. The Server properties tab is selected, by default. The server properties configured on a server are available to all the backend services running on that server. Client Properties are available to any client app that has permission to access the server. These properties can be read from Java or JavaScript logic associated to the service. The following fields are displayed in this screen: Field Field Name Enter the name of the key value pair. Field Value Enter the value of the key value pair by Kony, Inc. All rights reserved 60 of 80

66 10. Settings Kony Integration Service Admin Console User Guide Field Save Click Save to save the entered information. Cancel Click Cancel to reset the changes. Delete Mouse over across the existing key value pair, a delete icon is displayed across the field. Click the icon to delete the created key value pair. Search You can search the existing key value pairs by entering the field name (or) field value and clicking on search icon. Note: Steps (provided below) for adding or deleting a key value pair for server properties and client properties are same Adding a key value pair To add a set of key value pairs, perform the following actions: Log on to Admin Console and click Settings from the left pane of the screen. Click Configurable Parameters tab from the top pane of the settings screen. Enter a field name and field value to configure the key value pairs. Click Save to save the changes Deleting a key value pair To delete an existing key value pair, perform the following actions: Log on to Admin Console and click Settings from the left pane of the screen. Click Configurable Parameters tab from the top pane of the settings screen by Kony, Inc. All rights reserved 61 of 80

67 10. Settings Kony Integration Service Admin Console User Guide Mouse over a key value pair and you can find a delete icon across the selected row. Click the icon to delete the key value pair. Add the following code (highlighted in Blue) to the existing code to access the configured properties from Java PostProcessor: Access properties from Java PostProcessor: package com.custom.preprocessor; import com.konylabs.middleware.common.datapostprocessor2; import com.konylabs.middleware.controller.datacontrollerrequest; import com.konylabs.middleware.controller.datacontrollerresponse; import com.konylabs.middleware.dataobject.param; import com.konylabs.middleware.dataobject.result; import com.konylabs.middleware.api.configurableparametershelper; import com.konylabs.middleware.api.servicesmanager; import java.util.map; public class ServerConfigParamsPostProcessor implements DataPostProcessor2 public Object execute(result result, DataControllerRequest request, DataControllerResponse response) throws Exception { ServicesManager sm = request.getservicesmanager(); ConfigurableParametersHelper paramhelper = sm.getconfigurableparametershelper(); // encryption is the key configured under Server Properties tab in Admin console String myserverparam = paramhelper.getserverproperty("encryption"); // MAX_EVENTS_SIZE is the key configured under Client App Properties 2014 by Kony, Inc. All rights reserved 62 of 80

68 10. Settings Kony Integration Service Admin Console User Guide in Admin Console String myclientparam = paramhelper.getclientappproperty("max_events_ SIZE"); Map<String, String> serverproperties = paramhelper.getallserverproperties(); Map<String,String> clientappproperties = paramhelper.getallclientappproperties(); } return result; } } Add the following code (highlighted in Blue) to the existing code to access the configured properties from Java PreProcessor: Access Properties from Java Preprocessor: package com.custom.preprocessor; import com.konylabs.middleware.common.datapreprocessor2; import com.konylabs.middleware.controller.datacontrollerrequest; import com.konylabs.middleware.controller.datacontrollerresponse; import com.konylabs.middleware.dataobject.param; import com.konylabs.middleware.dataobject.record; import com.konylabs.middleware.dataobject.result; import com.konylabs.middleware.api.configurableparametershelper; import com.konylabs.middleware.api.servicesmanager; import java.util.hashmap; import java.util.map; public class ServerConfigParams implements DataPreProcessor2 public boolean execute(hashmap inputmap, DataControllerRequest 2014 by Kony, Inc. All rights reserved 63 of 80

69 10. Settings Kony Integration Service Admin Console User Guide request, DataControllerResponse response, Result result) throws Exception { ServicesManager sm = request.getservicesmanager(); ConfigurableParametersHelper paramhelper = sm.getconfigurableparametershelper(); // encryption is the key configured under Server Properties tab in Admin console String myserverparam = paramhelper.getserverproperty("encryption"); // MAX_EVENTS_SIZE is the key configured under Client App Properties in Admin Console String myclientparam = paramhelper.getclientappproperty("max_events_ SIZE"); Map<String, String> serverproperties = paramhelper.getallserverproperties(); Map<String, String> clientappproperties = paramhelper.getallclientappproperties(); return true; } } Add the following code (highlighted in Blue) to the existing code to access the configured properties of JavaScript Pre and Post Processor. var paramhelper = request.getservicesmanager ().getconfigurableparametershelper(); var serverprop = paramhelper.getserverproperty('encryption'); var clientprop = paramhelper.getclientappproperty('max_events_ SIZE'); var serverparam = new com.konylabs.middleware.dataobject.param 2014 by Kony, Inc. All rights reserved 64 of 80

70 10. Settings Kony Integration Service Admin Console User Guide ('encryption', serverprop); var clientparam = new com.konylabs.middleware.dataobject.param('max_ EVENTS_SIZE', clientprop); result.addparam(serverparam); result.addparam(clientparam); // allserverprops and allclientprops is of Map<String,String> type var allserverprops = paramhelper.getallserverproperties(); var allclientprops = paramhelper.getallclientappproperties(); var serverpropertykeyset = allserverprops.keyset().toarray(); for(var index=0; index<serverpropertykeyset.length; index++){ var serverpropfrommap = allserverprops.get(serverpropertykeyset [index]); var serverparamfrommap = new com.konylabs.middleware.dataobject.param(serverpropertykeyset [index], serverpropfrommap); result.addparam(serverparamfrommap); } var clientpropertykeyset = allclientprops.keyset().toarray(); for(index=0; index<clientpropertykeyset.length; index++){ var clientpropfrommap = allclientprops.get(clientpropertykeyset [index]); var clientparamfrommap = new com.konylabs.middleware.dataobject.param(clientpropertykeyset [index], clientpropfrommap); result.addparam(clientparamfrommap); } 2014 by Kony, Inc. All rights reserved 65 of 80

71 10. Settings Kony Integration Service Admin Console User Guide 10.3 Runtime Configuration The Runtime Configuration tab on the Settings screen of Admin Console enables you to view the configuration settings of the Kony Fabric Integration Server. The configuration details comprises of the following sections: General Configuration Log Configuration CORS Configuration SSL Configuration Metrics Configuration Storage Database Configuration Memcache Configuration General Configuration The General Configuration section displays the general settings of the Kony server. You can modify the settings of each feature, which appears in the list by selecting the available options and clicking Save to save the settings. The following image displays the options in the General Configuration section by Kony, Inc. All rights reserved 66 of 80

72 10. Settings Kony Integration Service Admin Console User Guide The following table describes the UI elements of General Configuration section: Property Name JSON Array Support Select the option to honor the JSON array support in response. Send Default User Agent Select the option to send the default user agent to the back end. The default user agent value is Mozilla/5.0 (Windows; U; Windows NT 5.1; en-us; rv: ) Gecko/ Firefox/3.5.7 (.NET CLR ) by Kony, Inc. All rights reserved 67 of 80

73 10. Settings Kony Integration Service Admin Console User Guide Property Name Accept only Gzip Compression for Endpoint Response If you select the option, gzip is sent as one of the accept-encoding formats in the request. Exclude Stacktrace from Logs Select the option to exclude stack trace messages in logs. Do not Escape XML Special Characters Enter the special characters that should not be excluded from the request template of XML and SOAP Services. Exclude Parameters in Request and Response Enter the sensitive parameter names to mask in the request/response. Exclude Input Parameters from Log Context (NDC) Enter the input parameters to exclude from the NDC context of logs. NDC Delimiter You can specify the NDC Delimiter apart from the default character \n. Server Time Frequency (milliseconds) Enter the delay in server time frequency in milliseconds. Server Time Delay in Startup (milliseconds) Enter the delay during the starting of the server in milliseconds. Number of Server Nodes for Throttling Set the number of nodes to configure API Throttling. Kony Reports Year Drop down Offset Enter the number of years to be displayed in the Reports tab of Admin Console. Kony Services Context Path Enter the default context path, /middleware, or /services. Save Click Save to save your changes by Kony, Inc. All rights reserved 68 of 80

74 10. Settings Kony Integration Service Admin Console User Guide Log Configuration The Log Configuration section displays the configuration settings of the server logs. You can modify the settings of each feature, which appears in the list by selecting the available options and clicking Save to update the changes. The following image displays the properties of the Log Configuration section: The following table describes the UI elements of the Log Configuration section: Property Name Server Log Option Select the log option from the list to specify how and where the logs can be collected. The available log options are as follows: Log file. User specified log file. Database. Logs are stored in the database of the server_application_log table in your admindb. Syslog. Logs stored in the respective system logs by Kony, Inc. All rights reserved 69 of 80

75 10. Settings Kony Integration Service Admin Console User Guide Property Name Server Log Location Enter the location of the server logs. Note: If you select the Database or Syslog as the Server Log Option, the Server Log Location field will be deactivated, you cannot edit it. Server Logger JNDI Name Enter the JNDI name for the serve logs. Note: You cannot edit the Server Logger JNDI Name field, if you select Logfile or Syslog as the Server Log Option. Save Click Save to save the changes CORS Configuration The CORS Configuration section displays the configuration settings of the Kony server access control. You can modify the settings of each feature, which appears in the list by selecting the available options and clicking Save to update the changes. The following image displays the properties of the CORS Configuration section with their values: The following table describes the UI elements of the CORS Configuration: 2014 by Kony, Inc. All rights reserved 70 of 80

76 10. Settings Kony Integration Service Admin Console User Guide Property Name CORS Enabled Select the CORS Enabled check box to enable the Cross Origin Resource Sharing mechanism. Kony Server Access Control Allow Origin Value If you set the Kony Server Access Control Allow Origin Value to ALL. Sets the value as '*' for Access-Control-Allow-Origin header. NONE. Does not add Access-Control-Allow-Origin header in the response. ECHO. Adds the value of Origin header as the Access- Control-Allow-Origin header in the response. Kony Server Access Control Echo Whitelist Domains If you set the Kony Server Access Control Allow Origin Value as: ALL. Accepts the CORS request from any domain. NONE. Sets the Kony Server Access Control Echo Whiltelist Domains as blank, as all the domains are echoed without whitelisting. ECHO. Adds a whitelist comma separated by a domain(s) to Kony Server Access Control Echo Whiltelist Domains. Save Click Save to save your changes SSL Configuration The SSL Configuration section is used to connect the Kony Server to the customer enterprise server. This type of configuration is required only when you want to connect the Kony Server by using the HTTPS protocol. You can modify the settings of each feature, which appears in the list by selecting the available options and clicking Save to update the changes. The following image displays the properties of the SSL Configuration section with their values: 2014 by Kony, Inc. All rights reserved 71 of 80

77 10. Settings Kony Integration Service Admin Console User Guide The following table describes the UI elements of the SSL Configuration section: Property Name SSL Trust Store Displays the SSL Trust store location where the public SSL certificates are stored. SSL Key Store Displays the SSL Key store location where the private SSL certificates are stored. SSL Trust Store Password Displays the password to unlock the SSL Trust Store file. SSL Key Store Password Displays the password to unlock the SSL Key Store file. SSL Key Store Type Displays the extension of the SSL Key Store file. By default, it is jks. SSL Trust Store Type Displays the extension of the SSL Trust Store file, By default, it is jks by Kony, Inc. All rights reserved 72 of 80

78 10. Settings Kony Integration Service Admin Console User Guide Property Name SSL Algorithm Displays the algorithm of SSL. For IBM application servers, the algorithm value is SSLv3. For any other application server, the algorithm value is TSL. SSL Socket Factory Provider Displays the security provider of SSL Socket Factory. SSL Server Socket Factory Provider Displays the security provider of SSL Server Socket Factory. SSL Socket Factory Host Name Verifier Select the SSL Socket Factory Host Name Verifier: BROWSER_COMPATIBLE_HOSTNAME_VERIFIER. Allows you to connect to the servers having wild card certificate as *.abc.com, abc.com, child.abc.com. ALLOW_ALL_HOSTNAME_VERIFIER. Allows you to connect to the servers having self-signed certificate. For self-signed certificate, change value to ALLOW_ ALL_HOSTNAME_VERIFIER. STRICT_HOSTNAME_VERIFIER. Allows you to connect to the servers with the specific host name. Save Click Save to save your changes Metrics Configuration The Metrics Configuration section displays the configuration properties of metric operations in the Kony server. You can modify the settings of each feature, which appears in the list by selecting using the available options and clicking Save to update the changes. The following image displays the properties of the Metrics Configuration section with their values: 2014 by Kony, Inc. All rights reserved 73 of 80

79 10. Settings Kony Integration Service Admin Console User Guide The following table describes the UI elements of the Metrics Configuration section: Property Name Metrics Topic Name Name of the metrics topic. By default, the installer assigns KonyMetricsTopic as the name of the metrics. Note: If you choose to install manually, you must provide the alterative name of your metrics and restart the server. Metrics Topic Connection Factory Name Similar to Metrics Topic Name, the admin console displays the name of the Metrics Topic Connection Factory. By default, the installer assigns the name as KonyConnectionFactory. Metrics Initial Context Factory Name Displays the classpath of the Initial Context Factory. Example for JBoss 7 EAP: org.jboss.naming.remote.client.initialcontextfactory 2014 by Kony, Inc. All rights reserved 74 of 80

80 10. Settings Kony Integration Service Admin Console User Guide Property Name Metrics Provider URL Displays the URL at which your messaging server is running. For example: <protocol>://<ip>:<port> Metrics Security Principal Displays the security principal for the metrics. Metrics Security Credentials Displays the security credentials for the metrics. Metrics User Name The username for accessing the metrics. Metrics Password The password for accessing the metrics. Metrics URL Package Prefixes The JNDI name for the URL package. Save Click Save to save your changes Storage Database Configuration The Storage Database Configuration section displays the properties of database structures of Kony server. You can modify the settings of each feature, which appears in the list by selecting the available options and clicking Save to update the changes. The following image displays the properties of the Storage Database Configuration section with their values: 2014 by Kony, Inc. All rights reserved 75 of 80

81 10. Settings Kony Integration Service Admin Console User Guide The following table describes the UI elements of Storage Database Configuration section: Property Name Database Type Displays the type of database on which the server is running. Database Host Name Displays the host name of the database. Database Port Displays the port number at which your database is running. The installer assigns a default port number to your database. Database User Name Displays the username for accessing the database. Database Password Displays the password for accessing the database by Kony, Inc. All rights reserved 76 of 80

82 10. Settings Kony Integration Service Admin Console User Guide Property Name Database Instance Displays the name of the database instance created. Note: Database instance is created only for Oracle database type. Data Tablespace Name Displays the name of the tablespace in which the data is stored logically. Note: The data tablespace name is applicable only for the Oracle database type. Index Tablespace Name Displays the name of the index created in the tablespace. Note: The index tablespace name is applicable only for the Oracle database type. LOB Tablespace Name Displays the name of the large object tablespace created in the server. Note: The LOB tablespace name is applicable only for the Oracle database type. SQL Server Default Schema Displays the default schema of the SQL server database. Note: The SQL Server Default Schema field is noneditable for database types other than SQL Server. Max Allowed Connections Enter the maximum number of allowed connections to access the database by Kony, Inc. All rights reserved 77 of 80

83 10. Settings Kony Integration Service Admin Console User Guide Property Name Connection Timeout in Seconds Sets the time out interval for server to reply to the client request for the Storage services. Save Click Save to save your changes Memcache Configuration The Memcache Configuration section displays the properties of the memory caching system in the Kony server. You can modify the settings of each feature, which appears in the list by selecting the available options and clicking Save to update the changes. The following image displays the properties of the Memcache Configuration section with their values: The following table describes the UI elements of the Memcache Configuration section: 2014 by Kony, Inc. All rights reserved 78 of 80

84 10. Settings Kony Integration Service Admin Console User Guide Property Name Memcache Custer Domains Displays the IP/Host name of the Memcache server. For Example : Memcache Cluster Domains = <IP>:<PORT> Memcache Number of Clients Displays the number of clients that can connect to the Memcache server. Memcache Store Timeout (milliseconds) Displays the maximum time allowed (in milliseconds) to store data in the Memcache server. Note: If the data is not stored within the specified time then the server triggers a timeout. Memcache Store Attempts Displays the number of attempts allowed to store data in the Memcache server. Memcache Retrive Attempts Displays the number maximum retry attempts to retrieve the data from the Memcache server. Memcache Expiry (Seconds) Displays the expiry time (in seconds) to store the data in the Memcache server. Memcache ID Transport Displays the mode of transport for cacheid. Possible values are COOKIE_ONLY, PARAM_ONLY, or EITHER. Memcache ID Cookie Path Displays the context path for cacheid in the cookie header. Memcache Cookie Secured Select the check box to secure the cookie header. Save Click Save to save your changes by Kony, Inc. All rights reserved 79 of 80

85 10. Settings Kony Integration Service Admin Console User Guide 10.4 Environment Details The environment details page displays the environments details of the Kony server. This page displays a table with two columns the Property Name and Property Value. The Property Name column displays the names of different properties such as the version of the Kony server used, the Gateway version, the JNDI name, JNDI version, Operating system on which the Kony server is installed, Environment Name, Environment API version and so on. The Property Value column displays the value against each property name displayed in the table by Kony, Inc. All rights reserved 80 of 80