.ia-secondary-container
The Administration UI guide assumes that Kaa has been already installed and Kaa UI is available from the web. If it's not the case look at the Installation guide for more info.
The Administration UI guide provides instructions and explanations on Kaa administration. The instructions were created on the basis of Kaa Sandbox system.
The following three user types are available in Kaa:
Kaa Sandbox provides default credentials for all three types of Kaa users.
The Kaa admin is the highest level administrator of Kaa. He is able to create, edit, and delete tenant admins.
To log into the Kaa UI as a Kaa admin, use the default Sandbox username/password for the Kaa admin - kaa/kaa123.
To customize the account, click Settings -> Profile in the upper right corner of the window and change the first/last name and e-mail to the private ones. Click Save to apply the changes.
Note that Email is a mandatory field.
To set a private password, click Settings -> Change password and fill in the fields as required.
The Tenants window, which is the starting window for a Kaa admin, displays the list of tenant admins. A Kaa admin can edit a tenant admin's name/e-mail and delete tenant admins from the system.
To view a tenant admin's details, select the tenant admin either from the list or from the navigation panel on the left side.
To create a new tenant admin, click Add new tenant and then fill in all the required fields. Click Add to apply the changes.
The newly created tenant admin will receive an e-mail with his or her login to Kaa web UI credentials window.
The tenant admin is a Kaa user who is responsible for managing applications, users and event class families.
To log into the Kaa UI as a tenant admin, use the default Sandbox username/password for the tenant admin - admin/admin123.
To customize the account, click Settings -> Profile and change the first/last name and e-mail to private ones.
To set a private password, click Settings -> Change password and fill in the fields as required.
As a tenant admin, you can add, edit and delete applications.
To create a new application, do the following:
NOTE: If you open the Application details window of the newly created application (by clicking this application on either the Applications menu on the navigation panel or the Applications window), you will notice that the Application Token field has been filled in automatically. This is a unique auto-generated application ID.
To edit the application, open the Application details window by clicking the application name either on the navigation panel or in the list in the Applications window.
To delete the application, open the Applications window and click Delete next to the application name.
The tenant admin can add, edit and delete users.
To add a user, do the following:
To edit a user's profile, open the User details window by clicking the user's name either on the navigation panel or in the list in the Users window..
To delete a user, open the Users window and click Delete next to the user's name.
To use the Kaa events feature for one or more applications, the tenant admin should create an event class family (ECF). Each ECF should be described using the Avro format.
To create a new ECF, do the following:
After saving the new ECF, you will be redirected to the Event class family details window. In this window you can add a shema by clicking Add schema under the Schemas table. Schemas should be written in the Avro format as a separate file and describe how the event classes should be grouped depending on subject areas.
NOTE: More than one schema can be added to an ECF.
A unique version number is assigned to a schema after its creation and then the schema appears as a clickable line in the Schemas table. To review the ECF schema details, click the appropriate schema line in the Schemas table. Each schema automatically splits into event classes. A full qualifier name, schema and type are shown for each event class in the table with the same name.
The tenant developer is a user that creates SDKs based on customer requirements. Tenant developers set the Kaa schemas, group endpoints, and control notification processes.
To log into the Kaa UI as a tenant developer, use the default Sandbox credentials for the tenant developer - devuser/devuser123.
To customize this account, click Settings -> Profile and change the first/last name and e-mail to private ones.
To set a private password, click Settings -> Change password.
NOTE: A tenant developer is able to work only with those applications which have been created by his tenant admin. The list of available applications is displayed in the Applications window, as well as on the navigation panel under the Applications menu.
To create an SDK for a particular application, do the following:
In Kaa, an SDK for an application is generated based on the following four schemas: profile, configuration, notification, and log. Every application has default schemas, which can be accessed from the Schema submenu in the corresponding application menu on the navigation panel.
The list of profile schemas created by a tenant developer for the application is shown in the Profile schemas window, which can be opened from the application menu on the navigation panel as illustrated by the following screenshot.
As a tenant developer, you can create new profile schemas for the application as follows:
If you want to review the avro schema, open the Profile schema details window by clicking the schema in the Profile schemas window.
The list of configuration schemas created by a tenant developer for the application is shown in the Configuration schemas window.
As a tenant developer, you can create new configuration schemas for the application as follows:
If you want to review the avro schema, open the Configuration schema details window by clicking the schema in the Configuration schemas window.
The list of notification schemas created by a tenant developer for the application is shown in the Notification schemas window.
As a tenant developer, you can create new notification schemas for the application as follows:
If you want to review the avro schema, open the Notification schema details window by clicking the schema in the Notification schemas window.
The list of log schemas created by a tenant developer for the application is shown in the Log schemas window.
As a tenant developer, you can create new log schemas for the application as follows:
If you want to review the avro schema, open the Log schema details window by clicking the schema in the Log schemas window.
Notification topics are used for grouping notifications by subject. An endpoint group will receive only those notifications which correspond to the notification topics this endpoint group is subscribed to.
To add a new notification topic to the application, do the following:
The newly created topic will appear in the Notification topics window.
To send a notification for the application, do the following:
NOTE: The contents of the file should match the corresponding notification schema structure.
For example, the default Sandbox notification schema structure is the following:
{ "type": "record", "name": "Notification", "namespace": "org.kaa.config", "fields": [ { "name": "message", "type": "string" } ] }
The file with the following contents will match the default Sandbox notification schema.
{"message": "Hello from Kaa!"}
Endpoint groups are created based on the profile filter and configuration.
To add a new endpoint group, do the following:
To add a profile filter to the endpoint group, do the following:
To add a configuration to the endpoint group, do the following:
To add a notification topic to the endpoint group, do the following:
Event family mappings are used by tenant developers to set event class families for the application and determine the actions for each class family - whether an application should be a source, a sink or both.
To view the list of ECFs which are mapped to the application, open the Event family mappings window by clicking Event family mappings under the application's menu on the navigation panel.
To add a new mapping, do the following: In the Event family mappings window, click Add new family event mapping, then select an appropriate ECF from the drop-down list and set appropriate actions for each class of the family.
A tenant developer can set a log appender for a schema depending on the data storage type - a file system, MongoDB, Hadoop, CDAP or Oracle NoSQL. All created log appenders are displayed in the Log appenders window. Each schema type can have only one log appender at a time.
To create a log appender of the file system storage type, do the following:
To create a log appender of the MongoDB storage type, do the following:
To create a log appender which will be integrated with Hadoop, do the following:
To create a log appender which will be integrated with CDAP, do the following:
To create a log appender of the Oracle NoSQL key/value storage type, do the following:
Use the following guides and references to make the most of Kaa.
Guide | What it is for |
---|---|
Design reference | Use this reference to learn about features and capabilities of Kaa. |
Programming guide | Use this guide to create your own Kaa applications. |
Contribute to Kaa | Use this guide to learn how to contribute to Kaa project and which code/documentation style conventions we use. |
Copyright © 2014, CyberVision, Inc.