IntegrationService AppServicesUserGuide On-Premises

Kony Fabric

Integration Service

App Services User Guide

On-Premises

Release V9Document 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 pageRemember to always view and download the latest document version relevant to the software release you are using

copy 2014 by Kony Inc All rights reserved 1 of 191

Kony Fabric App Services User GuideVersion17

Copyright copy 2014 Kony Inc

All rights reserved

September 2019

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 andmethods 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 andWindows Vista are registered trademarks of Microsoft

Corporation Apple the Apple logo iTunes iPhone iPad OS X Objective-C Safari Apple Pay AppleWatch

and Xcode are trademarks or registered trademarks of Apple Inc Google the Google logo Android and the

Android logo are registered trademarks of Google Inc Chrome is a trademark of Google Inc BlackBerry

PlayBook Research inMotion and RIM are registered trademarks of BlackBerry SAPreg and SAPreg Business

Suitereg are registered trademarks of SAP SE in Germany and in several other countries All other terms

trademarks or servicemarks mentioned in this document have been capitalized and are to be considered the

property of their respective owners


1 Revision History Kony Fabric App Services User GuideVersion17

1 Revision History

Date DocumentVersion

Description of ModificationsRelease

09302019 10 Updated the document for V9 release

l Added Server Monitoring to view the real time

analytical data about server events

l Updated Runtime Configuration to configure

throttling at service operation level



Table of Contents

1 Revision History 3

2 Launching App Services 9

21 Functional Flow 10

3 Web Apps 12

31 Test aWeb App 13

32 Delete an Application 14

4 Monitoring 15

41 Service 16

411 Export as CSV 21

412 CustomTimeRange 22

413 Node Filter 24

414 Threshold 24

415 Notifications 27

416 Configuring Email Alerts (On-Premises) 30

42 Environment 38

43 Server EventsMonitoring 42

5 Integration Services 50

51 Testing a Service 51

511 Request Input 51

512 ResponseOutput 53



52 Downloading a Swagger API File 55

6 Object Services 57

61 Hard Delete option for Storage Services using the X-Kony-Soft-Delete Flag 58




7 Orchestration Services 65




8 Workflow Services 69

9 Jobs 72

91 Searching for an existing job 74

92 Adding a new job 75

921 Job Info 76

922 Define 82

923 Schedule 85

93 Scheduling Job APIs 88

931 Get All Jobs 88

932 Get All Job Details with Job ID 91

933 Create a Job 96



934 Update a Job 102

935 Delete a Job with Job ID 108

936 Get Job History 109

937 Run a Job Now 111

938 Accounts Login API 113

10 Health Check 115

11 Logs 117

111 Standard Logs 117

1111 Log Level by Class 118

1112 Log Level by Client Filter 121

1113 Cloud Logs 125

112 Trace Logs 134

1121 Log Configuration 137

1122 Copy the Payload 139

1123 Customize Http Request (or) Response 140

1124 Export Logs 141

1125 Clear Logs 142

12 Settings 144

121 Configurable Parameters 144

1211 Adding a key value pair 146

1212 Deleting a key value pair 147



1213 Export the key value pair list 148

1214 Import the key value pair list 149

1215 Access properties from Java PostProcessor 150

1216 Access properties of Java PreProcessor 151

1217 Access properties of Java PreProcessor and PostProcessor 153

122 RuntimeConfiguration 154

1221 General Configuration 155


1223 CORS Configuration 158

1224 SSLConfiguration 159

1225 Storage Database Configuration 161

1226 GDPR Policy 162

1227 File Storage Configuration 163

1228 Web AppsConfiguration 163

1229 Cache Configuration 166

12210 Global Throttling Configuration 169

123 Environment Details 171

124 SSLCertificates 172

125 Add Certificate 175

1251 One-way SSL 175

1252 Two-way SSL 177



1253 Delete a Certificate 180

13 Downloads 181

14 Reports 182

141 Basic Reports 183

142 LegacyReports 185

143 Configuring Report Settings 188

144 Report Display Settings 188

1441 Add or Delete Platform Type 189

1442 Add or Delete Application Types 189

1443 Channel Types 189

1444 Time Zone 189

145 Report MetaDataMapping 189

146 FormMetaDataMapping 190


2 Launching App Services Kony Fabric App Services User GuideVersion17

2 Launching App Services

Prior to accessing the App Services you need to launch the console and log in with your credentials

You can launch the App Services in two ways

l FromKony Fabric Console

l Through App ServicesURL

From Kony Fabric Console

If you have the App Services server configured in Kony Fabric Console under the Environments

section you can access the App Services fromKony Fabric Console

To access the App Services 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 App Services

The App Services is displayed in another tab of the web browser By default theWeb Apps

page is displayed

Through an App Services URL

To access App Services directly from the URL follow these steps

1 Enter the URL httplthostnamegtltportgtadmin in the web browser and press Enter

For example http101011059090admin

The Login page of the App Services is displayed



2 Enter the user name and password to login to the system

User name Enter the default user name received after the installation of App Services

For example admin

Password Enter the valid password received after the installation of App Services

For example admin123

Upon successful authentication you are redirected toWeb Apps page

Note You can find the logged in user name displayed on the top right corner of the page

21 Functional Flow

The following modules are available in App Services

l WebApps

l Monitoring

l Integration Services



l Object Services

l Orchestration Services

l Jobs

l Health Check

l Logs

l Settings

l Reports

l Downloads

Version You can find the version number of the App Services accessed from the bottom of the left

pane

Logout At any point of time you can log out of the App Services by clicking on the Logout option

displayed on the top right corner of the page


3 Web Apps Kony Fabric App Services User GuideVersion17

3 Web Apps

TheWeb 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 Description

App

Name

Name of the web app deployed

Click the app name a new tab opens loading the selected web app

The URL of the selected web app is in the following format ipportappsVizappid

ForWAR based deployment applications the URL is in the following format

ipportappsVizappname

Note For multi-tenant servers WAR based deployment is not supported

Channel Different channels on which the application is built

Mobile All themobile channels on which the application is built are displayed

Desktop All the desktop channels on which the application is built are displayed

Tablet All the tablet channels on which the application is built are displayed

Version The version number of the web app displayed

You can perform the following actions in this screen

l Test aWeb App

l Delete aWeb App

31 Test a Web App

From the list of web applications displayed you can test an application by following these steps



1 Log on to App Services and clickWeb Apps from the left pane of the screen

2 From the list of web applications displayed in theWeb Apps page click an application in the App

Name column to test the application

32 Delete an Application

From the list of web applications displayed in theWeb Apps page you can delete an application from

the environment

To delete a web application from the environment follow these steps


2 From the list of web application displayed in theWeb Apps page click Delete displayed across

the web application

A confirmationmessage appears asking Are you sure you want to permanently delete the

ltltApp namegtgt application from this environment The application cannot be recovered

once you delete it

3 ClickOKThe application is deleted


4 Monitoring Kony Fabric App Services User GuideVersion17

4 Monitoring

App Services provides themonitoring capabilities on server performance to provide information on

server load performance errors and so on to the end user A dashboard that captures the real time

monitoring data such as traffic flow (number of calls per service) performance (total duration of the

calls) and error rate (count of errors per service) of the server is displayed Monitoring data is retained

for a week

Admins can set performance thresholds for individual services and automatically send email alerts

when thresholds exceed the predefined time settings

To access the Monitoring follow these steps

1 Log on to App Services For more information on accessing App Services refer Launching App

Services

Upon successful login theWeb Apps page appears

2 Click Monitoring from the left pane of the screen

TheMonitoring page appears with the list of services that hit the server

Enable Monitoring



Select the check box to enablemonitoring If Monitoring is disabled and the log level is debug

then it logs themetrics in the DB

If Log Level type is set as Debug or lower in Client Log Level filter themonitoring is captured

only for the usersmatching the filter criteria in the log If the servicemonitoring feature is

enabled the client log level set has no effect on it and data is collected for all the users For more

information on client log filters refer Log Level by Client Filter

Note Monitoring has no perceptible performance impact and it is highly recommended to

keep the feature enabled

TheMonitoring page has two tabs - Service and Environment

41 Service

The Service tab displays the performance data as graphs to view the overall performance and a

table with the information for each specific service such as count of the server requests

duration and other performancemetrics

The performance data of the services is displayed by default In the search field enter a service

name operation and click the Search icon to view the performance data of the specific service

operation The following three graphs represent the real-time datamonitoring

l Service Calls

l Service Performance

l Error



Service Calls

The graph displays the number of service calls received by the server within the selected time

period

Service Performance



The graph displays the performance of the server in terms of time taken by the server to

respond to the received request within the selected time period

Error

The graph displays the count of occurrence of errors from the total number of requests within

the selected time period



The table for Service Monitoring displays the following information

Field Description

Service Name Name of the displayed service Click the service name to navigate

to the test page of the selected service

Note Click on a specific row of a service (other than service

name) to view the statistics of that service To revert to the

default graphs page click anywhere else on the screen

ObjectOperation The object for the Object service or the operation created for the

IntegrationOrchestration service

VerbMethod The verb (or) method created for the service

Service Type Type of the created service (example Object Service Integration

Service and so on)

Parent Service Details of the parent service associated with the service

Example If an Integration service is part of an Orchestration service

and invoked as part of Orchestration service the orchestration

service name is displayed in the parent service and integration

service name is populated in the service name field

Total Request Count The count of total requests sent from the service within the selected

time range

Error Count Count of the errors received from the total requests sent

Error Percent Percentage of the errors received from the total requests sent



Field Description

Server Response Time Time taken to respond by the server for the received request

Mouse hover across each row to view the time split of service

performance For detailed information on time split refer Time-split

for Server Response time

Time-split for Server Response time You can view the details of the service performance in

terms of theminimum maximumand the average time spent on each of the logical components

The details include the time spent while executing the request in terms of external call to

backend and in transforming the backend request to fit the requirements of the client app It also

provides the details of pre-processor and post-processor duration along with request and

responsemapping duration for Object services

Note You can sort the displayed data in the table using the Service Name Object (or)

Operation Service Type Parent Service Total Request Count and Server Response

Time

Following actions can be performed in this screen

l Threshold

l Notifications

l Export as CSV



l TimeRange Filter

l Error Filter

l Node Filter

411 Export as CSV

You can export the data displayed into CSV format To export the data perform the following steps

l Click Export to CSV button to export the data into a CSV file

Note The exported CSV has | (pipe) as a delimiter

Time Range Filter You can filter the data using the time range filter The default time range of the

services displayed is 15minutes Select a time range to view the list of services that hit the server

within the selected time range

Note Any existingmetrics are logged in batches into the DB at the end of everyminute



The following are the different time ranges displayed in the drop-down list

l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week

412 Custom Time Range

Excluding the default time range displayed you can also select the custom time range to view the list of

services that hit the server within the selected time range



To select the custom time range follow these steps

l In the Time Range drop-down list select Custom

A pop-up is displayed to select the custom time range

l Select a day fromStarting at drop-down list and select the Hour andMinute by using the slider

l Select the amount of time the data to be captured from For drop-down list

The page displays the list of services that hit the server within the selected custom time range

Error filter You can filter the errors displayed from the total requests sent to the server within the

selected time range You can choose the options displayed from the Error Filter drop-down list

l Include Errors Selecting this option displays the count of errors displayed out of the requests

sent to the server within the selected time range



l Exclude Errors Selecting this option excludes the count of errors from the list of metrics

displayed

l Errors Only Selecting this option displays only those service requests that have errors

413 Node Filter

Nodes represent the different server instances that comprise the environment The name of the node

is determined by the first value found from a JVM -D of KONY_SERVER_NODE_NAME the host

name of themachine or theMAC addresswith a generated hash ID

The performance of All the nodes is displayed by default You can choose the nodes you want to

monitor from the Node drop-down list

414 Threshold

Threshold is a setting that determines the performance of services You can set Warning or Critical

thresholds for the given fields

l Response Time (in ms)

l Error Count

l Percentage of errors

When the value of any field exceed the threshold the server sends a notification to your email address

Based on the values of the fields you can identify the services that have a degraded performance



The error percent error count and response time columns are color coded for quicker identification of

serviceswith degraded performance

l Red indicates critical

l Amber indicateswarning

l Green indicates no issues

The admin can set warning and critical thresholds globally for all services or can override the settings

for individual services as expected response times can vary across services Notifications are

automatically sent to users through email when the response data exceeds the predefined threshold

settings

Note You can set custom thresholds for individual services These thresholds override the

thresholds that are set globally

To set a threshold globally perform the following actions

1 In Admin Consolegtgt Monitoringgtgt click Threshold The Threshold pop-up appears

2 You can set the threshold using one or more as a combination of

l Percentage of Errors

l Count of Errors



l Service Response Time exceeding a certain value inmilliseconds

Note If a combination of thresholds is set the email notification is sent even if one of the

values is triggered

For example if the warning threshold is set for error gt 5 and service response time gt 5000

the warning notification is sent to the users if the error countgt5 or if the service response

timegt5000

The server calculates the parameters for every operation of the service

Note The parameters are calculated for the duration that you have selected for the

monitoring data

Note Critical thresholds are expected to be higher than warning

Global thresholds can be overridden with different threshold values at individual operations as

some services are expected to takemore time to respond

For example a three second response time is considered slow for a service whereas a

complicated orchestration service which connects to multiple back ends and receivesmore data

as response can be expected to be normal even for eight seconds response time

3 To set threshold for an individual service In Admin Consolegtgt Monitoringgtgtclick

Threshold icon next to service to set the threshold The Threshold pop-up for the selected

service appears



4 Click the check box next to each parameter and enter a value to set a threshold Critical level

thresholdmust be greater than warning level threshold

5 Once the threshold is set click Save

If the threshold exceeds the predefined settings the data highlights with amber for warning and

red for critical irrespective of enabling the notifications

For example in the above screen shot we have set a specific threshold for NewOperation in

the getNews service This allows the admin to ensure that unnecessary alerts are not triggered

for this operation when its expected response time is higher than other services

415 Notifications

You can configure the time interval for monitoring the performance (ranging from 5minutes to 60

minutes) and enable email notifications to be set for critical or warning thresholds independently Email

notifications can be sent to all account owners or admins or custom users who have access to the

environment The threshold criteria is evaluated by calculating the average performance data over a

configurable time window

The flexibility of configuring the time interval and setting the notifications independently allows the

admin for example to check for warnings only once an hour and possibly notify the on-call support

person and for critical alerts sendmails to all admins to ensuremore people troubleshoot the issue

To enable notifications at different levels perform the following actions



1 In Admin Consolegtgt Monitoringgtgt click Notifications The Notifications window appears

2 Under Enable Notification on Critical level andor Enable Notification on Warning Level

select any of the following options

l All Account Owners - Select the check box to enable notifications at critical level for all

account owners

l All Account Admin - Select the check box to send notifications to all admins of the

account

l All Users with Full Access on this Environment - Select the check box to send

notifications to all the users having full access on this environment

l Custom User List - Select the check box to send notification to custom users You can

enter the email IDs of the custom users in the text box

Note Custom usersmust have access to the environment to receive the email alerts



l You can select the time interval to check the services in the critical (or) warning state The

available options are 5mins 10mins 15mins 20mins 30mins and 60mins

3 Click Save to save the changes

Email notifications are sent on Critical andWarning level thresholds

Click here to view sample email alert for Critical andWarning threshold

Sample email alert for Critical Threshold

Sample email alert for Warning threshold



416 Configuring Email Alerts (On-Premises)

To configure email alerts perform the following actions



1 Add the following server configuration parameters

l MAIL_TEMPLATE The Engagement email request payload API

Sample Payload

emailServiceRequest

emails

email

recipients

recipient [

emailId $mailId

type TO

]

senderName Kony

subject $mailSubject

content ltpgt This is a system generated



notification that one or more of the services has exceeded

the threshold limit and your email is part of the

notification distribution list for this alert The settings

for this notification can be changed by an admin at by

logging to admin consoleltpgt ltpgtEnvironment Services Detail

ltpgt $mailContent

priority true

startTimeStamp 0

endTimeStamp 0

l ENGAGEMENT_USER_NAMEENGAGEMENT_PASSWORD The Engagement

user login credentials

l AUTH_URL Auth service login URL to generate claims token

l ENGAGEMENT_URL Engagement services runtime URLwith API for adhoc email

Example httpsltruntime_urlgtapiv1messageemail

Click Save

2 Create custom servlet to make adhoc email request call to the Engagement services

package comkonysample

import javaioIOException

import javaxservletServletException

import javaxservlethttpHttpServlet

import javaxservlethttpHttpServletRequest

import javaxservlethttpHttpServletResponse

import orgapachecommonsioIOUtils



import orgapachecommonslangStringEscapeUtils

import orgapachecommonslangStringUtils

import orgapachehttpclientClientProtocolException

import orgapachehttpclientmethodsCloseableHttpResponse

import orgapachehttpclientmethodsHttpPost

import orgapachehttpentityStringEntity

import orgapachehttpimplclientCloseableHttpClient

import orgapachehttpimplclientHttpClients

import orgapachelogginglog4jLogManager

import orgapachelogginglog4jLogger

import orgjsonsimpleJSONObject

import orgjsonsimpleparserJSONParser

import comkonylabsmiddlewareapiServicesManagerHelper

import comkonylabsmiddlewareservletIntegrationCustomServlet

IntegrationCustomServlet(urlPatterns =

sendmail

)

public class MailServlet extends HttpServlet

private static final Logger LOGGER = LogManagergetLogger

(MailServletclass)

private static final long serialVersionUID = -

7623066890220333243 L

private String authToken

Override

protected void doPost(HttpServletRequest request

HttpServletResponse response)



throws ServletException IOException

String json = IOUtilstoString(requestgetInputStream()

UTF-8)

try

String requestpayload =

ServicesManagerHelpergetServicesManager

(request)getConfigurableParametersHelper()

getServerProperty(MAIL_TEMPLATE)

Object obj = new JSONParser()parse(json)

JSONObject jsonObj = (JSONObject) obj

JSONObject notifyList = (JSONObject) jsonObjget

(NotifyList)

String mailId = (String) notifyListget(users)

JSONObject alerts_services_details = (JSONObject)

jsonObjget(alerts_services_details)

String mailContent = (String) alerts_services_

detailsget(services_html_content)

String mailSubject = (String) jsonObjget(type)

mailSubject = mailSubjectreplace(_ )

requestpayload = requestpayloadreplace($mailId

mailId)

requestpayload = requestpayloadreplace

($mailSubject mailSubject)


($mailContent StringEscapeUtilsescapeJava(mailContent))

CloseableHttpResponse httpResponse =

getAuthTokenAndCallAPI(request requestpayload)

if (httpResponsegetStatusLine()getStatusCode() ==

200)

responsesetContentType(applicationjson)

responsegetWriter()write(messageMail



request initiated successfully)

else

LOGGERerror(Faild to trigger mail with

response code

httpResponsegetStatusLine()getStatusCode

())


responsegetWriter()write(messageFailed

to trigger mail)

catch (Exception e)

LOGGERerror(Failed to trigger mail e)


responsegetWriter()write(messageFailed to

trigger mail)

private CloseableHttpResponse getAuthTokenAndCallAPI

(HttpServletRequest request String requestPayload)

throws Exception

if (StringUtilsisBlank(authToken))

LOGGERdebug(Generating auth token using the

configured user credentials)

authToken = getAuthToken(request)

String url = ServicesManagerHelpergetServicesManager


getServerProperty(ENGAGEMENT_URL)

CloseableHttpResponse response =

executeRequestAndGetResponse(url requestPayload authToken)

if (responsegetStatusLine()getStatusCode() == 401 ||



responsegetStatusLine()getStatusCode() == 403)


response = executeRequestAndGetResponse(url

requestPayload authToken)

return response

private String getAuthToken(HttpServletRequest request)

throws Exception

String userId = ServicesManagerHelpergetServicesManager


getServerProperty(ENGAGEMENT_USER_NAME)

String password =



getServerProperty(ENGAGEMENT_USER_PASSWORD)



getServerProperty(AUTH_URL)


executeRequestAndGetResponse(url

userid + userId + password +

password + null)

String responseContent = IOUtilstoString

(responsegetEntity()getContent() UTF-8)

Object claimTokenObj = ((JSONObject) new JSONParser

()parse(responseContent))get(claims_token)

if (claimTokenObj = null)

return (String)((JSONObject) claimTokenObj)get

(value)

else



LOGGERdebug(Failed to get the cliams token check

if the user credentials are valid)

return null

private CloseableHttpResponse executeRequestAndGetResponse

(String url String payload String authToken)

throws ClientProtocolException IOException

CloseableHttpClient client = HttpClientscreateDefault()

HttpPost httpPost = new HttpPost(url)

httpPostsetEntity(new StringEntity(payload))

if (StringUtilsisNotBlank(authToken))

httpPostsetHeader(X-Kony-Authorization

authToken)

httpPostsetHeader(Accept applicationjson)

httpPostsetHeader(Content-type applicationjson)

CloseableHttpResponse httResponse = clientexecute

(httpPost)

return httResponse

Note Following are the third party libraries required to compile theMailServlet code

- Commons-io-26jar

- Commons-lang3-381jar

- Httpclient-456jar

- Log4j-apijar

- Json-simplejar

3 Create a custom jar with the custom servlet created in the earlier step



4 Upload the asset to the Kony Fabric server and publish the app

5 Configure the servlet endpoint URL -D parameter KONY_SERVER_ALERTS_NOTIFY_

ENDPOINT

Example -DKONY_SERVER_ALERTS_NOTIFY_

ENDPOINT=httplthostgtltportgtservicessendmail

Best Practices

l The thresholdsmust be set appropriately to avoid false alarms

l Use caution while setting the alert monitoring interval

For example if alert interval is set at 5minutes and the threshold criteria ismet for every 5

minutes an alert is sent for every such interval To avoid such clutter consider the time intervals

for warning and critical and set individual thresholds

l Ensure that appropriate users are copied for email alerts

42 Environment

Important Environment tab inMonitoring is available only in on-premise environments

Note The environment monitoring data by default is shown for the last 15minutes If necessary

you can customize the time for an hour a day or any custom range Environment monitoring data

is stored in the database for 7 days from the date of generation You can use Standard or Custom

reports fromKony Fabric Console to view data for longer durations For more details view Custom

TimeRange

