Interface

It might be useful to think of a project as a large folder. It contains datasets along with queries and their output tables. In a Redivis project, these entities are visually arranged to make it easy to see how your queries and tables are related to each other, and to make it easier to make changes that affect your whole project.

Minimap

The left side of the screen is where you'll see all entities that currently exist in your project. If you created this project from a dataset you'll see a rectangle with the dataset name next to it to start.

Nodes

Each shape on the minimap represents a different entity in your project.

Dataset nodes are direct copies of a dataset page.

Transform nodes are queries that don't contain any data themselves.

Table nodes are the resulting output of a transform that has been run.

Navigation

Click on a node in the minimap to bring up a corresponding panel on the right of your screen which shows the current state of the node. This right panel is where you will be able to inspect tables and datasets, and build transforms.

Nodes are connected by paths which show how they are related to each other. All nodes are sequential from the top of the screen to the bottom. As you create new nodes you can trace their relation to each other through these paths. When you have a node selected, it's path will be lit up in purple to more easily trace it through your project.

As you build your project, its minimap will expand with many new nodes. You can use the zoom buttons in the bottom left corner to make the map a more manageable size.

Getting started

The most basic step to start a project is to query a dataset using a transform. To get started, click on a dataset node and then click + Transform which appears below it.

This will create a new transform node and its output table which will eventually be populated with the output of this transform operation. The transform will initially show an invalid icon, indicating that it can't be run in its current state and you will need to choose parameters to build your query.

To specify parameters (including variables to select, new variables to create, rows to filter, and more) and run the transform, click on the transform to see its contents in the right panel. The powerful functionality available within the transform tool is explored more thoroughly in the Transforms section.

Once you build your transform you can press the Run button in the top right to run it and populate the output table. You can click on this table to inspect it and confirm that the transform worked the way you expected it to.

Next steps

From here you might want to create another transform on this output table to query it again. Or maybe you'll want to add new datasets to this project and join them in.

There are many ways to continue building your project as you query data and create new tables.

Project menus

The menu in the top left of the project tool contains a comprehensive list of all available project operations, which will be disabled if they can't be performed given the current state of the project.

Many of these operations are also accessible via right clicking on different elements of the minimap and throughout the the project. You might have an easier time finding an action you're looking for if you right click in context of a node

Node search

If you ever get lost, you can click the search icon in the top and input the name of a node to jump to it.