1 Summary 2 Architecture Design 3 Installation Manual 3.1 Development 3.2 Production 4 Test Cases 5 User Manual 5.1 API Specification 5.1.1 kpiQuery 5.2 Handbook

Summary

The Conceptual Analytics Engine is responsible for performing various types of analysis over the Semantic Knowledge Base (SKB) at the Data Layer of the Evaluation Environment's architecture. These types include:

• KPI analysis and evaluation
• Discovery of best BPaaS deployments
• Detection of event patterns leading to KPI or SLO violations

Currently, only the first type is supported through the current implementation.

Architecture Design

The current architecture of the Conceptual Analytics Engine implementation comprises a REST service which is deployed on a servlet container, namely tomcat, and communicates with the underlying Semantic KnowledgeBase in order to pose KPI evaluation queries. 

Installation Manual

Development

Currently, the following requirements hold for this component:

• Oracle's 1.7.x JDK or higher
• Apache tomcat 1.7 or higher
• Maven tool for code compilation and packaging

The installation procedure to be followed is the one given below:

1. Download source code from (to be completed)
2. Unzip code with tar (or any other tool)
3. Go to the root directory of the installed code
4. Run:

   mvn clean install
   

   and then:

   mvn war:war
   

5. Move the war file to the webapps directory of tomcat and start tomcat, if not yet started
6. Test installation by entering in your browser the following URL: http://localhost:8080/rest-test-swagger-0.0.1-SNAPSHOT/

Production

See instructions above

Test Cases

You can run test cases directly from the URL of the REST service due to the use of swagger (http://swagger.io) which enables the execution of the API method exposed by exploiting user input provided in a form-based manner. The following test cases are envisioned:

• Run a KPI evaluation query

Suppose that the user desires to obtain the most recent value for a KPI named as "Reliability". Then, he/she can browse the methods of the API and click on the one named as "kpiQuery". The following screenshot indicates the upper part of the description of the method when selected: Next, he/she can fill in the kpiName field with the value of "Reliability" and press the "Try it out!" button. He/she will be able to see the respective curl command issued and the request URL as indicated in the following figure. Finally, he/she can check the output produced along with the response status and headers by scrolling a little bit more on the screen as indicated in the next figure:

User Manual

API Specification

The reader should refer to the API web page of swagger for browsing an on-line documentation with the capability to execute the API methods. In the following, the API methods of the Conceptual Analytics REST Service are analyzed below:

kpiQuery

This method enables the posing of semantic queries over the underlying Semantic KnowledgeBase in order to evaluate the respective KPI involved:

POST skb/kpiQuery

The expected input format is multipart/form-data. The following input parameters are expected:

• kpiName: denotes the name of the KPI to be evaluated (obligatory)
• kpiPeriod: denotes the evaluation period such that a set of KPI evaluation values and not just one can be returned matching this period (optional)
• tenant: denotes the tenant for which the KPI can be evaluated. In this way, the KPI is assessed only for this tenant and not across all tenants that have purchased the respective BPaaS (optional)
• maxRows: denotes the maximum number of KPI values to return. Default value is 0 indicating that all possible values can be returned (optional)

Handbook