Note Few Features of environment monitoring like CPU usage graph will not work in AIX

The Environment tab displays line graphs and doughnut charts for each of the following three

sections



l CPU

l Memory

l Threads

CPU

The line graph displays the CPU usage across each node within the selected time period by default

with each line representing a node Select a node in the Node Filter to view the line graph specific to

that node



The doughnut charts display the average usage of the CPU power in a chosen time range and the

available CPU power

Click a doughnut chart of a specific node to display the line graph and the doughnut chart specific to

that node

Memory

The line graph displays thememory usage across all the nodeswithin the selected time period by

default with each line representing a node Select a node in the Node Filter to view the line graph

specific to that node

Thememory usage for each node will be shown in terms of

l Total Memory Available

l Total MemoryUsed

l HeapMemory Available

l HeapMemoryUsed

l NonHeapMemory Available

l NonHeapMemoryUsed



The doughnut charts display the average usage of HeapMemory and Non-HeapMemory in the Total

Memory


that node

Threads

The line graph displays the total number of threads processed across all the nodeswithin the selected

time period by default with each line representing a node Select a node in the Node Filter to view the

line graph specific to that node

The threads processed for each node will be shown in terms of

l Total Threads

l ThreadsDeadlocks

l Threads Blocked

l ThreadsRunnable



l ThreadsWaiting

l Threads TimedWaiting

The doughnut charts for threads processed displays various states of the threads such asWaiting

Runnable TimedWaiting Blocked and so on


that node

43 Server Events Monitoring

Using App services you canmonitor various details related to server events based on different filter

criteria You canmonitor details like event count subscriber error count subscriber error count

percentage and so on Thismonitoring dashboard provides real time information and which is

retained for a week

To access the Server Event Monitoring follow these steps

1 Log on to App Services For more information on accessing App Services refer to Launching

App Services


2 Click Monitoring from the left pane of the screen and select the Server Events tab

The Server Events Monitoring page appears



The Server Events tab displays the server events data as graphswhich displays the details like

event count (number of events created) subscriber error count and subscriber error

percentage as per the specified filter criteria Use the Search field to view themonitoring data of

the specific event The following three graphs represent the real-time datamonitoring

l Event Count

l Subscriber Error Count

l Subscriber Error Percentage

Event Count

The graph displays the number of server events processed with respective to the selected filter

criteria



Subscriber Error Count

The graph displays the number of event subscribers that failed to process the event as per the

filter criteria

Subscriber Error Percentage

The graph displays the percentage of total number of event subscribers failed with respect to

the total number of events triggered as per the selected filter criteria



Apart from the graphical view you can also find the table that lists all the events and provides

information about their related subscribers as follows

Field Description

Event Name (Topic) Displays the name of topic name of the event

Type Displays the type of service with which the event is related For

example Integration Service Object Service andmore If the event

is related to any custom code apart from any services then this field

displays Custom

App Name of the fabric app related to the event

Number of Subscribers Displays the number of subscribers listening to the event

Event Count Displays the number of events triggered with the respective topic

name

Subscriber Error Count Displays the number of subscribers failed to process the event



Field Description

Subscriber Error

Percentage

Displays the percentage of total number of events-subscriber fails

with respect to the total number of events triggered

Event Delivery Time Displays the total time taken to process the event

Click Export to CSV if you want to export the data in a CSV file format

You can set filters to get the list of events as per your requirement Following are the filter criteria

available in the Server Events Monitoring tab

l TimeRange Filter

l Error Filter

l Node Filter

4301 Time Range Filter

You can filter the data using the time range filter The default time range of the processed events

displayed is 15minutes Select a time range to view the list of processed events within the selected

time range





l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week

Custom Time Range


processed events within the selected time range








The page displays the list of processed events within the selected custom time range

4302 Error filter

You can filter the events that had errors while processing within the selected time range You can

choose the options displayed from the Error Filter list

l Include Errors Displays the count of the events that had errors while processing within the

selected time range



l Exclude Errors Excludes the count of errors from the list of metrics displayed

l Errors Only Displays only those processed events that have errors

4303 Node Filter







5 Integration Services Kony Fabric App Services User GuideVersion17

5 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 App Services to view a list of Integration

serviceswhich are available across the applicationswithin your Kony Fabric environment

The following fields are displayed for each integration service

Column Description

Service Name Name of the service deployed

Service Type Type of the service

To know the different types of services available in Integration Service refer Kony

Fabric Supported Endpoints



Column Description

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 canmake 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

51 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

l Request Input

l ResponseOutput

511 Request Input

The Request Input page displays the input parameters for the operation selected Youmust provide

the values across the parameters displayed in the page to get the response from the server



The following fields are displayed in the Request Input page

Field Description

Server URL Themiddleware 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



Field Description

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 namewith their values provided

512 Response Output

The response received for the input request sent is displayed in the Response Output page The page

contains two sections

l Response Header

l Response Body

Response Header The response header section displays the header values for the request sent



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 App Services 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



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 ClickGet Response

The response for the input parameters provided is displayed in the Response Header and

Response Body sections of the Response Output screen

52 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 App

Services

To download the Swagger file follow these steps

l Log in to the App Services and click Integration Services from the left pane of the screen

The list of available services are displayed



l Click Download for a selected service provided in the Documentation column

A JSON file for the selected service is downloaded to your local system

l The downloaded JSON file can be invoked into a third-party interface httpsapigeecom and

view(or) invoke the downloaded code in UI format


6 Object Services Kony Fabric App Services User GuideVersion17

6 Object Services

The object services are used test the defined app datamodel 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 datamodel objects of each service defined using different operations available

To know more refer Object Services

The following fields are displayed in the page

Column Description

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 Supported Endpoints

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



Column Description



If any Storage service is unpublished in Kony Fabric its status changes to Storage (Unused) in

Services Type and a Delete icon appears for that service Click the Delete icon if you want to remove

the data associated with that storage service permanently and free up the space in the environment

Note You can export the data associated to the storage service before deleting it

61 Hard Delete option for Storage Services using the X-Kony-Soft-

Delete Flag

TheDelete Strategy section is displayed in Kony Fabric Console for Storage services The Delete

Strategy contains two options Hard Delete or Soft Delete It helps you delete the selected record

data from the database

l Select the Soft Delete option tomark the selected record data as a soft delete flag If you have

selected the default Soft Delete setting in the Delete strategy in Kony Fabric Console and

when a client request is sent for deleting records these records aremarked for the

SoftDeleteFlag with value as 1 in the database This option is selected by default



l Select the Hard Delete option to delete the selected record data permanently from the

database

Note To configure the Delete strategy for Storage services using the Fabric Console refer

to ObjectsServices gt Storage Endpoint

In case you have published your storage service with the default Soft Delete option you can

permanently delete the selected records from the database by passing the header (X-Kony-Soft-

Delete) parameter in the delete request call by using the Admin Console as follows

a To use the hard delete option go to the App Services Console gt Object Services page

b Under the App Data Model Objects column select the object for a specific service of type

Storage

c In the Request Input tab select the delete operation from the list

d Click the Body section and specify the field value that you want to delete The field valuemust

be based on a primary key



e Click the Header section and enter the header parameter for the Hard Delete operation as

follows

l Field Name X-Kony-Soft-Delete

l Field Value false



f ClickGet Response

The response for the delete request is displayed under the Response Output tab gt Response

Body section

Sample response code for a Hard delete request call

Response Body

records[]opstatus0httpStatusCode0

The recordsmentioned in the request body are deleted


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 datamodel and select an object for a service The selected data

model object displays the page with two toggles

l Request Input

l ResponseOutput

621 Request Input

TheRequest Input page displays the input parameters for the selected services



Field Description

Operation l Select amethod from the drop-down list to send the request The available

methods are

Create

Update

Delete

Get

For more information onMethods Mapping refer ConfigureMethods Mapping

to the Fields in the Background

Server URL Displays themiddleware 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 addmore 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


Download You can download the request input records in CSV and JSON formats



622 Response Output

You can view the response for the request parameters sent in the Response Output toggle This page

displays the following fields

Section Description

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 App Services and clickObject 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 themethod 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

4 ClickGet Response

The response for the given input parameters is displayed in the Response Header and

Response Body sections of Response Output page


7 Orchestration Services Kony Fabric App Services User GuideVersion17

7 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 App Services For more information refer Orchestration Services

The operations in Orchestration services are classified as

l Concurrent Operation

l 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



Note AnOrchestration service created can be a combination of both Concurrent and Sequential

operations

TheOrchestration services page displays the following fields

Column Description

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



Search Search for a service by entering the service name in the text box provided


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

l Request Input

l Request Output

711 Request Input




Field Description

Input

Method

and URL

By default the input method of Orchestration service is considered as Postmethod and

based on themethod 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 namewith their values provided

712 Response Output

Once the request is passed to the back-end server the response is displayed in the following sections

Section Description

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



1 Log on to App Services and clickOrchestration Services from the left pane of the screen

2 Click the drop-down list and select an operation of a service


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 ClickGet Response

The response for the provided input parameters is displayed in the Response Header and



8 Workflow Services Kony Fabric App Services User GuideVersion17

8 Workflow Services

It lists all theWorkflow Services that were published to the current environment fromKony Fabric

Console You can view all the instances of theWorkflow that were triggered from here and the run-

time status of each triggered instance from here To know more aboutWorkflow service refer

Workflow Service

Click theWorkflow Services from the left pane of the App Services to view the list of Workflow

services

The following information is displayed about eachWorkflow service

Column Description

Workflow Name Name of the service deployed

LinkedObject Name of the Object Service that is linked with the respectiveWorkflow service





To view all the instances of aWorkflow click on the requiredWorkflow TheWorkflow Instance

screen appears

The following information is displayed about each instance

Column Description

Instance Name Name of the respective instance It is auto-generated

Status The current status of the instance A Workflow instance can be in Running

Completed or Failed status

Date Initiated Displays the information about when the instance was triggered

Date Completed Displays the information about when the instance was ended

You can filter the table using Status and Time Range lists The Status list contains four options - All

Running Completed Failed By default All is selected The Time Range list contains the following

options - All 5 minutes 15minutes 1 hour 4 hours 1 Day and 1Week By default All is selected

Click Refresh to get the latest data



To view the nodes that are executed in that instance of theWorkflow click on the required instance

The Nodes screen appears You can also find the run-time progress of theWorkflow from here as the

Nodes screen also displays the status of each node in theWorkflow If any instance fails you can

easily find out the node where theWorkflow has failed

The following information is displayed about each node

Column Description

Action Name Name of the node

Type Type of the node

Status The current status of the node




9 Jobs Kony Fabric App Services User GuideVersion17

9 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 emails automatically before the

userrsquos renewals expire

To access Kony Fabric Jobs in App Services 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


The App Services 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

l Searching for an existing job

l Adding a new job

The Jobs screen displays the following UI elements



UIElement

Description

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



UIElement

Description

Job

Status

Current status of the job This includes

l ActiveInactive Status

l Scheduled Date and Time of the next run

l 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 Description

Edit Edit the selected job

View Job History View the history of the selected job For detailed

information on Job History page refer ltltgtgt

Inactive Deactivate an active job

Delete Delete the selected job

RunOnce Now Ability to run the job immediately

91 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



3 Click the Search icon provided beside the text box

The page displays the list of jobsmatching the entered search criteria

92 Adding a new job

You can create a new job for the Integration Object andOrchestration 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

l Job Info

l Define

l Schedule



921 Job Info

The Job Info window displays the fields required to create a new job Enter the required details in the

fields provided


Name Enter the name of the job




Service Type Select the service type from the list

l Integration

l Orchestration

l 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 10 The service version is predefined

during the process of creating a service in Kony Fabric Console

Objects Select the objects for the selected service TheObjects 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 TheObjects 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




Service Security Level Based on the selected operation the security level (Public Anonymous

App User or Authenticated App User) is displayed




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

l Enter your login credentials

l 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

l Authenticated App User On selecting a private operation you

are considered as an Authenticated App User

l 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

l App Select the app to which the service is associated

l Identity Select the identity associated with the selected service

l Username and Password Provide the login credentials

l 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




History Strategy Displays the following options to view the job history

l No History History will not be tracked

l 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

l Full History for Failed Runs The complete history of failed runs

is displayed

l 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

Description Enter the description of the new job created




Email notifications on

Failure

Email notifications are automatically sent by the server on the failure of

the created jobs The email notifications contains the job failure

information You can select any of the following options for the email

notifications to be sent

l All Account Owners Email notifications are sent to all the owners

of the logged in account

l All Account Admins Email notifications are sent to all the

administrators of the logged in account

l All Users with Full Access on this Environment Email

notifications are sent to all the users having full access to the

environment associated to the logged in account

l Custom Users List You can customize the list of users by

entering their email address to receive the email 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 Enterselect themandatory fields to create a new job

3 Click Next to move to the next screen



922 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

l Job Info

l Define

l Schedule

2 Enter the required information in the fields displayed in the Job Info window and click Next

The Define window appears



TheRequest Input window displays the following fields

Field Description

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



Field Description

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 themandatory fields and click Next


2 Enter the query parameters against the selected operation

3 Provide the field values against the field names displayed

4 ClickGet 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 responseswhose opstatus is 0

5 Click Next

The Schedule window appears



Note The jobmight fail with an error Internal error during job execution if the service does

not return proper JSON response or if the service ismodifieddeleted after creating the job

923 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


The New Job window appears with three tabs

l Job Info

l Define

l Schedule

2 In the Job Info window fill the required fields and click Next


3 Enter the request parameters to receive the response parameters

4 Once you receive the response output click Next




The Schedule window displays the following fields

FieldName

Description

Every The time frame displays

l Hour

l Minute

l Day

l Week

l Month

l Advanced



FieldName

Description

Hour Select the time (in hours) to run the job You need to select the hour andminute to

schedule the time to run a job

Note This field is inactive when you select Hour from the Every list

Minute Select theminute field to schedule the next run of the selected job

Day Displays the hour andminute fields Select the time frame to schedule the run for the job

The job will run every day on the selected time

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 andminute

Select the day of a week and the time frame to schedule the run The job will run every

week on the selected day and time

Month Displays the Date and Time fields Select the date and the time frame to schedule the run

for the selected job The job will run every month on the selected date and time

Year Displays the Date Month and Time fields Select the date month and the time frame to

schedule the run for the selected job The job will run every year in the selectedmonth

date and time

Advanced You can provide a cron expression to define the schedule for the selected job For

example 0 05 8-18

Note You can use the tools like free formatter to create quartz expression

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

9231 Limitations

l Only identities that have user name and password are supported to authorize

l Oauth logins such as Facebook Google and so on are not supported You cannot view these

oauth identities under the identity list

l API Proxy services and response pass-through services are not supported

93 Scheduling Job APIs

Scheduling Job APIs enable you to configure Admin Console jobs for Integration Object and

Orchestration services fromV8 SP4 onwards You can configure the jobs by invoking APIs from either

Postman Curl or anyRest Client

Scheduling Job APIs help to schedule activities like the following

l Caching data at a specific time to sync data across the devices

l Performing a health check on the service

931 Get All Jobs

TheGet All Jobs API is used to get all the jobs



9311 URL

The HTTP URL for the Get All Jobs API is as follows

httpltlthostgtgtltltportgtgtadminapijobsjob

9312 Method

GET

9313 Header

The request header includes X-Kony-Authorization as ltX-Kony-Authorizationgt

Note For more information on X-Kony-Authorization refer Authentication

9314 Output Parameters

Output Parameter Type Description

jobId integer A unique ID generated by the system It

cannot be null for all the jobs

jobName string Name of the configured job

description string Description provided while creating a job

cronExpression string Expression used while configuring the job

For more information on CRON expression

refer

l httpsdocsoraclecomcdE12058_

01docdoc1014e12030cron_

expressionshtm

l httpswwwfreeformattercomcron-

expression-generator-quartzhtml




updatedUser string Email that is used to update the job

updatedDate string Date on which the job is updated

jobStatus string Current status of the job It can either be

Active orInactive

jobHistoryTotal integer Number of records in the Job History tab

jobHistorySuccessCount integer Number of successful runs

jobHistoryFailCount integer Number of runs that failed

jobHistorySucPercentage integer Percentage of runs that were successful

jobHistoryFailPercentage integer Percentage of runs that failed

jobLastRunStatus string Status of the last run of the configured job

jobNextRunTime string Occurrence of the job

9315 Sample Response

[

jobId 1

jobName job1

description null

cronExpression null

updatedUser xxxxx

updatedDate 2018-12-24 090455

jobStatus Active

jobHistoryTotal 0



jobHistorySuccessCount 0

jobHistoryFailCount 0

jobHistorySucPercentage 0

jobHistoryFailPercentage 0

jobLastRunStatus null

jobNextRunTime 2018-12-24 093541

]

932 Get All Job Details with Job ID

TheGet All Jobs Details with Job ID API accepts Job ID as an input parameter and returns the job

details

9321 URL

The HTTP URL for the Get All Jobs with Job ID API is as follows

httpltlthostgtgtltltportgtgtadminapijobsjob1

9322 Method

GET

9323 Header



9324 Input Parameters

Input Parameter Type Description

jobId integer A unique job ID for which the

details must be retrieved





jobId integer A unique ID generated by the

system It cannot be null for all

the jobs


jobFrequency string Frequency at which the job is

running

jobServiceInfo JSON Contains the service information

configured for the job

version string Version of the service that is


serviceType string Service type of the configured

job It includes the following

l intSer for Integration

Service

l objSer for Object

Service

l orchSerfor

Orchestration Service

serviceName string Name of the service for which the

job will run




objectName string Name of the Object service for

which the job is running

Note TheObjects field is

displayed only when you

select the service type as

Object Services

operationName string Name of the operation for which

the job is running

requestheaderMap JSON Headers map that is required to

execute the job

serviceExecutionType string The owner who runs the job as

Admin for the job execution the

Valuemust beSERVER_URL

This parameter is mandatory

while creating a job

postData JSON Job parameters that are required

to run the service

operationSecurityLevel string Security level that is configured

to execute the underlying

service

jobStatus string Current status of the job It can

either beActive or

Inactive




historyStrategy string History strategy that is

configured for the job The

possible values for this

parameter are as follows

l OFF History is not

recorded or displayed

l MINIMAL History related

to audits is recorded and

displayed

l ERROR History of failed

runs is recorded and

displayed

l FULL History for all runs

(including the payload and

response) is recorded and

displayed

retentionPeriod string Length of time for which the job

should retain its history

jobFrequencyInfo JSON Frequency at which the jobmust

run




frequencyType integer Type of frequency that was

configured The following are the

possible values

l 1 Hour-based Frequency

l 2 Day-based Frequency

l 3 Week-based Frequency

l 4 Month-based

Frequency


jobId 1

jobName job1

jobFrequency 41 5

jobServiceInfo

version 10

serviceType intSer

serviceName openweather

objectName

operationName getWeather

requestheaderMap

serviceExecutionType SERVER_URL

postData cityName

operationSecurityLevel public

jobStatus Active

historyStrategy MINIMAL

retentionPeriod 30



jobFrequencyInfo

frequencyType 1

minuteValues [

5

]

933 Create a Job

TheCreate Job API is used to create a server job

9331 URL

The HTTP URL for the Create Job API is as follows


9332 Method

POST

9333 Header

The following are the request headers

l X-Kony-Authorization as ltX-Kony-Authorizationgt


l Content -Type as applicationjson







any job



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9335 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0

description Job for testjob2

jobServiceInfo

version 10

serviceType intSer

serviceName jsonservices

objectName

operationName metadatajson

requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]


Output Parameter Description

status Represents the status of the operation It can either be

SUCCESS orFAIL

result If any operations failed to execute the parameter

contains the full results Otherwise the value is null

message If any operations failed to execute the parameter

contains a short notation of the error that occurred

Otherwise the value is null

token Represents the CSRF token if available


status SUCCESS

result null

message null



token null

934 Update a Job

TheUpdate Jobs API is used to update server jobs

9341 URL

The HTTP URL for the Update Jobs API is as follows


9342 Method

PUT

9343 Header



Note For more information on X-Kony-Authorization refer Authorization






any job






running








Service

l objSer for Object

Service

l orchSerfor



job will run






Object Services


the job is running





execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9345 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0

description Job for testjob 1

jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null

935 Delete a Job with Job ID

TheDelete Job with Job ID API takes job ID as an input parameter and deletes the job

9351 URL

The HTTP URL for the Delete Job with Job ID API is as follows


9352 Method

DELETE

9353 Header










SUCCESS orFAIL











status SUCCESS

result null

message null

token null

936 Get Job History

TheGet Job History API is used to get the history of a job

9361 URL

The HTTP URL for the Get Job History API is as follows

httpltlthostgtgtltltportgtgtadminapijobshistory2

9362 Method

GET

9363 Header











jobRunId integer A unique ID of the job

jobStartTime string Time at which the job execution process

started

jobEndTime string The time at which the job execution

process ended

jobDuration integer Job execution time

executionFrequency string Frequency at which the job was running

executionStatus string Status of the job run

completeHistory boolean If the history strategy of the run is

complete this parameter is true

Otherwise it is false


[



jobRunId 2

jobStartTime 2018-12-24 103541

jobEndTime 2018-12-24 103541

jobDuration 0

executionFrequency 41 5

executionStatus Fail

completeHistory false

jobRunId 1


jobEndTime 2018-12-24 093543

jobDuration 2000




]

937 Run a Job Now

TheRun Job Now API is used to run a job

9371 URL

The HTTP URL for the Run Job Now API is as follows

httpltlthostgtgtltltportgtgtadminapijobsjobrun2

9372 Method

POST

9373 Header




Note X-Kony-Authorizationmust be retrieved from the accounts login call

For more information on X-Kony-Authorization refer Authorization








SUCCESS orFAIL








status SUCCESS

result null

message null

token null



938 Accounts Login API

9381 URL

The HTTP URL for the Accounts Login API is as follows

httpltlthostgtgtltltportgtgtauthServiceaccountslogin

9382 Method

POST

9383 Header

The request header includes Content-Type as applicationx-www-form-urlencoded


Input Parameter Description

userid User ID of the account

password Password of the account


profile

userid usernamekonycom

email useridkonycom

firstname xxxxxx

lastname xxxxxxx

user_attributes

user_id usernamekonycom

profile_attributes

