open bouquet readme

Open Bouquet Developer Hub

Welcome to the Open Bouquet documentation hub for developers. You'll find comprehensive guides and documentation to help you start working with Bouquet as quickly as possible, as well as providing you with support if you get stuck on anything.

Below you will find links to our Quick Start Guide and to the general User Guide.
If you're new to Open Bouquet, there is an Introduction section at the start of the User Guide.
If you prefer the "Just Do It" approach, then I would suggest the Quick Start Guide ("Getting started with Bouquet") which explains how to get started with Bouquet from installation to working with projects and queries -- including links to more detailed information while you're working on through the quick start guide.

Getting started with Bouquet

Overview : a guide to get started with Bouquet and working on your first project.

This Getting Started guide will lead you through how to start using Bouquet by getting you started to work with Bouquet.

Install Bouquet

First, you need to download and install Bouquet in your development environment:

Create a project

Next, open the Bouquet app. For now, we'll focus on using the demo project, so choose "Use demo project" to start working with Bouquet.

Landing page

Landing page

"Use demo project"

A default project will be automatically created in your project list.

Double click on it and to display the list of the available tables in the demo database.

Click to add a project

Click to add a project

Create a query

Open your project and double click the table you want to analyze; choose the table "sales" from the Demo Project. This will open the Query Builder.

In the demo project, you can select, "Sales" table as an example.

In the demo project, you can select, "Sales" table as an example.

The left pane shows your query configuration, while on the right part of the screen you will see the items from your project and from Bouquet.

Switch between tabs to access:

  • Dimensions: which are the possible quantitative column values
  • Metrics: which are calculated outputs
  • Functions: which are the existing SQL built-in operations that you can use as aggregates.

For more details about the Query Builder and its possibilities, see Query a bookmark or a domain

Next, select a period and click the "Query" button at the bottom of the page.

The results of your query are now visible at the bottom of the page.

You will notice that the first metric is already selected for you by the zero-commute feature.

Add a breakdown column

Next, we'll add a breakdown column.

As interesting as the total of one month might be, we want to split this result for each day of the month.

Click the tab "Dimensions" in the right pane to display the possible columns information.

Look for a Date field among the Dimensions, such "Saletime" in the demo, then drag and drop it to the "groupBy" text area in the query configuration of the left panel.

Now the results will be displayed by date.

To order the results by date, once more drag and drop "Saletime" to the "orderBy" on the query configuration, in the same way as for "groupBy".

For more details about the Query Builder and its possibilities, see Query a bookmark or a domain

Getting started with Bouquet

Overview : a guide to get started with Bouquet and working on your first project.