Documentation

Basic Concepts and Information about Kleeen Authoring

Entities & Attributes

Where to start….

What is an Entity?

Entities are all the things you care about in your product. Entities could be a business unit, an employee, the employee’s address, an expense, etc. 

Entities are concepts or data you will want your users to see (e.g. visualization, table) or manipulate (e.g. change the value of, enable/disable, etc).

Creating your basic entities is a good place to start.

What is an Attribute?

An attribute is how to describe the relationship between any two Entities. You can create a relationship for various reasons. For example:

  • Attribute helps describe the entity (e.g. a person entity has an attribute to the eye-color entity)
  • Attribute shows ownership for the entity (e.g. a department entity has an attribute to multiple employee entities)

When you create an attribute from Entity A to Entity B, by default, it assumes that the Entity A has only one Entity B. However, you can change that to say that Entity A has multiple Entity Bs. 

As you want your attributes to describe increasingly complex relationships, you can encode that by changing the default values to the optional questions.

 

Workflows

Enabling your user’s goals

Kleeen software creates a product that will be used by your customers or end-users. Your product allows them to accomplish goals or objectives, and move their work forward. 

What is a Workflow?

When you create content for your end users, you do so by adding a Workflow. A workflow describes a task or process that Kleeen knows how to support.

For example if you want to enable your end-users to monitor information so they can quickly understand the state of their world, you would want to add a Monitoring/HUD workflow. This workflow allows auto-data refreshing, and your content to scale up/down to fill the browser window’s size.

Over time, Kleeen will be teaching its AI more complex and involved workflows.

The free Workflow: Cross-linking

Sometimes an end user’s process will span workflows. Imagine they are monitoring some information, and find something they want to understand better! How do they drill in? Kleeen will automatically cross-link all your pages together, so however your end-users want to transition from one workflow to another. 

Over time, Kleeen will be adding increasingly rich cross-linking support.

WHAT IS A WIDGET?

When creating most workflows in Kleeen, you want to showcase some information. Each “unit” of information is called a Widget. Some widgets are visual only (e.g. a table, visualization, etc), some provide configuration (e.g. enable/disable, setting a value, etc), and others support actions (e.g. download something, hire candidate, reboot a computer etc).

Based on the data you want to visualize, configure, or take action upon – Kleeen will provide the best UI interaction/element it knows about to empower your end users.

Widgets

How to create your content

What is a widget goal?

When you work with a high-priced UI/UX consultant or UI/UX designer – they will always try to understand not just what information you want to show, but why  you want to show it.  In other words, why are you showing your end user this information? E.g., you may want to have a comparison goal for two or more data points.

Kleeen’s AI is asking you the same question for the same reason. However, unlike a human designer, Kleeen proactively proposes goals that “make sense” given the data you selected.

What is Widget Specification?

Once you choose your goal for a widget, Kleeen’s AI comes up with unique ways to achieve your goal(s) with your selected data. This is presented as cards listing (in a sentence) how the data is used, and an abstract visual representation of the types of visualizations that Kleeen may choose to achieve your objective. 

By keeping a human in the loop, we ensure you can bring the real-world “context” into the creation process since only you know the deep details about your data and your end user’s needs.

Tasks

Simple Entity Detail Page

Select one type of entity (e.g. DEPARTMENT), and for each instance of that entity (e.g. HR, Engineering, Sales) present visualizations and configuration options about the specific instance of the entity selected (e.g. all the info about the Sales Department).

Simple Dashboard

Present information, visually, to allow your end-users to understand their data quickly and at a glance. Simple dashboards only support visualization  widgets.

List of All Records

Think of an excel spreadsheet. This lists all the records/values/entries of a given entity type. Each record is a row, and you can add any attribute of the selected entity type as a column. Filtering, and sorting are available.

HUD / Monitoring

Keep ontop of information as it changes with automatic data-refresh, and content to fill your screen making it easy to read at a glance