firstname xxxxxx




email useridkonycom

lastname xxxxxxx

claims_token

value xxxxx

exp 1540293966000

integrity_check_required false

refresh_token xxxxx


10 Health Check Kony Fabric App Services User GuideVersion17

10 Health Check

Health check of App Services 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 App Services

A list of four databaseswith their status is displayed The databases listed in the page are

l Access to Reports DB

l Access to Admin DB

l Access to Reporting Queue

l 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

Following are the health check APIs for server



For cloud

Get httpslthostgtadminhealthcheckoutput=json

Sample Response

healthCheck PASSED

healthDetail

Access to Cache PASSED

Access to Deployment Storage PASSED

Cloud Environment Identification PASSED

Access to Reporting Queue PASSED

Access to Device DB PASSED

Security Credentials PASSED

Access to Admin DB PASSED

Access to Storage DB PASSED

version xxxx

For On-premises

Get httplthostgtltportgtadminhealthcheckoutput=json

Sample Response

healthCheck PASSED

healthDetail



Access to Reports DB PASSED


version xxxxx


11 Logs Kony Fabric App Services User GuideVersion17

11 Logs

Logs section enables you to view data sync between the devices of the client and the Enterprise

Datasource server We have two types of Logs

l Standard Logs In the process of managing the App Services we need to track the

performance of the server and other client filters App Services 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 Standard Logs

l Trace Logs Trace Log enables you to view the request and response data between the clients

enterprise datasource server for a particular Application User Device Request and a session

For detailed information refer Trace Logs

111 Standard Logs

A log file is automatically created andmaintained by the server The log file displays the list of activities

performed by the device and the server The Standard Logs page in Logs displays the ways of

tracking different types of logswhich are displayed in App Services



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 andmiddleware to the back-

end server

l Trace All Client Request and Response Click the check box to trace all the incoming requests

and response payload from clients

l 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 logswill impact the server performance So do not

enable the trace for long periods or during the high traffic

1111 Log Level by Class

In the Log Level by class we can set the default root log level for a particular classpackage

To configure log level for classpackage

1 Provide the classpackage name in the text box provided under the Log level by class section

2 Set the log level for each classpackage by selecting the type of log level from the drop-down

The various types of log levels are

l 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



l DEBUG The debug log level displays the detailed information which is useful to debug

the incoming requests or response payloads in different log files

l INFO Displays the log level informationalmessageswhich highlight the progress of the

application

l WARN Displays the warningmessageswhich occur while capturing incoming requests

and response payloads

l ERROR Displays the error messageswhich occur while capturing incoming requests

and response payloads but still allows the application to continue running

l FATAL Displays the severe error messageswhich leads the application to abort

l OFF Turns off the logging

3 Click Save after completing all the configurations

11111 Verbose Logging for Trace and Debug Logs

When you select the Root Logger to Trace or Debug log levels a Verbose Log Duration drop-down

list is displayed for limited duration The available options are 15 30 and 60minswith 30mins is

selected by default

After selecting the Verbose Log Duration click Save

Note Verbose Log Duration can only be turned on for a limited duration as it impacts the server

performance

Once the verbose log is enabled amessage Verbose logs on until $time is displayed with Extend by

15 minutes and Verbose off buttons



Once the duration of the verbose log is complete the verbose logging will be turned off

11112 Extending the Verbose Log Duration

To extend the verbose log duration click Extend by 15 minutes

Verbose log can be extended only by fifteenminutes from the current duration If the current expiry

time is greater than fifteenminutes from the current time amessage appears stating the current expiry

time cannot bemodified

11113 Verbose Off

You can cancel the verbose logging on duration by clicking Verbose Off A message appears asking

for the confirmation



Click Yes to turn the verbose logging off

1112 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 app Id device Id client IP and service name

To filter the log level by client follow these steps



1 Select the parameter by clicking the drop-downmenu The parameter values are

Field Description

Login ID This refers to the userID field set in the application This can be set by using an

identity service or by usingkonysetUserID() in the application Refer

Kony Visualizer SDK gt setuserID API

App ID This refers to the Kony Fabric appId that is available when an app is published to

an environment The AppID is available from the app service document from the

Publish page for the app in Kony Fabric console (give example) like

Refer Kony Fabric gt Publish gt App Service Document

Service ID This refers to the Service Name of the service



Field Description

Device ID This refers to the deviceID of the device obtained from the client app You can

print the test value for the same using the

konyosdeviceinfodeviceid API

For more information on DeviceID refer Visualizer API Dev Guide gt konyos_

objects_deviceinfo

IP Address This refers to the external IP address of the client device You can find the IP

address of the client device in the HTTP payload returned from the device

The external IP address is also available from custom reports for service calls

from a device

If you are using a test device you can alternatively visit

httpswwwwhatismyipcom from the device to know the external IP address of

the device

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

5 Set the log level by selecting the type of log level from the drop-down list









Note Enabling Log Level type asDebug or lower will also enable Service

Monitoring feature in V8SP2 or higher versions of the server If the Service

Monitoring feature is disabled servicemonitoring data is captured only for the users

matching the client log filter criteria If the Service Monitoring feature is enabled the

client log level set here has no effect and data is collected for all the users For more

information on ServiceMonitoring feature refer ServiceMonitor


application








Click Save to save the changes done in the Logging page

Click Cancel to abort the changes



1113 Cloud Logs

TheCloud Logs view in Kony Fabric App ServicesConsole enables you to verify server logs in the

cloud environment The page displays a list of instanceswith Instance ID and the links to view the

Archived and Snapshot Logs If the number of logs ismore than 10 you can use the Next or Previous

options

There are two types of cloud logs

l Archived Logs

l Snapshot Logs

11131 Archived Logs

The log files for this server instance are archived every hour and stored for fifteen days You can view

and download these archived log files If the number of archived log files aremore than ten you can

use Next or Previous options



The screen displays the following fields

FieldName

Description

Refresh Click to refresh the logs For more information refer Refresh Logs

Download

All

Click to download all the logs For more information refer Download All logs

Download

Selected

Select any desired logs and click Download Selected to download the selected logs

For more information refer Download Selected

Search by

Name

Search the logs by log name For more information refer Search Archived Logs by

Name

Search by

Duration

Search the logs by duration For more information refer Search Archived Logs by

Duration

Log file Displays the list of archived logs

Time Displays the date and time when the logs are generated




l Download All Logs

l Download Selected Logs

l Refresh Archived logs

l Search Archived Logs byName

l Search Archived Logs byDuration

Download All Logs

To download all the archived log files follow these steps

1 On the Archived Logs page click Download All

A pop-up appears with themessage Are you sure you want to download all Log files

2 ClickOK to download the selected archived log files

Download Selected Logs

To download the selected logs follow these steps

1 On the Archived Logs page select the check box to the right of the log file(s) you want to

download and click Download Selected



A pop-up appears with themessage Are you sure you want to download selected Log files

2 ClickOK to download the selected archived logs

Refresh Archived Logs

Click Refresh from the Archived Logs page to refresh the logs

The Archived Logs are refreshed

Search Archived Logs by Name

You can search the archived logs by log name



l Enter a log name in the Search field to search for a particular log

The Archived Logs are filtered based on the search criteria

Search Archived Logs by Duration

You can select a duration to search for the logswithin a time period

l Click Calendar to the right of the Search by Duration field to select From and To date

Or

l Enter the From and To date in the Search by Duration field



The Archived Logs are filtered for the selected time period

11132 Snapshot Logs

Snapshot Logs include the last manual log snapshot fetched from the server The logs listed in the

table are periodic snapshots of the log files and could not contain the latest log data You can view and

download the snapshot log files You can initiate manual snapshot of all the logs on all the servers If

the number of snapshot log files aremore than 10 you can use Next or Previous options

Click View Snapshot Logs from the cloud logs tab to view the snapshot logs



Refresh Refreshes the displayed logs

Download

All

Select to download all the snapshot logs For more information refer Download All

Snapshot Logs

Download

Selected

Logs

Select the desired logs and click Download Selected to download the selected logs

For more information refer Download Selected Snapshot Logs

Request

Latest Logs

Click to request the latest logs For more information refer Request Latest Snapshot

Logs




Search by

Name

Search logs by log file name For more information refer Search Snapshot Logs by

Name

Log File Displays the list of Snapshot logs

Time Displays the date and time when the logs generated

You can perform the following actions in this window

l Refresh Snapshot Logs

l Download All Snapshot Logs

l Download Selected Snapshot Logs

l Request Latest Snapshot Logs

l Search by Snapshot Logs byName

Refresh Snapshot Logs

Click Refresh from the Snapshot Logs page to refresh the logs

The Snapshot logs are refreshed

Download All Snapshot Logs

To download all the snapshot log files follow these steps

1 On the Snapshot Logs page click Download All




2 ClickOK to download the selected snapshot log files

Download Selected Snapshot Logs


1 On the Snapshot Logs page select the check box to the left of the snapshot file(s) you want to





2 ClickOK to download the selected snapshot logs

Request Latest Snapshot Logs

To refresh the snapshot logs and to reload the table with new snapshots available for download

1 Click Request Latest Logs

A pop-up appears with themessage Are you sure you want to get latest Log files

2 ClickOK to download the latest log files

Themanual snapshots of the logs are typically available within fiveminutes

Search Snapshot Logs by Name


Enter a log name in the Search field to search for a particular log



The Snapshot Logs are filtered based on the search criteria

112 Trace Logs

Trace Log feature enables you to view the request and response data between the clients and


To access Trace Logs in Admin Console follow these steps



2 Click Server to access the Admin Console

The Admin Console UI appears

3 Click Logs from the left pane of the screen

The new window appears with the list of logs created



You can perform following actions in this screen

l Log Configuration

l Copy the payload

l Customize Http Request (or) Response

l Export Logs

l Clear Logs

The logs screen displays the following UI elements

UIElement

Description

Request ID ID of the selected request



UIElement

Description

User ID ID of the logged in user

Application

ID

ID of the application on which the log is created

Session ID ID of the particular session on which the log is created

Request

Method

Method on which the request is sent

Http

Request

(sec)

Displays the time taken (in seconds) to send the request

Click Http Request against a log to display the device payload information

Note You can sort the displayed logs based on the request or the response time

You can customize the Http Request by selecting the date and time For more

information refer Customize Http Request (or) Response

Http

Response

(sec)

Displays the time taken (in seconds) to receive the response

Click Http Response against a log to display the device payload information


You can customize the Http Response by selecting the date and time For more


Elapsed

Time

The amount of time taken between the request sent and the response received

Request

Size

Size (in bytes) of the request sent



UIElement

Description

Response

Size

Size (in bytes) of the response received

opstatus op status of the response

Refresh Refreshes the log list

Clear Logs Clears the logs Trace logs older than seven days are automatically deleted You can

alsomanually delete the logs using Clear Logs

Tomanually delete the logs you can perform the following actions

l All - Clear all the logs

l Older than 2 days - Delete logs older than 2 days

l Older than 1 day - Delete logs older than 1 day

For more information refer Clear Logs

Show Only

Errors

Displays only the error logs

Export Exports the trace logs list You can export the logs in two ways

l Export Current Exports the current log list

l Export All Exports all the logs from the server

1121 Log Configuration

Log configuration can be set from the Trace Logs drop-down list Trace logs can be enabled or

disabled by selecting ON or OFF from the drop-down list



Upon enabling the trace log a drop-down list is displayed to select the duration of the trace on The

available options are 15 30 and 60minswith 30mins is selected by default

After selecting the Trace on duration click Save

Note Trace log can only be turned on for a limited duration as it impacts the server performance

Once the trace log is enabled amessage Trace on until $time is displayed with Extend by 15

minutes and Trace off buttons

Once the duration of the trace log is complete trace logging will be turned off

11211 Extending the Trace time

To extend the trace time click Extend by 15 minutes button

Trace log can be extended only by fifteenminutes from the current duration If the current expiry time is

greater than fifteenminutes from the current time amessage appears stating the current expiry time

cannot bemodified



11212 Trace off

You can cancel the trace on duration by clicking Trace Off A message appears asking for the

confirmation

Click Yes to turn the trace off

1122 Copy the Payload

To copy the request or response payload in the Logs screen follow these steps

1 Select a log from the list of logs by clicking against the Http Request or Http response

2 Click Copy in the body parameter to copy the payload



1123 Customize Http Request (or) Response

You can customize the Http request (or) response by selecting the date and time To customize the

Http Request (or) Response follow these steps

1 Click the text box associated with the Http Request The date and time pop-up appears

2 Select the date and time to view the Http requests and clickOk The selected date and time

appears in the text box

The Trace Logs screen displays the Http requests sent after the selected date and time and the

current date

3 Similarly click the text box associated with Http Response

4 Select the date and time in the pop-up and clickOk

The Trace Logs screen displays the Http responses received before the selected date and time



1124 Export Logs

You can export the trace logs created in the system to an Excel sheet Perform the following actions to

export the logs to your system

1 Log on to Admin Console and select Logs from the left pane of the screen

You can view the generated logs displayed on the screen

2 Click Export from the right pane of the screen Two options Export All and Export Current are

displayed

3 Select either of the options to export logs to an Excel sheet A pop-up displays asking for a

confirmation

4 Click Yes An Excel file is downloaded to the systemwith the list of logs and the details

The following is a sample Excel sheet with the list of logs and its details



1125 Clear Logs

Trace logs are deleted automatically after seven days You can alsomanually delete the logs using the

options provided in clear logs

l AutoDelete - All the trace logs older than seven days are automatically deleted

Note Admin does not have the option to turn off AutoDelete

Note From release version V8 SP4 and above Admin Console supports auto-delete and

clear logs for logs older than two days



l Manual Delete - Tomanually delete the logs perform the following actions

1 Click Clear Logs the system displays the following options

l All - Click All to delete all the trace logs displaying on the screen

l Older than 2 days - ClickOlder than 2 days to delete the logs older than two days

l Older than 1 day - ClickOlder than 1 day to delete the logs older than one day

2 Select any of the options tomanually clear the logs A pop-up displays that asks you for the

confirmation

3 Click Yes to clear the logs The logs are deleted based on the selection


12 Settings Kony Fabric App Services User GuideVersion17

12 Settings

The Settings page of App Services consists of four modules

l Configurable Parameters

l RuntimeConfiguration

l Environment Details

l SSLCertificates

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

SSL Certificates This section allows you to upload the one-way and two-way SSL certificates to

configure the secured communication between the client and the server For detailed information

refer SSLCertificates

121 Configurable Parameters

Configurable Parameters 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 updatesmade to the configured properties are reflected in the custom code

From the left pane click Settings gt Configurable Parameters tab Here you can define the key value

pairs for Server Properties and Client App Properties By default the Server Properties tab is

selected



The configured server properties are available to all the back-end services running on that server The

configured client properties are available to any client app that has permission to access the server

You can read these properties from Java or JavaScript logic associated to the service

Note Steps to add delete export and import key value pairs for server properties and client

properties are same

The following fields are displayed in this screen

Field Description

Field Name Name of the key value pair

Field Value Value of the key value pair

Save Saves the entered information

Cancel Resets the changes



Field Description

Delete Removes the key value pair from the list

Note The delete option is displayed only after you select any key value pair

check-box

Mask It masks the value in the key value pair in the UI Themasked values are stored in an

encrypted format in the database When you export the key value pairs the values

which aremasked are empty Once youmask a value they cannot be unmasked

Note If you want to update the Key or Value after you havemasked a value you

must remove the existing value and retype the required value

Export Downloads a zip file which contains the list in CSV files

Import Uploads the key value pair list You can only upload zip files

Sort Displays the list in alphabetical order (ascending or descending)

Search Enter the field name or field value to search for any existing key value pairs

If you have not configured any property the Server Properties tab displays a blank row where you can

enter the key value pair If the properties are available by default they are displayed in an alphabetical

order (ascending) based on Field Name The provision to add a new key value pair is provided at the

bottom

Click the Sort icon if you want to change the alphabetical order

Note If you re-load the page the alphabetical order changes to the default order

1211 Adding a key value pair

To add a set of key value pairs perform the following actions



1 Log on to App Services and from the left pane click Settings

2 From the top pane of the Settings screen click Configurable Parameters tab

3 Enter a field name and field value in the blank row to configure the key value pair


1212 Deleting a key value pair

To delete an existing key value pair perform the following actions





3 Select the check-box of the key value pair which you want to delete and click Delete You can

also hover on the key value pair which you want to delete and click the delete icon

4 You can also deletemultiple key pair values (bulk delete) at the same time Perform the

following steps to bulk delete the key pair values

l Select the check-boxes of the required key value pairs and click Delete

l If you want to delete all the key value pairs select the check-box available in the header

section of the configurable parameters table and click Delete

1213 Export the key value pair list

To export the key value pair list perform the following actions





3 Click Export The key value pair list is downloaded asCSV file within a zip file

Note To export the Configurable Parameters usingMFCLI command refer to Export and

Import Configurable Parameters for App Services throughMFCLI

1214 Import the key value pair list

To import the key value pair list perform the following actions



3 Click Import to upload the required zip file

4 Click Browse and Validate and select the required zip file that contains the CSV files

Important Name the files as serverProperties and clientAppProperties Each file must

contain two columns Header of the first and second column should be Field Name and

Field Value respectively It ismandatory to follow these naming conventions

If the name of the keys in the imported file matcheswith the existing names you will see a conflict

message while importing with the list of keys that have the conflict Click Upload to overwrite the

existing keys and valueswith the new keys and values or click Cancel to stop the upload

Note If the imported file contains same key namewith different key values the last key value

takes the precedence for that key name



Note To import the Configurable Parameters usingMFCLI command refer to Export and Import

Configurable Parameters for App Services throughMFCLI

1215 Access properties from Java PostProcessor

Add the following code to the existing code to access the configured properties from Java

PostProcessor

package comcustompreprocessor

import comkonylabsmiddlewarecommonDataPostProcessor2

import comkonylabsmiddlewarecontrollerDataControllerRequest

import comkonylabsmiddlewarecontrollerDataControllerResponse

import comkonylabsmiddlewaredataobjectParam

import comkonylabsmiddlewaredataobjectResult

import comkonylabsmiddlewareapiConfigurableParametersHelper

import comkonylabsmiddlewareapiServicesManager

import javautilMap



public class ServerConfigParamsPostProcessor

implements DataPostProcessor2

Override

public Object execute(Result result DataControllerRequest request

DataControllerResponse response)

throws Exception

ServicesManager sm = requestgetServicesManager()

ConfigurableParametersHelper paramHelper =

smgetConfigurableParametersHelper()

encryption is the key configured under Server Properties tab in

App Services

String myServerParam = paramHelpergetServerProperty(encryption)

MAX_EVENTS_SIZE is the key configured under Client App Properties

in App Services

String myClientParam = paramHelpergetClientAppProperty(MAX_EVENTS_

SIZE)

MapltStringStringgt serverProperties =

paramHelpergetAllServerProperties()

MapltStringStringgt clientAppProperties =

paramHelpergetAllClientAppProperties()

return result

1216 Access properties of Java PreProcessor


PreProcessor




import comkonylabsmiddlewarecommonDataPreProcessor2




import comkonylabsmiddlewaredataobjectRecord




import javautilHashMap

import javautilMap

public class ServerConfigParams

implements DataPreProcessor2

Override

public boolean execute(HashMap inputMap DataControllerRequest

request

DataControllerResponse response Result result)

throws Exception





App Services



in App Services




SIZE)

MapltString Stringgt serverProperties =


MapltString Stringgt clientAppProperties =


return true

1217 Access properties of Java PreProcessor and PostProcessor

Add the following code to the existing code to access the configured properties of JavaScript

PreProcessor and PostProcessor

var paramHelper = requestgetServicesManager

()getConfigurableParametersHelper()

var serverProp = paramHelpergetServerProperty(encryption)

var clientProp = paramHelpergetClientAppProperty(MAX_EVENTS_SIZE)

var serverParam = new comkonylabsmiddlewaredataobjectParam

(encryption serverProp)

var clientParam = new comkonylabsmiddlewaredataobjectParam(MAX_

EVENTS_SIZE clientProp)

resultaddParam(serverParam)

resultaddParam(clientParam)

allServerProps and allClientProps is of MapltStringStringgt type

var allServerProps = paramHelpergetAllServerProperties()

var allClientProps = paramHelpergetAllClientAppProperties()

var serverPropertyKeyset = allServerPropskeySet()toArray()

for(var index=0 indexltserverPropertyKeysetlengthgt index++)



var serverPropFromMap = allServerPropsget(serverPropertyKeyset

[index])

var serverParamFromMap = new comkonylabsmiddlewaredataobjectParam

(serverPropertyKeyset[index]

serverPropFromMap)

resultaddParam(serverParamFromMap)

var clientPropertyKeyset = allClientPropskeySet()toArray()

for(index=0 indexltclientPropertyKeysetlengthgt index++)

var clientPropFromMap = allClientPropsget(clientPropertyKeyset

[index])

var clientParamFromMap = new comkonylabsmiddlewaredataobjectParam

(clientPropertyKeyset[index]

clientPropFromMap)

resultaddParam(clientParamFromMap)

122 Runtime Configuration

TheRuntime Configuration tab on the Settings screen of App Services enables you to view and edit

the runtime configuration settings of the Fabric Server The configuration details comprise of the

following sections

l General Configuration

l Log Configuration

l CORS Configuration

l SSLConfiguration

l Storage Database Configuration

l GDPR Policy



l File Storage Configuration

l WebAppsConfiguration

l Cache Configuration

l Global Throttling Configuration

1221 General Configuration

TheGeneral Configuration section displays the general settings of the Fabric server You canmodify

any setting and click Save to update the change

The following table describes the settings in the General Configuration section

Property Name Description

JSON Array Support Enable this option to accumulatemultiple JSON

objects with same ID into an array If not enabled the

latest JSON object will overwrite the previous one

Send Default User Agent Enable this to send the default user agent to the

backend instead of user agent of the client This is

True by default

The default user agent value is Mozilla50(Windows U Windows NT 51 en-US

rv1917) Gecko20091221

Firefox357 (NET CLR 3530729)

Accept only Gzip Compression for Endpoint

Response

If enabled gzip is sent as one of the Accept-

Encoding formats in the backend request

Exclude Stacktrace from Logs Option to exclude exception stack trace from the

logs




