Create Business Object

Before creating decisions and visualizations, you must define and activate a Business Object

Business Object

A container for measures, dimensions, and metrics that defines aggregations and data sources.
— a model of the data you want to process.

Use case

For our documentation use case, we’ll create a Business Object that captures data such as the guild name, message sent, purchase item, and purchase item value.

We’ll capture that data as either a numeric measure (message sent and purchase item value) or a qualitative dimension (guild name and purchase item).

This is a sample of the JSON structure we’ll use to map

Mapped/Unmapped

Whether the data source for a measure or dimension has been defined or the action has been configured.
the defined measures

Measure

Quantitative, numeric values that can be measured. Measures can be aggregated, and calculations (for example, sum or average) can be performed on them.
and dimensions

Dimension

Qualitative values (places, products, people) that can be used to categorize and segment data or measures. Used to slice & dice measures.
with our app’s data.

[
{
"chatMessage": 1,
"guildName": "Rockin Guild",
"purchasedItem": "Wood Fort",
"purchaseValue": "5",
"discountCode": "FORTFREE"
},
{
"chatMessage": 1,
"guildName": "Hurrah",
"purchasedItem": "Metal Fort",
"purchaseValue": "8",
"discountCode": "FORTX"
},
show all 17 lines

We’ll later create metrics

Metric

What exactly is evaluated using measures, dimensions, and aggregation functions.
(one for each measure) to aggregate the data and activate the Business Object at the end to let Illuminate start capturing data.

icon

Check configuration details

Steps

Follow the sections to prepare a Business Object — create and map measures and dimensions, add metrics, and activate it.

Create and map measures and dimensions

Start by defining what data you want to track (measures) and how (dimensions).

Create metrics

Add calculations to your measures and/or dimensions.

Order of steps

You can add metrics before measures and dimensions are mapped.

A ready and activated Business Object with metrics looks as follows.

Saved and active Business Object

Activate Business Object

To start capturing and storing the data, you must activate the Business Object.

Conditions for activating a Business Object

Head to the Additional details section for details on conditions that must be met to activate a Business Object.

From now on, Illuminate will start capturing the requested data until you deactivate or delete the Business Object. You can't add or remove measures or dimensions once you've activated a Business Object, but you can add a metric to it.

Data you defined in Business Objects and subsequently captured are housed in a single database for 90 days.

With the Business Object that is configured and active, you can create a Decision or a Dashboard.

Last updated on