Skip to content
ROKKS Docs
DRAFTEnglish end user manual · web beta f7b7740e7371 · Android beta ed5d9494be9eDownload PDF

Quick Start

Overview

Section titled “Overview”

This quick start summarizes the smallest useful Rokks workflow: load the public fictional six-table Pagila sample, review its relationships, and build a dashboard widget. It assumes your platform is already available at your organization’s Rokks URL. Follow the Pagila maiden flight for exact checksums, mappings, acceptance totals, and illustrated checkpoints.

How it works

Section titled “How it works”

A regular File Area groups related uploads. Its Constellation child accepts one JSON source and turns that source into several related governed tables. The Pagila source produces six nodes and five declared relationships. After the data is loaded, the Widget Builder reads the catalog and lets you follow those relationships across the available tables and columns. The dashboard never stores copied rows; it queries the governed data whenever it renders.

File Areas owns the imported outputs. Local Tables provisions tables created directly in Rokks and does not list Constellation outputs.

MOCKUPSource-derived illustration — not a captured product state
Source-derived Data Fabric illustration
Data Fabric illustration based on the File Areas surface.Source baseline: beta f7b7740e

Step-by-step

Section titled “Step-by-step”
  1. Download the Pagila Rental Constellation JSON and its source and derivation record.
  2. Open Data Fabric → File Areas, click New, and name the regular area Pagila Samples.
  3. Open that area’s action menu, choose Add Constellation, and name the child Pagila Rental Constellation.
  4. Select the child, click Upload Source, and choose pagila-rental-constellation.json.
  5. Wait for sampling, choose Generate Plan, and confirm six nodes named categories, stores, customers, films, rentals, and payments plus five relationships. Click Save Constellation.
  6. Click Run and wait until the Constellation reports 6/6 loaded. If you can access Job Queue, also confirm its child FILE_ETL job is DONE.
  7. Open Workspaces, enter or create ACME Analytics, create the dashboard Pagila — Rental Performance, and choose Build it by hand.
  8. Choose Add column to create the first empty lane, then use the slot labelled Add or drag widget here.
  9. In the schema canvas, follow the catalog relationship payments.rental_id → rentals.rental_id. Configure Monthly Revenue as SUM("payments"."amount") by month of "rentals"."rental_date", then click Run Query.
  10. When the preview is correct, wait for the instant save to finish, then click Close.

If you prefer a chat-driven path, the Sidekick task cookbook shows how to request the workspace, dashboard, and first widget while keeping each result reviewable.

Common mistakes

Section titled “Common mistakes”

Do not close the job queue because a job is running. Jobs continue in the background, but the queue is the best place to see progress, errors, and completion status.

Do not skip the schema review. Good display names, types, units, and constraints make dashboards easier to build and easier for Sidekick to understand.

Section titled “Related”