DoNot Escape XMLSpecial Characters A comma separated list of special characters that

should not be escaped in the request template of

XML and SOAP Services

Exclude Parameters in Request and

Response

A comma separated list of sensitive keys in the

request or the response tomask while logging any

information

Exclude Input Parameters from Log Context

(NDC)

A comma separated list of keys to exclude from the

diagnostic thread context of the logs

Server Time Frequency (milliseconds) The time period in milliseconds between successive

load of any change in asset or configuration If this

value is too low it could lead to performance issues

The default time is 10 seconds

Server Timer Delay in Startup (milliseconds) The delay in milliseconds after server starts and

before the assets and configurations are loaded

Number of Server Nodes for Throttling The number of nodes in this server cluster It is used

for calculating API Throttling values

Kony Reports Year Drop downOffset The number of years to be displayed in the Reports

tab of App Services

Kony Services Context Path The context path of the current Fabric instance The

default path is services

Enable Proxy Enable proxy for communication with the backend

The proxy settings are part of the service definition




Service Custom Response Headers List of additional custom headers to return in every

response The list is in the following JSON array

format

[name_Cache-Control value_

no-cache_no-store_must-

revalidate]

These headers will be appended to the response of

integration service requests originating from

applications


The Log Configuration section displays the configuration settings related to the server logs You can

modify any setting and click Save to update the changes

The following table describes the settings in the Log Configuration section


Server LogOption Select the log option from the list to specify where the

logs can be collected The available log options are as

follows

l Log file - User specified log file

l Database - Logs are stored in the database of the

server_application_log table in your

adminDB

l SYSLOG - Logs stored in the respective system

logs




Server Log Location When log option is logfile use this to specify the location

of the log file

Note After upgrading the server to the latest

version verify that the specified log location on the

Admin Consolematches with the current log

location

Server Logger JNDI Name When log option is database use this to specify the

JNDI name of the data-source

1223 CORS Configuration

TheCORS Configuration section displays the configuration settings related to CrossOrigin Resource

Sharing (CORS) access You canmodify any setting and click Save to update the changes

The following table describes the settings in the CORS Configuration section


CORS Enabled Enable this option for Cross Origin Resource Sharing (CORS)

support It will allow users to access resources across internet

domains




Fabric Server Access Control

Allow Origin Value

If you set the Fabric Server Access Control Allow Origin Value to

l ALL Sets the value as for Access-Control-Allow-Origin

header

l NONE Does not add Access-Control-Allow-Origin header

in the response

l ECHO Adds the value of Origin header as the Access-

Control-Allow-Origin header in the response


EchoWhitelist Domains

If Fabric Server Access Control Allow Origin Value is set to

ECHO then this whitelist (comma separated list) is used to specify

the list of valid domains that you echo back in the response The

request should specify the domain to echo back as ldquoOriginrdquo header

Control Allow Credentials If the value is not NONE and Fabric server Access Control Allow

Origin Value is not ALL then this value is set as Access-Control-

Allow-Credentials header in the response

Control Vary Header If the value is not NONE and Fabric server Access Control Allow

Origin Value is not ALL then this value is set as Vary header in the

response

1224 SSL Configuration

The SSL Configuration section is used to connect the Fabric Server to the customer enterprise server

using appropriate SSL certificates and settings This type of configuration is required only when you

want to connect the Fabric Server by using the HTTPS protocol You canmodify any setting and click

Save to update the changes

The following table describes the settings in the SSL Configuration section




SSL Trust Store The trust store location where the public SSL certificates are

stored

SSL Trust Store Password The password of trust store file

SSL Trust Store Type The extension of the trust store file If not specified then the

default value is jks

SSL Key Store The key store location where the private SSL certificates are

stored

SSL Key Store Password The password of key store file

SSL Key Store Type The extension of the key store file If not specified then the


SSL Algorithm The SSL algorithm used

For IBM application servers the algorithm value is SSLv3

For any other application server the algorithm value is TLS

SSL Socket Factory Provider The security provider of SSL Socket Factory

SSL Server Socket Factory Provider The security provider of SSL Server Socket Factory




SSL Socket Factory Host Name

Verifier

Select the SSL Socket Factory Host Name Verifier

l BROWSER_COMPATIBLE_HOSTNAME_VERIFIER

Allows you to connect to the servers having wild card

certificate as abccom abccom

childabccom

l 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

l STRICT_HOSTNAME_VERIFIER Allows you to

connect to the servers with the specific host name

1225 Storage Database Configuration

The Storage Database Configuration section displays the database properties of storage services of

Fabric server This is used only for on-premise installs You canmodify any setting and click Save to

update the changes

The following table describes the settings in the Storage Database Configuration section


Database Type The type of database to be used By default this will be same

as the type of the Fabric database

Database Host Name The host name of the database By default this will be same as

the host name of the Fabric database

Database Port The port number at which your database is running By default

this will be same as the port number of the Fabric database




Database User Name The username for accessing the database By default this will

be same as the username of the Fabric database

Database Password The password for accessing the database By default this will

be same as the password of the Fabric database

Database Instance The name of the database instance if the database type is

Oracle database

Data Tablespace Name The name of the tablespace in which data is stored if the

database type is Oracle database

Index Tablespace Name The name of the tablespace in which index is created if the


LOB Tablespace Name The name of the large object tablespace created in the server if

the database type is Oracle database

SQL Server Default Schema The default schema of the SQL Server database

Max Allowed Connections Themaximum number of allowed connections to access the

database

Connection Timeout in Seconds The time out interval in seconds for server to reply to the client

request for the Storage services

1226 GDPR Policy

The section displays the property for encoding Personally Identifiable Information (PII) data sent to the

Fabric Server for reporting To comply with GDPR (General Data Protection Regulation) Policy

customersmust enable the setting to ensure any reporting data collected from the app (that could be

PII encoded or cleared) cannot be changed back to its original content You canmodify any setting and



click Save to update the changes

The following table describes the settings in the GDPR Policy section

Property Description

Enable PII Encode Enable to encode the PII data sent for reporting The setting

must be enabled for GDPR compliance

1227 File Storage Configuration

The File Storage Configuration section displays the configuration properties related to File Storage

adapter It is applicable only for on-premise install

The following table describes the settings in the File Storage Configuration section


File Storage Root Directory The root directory of Network File System (NFS) for storing the

files

1228 Web Apps Configuration

TheWeb Apps configuration section displays the configuring properties of the new optimized web

apps package format that improves the app performance andminimize the downtime during

deployments The section displays the properties such asResponse Content TypeMappings Cache

Control age HTTP session caching and CustomResponse Headers You canmodify any setting and


The following table describes the settings in theWeb Apps Configuration section




Response Content

TypeMapping

The property is used to set the Content-Type header in the response based on

thematching file extension

Example If the file extension is css the Content-Type header value of the

response will be textcss Similarly there are other common extensions that

aremapped by default

Note If the response header is not defined the server displays an empty

string leaving it to the browser to sniff themime types placed in Kony

Fabric to intercept and alter themime types of the requested resource

Cache Control Age

(in secs)

The Cache-Control header in the response ie themaximum cache duration in

seconds The default value is 86400 seconds (ie 1 day)

HTTP Session

Caching

Enable this to cache the user session data The value is set to True by default




Custom Response

Headers

You can use the property to return additional custom headers in every

response For every requested resource of SPA application thementioned

headers are added to the response You can add the response header and its

value to the field It takes an array of JSON objects Each JSON object

contains two keys name and value Name is the header name and value as

the header value

Example

[

name X-Content-Type-Options value

nosniff

]

Limitations

l The header key and the value are static

l The header and the value added are not specific for SPA application (or)

resources (global)

Note User is responsible to provide a valid header key and value

The default value of the field is blank

Enable iPad

Redirect

Enable this to redirect requests coming from iPad devices above iOS 13 to

iPad view instead of Desktop view By default it is False



1229 Cache Configuration

Kony Fabric supports EHCache Memcached and Redis cache vendors AnOn-premise setup of

Kony Fabric uses EHCache as the default cachemechanism A cloud environment usesMemcached

as the default cachemechanism The Cache Configuration section displays the configuration

properties of the new cachemechanism The section displays the properties such asCache Type

Expiry time Cache Server URLs Advanced Cache properties and Enable Session Distribution You

canmodify any setting and click Save to update the change

The following table describes the settings in the Cache Configuration section


Cache Type The type of cache to use The list displays the

following possible options - EHCACHE

MEMECACHED and REDIS

Cache Expiry The cache expiry time in seconds for each cache

entry The default value is 20minutes

Note The default cache expiry time is 20

minutes




Cache Server URLs The URLs of the external cache servers

For example

MEMCACHED -

l For single node -ltIP

addresshostnamegtltportgt

l For Multi-node -ltIP

address1hostname1gtltport1gt

ltIP


REDIS



l For a Cluster Redis setup provide the list of

master nodes (separated by commas) in

multimodememcached nodes

ltIP


ltIPaddress2hostname2gtltport2gt




Advanced Properties The advanced properties specific to cache type in

JSON format

Default JSON template property

environment_properties

jcache_configuration_

properties_ additional_

properties_

environment_properties Add the cache properties

that are utilized by Kony Fabric

For example to identify themode of the Redis server

youmust add the following property

TheREDIS_CACHE_MODE property will have the

value as SINGLE CLUSTER or SENTINAL

based on the Redis server mode

Advanced properties of REDIS cluster mode


REDIS_CACHE_MODECLUSTER

jcache_configuration_properties

additional_properties_

Note If REDIS_CACHE_MODE is not defined in

Advanced Properties Kony Fabric considers

REDIS as the single node setup

jcache_configurations_properties Custom

properties related to JCache configuration are

configured in this section The configured custom

properties are sent directly to JCache

additional_properties The properties that are not

related to REDIS or JCache configurationmust be

added in this section




Enable Session Distribution Enable the property to distribute the cache session

amongmultiple nodes

Note EHCache does not support session

distribution If you want to distribute the session

data among themultiple nodes the cache type

must beMEMCACHE or REDIS

12210 Global Throttling Configuration

Apart from configuring the service level throttling from the Kony Fabric console you can also configure

the operation level throttling from theGlobal Throttling Configuration field The throttling limit set for a

service is applicable to all the operationswithin the service whereas the throttling information given

here will be implied to the respective operation of the service that youmention here

Note If you have set the throttling limit at both service and operation level then the service will not

respond when either of the limit ismet first

The following table describes the settings in the Global Throttling Configuration section


Operation Level Throttling You can limit the number of times the operation is invoked per

minute You can provide the throttling information in a JSON

array format

Note If an API exceeds the throttling limit it will not return

the service response

Following are the parameters required to define the throttling limit for the respective service type

Integration and Orchestration Service



[

resourcePathNameServicegetFirstName

httpMethodPOST

totalRateLimitPerMinute100

ipRateLimitPerMinute10

resourcePathNameServicegetLastName

httpMethodPOST



]

Object Service

[

resourcePathObjectServiceNameObject

httpMethodGET




httpMethodGET



]



Important You can only configure the POST httpMethod for Integration service andOrchestration

service types For Object service you can configure GET and DELETE httpMethod as is

whereas the POST and PUT httpMethod should be configured asCREATE and UPDATE

respectively

Note If you want to apply throttling on some custom verb then you can configure the custom verb

as the httpMethod

Note displayed beside the property implies the changes to the property groups required restart

of the server to reflect modified values

123 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 onwhich 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



124 SSL Certificates

Note SSLCertificates are available in Enterprise and Community editions of Kony Fabric Admin

Console Customers using Kony Fabric Admin Console in Starter edition cannot view the

following features

- ServiceMonitor

- Jobs

- Health Check

- Logs

- Reports

- Downloads

To configure secured communication between the server and the client App Services provides an

interface to upload the cliennt certificates and the root certificates of the backend to themiddleware

The uploaded SSL certificates aids in encrypting the information sent between the client and the

server

There are two ways of uploading the certificates to themiddleware



l One-way SSL

l Two-way SSL

One-way SSL A root certificate of the backend server is uploaded When the client sends a request

to the server themiddleware server(client) validates the certificate uploaded with the certificate in the

trust store If the certificate is found in the trust store the client accepts the communication from the

server

Two-way SSL A client SSL certificate is uploaded in the key store When a request is received both

the parties (client and the server) validates the certificates uploaded and the response is sent to the

client

To access SSL certificates in the App Services follow these steps

1 Log on to App Services For more information on logging refer Launching the App Services

2 Click Settings from the left pane of the App Services and click SSL Certificates tab to upload

the SSL certificates The SSL Certificates page appears




Field Description

Certificate Alias Name of the certificate provided while uploading

Note The field is case-insensitive andmust be unique

Type Type of the certificate uploaded SSL certificates are of two types

l One-way SSL

l Two-way SSL

Expires On The expiry date of the uploaded certificate

UploadedOn The uploaded date of the certificate

Uploaded By Name of the certificate uploaded user

Certificate Details Details of the uploaded certificate

Field Description

Cert Domain Domain of the uploaded certificate

Target Domain Intended target server to which the data is sent

Organization Certificate issuing organization

Issuer Certificate issuing authority

Add certificate Click Add Certificate to upload the certificate

Delete Delete the uploaded certificates




l AddCertificate

l Delete a Certificate

125 Add Certificate

You can add aOne-way or Two-way SSL certificates by clicking on Add Certificate button To add a

certificate click Add Certificate An Add SSL Certificate pop-up appears with two options

l One-way SSL

l Two-way SSL

1251 One-way SSL

You can uploadOne-way SSL certificates the root certificate signed by your own internal private

certificate authority or any intermediate certificates Enter the required details in the fields provided to

upload a one-way SSL certificate



Field Description

Certificate Alias Enter an alias name to upload the certificate


Server SSLCertificate Select the certificate to be uploaded by clicking the Browse button

Submit Click Submit to upload the certificate

Cancel Cancel the operation

To upload one-way SSL perform the following actions



1 Click one-way SSL fromAdd SSL Certificate pop-up

2 Enter an alias name for the certificate to be uploaded

3 Select the certificate by clicking the Browse button

4 Click Submit

1252 Two-way SSL

The two-way SSL certificate is the client certificate uploaded in the trust store In Add Certificate pop-

up select Two-way SSL and enter the required details in the fields provided





Field Description

Certificate Alias An alias name for the certificate to be

uploaded

Note The field is case-insensitive

andmust be unique

Client SSL certificate Browse to select the client SSL

certificate

Target Domains Target server to send the data

Note This field is mandatory if you

are using SSLCertificates in

Community edition

Private Key Private key of the certificate to be

uploaded

Private Key Password (Optional) Password for the private key

Note This is an optional field This

field is not applicable in community

edition

Submit Submit to upload the details entered

Cancel Cancel to abort the operation

Perform the following actions to upload a two-way SSL



l Click Two-way SSL fromAdd SSL Certificate pop-up

l Enter the required details and click Browse to select the Two-way SSL certificate

l Click Submit to upload the certificate to themiddleware

1253 Delete a Certificate

You can delete an uploaded certificate by performing the following actions

l Log on to App Services and click Settings from the left pane of the screen

l Click SSL Certificates tab from the top pane of the settings screen The list of uploaded

certificates appears

You can find a Delete icon displayed on the right corner across each row

l Click Delete to delete the certificate

Limitation

l Kony supports PKCS1 private key


13 Downloads Kony Fabric App Services User GuideVersion17

13 Downloads

From the Downloads screen you can view and download the exact version of libraries used in App

Services These libraries can be used in custom code defined for services for example Pre-

processor Post-processor or Java Service


14 Reports Kony Fabric App Services User GuideVersion17

14 Reports

As a part of App Services a standard set of applicationmetrics are gathered andmade 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 andmore

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 andmore 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 youmust configure the konyreportshome

environment in your system A legacy report can be generated to filter the traffic of various

applicationsplatforms For detailed information refer Legacy reports

Reports Settings Different types of report settings are displayed in the Settings page Using the

report settings you canmodify the displays of the reports change the timezone andmodify themeta

datamapping For detailed information refer Reports Settings



141 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

Statistics Description

AppUsage Displays the usage of an app in used sessions and users

Users are based on the developers using the konysetUserID()method If

themethod 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 themin 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 fromApplication 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

6 Select an application type from the Application Type drop-down list

The available values include Hybrid MixedMode MobileWeb Native and SPA

7 Select the aggregation of the report from the Aggregation list

The available aggregation values are Day Month andWeek

8 ClickGenerate

A basic report is generated with the selected parameters



142 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

konyreportshome environment property points to a valid directory and a JNDI entry for

konyadminreportsjndiname exists to access the Legacy reports database Legacy

Reports is only needed if you have upgraded from a 5x Kony Server instance and need to run

reports on data captured before the 6x upgrade

You can generate the following legacy reports in Kony Fabric Integration Service App Services portal

Report Description

Traffic Report Service

Requests (NativeSPA)

Traffic report for the service requests received

Traffic Report Visitors

(NativeSPA)

Traffic report for the session invoked by visitors



Report Description

Device Summary Report

(Thin client)

Summary report of the page views per thin client platform with date

aggregationmodes day week and themonth

Traffic Report-TC-Page

Views

Traffic report of the page view per thin client platform

Traffic Report ndash 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 App Services 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



10 ClickGenerate 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



143 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 additionalmetadata 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 associatedmenuwhich is related to the service call

andor an associated user event namewhich triggers at service call

3 Form MetaData Mapping Reports can display additionalmetadata 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 associatedmenuwhich is related to

viewing that form andor an associated user event name that triggers the form to load

144 Report Display Settings

Add or remove the platform types application types and channel types in the Report Display Settings

area



1441 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

1442 Add or Delete Application Types

Set the application type stringswhich you require to be displayed in the platform aggregation selection

boxwhile creating a report

1 To add an application type click Add

2 To delete an application type click Delete

1443 Channel Types

Set the channel type names you require to be displayed in the platform aggregation selection box


1 To add a channel type click Add

2 To delete a channel type click Delete

1444 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 fromUTC The timezone offset feature is used in all queries to convert data from

UTC to userrsquos timezone Default will be UTC

145 Report MetaData Mapping

The Report meta datamapping feature helps you add edit and delete themeta datamappings



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 associatedmenu in Associate Menu box

6 Enter the associated user event in Associated User Event box

7 Click Save Themapping is created

8 To edit an existingmapping select themapping and click Edit

9 To delete a servicemeta datamapping select themapping and click Delete

146 Form MetaData Mapping

The Formmeta datamapping helps you add edit and delete themeta datamappings of a form



To add or delete a form meta data mapping follow these steps

1 Click Add to add a new row in formmetadatamapping

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 themenu associated in Associate Menu text box

6 Type the associated user event in Associated User Event text box

7 Click Save

The formmetadatamapping is created




1 Revision History


21 Functional Flow

3 Web Apps

31 Test a Web App


4 Monitoring

41 Service

411 Export as CSV


413 Node Filter

414 Threshold

415 Notifications


42 Environment




511 Request Input

512 Response Output


6 Object Services

61 Hard Delete option for Storage Services using the X-Kony-Soft-Delete Flag


621 Request Input

622 Response Output



711 Request Input

712 Response Output

8 Workflow Services

9 Jobs


92 Adding a new job

921 Job Info

922 Define

923 Schedule


931 Get All Jobs


933 Create a Job

934 Update a Job


936 Get Job History

937 Run a Job Now


10 Health Check

11 Logs

111 Standard Logs



1113 Cloud Logs

112 Trace Logs




1124 Export Logs

1125 Clear Logs

12 Settings















1226 GDPR Policy







125 Add Certificate

1251 One-way SSL

1252 Two-way SSL


13 Downloads

14 Reports

141 Basic Reports

142 Legacy Reports





1443 Channel Types

1444 Time Zone




Copyright copy 2014 Kony Inc

All rights reserved

September 2019

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 andmethods 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 andWindows Vista are registered trademarks of Microsoft

Corporation Apple the Apple logo iTunes iPhone iPad OS X Objective-C Safari Apple Pay AppleWatch

and Xcode are trademarks or registered trademarks of Apple Inc Google the Google logo Android and the

Android logo are registered trademarks of Google Inc Chrome is a trademark of Google Inc BlackBerry

PlayBook Research inMotion and RIM are registered trademarks of BlackBerry SAPreg and SAPreg Business

Suitereg are registered trademarks of SAP SE in Germany and in several other countries All other terms

trademarks or servicemarks mentioned in this document have been capitalized and are to be considered the

property of their respective owners



1 Revision History










Table of Contents




3 Web Apps 12

31 Test aWeb App 13


4 Monitoring 15

41 Service 16



413 Node Filter 24

414 Threshold 24



42 Environment 38



















9 Jobs 72



921 Job Info 76

922 Define 82

923 Schedule 85


931 Get All Jobs 88


933 Create a Job 96








10 Health Check 115

11 Logs 117




1113 Cloud Logs 125

112 Trace Logs 134





1125 Clear Logs 142

12 Settings 144






























13 Downloads 181

14 Reports 182








1444 Time Zone 189
















Console





page is displayed










For example admin





21 Functional Flow


l WebApps

l Monitoring




l Object Services


l Jobs

l Health Check

l Logs

l Settings

l Reports

l Downloads


pane





3 Web Apps


application




Column Description

App

Name













l Test aWeb App

l Delete aWeb App

31 Test a Web App









the environment




the web application



once you delete it




4 Monitoring





for a week





Services




Enable Monitoring












41 Service







l Service Calls


l Error



Service Calls


period

Service Performance





Error






Field Description










Service and so on)







time range





Field Description













Time


l Threshold

l Notifications

l Export as CSV



l TimeRange Filter

l Error Filter

l Node Filter

411 Export as CSV











l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week



















displayed


413 Node Filter






414 Threshold




l Error Count














settings







l Count of Errors





values is triggered



timegt5000



monitoring data









service appears











415 Notifications
















account owners


account























Sample Payload

emailServiceRequest

emails

email

recipients

recipient [

emailId $mailId

type TO

]

senderName Kony










ltpgt $mailContent

priority true

startTimeStamp 0

endTimeStamp 0






Click Save


























sendmail

)



(MailServletclass)


7623066890220333243 L


Override







UTF-8)

try








(NotifyList)









mailId)








200)






else


response code


())



to trigger mail)

catch (Exception e)




trigger mail)



throws Exception

















return response


throws Exception




String password =










password + null)







(value)

else





return null









authToken)




(httpPost)

return httResponse


- Commons-io-26jar


- Httpclient-456jar

- Log4j-apijar

- Json-simplejar






ENDPOINT



Best Practices







42 Environment






TimeRange



sections



l CPU

l Memory

l Threads

CPU



that node




available CPU power


that node

Memory






l Total MemoryUsed


l HeapMemoryUsed


l NonHeapMemoryUsed




Memory


that node

Threads





l Total Threads

l ThreadsDeadlocks

l Threads Blocked

l ThreadsRunnable



l ThreadsWaiting





that node





retained for a week



App Services










l Event Count



Event Count


criteria





filter criteria








Field Description





displays Custom




name




Field Description

Subscriber Error

Percentage







l TimeRange Filter

l Error Filter

l Node Filter




time range





l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week

Custom Time Range











4302 Error filter




selected time range





4303 Node Filter
















Column Description







Column Description













l Request Input

l ResponseOutput

511 Request Input






Field Description




parameter





Field Description


name


value



512 Response Output



l Response Header

l Response Body













4 ClickGet Response






Services












6 Object Services






Column Description



refer




App Data

Model Objects





Column Description








Delete Flag











database








Storage







follows


l Field Value false



f ClickGet Response


Body section


Response Body





service







l Request Input

l ResponseOutput

621 Request Input




Field Description


methods are

Create

Update

Delete

Get




editable field)







field name entered


header table






622 Response Output



Section Description


request sent


code format








4 ClickGet Response




















operations


Column Description












two toggles

l Request Input

l Request Output

711 Request Input




Field Description

Input

Method

and URL








icon


row

Get

Response


712 Response Output


Section Description













4 ClickGet Response





8 Workflow Services




Workflow Service


services


Column Description








screen appears


Column Description

















Column Description








9 Jobs













l Adding a new job




UIElement

Description


Updat

ed by


Succe

ss

Rate


Last

run

status




UIElement

Description

Job

Status

















2 Type a keyword





92 Adding a new job




l Job Info

l Define

l Schedule



921 Job Info


fields provided







l Integration

l Orchestration

l Object Services

















the Jobs













actions


























displayed


logged


is displayed


displayed




expires






Failure























922 Define





l Job Info

l Define

l Schedule






Field Description






Field Description









4 ClickGet Response



provided






5 Click Next






923 Schedule






l Job Info

l Define

l Schedule









FieldName

Description


l Hour

l Minute

l Day

l Week

l Month

l Advanced



FieldName

Description
















date and time


example 0 05 8-18







click Next





9231 Limitations












931 Get All Jobs




9311 URL



9312 Method

GET

9313 Header











refer



expressionshtm









Active orInactive









[

jobId 1

jobName job1

description null

cronExpression null

updatedUser xxxxx

updatedDate 2018-12-24 090455

jobStatus Active

jobHistoryTotal 0









]



details

9321 URL



9322 Method

GET

9323 Header













the jobs



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency


jobId 1

jobName job1

jobFrequency 41 5

jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData cityName


jobStatus Active


retentionPeriod 30



jobFrequencyInfo

frequencyType 1

minuteValues [

5

]

933 Create a Job


9331 URL



9332 Method

POST

9333 Header











any job



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9335 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null

934 Update a Job


9341 URL



9342 Method

PUT

9343 Header









any job






running








Service

l objSer for Object

Service

l orchSerfor



job will run






Object Services


the job is running





execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9345 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null



9351 URL



9352 Method

DELETE

9353 Header










SUCCESS orFAIL











status SUCCESS

result null

message null

token null

936 Get Job History


9361 URL



9362 Method

GET

9363 Header













started


process ended








[



jobRunId 2


jobEndTime 2018-12-24 103541

jobDuration 0




jobRunId 1


jobEndTime 2018-12-24 093543

jobDuration 2000




]

937 Run a Job Now


9371 URL



9372 Method

POST

9373 Header













SUCCESS orFAIL








status SUCCESS

result null

message null

token null




9381 URL



9382 Method

POST

9383 Header







profile


email useridkonycom

firstname xxxxxx

lastname xxxxxxx

user_attributes


profile_attributes

firstname xxxxxx




email useridkonycom

lastname xxxxxxx

claims_token

value xxxxx

exp 1540293966000


refresh_token xxxxx



10 Health Check













For cloud


Sample Response

healthCheck PASSED

healthDetail









version xxxx

For On-premises


Sample Response

healthCheck PASSED

healthDetail





version xxxxx



11 Logs










111 Standard Logs








end server





















application











selected by default



performance











11113 Verbose Off













Field Description











Field Description





objects_deviceinfo




from a device



the device






client




















application












1113 Cloud Logs




options


l Archived Logs

l Snapshot Logs

11131 Archived Logs







FieldName

Description


Download

All


Download

Selected



Search by

Name


Name

Search by

Duration


Duration






l Download All Logs





Download All Logs

























Or





11132 Snapshot Logs









Download

All


Snapshot Logs

Download

Selected

Logs



Request

Latest Logs


Logs




Search by

Name


Name







































112 Trace Logs













l Log Configuration

l Copy the payload


l Export Logs

l Clear Logs


UIElement

Description




UIElement

Description


Application

ID



Request

Method


Http

Request

(sec)






Http

Response

(sec)






Elapsed

Time


Request

Size




UIElement

Description

Response

Size











Show Only

Errors





















cannot bemodified



11212 Trace off


confirmation















current date






1124 Export Logs






displayed


confirmation





1125 Clear Logs















confirmation




12 Settings





l SSLCertificates


















selected







properties are same


Field Description







Field Description



check-box













bottom





















































PostProcessor









import javautilMap





Override



throws Exception





App Services



in App Services


SIZE)





return result



PreProcessor













import javautilMap



Override


request


throws Exception





App Services



in App Services




SIZE)





return true






















[index])



serverPropFromMap)





[index])



clientPropFromMap)





following sections


l Log Configuration


l SSLConfiguration


l GDPR Policy

















True by default


rv1917) Gecko20091221



Response




logs








Response



information


(NDC)












tab of App Services










format



revalidate]



applications








follows




adminDB


logs





of the log file




location










domains





Allow Origin Value



header


in the response














response











stored





stored













Verifier





childabccom










update the changes

















Oracle database









database



1226 GDPR Policy


















files











Response Content

TypeMapping









Cache Control Age

(in secs)



HTTP Session

Caching





Custom Response

Headers






the header value

Example

[


nosniff

]

Limitations



resources (global)



Enable iPad

Redirect




















minutes





For example

MEMCACHED -





ltIP


REDIS






ltIP







JSON format





properties_



























amongmultiple nodes
















array format







[


httpMethodPOST




httpMethodPOST



]

Object Service

[


httpMethodGET




httpMethodGET



]






respectively


as the httpMethod















following features

- ServiceMonitor

- Jobs

- Health Check

- Logs

- Reports

- Downloads




server




l One-way SSL

l Two-way SSL




server



client








Field Description




l One-way SSL

l Two-way SSL





Field Description










l AddCertificate


125 Add Certificate



l One-way SSL

l Two-way SSL

1251 One-way SSL






Field Description












4 Click Submit

1252 Two-way SSL







Field Description


uploaded


andmust be unique


certificate




Community edition


uploaded




edition
















Limitation




13 Downloads






14 Reports

















141 Basic Reports








Requests per

Service


application


Sessions per

Device



max time taken

Service Duration

Detail
















8 ClickGenerate




142 Legacy Reports








Report Description





(NativeSPA)




Report Description


(Thin client)




Views



Visitors

























and time zones











area













1443 Channel Types





1444 Time Zone





























7 Click Save





1 Revision History


21 Functional Flow

3 Web Apps

31 Test a Web App


4 Monitoring

41 Service

411 Export as CSV


413 Node Filter

414 Threshold

415 Notifications


42 Environment




511 Request Input

512 Response Output


6 Object Services



621 Request Input

622 Response Output



711 Request Input

712 Response Output

8 Workflow Services

9 Jobs


92 Adding a new job

921 Job Info

922 Define

923 Schedule


931 Get All Jobs


933 Create a Job

934 Update a Job


936 Get Job History

937 Run a Job Now


10 Health Check

11 Logs

111 Standard Logs



1113 Cloud Logs

112 Trace Logs




1124 Export Logs

1125 Clear Logs

12 Settings















1226 GDPR Policy







125 Add Certificate

1251 One-way SSL

1252 Two-way SSL


13 Downloads

14 Reports

141 Basic Reports

142 Legacy Reports





1443 Channel Types

1444 Time Zone




1 Revision History










Table of Contents




3 Web Apps 12

31 Test aWeb App 13


4 Monitoring 15

41 Service 16



413 Node Filter 24

414 Threshold 24



42 Environment 38



















9 Jobs 72



921 Job Info 76

922 Define 82

923 Schedule 85


931 Get All Jobs 88


933 Create a Job 96








10 Health Check 115

11 Logs 117




1113 Cloud Logs 125

112 Trace Logs 134





1125 Clear Logs 142

12 Settings 144






























13 Downloads 181

14 Reports 182








1444 Time Zone 189
















Console





page is displayed










For example admin





21 Functional Flow


l WebApps

l Monitoring




l Object Services


l Jobs

l Health Check

l Logs

l Settings

l Reports

l Downloads


pane





3 Web Apps


application




Column Description

App

Name













l Test aWeb App

l Delete aWeb App

31 Test a Web App









the environment




the web application



once you delete it




4 Monitoring





for a week





Services




Enable Monitoring












41 Service







l Service Calls


l Error



Service Calls


period

Service Performance





Error






Field Description










Service and so on)







time range





Field Description













Time


l Threshold

l Notifications

l Export as CSV



l TimeRange Filter

l Error Filter

l Node Filter

411 Export as CSV











l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week



















displayed


413 Node Filter






414 Threshold




l Error Count














settings







l Count of Errors





values is triggered



timegt5000



monitoring data









service appears











415 Notifications
















account owners


account























Sample Payload

emailServiceRequest

emails

email

recipients

recipient [

emailId $mailId

type TO

]

senderName Kony










ltpgt $mailContent

priority true

startTimeStamp 0

endTimeStamp 0






Click Save


























sendmail

)



(MailServletclass)


7623066890220333243 L


Override







UTF-8)

try








(NotifyList)









mailId)








200)






else


response code


())



to trigger mail)

catch (Exception e)




trigger mail)



throws Exception

















return response


throws Exception




String password =










password + null)







(value)

else





return null









authToken)




(httpPost)

return httResponse


- Commons-io-26jar


- Httpclient-456jar

- Log4j-apijar

- Json-simplejar






ENDPOINT



Best Practices







42 Environment






TimeRange



sections



l CPU

l Memory

l Threads

CPU



that node




available CPU power


that node

Memory






l Total MemoryUsed


l HeapMemoryUsed


l NonHeapMemoryUsed




Memory


that node

Threads





l Total Threads

l ThreadsDeadlocks

l Threads Blocked

l ThreadsRunnable



l ThreadsWaiting





that node





retained for a week



App Services










l Event Count



Event Count


criteria





filter criteria








Field Description





displays Custom




name




Field Description

Subscriber Error

Percentage







l TimeRange Filter

l Error Filter

l Node Filter




time range





l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week

Custom Time Range











4302 Error filter




selected time range





4303 Node Filter
















Column Description







Column Description













l Request Input

l ResponseOutput

511 Request Input






Field Description




parameter





Field Description


name


value



512 Response Output



l Response Header

l Response Body













4 ClickGet Response






Services












6 Object Services






Column Description



refer




App Data

Model Objects





Column Description








Delete Flag











database








Storage







follows


l Field Value false



f ClickGet Response


Body section


Response Body





service







l Request Input

l ResponseOutput

621 Request Input




Field Description


methods are

Create

Update

Delete

Get




editable field)







field name entered


header table






622 Response Output



Section Description


request sent


code format








4 ClickGet Response




















operations


Column Description












two toggles

l Request Input

l Request Output

711 Request Input




Field Description

Input

Method

and URL








icon


row

Get

Response


712 Response Output


Section Description













4 ClickGet Response





8 Workflow Services




Workflow Service


services


Column Description








screen appears


Column Description

















Column Description








9 Jobs













l Adding a new job




UIElement

Description


Updat

ed by


Succe

ss

Rate


Last

run

status




UIElement

Description

Job

Status

















2 Type a keyword





92 Adding a new job




l Job Info

l Define

l Schedule



921 Job Info


fields provided







l Integration

l Orchestration

l Object Services

















the Jobs













actions


























displayed


logged


is displayed


displayed




expires






Failure























922 Define





l Job Info

l Define

l Schedule






Field Description






Field Description









4 ClickGet Response



provided






5 Click Next






923 Schedule






l Job Info

l Define

l Schedule









FieldName

Description


l Hour

l Minute

l Day

l Week

l Month

l Advanced



FieldName

Description
















date and time


example 0 05 8-18







click Next





9231 Limitations












931 Get All Jobs




9311 URL



9312 Method

GET

9313 Header











refer



expressionshtm









Active orInactive









[

jobId 1

jobName job1

description null

cronExpression null

updatedUser xxxxx

updatedDate 2018-12-24 090455

jobStatus Active

jobHistoryTotal 0









]



details

9321 URL



9322 Method

GET

9323 Header













the jobs



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency


jobId 1

jobName job1

jobFrequency 41 5

jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData cityName


jobStatus Active


retentionPeriod 30



jobFrequencyInfo

frequencyType 1

minuteValues [

5

]

933 Create a Job


9331 URL



9332 Method

POST

9333 Header











any job



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9335 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null

934 Update a Job


9341 URL



9342 Method

PUT

9343 Header









any job






running








Service

l objSer for Object

Service

l orchSerfor



job will run






Object Services


the job is running





execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9345 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null



9351 URL



9352 Method

DELETE

9353 Header










SUCCESS orFAIL











status SUCCESS

result null

message null

token null

936 Get Job History


9361 URL



9362 Method

GET

9363 Header













started


process ended








[



jobRunId 2


jobEndTime 2018-12-24 103541

jobDuration 0




jobRunId 1


jobEndTime 2018-12-24 093543

jobDuration 2000




]

937 Run a Job Now


9371 URL



9372 Method

POST

9373 Header













SUCCESS orFAIL








status SUCCESS

result null

message null

token null




9381 URL



9382 Method

POST

9383 Header







profile


email useridkonycom

firstname xxxxxx

lastname xxxxxxx

user_attributes


profile_attributes

firstname xxxxxx




email useridkonycom

lastname xxxxxxx

claims_token

value xxxxx

exp 1540293966000


refresh_token xxxxx



10 Health Check













For cloud


Sample Response

healthCheck PASSED

healthDetail









version xxxx

For On-premises


Sample Response

healthCheck PASSED

healthDetail





version xxxxx



11 Logs










111 Standard Logs








end server





















application











selected by default



performance











11113 Verbose Off













Field Description











Field Description





objects_deviceinfo




from a device



the device






client




















application












1113 Cloud Logs




options


l Archived Logs

l Snapshot Logs

11131 Archived Logs







FieldName

Description


Download

All


Download

Selected



Search by

Name


Name

Search by

Duration


Duration






l Download All Logs





Download All Logs

























Or





11132 Snapshot Logs









Download

All


Snapshot Logs

Download

Selected

Logs



Request

Latest Logs


Logs




Search by

Name


Name







































112 Trace Logs













l Log Configuration

l Copy the payload


l Export Logs

l Clear Logs


UIElement

Description




UIElement

Description


Application

ID



Request

Method


Http

Request

(sec)






Http

Response

(sec)






Elapsed

Time


Request

Size




UIElement

Description

Response

Size











Show Only

Errors





















cannot bemodified



11212 Trace off


confirmation















current date






1124 Export Logs






displayed


confirmation





1125 Clear Logs















confirmation




12 Settings





l SSLCertificates


















selected







properties are same


Field Description







Field Description



check-box













bottom





















































PostProcessor









import javautilMap





Override



throws Exception





App Services



in App Services


SIZE)





return result



PreProcessor













import javautilMap



Override


request


throws Exception





App Services



in App Services




SIZE)





return true






















[index])



serverPropFromMap)





[index])



clientPropFromMap)





following sections


l Log Configuration


l SSLConfiguration


l GDPR Policy

















True by default


rv1917) Gecko20091221



Response




logs








Response



information


(NDC)












tab of App Services










format



revalidate]



applications








follows




adminDB


logs





of the log file




location










domains





Allow Origin Value



header


in the response














response











stored





stored













Verifier





childabccom










update the changes

















Oracle database









database



1226 GDPR Policy


















files











Response Content

TypeMapping









Cache Control Age

(in secs)



HTTP Session

Caching





Custom Response

Headers






the header value

Example

[


nosniff

]

Limitations



resources (global)



Enable iPad

Redirect




















minutes





For example

MEMCACHED -





ltIP


REDIS






ltIP







JSON format





properties_



























amongmultiple nodes
















array format







[


httpMethodPOST




httpMethodPOST



]

Object Service

[


httpMethodGET




httpMethodGET



]






respectively


as the httpMethod















following features

- ServiceMonitor

- Jobs

- Health Check

- Logs

- Reports

- Downloads




server




l One-way SSL

l Two-way SSL




server



client








Field Description




l One-way SSL

l Two-way SSL





Field Description










l AddCertificate


125 Add Certificate



l One-way SSL

l Two-way SSL

1251 One-way SSL






Field Description












4 Click Submit

1252 Two-way SSL







Field Description


uploaded


andmust be unique


certificate




Community edition


uploaded




edition
















Limitation




13 Downloads






14 Reports

















141 Basic Reports








Requests per

Service


application


Sessions per

Device



max time taken

Service Duration

Detail
















8 ClickGenerate




142 Legacy Reports








Report Description





(NativeSPA)




Report Description


(Thin client)




Views



Visitors

























and time zones











area













1443 Channel Types





1444 Time Zone





























7 Click Save





1 Revision History


21 Functional Flow

3 Web Apps

31 Test a Web App


4 Monitoring

41 Service

411 Export as CSV


413 Node Filter

414 Threshold

415 Notifications


42 Environment




511 Request Input

512 Response Output


6 Object Services



621 Request Input

622 Response Output



711 Request Input

712 Response Output

8 Workflow Services

9 Jobs


92 Adding a new job

921 Job Info

922 Define

923 Schedule


931 Get All Jobs


933 Create a Job

934 Update a Job


936 Get Job History

937 Run a Job Now


10 Health Check

11 Logs

111 Standard Logs



1113 Cloud Logs

112 Trace Logs




1124 Export Logs

1125 Clear Logs

12 Settings















1226 GDPR Policy







125 Add Certificate

1251 One-way SSL

1252 Two-way SSL


13 Downloads

14 Reports

141 Basic Reports

142 Legacy Reports





1443 Channel Types

1444 Time Zone




Table of Contents




3 Web Apps 12

31 Test aWeb App 13


4 Monitoring 15

41 Service 16



413 Node Filter 24

414 Threshold 24



42 Environment 38



















9 Jobs 72



921 Job Info 76

922 Define 82

923 Schedule 85


931 Get All Jobs 88


933 Create a Job 96








10 Health Check 115

11 Logs 117




1113 Cloud Logs 125

112 Trace Logs 134





1125 Clear Logs 142

12 Settings 144






























13 Downloads 181

14 Reports 182








1444 Time Zone 189
















Console





page is displayed










For example admin





21 Functional Flow


l WebApps

l Monitoring




l Object Services


l Jobs

l Health Check

l Logs

l Settings

l Reports

l Downloads


pane





3 Web Apps


application




Column Description

App

Name













l Test aWeb App

l Delete aWeb App

31 Test a Web App









the environment




the web application



once you delete it




4 Monitoring





for a week





Services




Enable Monitoring












41 Service







l Service Calls


l Error



Service Calls


period

Service Performance





Error






Field Description










Service and so on)







time range





Field Description













Time


l Threshold

l Notifications

l Export as CSV



l TimeRange Filter

l Error Filter

l Node Filter

411 Export as CSV











l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week



















displayed


413 Node Filter






414 Threshold




l Error Count














settings







l Count of Errors





values is triggered



timegt5000



monitoring data









service appears











415 Notifications
















account owners


account























Sample Payload

emailServiceRequest

emails

email

recipients

recipient [

emailId $mailId

type TO

]

senderName Kony










ltpgt $mailContent

priority true

startTimeStamp 0

endTimeStamp 0






Click Save


























sendmail

)



(MailServletclass)


7623066890220333243 L


Override







UTF-8)

try








(NotifyList)









mailId)








200)






else


response code


())



to trigger mail)

catch (Exception e)




trigger mail)



throws Exception

















return response


throws Exception




String password =










password + null)







(value)

else





return null









authToken)




(httpPost)

return httResponse


- Commons-io-26jar


- Httpclient-456jar

- Log4j-apijar

- Json-simplejar






ENDPOINT



Best Practices







42 Environment






TimeRange



sections



l CPU

l Memory

l Threads

CPU



that node




available CPU power


that node

Memory






l Total MemoryUsed


l HeapMemoryUsed


l NonHeapMemoryUsed




Memory


that node

Threads





l Total Threads

l ThreadsDeadlocks

l Threads Blocked

l ThreadsRunnable



l ThreadsWaiting





that node





retained for a week



App Services










l Event Count



Event Count


criteria





filter criteria








Field Description





displays Custom




name




Field Description

Subscriber Error

Percentage







l TimeRange Filter

l Error Filter

l Node Filter




time range





l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week

Custom Time Range











4302 Error filter




selected time range





4303 Node Filter
















Column Description







Column Description













l Request Input

l ResponseOutput

511 Request Input






Field Description




parameter





Field Description


name


value



512 Response Output



l Response Header

l Response Body













4 ClickGet Response






Services












6 Object Services






Column Description



refer




App Data

Model Objects





Column Description








Delete Flag











database








Storage







follows


l Field Value false



f ClickGet Response


Body section


Response Body





service







l Request Input

l ResponseOutput

621 Request Input




Field Description


methods are

Create

Update

Delete

Get




editable field)







field name entered


header table






622 Response Output



Section Description


request sent


code format








4 ClickGet Response




















operations


Column Description












two toggles

l Request Input

l Request Output

711 Request Input




Field Description

Input

Method

and URL








icon


row

Get

Response


712 Response Output


Section Description













4 ClickGet Response





8 Workflow Services




Workflow Service


services


Column Description








screen appears


Column Description

















Column Description








9 Jobs













l Adding a new job




UIElement

Description


Updat

ed by


Succe

ss

Rate


Last

run

status




UIElement

Description

Job

Status

















2 Type a keyword





92 Adding a new job




l Job Info

l Define

l Schedule



921 Job Info


fields provided







l Integration

l Orchestration

l Object Services

















the Jobs













actions


























displayed


logged


is displayed


displayed




expires






Failure























922 Define





l Job Info

l Define

l Schedule






Field Description






Field Description









4 ClickGet Response



provided






5 Click Next






923 Schedule






l Job Info

l Define

l Schedule









FieldName

Description


l Hour

l Minute

l Day

l Week

l Month

l Advanced



FieldName

Description
















date and time


example 0 05 8-18







click Next





9231 Limitations












931 Get All Jobs




9311 URL



9312 Method

GET

9313 Header











refer



expressionshtm









Active orInactive









[

jobId 1

jobName job1

description null

cronExpression null

updatedUser xxxxx

updatedDate 2018-12-24 090455

jobStatus Active

jobHistoryTotal 0









]



details

9321 URL



9322 Method

GET

9323 Header













the jobs



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency


jobId 1

jobName job1

jobFrequency 41 5

jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData cityName


jobStatus Active


retentionPeriod 30



jobFrequencyInfo

frequencyType 1

minuteValues [

5

]

933 Create a Job


9331 URL



9332 Method

POST

9333 Header











any job



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9335 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null

934 Update a Job


9341 URL



9342 Method

PUT

9343 Header









any job






running








Service

l objSer for Object

Service

l orchSerfor



job will run






Object Services


the job is running





execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9345 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null



9351 URL



9352 Method

DELETE

9353 Header










SUCCESS orFAIL











status SUCCESS

result null

message null

token null

936 Get Job History


9361 URL



9362 Method

GET

9363 Header













started


process ended








[



jobRunId 2


jobEndTime 2018-12-24 103541

jobDuration 0




jobRunId 1


jobEndTime 2018-12-24 093543

jobDuration 2000




]

937 Run a Job Now


9371 URL



9372 Method

POST

9373 Header













SUCCESS orFAIL








status SUCCESS

result null

message null

token null




9381 URL



9382 Method

POST

9383 Header







profile


email useridkonycom

firstname xxxxxx

lastname xxxxxxx

user_attributes


profile_attributes

firstname xxxxxx




email useridkonycom

lastname xxxxxxx

claims_token

value xxxxx

exp 1540293966000


refresh_token xxxxx



10 Health Check













For cloud


Sample Response

healthCheck PASSED

healthDetail









version xxxx

For On-premises


Sample Response

healthCheck PASSED

healthDetail





version xxxxx



11 Logs










111 Standard Logs








end server





















application











selected by default



performance











11113 Verbose Off













Field Description











Field Description





objects_deviceinfo




from a device



the device






client




















application












1113 Cloud Logs




options


l Archived Logs

l Snapshot Logs

11131 Archived Logs







FieldName

Description


Download

All


Download

Selected



Search by

Name


Name

Search by

Duration


Duration






l Download All Logs





Download All Logs

























Or





11132 Snapshot Logs









Download

All


Snapshot Logs

Download

Selected

Logs



Request

Latest Logs


Logs




Search by

Name


Name







































112 Trace Logs













l Log Configuration

l Copy the payload


l Export Logs

l Clear Logs


UIElement

Description




UIElement

Description


Application

ID



Request

Method


Http

Request

(sec)






Http

Response

(sec)






Elapsed

Time


Request

Size




UIElement

Description

Response

Size











Show Only

Errors





















cannot bemodified



11212 Trace off


confirmation















current date






1124 Export Logs






displayed


confirmation





1125 Clear Logs















confirmation




12 Settings





l SSLCertificates


















selected







properties are same


Field Description







Field Description



check-box













bottom





















































PostProcessor









import javautilMap





Override



throws Exception





App Services



in App Services


SIZE)





return result



PreProcessor













import javautilMap



Override


request


throws Exception





App Services



in App Services




SIZE)





return true






















[index])



serverPropFromMap)





[index])



clientPropFromMap)





following sections


l Log Configuration


l SSLConfiguration


l GDPR Policy

















True by default


rv1917) Gecko20091221



Response




logs








Response



information


(NDC)












tab of App Services










format



revalidate]



applications








follows




adminDB


logs





of the log file




location










domains





Allow Origin Value



header


in the response














response











stored





stored













Verifier





childabccom










update the changes

















Oracle database









database



1226 GDPR Policy


















files











Response Content

TypeMapping









Cache Control Age

(in secs)



HTTP Session

Caching





Custom Response

Headers






the header value

Example

[


nosniff

]

Limitations



resources (global)



Enable iPad

Redirect




















minutes





For example

MEMCACHED -





ltIP


REDIS






ltIP







JSON format





properties_



























amongmultiple nodes
















array format







[


httpMethodPOST




httpMethodPOST



]

Object Service

[


httpMethodGET




httpMethodGET



]






respectively


as the httpMethod















following features

- ServiceMonitor

- Jobs

- Health Check

- Logs

- Reports

- Downloads




server




l One-way SSL

l Two-way SSL




server



client








Field Description




l One-way SSL

l Two-way SSL





Field Description










l AddCertificate


125 Add Certificate



l One-way SSL

l Two-way SSL

1251 One-way SSL






Field Description












4 Click Submit

1252 Two-way SSL







Field Description


uploaded


andmust be unique


certificate




Community edition


uploaded




edition
















Limitation




13 Downloads






14 Reports

















141 Basic Reports








Requests per

Service


application


Sessions per

Device



max time taken

Service Duration

Detail
















8 ClickGenerate




142 Legacy Reports








Report Description





(NativeSPA)




Report Description


(Thin client)




Views



Visitors

























and time zones











area













1443 Channel Types





1444 Time Zone





























7 Click Save





1 Revision History


21 Functional Flow

3 Web Apps

31 Test a Web App


4 Monitoring

41 Service

411 Export as CSV


413 Node Filter

414 Threshold

415 Notifications


42 Environment




511 Request Input

512 Response Output


6 Object Services



621 Request Input

622 Response Output



711 Request Input

712 Response Output

8 Workflow Services

9 Jobs


92 Adding a new job

921 Job Info

922 Define

923 Schedule


931 Get All Jobs


933 Create a Job

934 Update a Job


936 Get Job History

937 Run a Job Now


10 Health Check

11 Logs

111 Standard Logs



1113 Cloud Logs

112 Trace Logs




1124 Export Logs

1125 Clear Logs

12 Settings















1226 GDPR Policy







125 Add Certificate

1251 One-way SSL

1252 Two-way SSL


13 Downloads

14 Reports

141 Basic Reports

142 Legacy Reports





1443 Channel Types

1444 Time Zone















9 Jobs 72



921 Job Info 76

922 Define 82

923 Schedule 85


931 Get All Jobs 88


933 Create a Job 96








10 Health Check 115

11 Logs 117




1113 Cloud Logs 125

112 Trace Logs 134





1125 Clear Logs 142

12 Settings 144






























13 Downloads 181

14 Reports 182








1444 Time Zone 189
















Console





page is displayed










For example admin





21 Functional Flow


l WebApps

l Monitoring




l Object Services


l Jobs

l Health Check

l Logs

l Settings

l Reports

l Downloads


pane





3 Web Apps


application




Column Description

App

Name













l Test aWeb App

l Delete aWeb App

31 Test a Web App









the environment




the web application



once you delete it




4 Monitoring





for a week





Services




Enable Monitoring












41 Service







l Service Calls


l Error



Service Calls


period

Service Performance





Error






Field Description










Service and so on)







time range





Field Description













Time


l Threshold

l Notifications

l Export as CSV



l TimeRange Filter

l Error Filter

l Node Filter

411 Export as CSV











l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week



















displayed


413 Node Filter






414 Threshold




l Error Count














settings







l Count of Errors





values is triggered



timegt5000



monitoring data









service appears











415 Notifications
















account owners


account























Sample Payload

emailServiceRequest

emails

email

recipients

recipient [

emailId $mailId

type TO

]

senderName Kony










ltpgt $mailContent

priority true

startTimeStamp 0

endTimeStamp 0






Click Save


























sendmail

)



(MailServletclass)


7623066890220333243 L


Override







UTF-8)

try








(NotifyList)









mailId)








200)






else


response code


())



to trigger mail)

catch (Exception e)




trigger mail)



throws Exception

















return response


throws Exception




String password =










password + null)







(value)

else





return null









authToken)




(httpPost)

return httResponse


- Commons-io-26jar


- Httpclient-456jar

- Log4j-apijar

- Json-simplejar






ENDPOINT



Best Practices







42 Environment






TimeRange



sections



l CPU

l Memory

l Threads

CPU



that node




available CPU power


that node

Memory






l Total MemoryUsed


l HeapMemoryUsed


l NonHeapMemoryUsed




Memory


that node

Threads





l Total Threads

l ThreadsDeadlocks

l Threads Blocked

l ThreadsRunnable



l ThreadsWaiting





that node





retained for a week



App Services










l Event Count



Event Count


criteria





filter criteria








Field Description





displays Custom




name




Field Description

Subscriber Error

Percentage







l TimeRange Filter

l Error Filter

l Node Filter




time range





l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week

Custom Time Range











4302 Error filter




selected time range





4303 Node Filter
















Column Description







Column Description













l Request Input

l ResponseOutput

511 Request Input






Field Description




parameter





Field Description


name


value



512 Response Output



l Response Header

l Response Body













4 ClickGet Response






Services












6 Object Services






Column Description



refer




App Data

Model Objects





Column Description








Delete Flag











database








Storage







follows


l Field Value false



f ClickGet Response


Body section


Response Body





service







l Request Input

l ResponseOutput

621 Request Input




Field Description


methods are

Create

Update

Delete

Get




editable field)







field name entered


header table






622 Response Output



Section Description


request sent


code format








4 ClickGet Response




















operations


Column Description












two toggles

l Request Input

l Request Output

711 Request Input




Field Description

Input

Method

and URL








icon


row

Get

Response


712 Response Output


Section Description













4 ClickGet Response





8 Workflow Services




Workflow Service


services


Column Description








screen appears


Column Description

















Column Description








9 Jobs













l Adding a new job




UIElement

Description


Updat

ed by


Succe

ss

Rate


Last

run

status




UIElement

Description

Job

Status

















2 Type a keyword





92 Adding a new job




l Job Info

l Define

l Schedule



921 Job Info


fields provided







l Integration

l Orchestration

l Object Services

















the Jobs













actions


























displayed


logged


is displayed


displayed




expires






Failure























922 Define





l Job Info

l Define

l Schedule






Field Description






Field Description









4 ClickGet Response



provided






5 Click Next






923 Schedule






l Job Info

l Define

l Schedule









FieldName

Description


l Hour

l Minute

l Day

l Week

l Month

l Advanced



FieldName

Description
















date and time


example 0 05 8-18







click Next





9231 Limitations












931 Get All Jobs




9311 URL



9312 Method

GET

9313 Header











refer



expressionshtm









Active orInactive









[

jobId 1

jobName job1

description null

cronExpression null

updatedUser xxxxx

updatedDate 2018-12-24 090455

jobStatus Active

jobHistoryTotal 0









]



details

9321 URL



9322 Method

GET

9323 Header













the jobs



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency


jobId 1

jobName job1

jobFrequency 41 5

jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData cityName


jobStatus Active


retentionPeriod 30



jobFrequencyInfo

frequencyType 1

minuteValues [

5

]

933 Create a Job


9331 URL



9332 Method

POST

9333 Header











any job



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9335 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null

934 Update a Job


9341 URL



9342 Method

PUT

9343 Header









any job






running








Service

l objSer for Object

Service

l orchSerfor



job will run






Object Services


the job is running





execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9345 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null



9351 URL



9352 Method

DELETE

9353 Header










SUCCESS orFAIL











status SUCCESS

result null

message null

token null

936 Get Job History


9361 URL



9362 Method

GET

9363 Header













started


process ended








[



jobRunId 2


jobEndTime 2018-12-24 103541

jobDuration 0




jobRunId 1


jobEndTime 2018-12-24 093543

jobDuration 2000




]

937 Run a Job Now


9371 URL



9372 Method

POST

9373 Header













SUCCESS orFAIL








status SUCCESS

result null

message null

token null




9381 URL



9382 Method

POST

9383 Header







profile


email useridkonycom

firstname xxxxxx

lastname xxxxxxx

user_attributes


profile_attributes

firstname xxxxxx




email useridkonycom

lastname xxxxxxx

claims_token

value xxxxx

exp 1540293966000


refresh_token xxxxx



10 Health Check













For cloud


Sample Response

healthCheck PASSED

healthDetail









version xxxx

For On-premises


Sample Response

healthCheck PASSED

healthDetail





version xxxxx



11 Logs










111 Standard Logs








end server





















application











selected by default



performance











11113 Verbose Off













Field Description











Field Description





objects_deviceinfo




from a device



the device






client




















application












1113 Cloud Logs




options


l Archived Logs

l Snapshot Logs

11131 Archived Logs







FieldName

Description


Download

All


Download

Selected



Search by

Name


Name

Search by

Duration


Duration






l Download All Logs





Download All Logs

























Or





11132 Snapshot Logs









Download

All


Snapshot Logs

Download

Selected

Logs



Request

Latest Logs


Logs




Search by

Name


Name







































112 Trace Logs













l Log Configuration

l Copy the payload


l Export Logs

l Clear Logs


UIElement

Description




UIElement

Description


Application

ID



Request

Method


Http

Request

(sec)






Http

Response

(sec)






Elapsed

Time


Request

Size




UIElement

Description

Response

Size











Show Only

Errors





















cannot bemodified



11212 Trace off


confirmation















current date






1124 Export Logs






displayed


confirmation





1125 Clear Logs















confirmation




12 Settings





l SSLCertificates


















selected







properties are same


Field Description







Field Description



check-box













bottom





















































PostProcessor









import javautilMap





Override



throws Exception





App Services



in App Services


SIZE)





return result



PreProcessor













import javautilMap



Override


request


throws Exception





App Services



in App Services




SIZE)





return true






















[index])



serverPropFromMap)





[index])



clientPropFromMap)





following sections


l Log Configuration


l SSLConfiguration


l GDPR Policy

















True by default


rv1917) Gecko20091221



Response




logs








Response



information


(NDC)












tab of App Services










format



revalidate]



applications








follows




adminDB


logs





of the log file




location










domains





Allow Origin Value



header


in the response














response











stored





stored













Verifier





childabccom










update the changes

















Oracle database









database



1226 GDPR Policy


















files











Response Content

TypeMapping









Cache Control Age

(in secs)



HTTP Session

Caching





Custom Response

Headers






the header value

Example

[


nosniff

]

Limitations



resources (global)



Enable iPad

Redirect




















minutes





For example

MEMCACHED -





ltIP


REDIS






ltIP







JSON format





properties_



























amongmultiple nodes
















array format







[


httpMethodPOST




httpMethodPOST



]

Object Service

[


httpMethodGET




httpMethodGET



]






respectively


as the httpMethod















following features

- ServiceMonitor

- Jobs

- Health Check

- Logs

- Reports

- Downloads




server




l One-way SSL

l Two-way SSL




server



client








Field Description




l One-way SSL

l Two-way SSL





Field Description










l AddCertificate


125 Add Certificate



l One-way SSL

l Two-way SSL

1251 One-way SSL






Field Description












4 Click Submit

1252 Two-way SSL







Field Description


uploaded


andmust be unique


certificate




Community edition


uploaded




edition
















Limitation




13 Downloads






14 Reports

















141 Basic Reports








Requests per

Service


application


Sessions per

Device



max time taken

Service Duration

Detail
















8 ClickGenerate




142 Legacy Reports








Report Description





(NativeSPA)




Report Description


(Thin client)




Views



Visitors

























and time zones











area













1443 Channel Types





1444 Time Zone





























7 Click Save





1 Revision History


21 Functional Flow

3 Web Apps

31 Test a Web App


4 Monitoring

41 Service

411 Export as CSV


413 Node Filter

414 Threshold

415 Notifications


42 Environment




511 Request Input

512 Response Output


6 Object Services



621 Request Input

622 Response Output



711 Request Input

712 Response Output

8 Workflow Services

9 Jobs


92 Adding a new job

921 Job Info

922 Define

923 Schedule


931 Get All Jobs


933 Create a Job

934 Update a Job


936 Get Job History

937 Run a Job Now


10 Health Check

11 Logs

111 Standard Logs



1113 Cloud Logs

112 Trace Logs




1124 Export Logs

1125 Clear Logs

12 Settings















1226 GDPR Policy







125 Add Certificate

1251 One-way SSL

1252 Two-way SSL


13 Downloads

14 Reports

141 Basic Reports

142 Legacy Reports





1443 Channel Types

1444 Time Zone









10 Health Check 115

11 Logs 117




1113 Cloud Logs 125

112 Trace Logs 134





1125 Clear Logs 142

12 Settings 144






























13 Downloads 181

14 Reports 182








1444 Time Zone 189
















Console





page is displayed










For example admin





21 Functional Flow


l WebApps

l Monitoring




l Object Services


l Jobs

l Health Check

l Logs

l Settings

l Reports

l Downloads


pane





3 Web Apps


application




Column Description

App

Name













l Test aWeb App

l Delete aWeb App

31 Test a Web App









the environment




the web application



once you delete it




4 Monitoring





for a week





Services




Enable Monitoring












41 Service







l Service Calls


l Error



Service Calls


period

Service Performance





Error






Field Description










Service and so on)







time range





Field Description













Time


l Threshold

l Notifications

l Export as CSV



l TimeRange Filter

l Error Filter

l Node Filter

411 Export as CSV











l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week



















displayed


413 Node Filter






414 Threshold




l Error Count














settings







l Count of Errors





values is triggered



timegt5000



monitoring data









service appears











415 Notifications
















account owners


account























Sample Payload

emailServiceRequest

emails

email

recipients

recipient [

emailId $mailId

type TO

]

senderName Kony










ltpgt $mailContent

priority true

startTimeStamp 0

endTimeStamp 0






Click Save


























sendmail

)



(MailServletclass)


7623066890220333243 L


Override







UTF-8)

try








(NotifyList)









mailId)








200)






else


response code


())



to trigger mail)

catch (Exception e)




trigger mail)



throws Exception

















return response


throws Exception




String password =










password + null)







(value)

else





return null









authToken)




(httpPost)

return httResponse


- Commons-io-26jar


- Httpclient-456jar

- Log4j-apijar

- Json-simplejar






ENDPOINT



Best Practices







42 Environment






TimeRange



sections



l CPU

l Memory

l Threads

CPU



that node




available CPU power


that node

Memory






l Total MemoryUsed


l HeapMemoryUsed


l NonHeapMemoryUsed




Memory


that node

Threads





l Total Threads

l ThreadsDeadlocks

l Threads Blocked

l ThreadsRunnable



l ThreadsWaiting





that node





retained for a week



App Services










l Event Count



Event Count


criteria





filter criteria








Field Description





displays Custom




name




Field Description

Subscriber Error

Percentage







l TimeRange Filter

l Error Filter

l Node Filter




time range





l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week

Custom Time Range











4302 Error filter




selected time range





4303 Node Filter
















Column Description







Column Description













l Request Input

l ResponseOutput

511 Request Input






Field Description




parameter





Field Description


name


value



512 Response Output



l Response Header

l Response Body













4 ClickGet Response






Services












6 Object Services






Column Description



refer




App Data

Model Objects





Column Description








Delete Flag











database








Storage







follows


l Field Value false



f ClickGet Response


Body section


Response Body





service







l Request Input

l ResponseOutput

621 Request Input




Field Description


methods are

Create

Update

Delete

Get




editable field)







field name entered


header table






622 Response Output



Section Description


request sent


code format








4 ClickGet Response




















operations


Column Description












two toggles

l Request Input

l Request Output

711 Request Input




Field Description

Input

Method

and URL








icon


row

Get

Response


712 Response Output


Section Description













4 ClickGet Response





8 Workflow Services




Workflow Service


services


Column Description








screen appears


Column Description

















Column Description








9 Jobs













l Adding a new job




UIElement

Description


Updat

ed by


Succe

ss

Rate


Last

run

status




UIElement

Description

Job

Status

















2 Type a keyword





92 Adding a new job




l Job Info

l Define

l Schedule



921 Job Info


fields provided







l Integration

l Orchestration

l Object Services

















the Jobs













actions


























displayed


logged


is displayed


displayed




expires






Failure























922 Define





l Job Info

l Define

l Schedule






Field Description






Field Description









4 ClickGet Response



provided






5 Click Next






923 Schedule






l Job Info

l Define

l Schedule









FieldName

Description


l Hour

l Minute

l Day

l Week

l Month

l Advanced



FieldName

Description
















date and time


example 0 05 8-18







click Next





9231 Limitations












931 Get All Jobs




9311 URL



9312 Method

GET

9313 Header











refer



expressionshtm









Active orInactive









[

jobId 1

jobName job1

description null

cronExpression null

updatedUser xxxxx

updatedDate 2018-12-24 090455

jobStatus Active

jobHistoryTotal 0









]



details

9321 URL



9322 Method

GET

9323 Header













the jobs



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency


jobId 1

jobName job1

jobFrequency 41 5

jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData cityName


jobStatus Active


retentionPeriod 30



jobFrequencyInfo

frequencyType 1

minuteValues [

5

]

933 Create a Job


9331 URL



9332 Method

POST

9333 Header











any job



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9335 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null

934 Update a Job


9341 URL



9342 Method

PUT

9343 Header









any job






running








Service

l objSer for Object

Service

l orchSerfor



job will run






Object Services


the job is running





execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9345 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null



9351 URL



9352 Method

DELETE

9353 Header










SUCCESS orFAIL











status SUCCESS

result null

message null

token null

936 Get Job History


9361 URL



9362 Method

GET

9363 Header













started


process ended








[



jobRunId 2


jobEndTime 2018-12-24 103541

jobDuration 0




jobRunId 1


jobEndTime 2018-12-24 093543

jobDuration 2000




]

937 Run a Job Now


9371 URL



9372 Method

POST

9373 Header













SUCCESS orFAIL








status SUCCESS

result null

message null

token null




9381 URL



9382 Method

POST

9383 Header







profile


email useridkonycom

firstname xxxxxx

lastname xxxxxxx

user_attributes


profile_attributes

firstname xxxxxx




email useridkonycom

lastname xxxxxxx

claims_token

value xxxxx

exp 1540293966000


refresh_token xxxxx



10 Health Check













For cloud


Sample Response

healthCheck PASSED

healthDetail









version xxxx

For On-premises


Sample Response

healthCheck PASSED

healthDetail





version xxxxx



11 Logs










111 Standard Logs








end server





















application











selected by default



performance











11113 Verbose Off













Field Description











Field Description





objects_deviceinfo




from a device



the device






client




















application












1113 Cloud Logs




options


l Archived Logs

l Snapshot Logs

11131 Archived Logs







FieldName

Description


Download

All


Download

Selected



Search by

Name


Name

Search by

Duration


Duration






l Download All Logs





Download All Logs

























Or





11132 Snapshot Logs









Download

All


Snapshot Logs

Download

Selected

Logs



Request

Latest Logs


Logs




Search by

Name


Name







































112 Trace Logs













l Log Configuration

l Copy the payload


l Export Logs

l Clear Logs


UIElement

Description




UIElement

Description


Application

ID



Request

Method


Http

Request

(sec)






Http

Response

(sec)






Elapsed

Time


Request

Size




UIElement

Description

Response

Size











Show Only

Errors





















cannot bemodified



11212 Trace off


confirmation















current date






1124 Export Logs






displayed


confirmation





1125 Clear Logs















confirmation




12 Settings





l SSLCertificates


















selected







properties are same


Field Description







Field Description



check-box













bottom





















































PostProcessor









import javautilMap





Override



throws Exception





App Services



in App Services


SIZE)





return result



PreProcessor













import javautilMap



Override


request


throws Exception





App Services



in App Services




SIZE)





return true






















[index])



serverPropFromMap)





[index])



clientPropFromMap)





following sections


l Log Configuration


l SSLConfiguration


l GDPR Policy

















True by default


rv1917) Gecko20091221



Response




logs








Response



information


(NDC)












tab of App Services










format



revalidate]



applications








follows




adminDB


logs





of the log file




location










domains





Allow Origin Value



header


in the response














response











stored





stored













Verifier





childabccom










update the changes

















Oracle database









database



1226 GDPR Policy


















files











Response Content

TypeMapping









Cache Control Age

(in secs)



HTTP Session

Caching





Custom Response

Headers






the header value

Example

[


nosniff

]

Limitations



resources (global)



Enable iPad

Redirect




















minutes





For example

MEMCACHED -





ltIP


REDIS






ltIP







JSON format





properties_



























amongmultiple nodes
















array format







[


httpMethodPOST




httpMethodPOST



]

Object Service

[


httpMethodGET




httpMethodGET



]






respectively


as the httpMethod















following features

- ServiceMonitor

- Jobs

- Health Check

- Logs

- Reports

- Downloads




server




l One-way SSL

l Two-way SSL




server



client








Field Description




l One-way SSL

l Two-way SSL





Field Description










l AddCertificate


125 Add Certificate



l One-way SSL

l Two-way SSL

1251 One-way SSL






Field Description












4 Click Submit

1252 Two-way SSL







Field Description


uploaded


andmust be unique


certificate




Community edition


uploaded




edition
















Limitation




13 Downloads






14 Reports

















141 Basic Reports








Requests per

Service


application


Sessions per

Device



max time taken

Service Duration

Detail
















8 ClickGenerate




142 Legacy Reports








Report Description





(NativeSPA)




Report Description


(Thin client)




Views



Visitors

























and time zones











area













1443 Channel Types





1444 Time Zone





























7 Click Save





1 Revision History


21 Functional Flow

3 Web Apps

31 Test a Web App


4 Monitoring

41 Service

411 Export as CSV


413 Node Filter

414 Threshold

415 Notifications


42 Environment




511 Request Input

512 Response Output


6 Object Services



621 Request Input

622 Response Output



711 Request Input

712 Response Output

8 Workflow Services

9 Jobs


92 Adding a new job

921 Job Info

922 Define

923 Schedule


931 Get All Jobs


933 Create a Job

934 Update a Job


936 Get Job History

937 Run a Job Now


10 Health Check

11 Logs

111 Standard Logs



1113 Cloud Logs

112 Trace Logs




1124 Export Logs

1125 Clear Logs

12 Settings















1226 GDPR Policy







125 Add Certificate

1251 One-way SSL

1252 Two-way SSL


13 Downloads

14 Reports

141 Basic Reports

142 Legacy Reports





1443 Channel Types

1444 Time Zone




























13 Downloads 181

14 Reports 182








1444 Time Zone 189
















Console





page is displayed










For example admin





21 Functional Flow


l WebApps

l Monitoring




l Object Services


l Jobs

l Health Check

l Logs

l Settings

l Reports

l Downloads


pane





3 Web Apps


application




Column Description

App

Name













l Test aWeb App

l Delete aWeb App

31 Test a Web App









the environment




the web application



once you delete it




4 Monitoring





for a week





Services




Enable Monitoring












41 Service







l Service Calls


l Error



Service Calls


period

Service Performance





Error






Field Description










Service and so on)







time range





Field Description













Time


l Threshold

l Notifications

l Export as CSV



l TimeRange Filter

l Error Filter

l Node Filter

411 Export as CSV











l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week



















displayed


413 Node Filter






414 Threshold




l Error Count














settings







l Count of Errors





values is triggered



timegt5000



monitoring data









service appears











415 Notifications
















account owners


account























Sample Payload

emailServiceRequest

emails

email

recipients

recipient [

emailId $mailId

type TO

]

senderName Kony










ltpgt $mailContent

priority true

startTimeStamp 0

endTimeStamp 0






Click Save


























sendmail

)



(MailServletclass)


7623066890220333243 L


Override







UTF-8)

try








(NotifyList)









mailId)








200)






else


response code


())



to trigger mail)

catch (Exception e)




trigger mail)



throws Exception

















return response


throws Exception




String password =










password + null)







(value)

else





return null









authToken)




(httpPost)

return httResponse


- Commons-io-26jar


- Httpclient-456jar

- Log4j-apijar

- Json-simplejar






ENDPOINT



Best Practices







42 Environment






TimeRange



sections



l CPU

l Memory

l Threads

CPU



that node




available CPU power


that node

Memory






l Total MemoryUsed


l HeapMemoryUsed


l NonHeapMemoryUsed




Memory


that node

Threads





l Total Threads

l ThreadsDeadlocks

l Threads Blocked

l ThreadsRunnable



l ThreadsWaiting





that node





retained for a week



App Services










l Event Count



Event Count


criteria





filter criteria








Field Description





displays Custom




name




Field Description

Subscriber Error

Percentage







l TimeRange Filter

l Error Filter

l Node Filter




time range





l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week

Custom Time Range











4302 Error filter




selected time range





4303 Node Filter
















Column Description







Column Description













l Request Input

l ResponseOutput

511 Request Input






Field Description




parameter





Field Description


name


value



512 Response Output



l Response Header

l Response Body













4 ClickGet Response






Services












6 Object Services






Column Description



refer




App Data

Model Objects





Column Description








Delete Flag











database








Storage







follows


l Field Value false



f ClickGet Response


Body section


Response Body





service







l Request Input

l ResponseOutput

621 Request Input




Field Description


methods are

Create

Update

Delete

Get




editable field)







field name entered


header table






622 Response Output



Section Description


request sent


code format








4 ClickGet Response




















operations


Column Description












two toggles

l Request Input

l Request Output

711 Request Input




Field Description

Input

Method

and URL








icon


row

Get

Response


712 Response Output


Section Description













4 ClickGet Response





8 Workflow Services




Workflow Service


services


Column Description








screen appears


Column Description

















Column Description








9 Jobs













l Adding a new job




UIElement

Description


Updat

ed by


Succe

ss

Rate


Last

run

status




UIElement

Description

Job

Status

















2 Type a keyword





92 Adding a new job




l Job Info

l Define

l Schedule



921 Job Info


fields provided







l Integration

l Orchestration

l Object Services

















the Jobs













actions


























displayed


logged


is displayed


displayed




expires






Failure























922 Define





l Job Info

l Define

l Schedule






Field Description






Field Description









4 ClickGet Response



provided






5 Click Next






923 Schedule






l Job Info

l Define

l Schedule









FieldName

Description


l Hour

l Minute

l Day

l Week

l Month

l Advanced



FieldName

Description
















date and time


example 0 05 8-18







click Next





9231 Limitations












931 Get All Jobs




9311 URL



9312 Method

GET

9313 Header











refer



expressionshtm









Active orInactive









[

jobId 1

jobName job1

description null

cronExpression null

updatedUser xxxxx

updatedDate 2018-12-24 090455

jobStatus Active

jobHistoryTotal 0









]



details

9321 URL



9322 Method

GET

9323 Header













the jobs



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency


jobId 1

jobName job1

jobFrequency 41 5

jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData cityName


jobStatus Active


retentionPeriod 30



jobFrequencyInfo

frequencyType 1

minuteValues [

5

]

933 Create a Job


9331 URL



9332 Method

POST

9333 Header











any job



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9335 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null

934 Update a Job


9341 URL



9342 Method

PUT

9343 Header









any job






running








Service

l objSer for Object

Service

l orchSerfor



job will run






Object Services


the job is running





execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9345 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null



9351 URL



9352 Method

DELETE

9353 Header










SUCCESS orFAIL











status SUCCESS

result null

message null

token null

936 Get Job History


9361 URL



9362 Method

GET

9363 Header













started


process ended








[



jobRunId 2


jobEndTime 2018-12-24 103541

jobDuration 0




jobRunId 1


jobEndTime 2018-12-24 093543

jobDuration 2000




]

937 Run a Job Now


9371 URL



9372 Method

POST

9373 Header













SUCCESS orFAIL








status SUCCESS

result null

message null

token null




9381 URL



9382 Method

POST

9383 Header







profile


email useridkonycom

firstname xxxxxx

lastname xxxxxxx

user_attributes


profile_attributes

firstname xxxxxx




email useridkonycom

lastname xxxxxxx

claims_token

value xxxxx

exp 1540293966000


refresh_token xxxxx



10 Health Check













For cloud


Sample Response

healthCheck PASSED

healthDetail









version xxxx

For On-premises


Sample Response

healthCheck PASSED

healthDetail





version xxxxx



11 Logs










111 Standard Logs








end server





















application











selected by default



performance











11113 Verbose Off













Field Description











Field Description





objects_deviceinfo




from a device



the device






client




















application












1113 Cloud Logs




options


l Archived Logs

l Snapshot Logs

11131 Archived Logs







FieldName

Description


Download

All


Download

Selected



Search by

Name


Name

Search by

Duration


Duration






l Download All Logs





Download All Logs

























Or





11132 Snapshot Logs









Download

All


Snapshot Logs

Download

Selected

Logs



Request

Latest Logs


Logs




Search by

Name


Name







































112 Trace Logs













l Log Configuration

l Copy the payload


l Export Logs

l Clear Logs


UIElement

Description




UIElement

Description


Application

ID



Request

Method


Http

Request

(sec)






Http

Response

(sec)






Elapsed

Time


Request

Size




UIElement

Description

Response

Size











Show Only

Errors





















cannot bemodified



11212 Trace off


confirmation















current date






1124 Export Logs






displayed


confirmation





1125 Clear Logs















confirmation




12 Settings





l SSLCertificates


















selected







properties are same


Field Description







Field Description



check-box













bottom





















































PostProcessor









import javautilMap





Override



throws Exception





App Services



in App Services


SIZE)





return result



PreProcessor













import javautilMap



Override


request


throws Exception





App Services



in App Services




SIZE)





return true






















[index])



serverPropFromMap)





[index])



clientPropFromMap)





following sections


l Log Configuration


l SSLConfiguration


l GDPR Policy

















True by default


rv1917) Gecko20091221



Response




logs








Response



information


(NDC)












tab of App Services










format



revalidate]



applications








follows




adminDB


logs





of the log file




location










domains





Allow Origin Value



header


in the response














response











stored





stored













Verifier





childabccom










update the changes

















Oracle database









database



1226 GDPR Policy


















files











Response Content

TypeMapping









Cache Control Age

(in secs)



HTTP Session

Caching





Custom Response

Headers






the header value

Example

[


nosniff

]

Limitations



resources (global)



Enable iPad

Redirect




















minutes





For example

MEMCACHED -





ltIP


REDIS






ltIP







JSON format





properties_



























amongmultiple nodes
















array format







[


httpMethodPOST




httpMethodPOST



]

Object Service

[


httpMethodGET




httpMethodGET



]






respectively


as the httpMethod















following features

- ServiceMonitor

- Jobs

- Health Check

- Logs

- Reports

- Downloads




server




l One-way SSL

l Two-way SSL




server



client








Field Description




l One-way SSL

l Two-way SSL





Field Description










l AddCertificate


125 Add Certificate



l One-way SSL

l Two-way SSL

1251 One-way SSL






Field Description












4 Click Submit

1252 Two-way SSL







Field Description


uploaded


andmust be unique


certificate




Community edition


uploaded




edition
















Limitation




13 Downloads






14 Reports

















141 Basic Reports








Requests per

Service


application


Sessions per

Device



max time taken

Service Duration

Detail
















8 ClickGenerate




142 Legacy Reports








Report Description





(NativeSPA)




Report Description


(Thin client)




Views



Visitors

























and time zones











area













1443 Channel Types





1444 Time Zone





























7 Click Save





1 Revision History


21 Functional Flow

3 Web Apps

31 Test a Web App


4 Monitoring

41 Service

411 Export as CSV


413 Node Filter

414 Threshold

415 Notifications


42 Environment




511 Request Input

512 Response Output


6 Object Services



621 Request Input

622 Response Output



711 Request Input

712 Response Output

8 Workflow Services

9 Jobs


92 Adding a new job

921 Job Info

922 Define

923 Schedule


931 Get All Jobs


933 Create a Job

934 Update a Job


936 Get Job History

937 Run a Job Now


10 Health Check

11 Logs

111 Standard Logs



1113 Cloud Logs

112 Trace Logs




1124 Export Logs

1125 Clear Logs

12 Settings















1226 GDPR Policy







125 Add Certificate

1251 One-way SSL

1252 Two-way SSL


13 Downloads

14 Reports

141 Basic Reports

142 Legacy Reports





1443 Channel Types

1444 Time Zone















Console





page is displayed










For example admin





21 Functional Flow


l WebApps

l Monitoring




l Object Services


l Jobs

l Health Check

l Logs

l Settings

l Reports

l Downloads


pane





3 Web Apps


application




Column Description

App

Name













l Test aWeb App

l Delete aWeb App

31 Test a Web App









the environment




the web application



once you delete it




4 Monitoring





for a week





Services




Enable Monitoring












41 Service







l Service Calls


l Error



Service Calls


period

Service Performance





Error






Field Description










Service and so on)







time range





Field Description













Time


l Threshold

l Notifications

l Export as CSV



l TimeRange Filter

l Error Filter

l Node Filter

411 Export as CSV











l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week



















displayed


413 Node Filter






414 Threshold




l Error Count














settings







l Count of Errors





values is triggered



timegt5000



monitoring data









service appears











415 Notifications
















account owners


account























Sample Payload

emailServiceRequest

emails

email

recipients

recipient [

emailId $mailId

type TO

]

senderName Kony










ltpgt $mailContent

priority true

startTimeStamp 0

endTimeStamp 0






Click Save


























sendmail

)



(MailServletclass)


7623066890220333243 L


Override







UTF-8)

try








(NotifyList)









mailId)








200)






else


response code


())



to trigger mail)

catch (Exception e)




trigger mail)



throws Exception

















return response


throws Exception




String password =










password + null)







(value)

else





return null









authToken)




(httpPost)

return httResponse


- Commons-io-26jar


- Httpclient-456jar

- Log4j-apijar

- Json-simplejar






ENDPOINT



Best Practices







42 Environment






TimeRange



sections



l CPU

l Memory

l Threads

CPU



that node




available CPU power


that node

Memory






l Total MemoryUsed


l HeapMemoryUsed


l NonHeapMemoryUsed




Memory


that node

Threads





l Total Threads

l ThreadsDeadlocks

l Threads Blocked

l ThreadsRunnable



l ThreadsWaiting





that node





retained for a week



App Services










l Event Count



Event Count


criteria





filter criteria








Field Description





displays Custom




name




Field Description

Subscriber Error

Percentage







l TimeRange Filter

l Error Filter

l Node Filter




time range





l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week

Custom Time Range











4302 Error filter




selected time range





4303 Node Filter
















Column Description







Column Description













l Request Input

l ResponseOutput

511 Request Input






Field Description




parameter





Field Description


name


value



512 Response Output



l Response Header

l Response Body













4 ClickGet Response






Services












6 Object Services






Column Description



refer




App Data

Model Objects





Column Description








Delete Flag











database








Storage







follows


l Field Value false



f ClickGet Response


Body section


Response Body





service







l Request Input

l ResponseOutput

621 Request Input




Field Description


methods are

Create

Update

Delete

Get




editable field)







field name entered


header table






622 Response Output



Section Description


request sent


code format








4 ClickGet Response




















operations


Column Description












two toggles

l Request Input

l Request Output

711 Request Input




Field Description

Input

Method

and URL








icon


row

Get

Response


712 Response Output


Section Description













4 ClickGet Response





8 Workflow Services




Workflow Service


services


Column Description








screen appears


Column Description

















Column Description








9 Jobs













l Adding a new job




UIElement

Description


Updat

ed by


Succe

ss

Rate


Last

run

status




UIElement

Description

Job

Status

















2 Type a keyword





92 Adding a new job




l Job Info

l Define

l Schedule



921 Job Info


fields provided







l Integration

l Orchestration

l Object Services

















the Jobs













actions


























displayed


logged


is displayed


displayed




expires






Failure























922 Define





l Job Info

l Define

l Schedule






Field Description






Field Description









4 ClickGet Response



provided






5 Click Next






923 Schedule






l Job Info

l Define

l Schedule









FieldName

Description


l Hour

l Minute

l Day

l Week

l Month

l Advanced



FieldName

Description
















date and time


example 0 05 8-18







click Next





9231 Limitations












931 Get All Jobs




9311 URL



9312 Method

GET

9313 Header











refer



expressionshtm









Active orInactive









[

jobId 1

jobName job1

description null

cronExpression null

updatedUser xxxxx

updatedDate 2018-12-24 090455

jobStatus Active

jobHistoryTotal 0









]



details

9321 URL



9322 Method

GET

9323 Header













the jobs



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency


jobId 1

jobName job1

jobFrequency 41 5

jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData cityName


jobStatus Active


retentionPeriod 30



jobFrequencyInfo

frequencyType 1

minuteValues [

5

]

933 Create a Job


9331 URL



9332 Method

POST

9333 Header











any job



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9335 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null

934 Update a Job


9341 URL



9342 Method

PUT

9343 Header









any job






running








Service

l objSer for Object

Service

l orchSerfor



job will run






Object Services


the job is running





execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9345 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null



9351 URL



9352 Method

DELETE

9353 Header










SUCCESS orFAIL











status SUCCESS

result null

message null

token null

936 Get Job History


9361 URL



9362 Method

GET

9363 Header













started


process ended








[



jobRunId 2


jobEndTime 2018-12-24 103541

jobDuration 0




jobRunId 1


jobEndTime 2018-12-24 093543

jobDuration 2000




]

937 Run a Job Now


9371 URL



9372 Method

POST

9373 Header













SUCCESS orFAIL








status SUCCESS

result null

message null

token null




9381 URL



9382 Method

POST

9383 Header







profile


email useridkonycom

firstname xxxxxx

lastname xxxxxxx

user_attributes


profile_attributes

firstname xxxxxx




email useridkonycom

lastname xxxxxxx

claims_token

value xxxxx

exp 1540293966000


refresh_token xxxxx



10 Health Check













For cloud


Sample Response

healthCheck PASSED

healthDetail









version xxxx

For On-premises


Sample Response

healthCheck PASSED

healthDetail





version xxxxx



11 Logs










111 Standard Logs








end server





















application











selected by default



performance











11113 Verbose Off













Field Description











Field Description





objects_deviceinfo




from a device



the device






client




















application












1113 Cloud Logs




options


l Archived Logs

l Snapshot Logs

11131 Archived Logs







FieldName

Description


Download

All


Download

Selected



Search by

Name


Name

Search by

Duration


Duration






l Download All Logs





Download All Logs

























Or





11132 Snapshot Logs









Download

All


Snapshot Logs

Download

Selected

Logs



Request

Latest Logs


Logs




Search by

Name


Name







































112 Trace Logs













l Log Configuration

l Copy the payload


l Export Logs

l Clear Logs


UIElement

Description




UIElement

Description


Application

ID



Request

Method


Http

Request

(sec)






Http

Response

(sec)






Elapsed

Time


Request

Size




UIElement

Description

Response

Size











Show Only

Errors





















cannot bemodified



11212 Trace off


confirmation















current date






1124 Export Logs






displayed


confirmation





1125 Clear Logs















confirmation




12 Settings





l SSLCertificates


















selected







properties are same


Field Description







Field Description



check-box













bottom





















































PostProcessor









import javautilMap





Override



throws Exception





App Services



in App Services


SIZE)





return result



PreProcessor













import javautilMap



Override


request


throws Exception





App Services



in App Services




SIZE)





return true






















[index])



serverPropFromMap)





[index])



clientPropFromMap)





following sections


l Log Configuration


l SSLConfiguration


l GDPR Policy

















True by default


rv1917) Gecko20091221



Response




logs








Response



information


(NDC)












tab of App Services










format



revalidate]



applications








follows




adminDB


logs





of the log file




location










domains





Allow Origin Value



header


in the response














response











stored





stored













Verifier





childabccom










update the changes

















Oracle database









database



1226 GDPR Policy


















files











Response Content

TypeMapping









Cache Control Age

(in secs)



HTTP Session

Caching





Custom Response

Headers






the header value

Example

[


nosniff

]

Limitations



resources (global)



Enable iPad

Redirect




















minutes





For example

MEMCACHED -





ltIP


REDIS






ltIP







JSON format





properties_



























amongmultiple nodes
















array format







[


httpMethodPOST




httpMethodPOST



]

Object Service

[


httpMethodGET




httpMethodGET



]






respectively


as the httpMethod















following features

- ServiceMonitor

- Jobs

- Health Check

- Logs

- Reports

- Downloads




server




l One-way SSL

l Two-way SSL




server



client








Field Description




l One-way SSL

l Two-way SSL





Field Description










l AddCertificate


125 Add Certificate



l One-way SSL

l Two-way SSL

1251 One-way SSL






Field Description












4 Click Submit

1252 Two-way SSL







Field Description


uploaded


andmust be unique


certificate




Community edition


uploaded




edition
















Limitation




13 Downloads






14 Reports

















141 Basic Reports








Requests per

Service


application


Sessions per

Device



max time taken

Service Duration

Detail
















8 ClickGenerate




142 Legacy Reports








Report Description





(NativeSPA)




Report Description


(Thin client)




Views



Visitors

























and time zones











area













1443 Channel Types





1444 Time Zone





























7 Click Save





1 Revision History


21 Functional Flow

3 Web Apps

31 Test a Web App


4 Monitoring

41 Service

411 Export as CSV


413 Node Filter

414 Threshold

415 Notifications


42 Environment




511 Request Input

512 Response Output


6 Object Services



621 Request Input

622 Response Output



711 Request Input

712 Response Output

8 Workflow Services

9 Jobs


92 Adding a new job

921 Job Info

922 Define

923 Schedule


931 Get All Jobs


933 Create a Job

934 Update a Job


936 Get Job History

937 Run a Job Now


10 Health Check

11 Logs

111 Standard Logs



1113 Cloud Logs

112 Trace Logs




1124 Export Logs

1125 Clear Logs

12 Settings















1226 GDPR Policy







125 Add Certificate

1251 One-way SSL

1252 Two-way SSL


13 Downloads

14 Reports

141 Basic Reports

142 Legacy Reports





1443 Channel Types

1444 Time Zone






For example admin





21 Functional Flow


l WebApps

l Monitoring




l Object Services


l Jobs

l Health Check

l Logs

l Settings

l Reports

l Downloads


pane





3 Web Apps


application




Column Description

App

Name













l Test aWeb App

l Delete aWeb App

31 Test a Web App









the environment




the web application



once you delete it




4 Monitoring





for a week





Services




Enable Monitoring












41 Service







l Service Calls


l Error



Service Calls


period

Service Performance





Error






Field Description










Service and so on)







time range





Field Description













Time


l Threshold

l Notifications

l Export as CSV



l TimeRange Filter

l Error Filter

l Node Filter

411 Export as CSV











l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week



















displayed


413 Node Filter






414 Threshold




l Error Count














settings







l Count of Errors





values is triggered



timegt5000



monitoring data









service appears











415 Notifications
















account owners


account























Sample Payload

emailServiceRequest

emails

email

recipients

recipient [

emailId $mailId

type TO

]

senderName Kony










ltpgt $mailContent

priority true

startTimeStamp 0

endTimeStamp 0






Click Save


























sendmail

)



(MailServletclass)


7623066890220333243 L


Override







UTF-8)

try








(NotifyList)









mailId)








200)






else


response code


())



to trigger mail)

catch (Exception e)




trigger mail)



throws Exception

















return response


throws Exception




String password =










password + null)







(value)

else





return null









authToken)




(httpPost)

return httResponse


- Commons-io-26jar


- Httpclient-456jar

- Log4j-apijar

- Json-simplejar






ENDPOINT



Best Practices







42 Environment






TimeRange



sections



l CPU

l Memory

l Threads

CPU



that node




available CPU power


that node

Memory






l Total MemoryUsed


l HeapMemoryUsed


l NonHeapMemoryUsed




Memory


that node

Threads





l Total Threads

l ThreadsDeadlocks

l Threads Blocked

l ThreadsRunnable



l ThreadsWaiting





that node





retained for a week



App Services










l Event Count



Event Count


criteria





filter criteria








Field Description





displays Custom




name




Field Description

Subscriber Error

Percentage







l TimeRange Filter

l Error Filter

l Node Filter




time range





l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week

Custom Time Range











4302 Error filter




selected time range





4303 Node Filter
















Column Description







Column Description













l Request Input

l ResponseOutput

511 Request Input






Field Description




parameter





Field Description


name


value



512 Response Output



l Response Header

l Response Body













4 ClickGet Response






Services












6 Object Services






Column Description



refer




App Data

Model Objects





Column Description








Delete Flag











database








Storage







follows


l Field Value false



f ClickGet Response


Body section


Response Body





service







l Request Input

l ResponseOutput

621 Request Input




Field Description


methods are

Create

Update

Delete

Get




editable field)







field name entered


header table






622 Response Output



Section Description


request sent


code format








4 ClickGet Response




















operations


Column Description












two toggles

l Request Input

l Request Output

711 Request Input




Field Description

Input

Method

and URL








icon


row

Get

Response


712 Response Output


Section Description













4 ClickGet Response





8 Workflow Services




Workflow Service


services


Column Description








screen appears


Column Description

















Column Description








9 Jobs













l Adding a new job




UIElement

Description


Updat

ed by


Succe

ss

Rate


Last

run

status




UIElement

Description

Job

Status

















2 Type a keyword





92 Adding a new job




l Job Info

l Define

l Schedule



921 Job Info


fields provided







l Integration

l Orchestration

l Object Services

















the Jobs













actions


























displayed


logged


is displayed


displayed




expires






Failure























922 Define





l Job Info

l Define

l Schedule






Field Description






Field Description









4 ClickGet Response



provided






5 Click Next






923 Schedule






l Job Info

l Define

l Schedule









FieldName

Description


l Hour

l Minute

l Day

l Week

l Month

l Advanced



FieldName

Description
















date and time


example 0 05 8-18







click Next





9231 Limitations












931 Get All Jobs




9311 URL



9312 Method

GET

9313 Header











refer



expressionshtm









Active orInactive









[

jobId 1

jobName job1

description null

cronExpression null

updatedUser xxxxx

updatedDate 2018-12-24 090455

jobStatus Active

jobHistoryTotal 0









]



details

9321 URL



9322 Method

GET

9323 Header













the jobs



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency


jobId 1

jobName job1

jobFrequency 41 5

jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData cityName


jobStatus Active


retentionPeriod 30



jobFrequencyInfo

frequencyType 1

minuteValues [

5

]

933 Create a Job


9331 URL



9332 Method

POST

9333 Header











any job



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9335 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null

934 Update a Job


9341 URL



9342 Method

PUT

9343 Header









any job






running








Service

l objSer for Object

Service

l orchSerfor



job will run






Object Services


the job is running





execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9345 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null



9351 URL



9352 Method

DELETE

9353 Header










SUCCESS orFAIL











status SUCCESS

result null

message null

token null

936 Get Job History


9361 URL



9362 Method

GET

9363 Header













started


process ended








[



jobRunId 2


jobEndTime 2018-12-24 103541

jobDuration 0




jobRunId 1


jobEndTime 2018-12-24 093543

jobDuration 2000




]

937 Run a Job Now


9371 URL



9372 Method

POST

9373 Header













SUCCESS orFAIL








status SUCCESS

result null

message null

token null




9381 URL



9382 Method

POST

9383 Header







profile


email useridkonycom

firstname xxxxxx

lastname xxxxxxx

user_attributes


profile_attributes

firstname xxxxxx




email useridkonycom

lastname xxxxxxx

claims_token

value xxxxx

exp 1540293966000


refresh_token xxxxx



10 Health Check













For cloud


Sample Response

healthCheck PASSED

healthDetail









version xxxx

For On-premises


Sample Response

healthCheck PASSED

healthDetail





version xxxxx



11 Logs










111 Standard Logs








end server





















application











selected by default



performance











11113 Verbose Off













Field Description











Field Description





objects_deviceinfo




from a device



the device






client




















application












1113 Cloud Logs




options


l Archived Logs

l Snapshot Logs

11131 Archived Logs







FieldName

Description


Download

All


Download

Selected



Search by

Name


Name

Search by

Duration


Duration






l Download All Logs





Download All Logs

























Or





11132 Snapshot Logs









Download

All


Snapshot Logs

Download

Selected

Logs



Request

Latest Logs


Logs




Search by

Name


Name







































112 Trace Logs













l Log Configuration

l Copy the payload


l Export Logs

l Clear Logs


UIElement

Description




UIElement

Description


Application

ID



Request

Method


Http

Request

(sec)






Http

Response

(sec)






Elapsed

Time


Request

Size




UIElement

Description

Response

Size











Show Only

Errors





















cannot bemodified



11212 Trace off


confirmation















current date






1124 Export Logs






displayed


confirmation





1125 Clear Logs















confirmation




12 Settings





l SSLCertificates


















selected







properties are same


Field Description







Field Description



check-box













bottom





















































PostProcessor









import javautilMap





Override



throws Exception





App Services



in App Services


SIZE)





return result



PreProcessor













import javautilMap



Override


request


throws Exception





App Services



in App Services




SIZE)





return true






















[index])



serverPropFromMap)





[index])



clientPropFromMap)





following sections


l Log Configuration


l SSLConfiguration


l GDPR Policy

















True by default


rv1917) Gecko20091221



Response




logs








Response



information


(NDC)












tab of App Services










format



revalidate]



applications








follows




adminDB


logs





of the log file




location










domains





Allow Origin Value



header


in the response














response











stored





stored













Verifier





childabccom










update the changes

















Oracle database









database



1226 GDPR Policy


















files











Response Content

TypeMapping









Cache Control Age

(in secs)



HTTP Session

Caching





Custom Response

Headers






the header value

Example

[


nosniff

]

Limitations



resources (global)



Enable iPad

Redirect




















minutes





For example

MEMCACHED -





ltIP


REDIS






ltIP







JSON format





properties_



























amongmultiple nodes
















array format







[


httpMethodPOST




httpMethodPOST



]

Object Service

[


httpMethodGET




httpMethodGET



]






respectively


as the httpMethod















following features

- ServiceMonitor

- Jobs

- Health Check

- Logs

- Reports

- Downloads




server




l One-way SSL

l Two-way SSL




server



client








Field Description




l One-way SSL

l Two-way SSL





Field Description










l AddCertificate


125 Add Certificate



l One-way SSL

l Two-way SSL

1251 One-way SSL






Field Description












4 Click Submit

1252 Two-way SSL







Field Description


uploaded


andmust be unique


certificate




Community edition


uploaded




edition
















Limitation




13 Downloads






14 Reports

















141 Basic Reports








Requests per

Service


application


Sessions per

Device



max time taken

Service Duration

Detail
















8 ClickGenerate




142 Legacy Reports








Report Description





(NativeSPA)




Report Description


(Thin client)




Views



Visitors

























and time zones











area













1443 Channel Types





1444 Time Zone





























7 Click Save





1 Revision History


21 Functional Flow

3 Web Apps

31 Test a Web App


4 Monitoring

41 Service

411 Export as CSV


413 Node Filter

414 Threshold

415 Notifications


42 Environment




511 Request Input

512 Response Output


6 Object Services



621 Request Input

622 Response Output



711 Request Input

712 Response Output

8 Workflow Services

9 Jobs


92 Adding a new job

921 Job Info

922 Define

923 Schedule


931 Get All Jobs


933 Create a Job

934 Update a Job


936 Get Job History

937 Run a Job Now


10 Health Check

11 Logs

111 Standard Logs



1113 Cloud Logs

112 Trace Logs




1124 Export Logs

1125 Clear Logs

12 Settings















1226 GDPR Policy







125 Add Certificate

1251 One-way SSL

1252 Two-way SSL


13 Downloads

14 Reports

141 Basic Reports

142 Legacy Reports





1443 Channel Types

1444 Time Zone




l Object Services


l Jobs

l Health Check

l Logs

l Settings

l Reports

l Downloads


pane





3 Web Apps


application




Column Description

App

Name













l Test aWeb App

l Delete aWeb App

31 Test a Web App









the environment




the web application



once you delete it




4 Monitoring





for a week





Services




Enable Monitoring












41 Service







l Service Calls


l Error



Service Calls


period

Service Performance





Error






Field Description










Service and so on)







time range





Field Description













Time


l Threshold

l Notifications

l Export as CSV



l TimeRange Filter

l Error Filter

l Node Filter

411 Export as CSV











l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week



















displayed


413 Node Filter






414 Threshold




l Error Count














settings







l Count of Errors





values is triggered



timegt5000



monitoring data









service appears











415 Notifications
















account owners


account























Sample Payload

emailServiceRequest

emails

email

recipients

recipient [

emailId $mailId

type TO

]

senderName Kony










ltpgt $mailContent

priority true

startTimeStamp 0

endTimeStamp 0






Click Save


























sendmail

)



(MailServletclass)


7623066890220333243 L


Override







UTF-8)

try








(NotifyList)









mailId)








200)






else


response code


())



to trigger mail)

catch (Exception e)




trigger mail)



throws Exception

















return response


throws Exception




String password =










password + null)







(value)

else





return null









authToken)




(httpPost)

return httResponse


- Commons-io-26jar


- Httpclient-456jar

- Log4j-apijar

- Json-simplejar






ENDPOINT



Best Practices







42 Environment






TimeRange



sections



l CPU

l Memory

l Threads

CPU



that node




available CPU power


that node

Memory






l Total MemoryUsed


l HeapMemoryUsed


l NonHeapMemoryUsed




Memory


that node

Threads





l Total Threads

l ThreadsDeadlocks

l Threads Blocked

l ThreadsRunnable



l ThreadsWaiting





that node





retained for a week



App Services










l Event Count



Event Count


criteria





filter criteria








Field Description





displays Custom




name




Field Description

Subscriber Error

Percentage







l TimeRange Filter

l Error Filter

l Node Filter




time range





l 5minutes

l 15minutes

l 1 hour

l 4 hours

l 1 day

l 1 week

Custom Time Range











4302 Error filter




selected time range





4303 Node Filter
















Column Description







Column Description













l Request Input

l ResponseOutput

511 Request Input






Field Description




parameter





Field Description


name


value



512 Response Output



l Response Header

l Response Body













4 ClickGet Response






Services












6 Object Services






Column Description



refer




App Data

Model Objects





Column Description








Delete Flag











database








Storage







follows


l Field Value false



f ClickGet Response


Body section


Response Body





service







l Request Input

l ResponseOutput

621 Request Input




Field Description


methods are

Create

Update

Delete

Get




editable field)







field name entered


header table






622 Response Output



Section Description


request sent


code format








4 ClickGet Response




















operations


Column Description












two toggles

l Request Input

l Request Output

711 Request Input




Field Description

Input

Method

and URL








icon


row

Get

Response


712 Response Output


Section Description













4 ClickGet Response





8 Workflow Services




Workflow Service


services


Column Description








screen appears


Column Description

















Column Description








9 Jobs













l Adding a new job




UIElement

Description


Updat

ed by


Succe

ss

Rate


Last

run

status




UIElement

Description

Job

Status

















2 Type a keyword





92 Adding a new job




l Job Info

l Define

l Schedule



921 Job Info


fields provided







l Integration

l Orchestration

l Object Services

















the Jobs













actions


























displayed


logged


is displayed


displayed




expires






Failure























922 Define





l Job Info

l Define

l Schedule






Field Description






Field Description









4 ClickGet Response



provided






5 Click Next






923 Schedule






l Job Info

l Define

l Schedule









FieldName

Description


l Hour

l Minute

l Day

l Week

l Month

l Advanced



FieldName

Description
















date and time


example 0 05 8-18







click Next





9231 Limitations












931 Get All Jobs




9311 URL



9312 Method

GET

9313 Header











refer



expressionshtm









Active orInactive









[

jobId 1

jobName job1

description null

cronExpression null

updatedUser xxxxx

updatedDate 2018-12-24 090455

jobStatus Active

jobHistoryTotal 0









]



details

9321 URL



9322 Method

GET

9323 Header













the jobs



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency


jobId 1

jobName job1

jobFrequency 41 5

jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData cityName


jobStatus Active


retentionPeriod 30



jobFrequencyInfo

frequencyType 1

minuteValues [

5

]

933 Create a Job


9331 URL



9332 Method

POST

9333 Header











any job



running








Service

l objSer for Object

Service

l orchSerfor



job will run









Object Services


the job is running


execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9335 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null

934 Update a Job


9341 URL



9342 Method

PUT

9343 Header









any job






running








Service

l objSer for Object

Service

l orchSerfor



job will run






Object Services


the job is running





execute the job







to run the service



service


either beActive or

Inactive












displayed



displayed




displayed




run






possible values




l 4 Month-based

Frequency

9345 Sample Request

jobId 2

jobName testjob1

jobFrequency 19 0


jobServiceInfo

version 10

serviceType intSer


objectName


requestheaderMap


postData


jobStatus Active

historyStrategy OFF



retentionPeriod 30

jobFrequencyInfo

frequencyType 1

minuteValues [

0

]

hourValues [

1

]




SUCCESS orFAIL








status SUCCESS

result null

message null



token null



9351 URL



9352 Method

DELETE

9353 Header










SUCCESS orFAIL











status SUCCESS

result null

message null

token null

936 Get Job History


9361 URL



9362 Method

GET

9363 Header













started


process ended








[



jobRunId 2


jobEndTime 2018-12-24 103541

jobDuration 0




jobRunId 1


jobEndTime 2018-12-24 093543

jobDuration 2000




]

937 Run a Job Now


9371 URL



9372 Method

POST

9373 Header













SUCCESS orFAIL








status SUCCESS

result null

message null

token null




9381 URL



9382 Method

POST

9383 Header







profile


email useridkonycom

firstname xxxxxx

lastname xxxxxxx

user_attributes


profile_attributes

firstname xxxxxx




email useridkonycom

lastname xxxxxxx

claims_token

value xxxxx

exp 1540293966000


refresh_token xxxxx



10 Health Check













For cloud


Sample Response

healthCheck PASSED

healthDetail









version xxxx

For On-premises


Sample Response

healthCheck PASSED

healthDetail





version xxxxx



11 Logs










111 Standard Logs








end server





















application











selected by default



performance











11113 Verbose Off













Field Description











Field Description





objects_deviceinfo




from a device



the device






client




















application












1113 Cloud Logs




options


l Archived Logs

l Snapshot Logs

11131 Archived Logs







FieldName

Description


Download

All


Download

Selected



Search by

Name


Name

Search by

Duration


Duration






l Download All Logs





Download All Logs

























Or





11132 Snapshot Logs









Download

All


Snapshot Logs

Download

Selected

Logs



Request

Latest Logs


Logs




Search by

Name


Name







































112 Trace Logs













l Log Configuration

l Copy the payload


l Export Logs

l Clear Logs


UIElement

Description




UIElement

Description


Application

ID



Request

Method


Http

Request

(sec)






Http

Response

(sec)






Elapsed

Time


Request

Size




UIElement

Description

Response

Size











Show Only

Errors





















cannot bemodified



11212 Trace off


confirmation















current date






1124 Export Logs






displayed


confirmation





1125 Clear Logs















confirmation




12 Settings





l SSLCertificates


















selected







properties are same


Field Description







Field Description



check-box













bottom





















































PostProcessor









import javautilMap





Override



throws Exception





App Services



in App Services


SIZE)





return result



PreProcessor













import javautilMap



Override


request


throws Exception





App Services



in App Services




SIZE)





return true






















[index])



serverPropFromMap)





[index])



clientPropFromMap)





following sections


l Log Configuration


l SSLConfiguration


l GDPR Policy

















True by default


rv1917) Gecko20091221



Response




logs








Response



information


(NDC)












tab of App Services










format



revalidate]



applications








follows




adminDB


logs





of the log file




location










domains





Allow Origin Value



header


in the response














response











stored





stored













Verifier





childabccom










update the changes

















Oracle database









database



1226 GDPR Policy


















files











Response Content

TypeMapping









Cache Control Age

(in secs)



HTTP Session

Caching





Custom Response

Headers






the header value

Example

[


nosniff

]

Limitations



resources (global)



Enable iPad

Redirect




















minutes





For example

MEMCACHED -





ltIP


REDIS






ltIP







JSON format





properties_



























amongmultiple nodes
















array format







[


httpMethodPOST




httpMethodPOST



]

Object Service

[


httpMethodGET




httpMethodGET



]






respectively


as the httpMethod















following features

- ServiceMonitor

- Jobs

- Health Check

- Logs

- Reports

- Downloads




server




l One-way SSL

l Two-way SSL




server



client








Field Description




l One-way SSL

l Two-way SSL





Field Description










l AddCertificate


125 Add Certificate



l One-way SSL

l Two-way SSL

1251 One-way SSL






Field Description












4 Click Submit

1252 Two-way SSL







Field Description


uploaded


andmust be unique


certificate




Community edition


uploaded




edition
















Limitation




13 Downloads






14 Reports

















141 Basic Reports








Requests per

Service


application


Sessions per

Device



max time taken

Service Duration

Detail
















8 ClickGenerate




142 Legacy Reports








Report Description





(NativeSPA)




Report Description


(Thin client)




Views



Visitors

























and time zones











area













1443 Channel Types





1444 Time Zone





























7 Click Save





1 Revision History


21 Functional Flow

3 Web Apps

31 Test a Web App


4 Monitoring

41 Service

411 Export as CSV


413 Node Filter

414 Threshold

415 Notifications


42 Environment




511 Request Input

512 Response Output


6 Object Services



621 Request Input

622 Response Output



711 Request Input

712 Response Output

8 Workflow Services

9 Jobs


92 Adding a new job

921 Job Info

922 Define

923 Schedule


931 Get All Jobs


933 Create a Job

934 Update a Job


936 Get Job History

937 Run a Job Now


10 Health Check

11 Logs

111 Standard Logs



1113 Cloud Logs

112 Trace Logs




1124 Export Logs

1125 Clear Logs

12 Settings















1226 GDPR Policy







125 Add Certificate

1251 One-way SSL

1252 Two-way SSL


13 Downloads

14 Reports

141 Basic Reports

142 Legacy Reports





1443 Channel Types

1444 Time Zone



IntegrationService AppServicesUserGuide On-Premises

Documents

Transcript of IntegrationService AppServicesUserGuide On-Premises