Skip to content
Snippets Groups Projects
Commit 40b6ce50 authored by Maz Ameli's avatar Maz Ameli
Browse files

Merge branch 'one-page-getting-started' into new-users-guide

parents 15bf0224 ffdb16b2
Branches
Tags
No related merge requests found
Showing
with 126 additions and 102 deletions
## Administration Guide
Are you in charge of managing Metabase for your organization? Then you're in the right spot. You are the chosen one.
**This guide will teach you how to:**
* [Connect Metabase to databases in your organization](01-managing-databases.md)
......@@ -9,6 +10,6 @@ Are you in charge of managing Metabase for your organization? Then you're in the
* [Manage user accounts](04-managing-users.md)
* [Configure settings](06-configuration-settings.md)
But first, you'll need to install a copy of Metabase if you haven’t already. Our [Installation Guide](../operations-guide/start.md#installing-metabase) will help you through the process.
First things first, you'll need to install Metabase. If you haven’t done that yet, our [Installation Guide](../operations-guide/start.md#installing-metabase) will help you through the process.
Already done with that? Then let’s start with going over [connecting Metabase to your database](01-managing-databases.md).
## Step 3: Asking Questions
# Getting Started with Metabase
For the next few examples, we'll be using the sample dataset that comes with Metabase. If you want to follow along using your own database that you connected in step 2, everything should work similarly, though obviously with different results.
Metabase is a simple and powerful analytics tool which lets anyone learn and make decisions from their company's data. No technical knowledge required! We hope you love it.
### The homepage
## Logging in
The way you log in to Metabase will depend on how you or your admin set it up, so if you don’t know where to go, just ask the person who sent you your Metabase invite.
If you look at the Metabase homepage, you'll see the activity feed. Right now there’s not much there, but it’ll soon get full as you or your teammates do things in Metabase.
## The homepage
Go ahead and log in to Metabase and the first thing you'll see is the activity feed. Right now there’s not much there, but it’ll soon get full as you and your teammates do things in Metabase.
![Activity Feed](images/ActivityFeed.png)
### Asking a new question
## Asking a new question
Enough about that — let’s get to asking questions. Go ahead and click **New Question** at the top of the screen.
But, enough about that — let’s get to asking questions. For the next few examples, we'll be using the **Sample Dataset** that comes with Metabase.
Now we’re on the new question page. The bar that you see going across the page is what you’ll use to ask your questions. You’ll notice that the “Select a table” dropdown is already open, showing you a list of your database(s) and the tables within them.
Go ahead and click **New Question** at the top of the screen. Now we’re on the new question page. The bar that you see going across the page is what you’ll use to ask your questions. The “Select a table” dropdown should already be open, showing you a list of your database(s) and the tables within them.
![Query Builder](images/QueryBuilder.png)
In our example, we’re going to ask a question about the Orders table in the Sample Dataset database, so we’ll click on **Orders** in the dropdown. The Orders table has a bunch of fake data in it about product orders for a made up company.
## Our first question
![Orders](images/Orders.png)
We’re going to ask a question about the Orders table in the Sample Dataset database, so we’ll click on **Orders** in the dropdown. The Orders table has a bunch of fake data in it about product orders for a made up company. If you just want to see everything that’s in this table, you can click **Run query** and see all the raw data.
### Our first question…
![Orders](images/Orders.png)
For now, let's start with a simple question: how many orders have been placed with a subtotal (before tax) greater than $40? More precisely, this question translates to, "How many records (or rows) are in the table 'Orders' with a value greater than 40 in the Subtotal column?”
Let's start with a simple question: how many orders have been placed with a subtotal (before tax) greater than $40? More precisely, this question translates to, "How many records (or rows) are in the table 'Orders' with a value greater than 40 in the Subtotal column?”
To find out, we want to *filter* the data by **the field we’re interested in**, which is **Subtotal**. Since each row in this table represents one order, counting how many rows there are after we’ve filtered them will give us the answer we want.
......@@ -37,12 +39,11 @@ Next we need to tell Metabase what we want to see. Under the View dropdown, we
![Count](images/Count.png)
### …and our first answer!
### And our first answer!
Okay, cool — we’re ready to ask our question, so let’s click the **Run query** button!
So it looks like there were 12,284 orders, each with a subtotal greater than $40. Ka-ching! Another way of saying this is that there were 12,284 *records* in the table that met the parameters we set.
So it looks like there were 12,284 orders, each with a subtotal greater than $40. (By the way, you’ll definitely get a different answer than us, because the data in the sample dataset is randomized.) Another way of saying this is that there were 12,284 *records* in the table that met the parameters we set.
![Count Answer](images/CountAnswer.png)
### Tweaking our question
......@@ -71,5 +72,53 @@ You’ll notice that some formats aren’t the best way to show an answer to a q
If you want, you can try playing around with your question, like changing the number 40 to a different number. Whenever you make any changes to the question, the blue "Run query" button will reappear. Click it to ask your new question and get your new answer.
### Next: share your answers
While Metabase can be used on your own, you can also share your answers with others in your company. Let's learn [how to share your answers](04-sharing-answers.md).
\ No newline at end of file
## Sharing answers with others
You can use Metabase all on your own, but it becomes even more useful when you start sharing your answers with other people on your team or in your organization. The first step is saving some of your questions.
### Saving questions
Sometimes you’ll find yourself asking certain questions again and again, whether it’s running regular reports, looking up something about an important segment of users, or just answering the same question for other people in your company. To keep from repeating the same set of steps each time you want to ask the same question, you can save your questions to use later.
To do this, click on the **SAVE** button in the top-right of the question builder screen.
![savebutton](images/SaveButton.png)
Metabase will take a stab at giving your question a meaningful name, but you can (and should) use your own naming convention that’ll help you and others find your questions later on, after amnesia has sunk in.
![Save Question Dialog](images/SaveQuestionDialog.png)
Once you’ve saved your question, you can either go back to the home page, add your saved question to a dashboard, or keep asking questions. Let’s click **Add to a dashboard** and give that a try.
![Saved Question](images/SavedQuestion.png)
### Creating a dashboard
Unless you went off and did your own thing, you shouldn’t have any dashboards yet, so you’ll see a dialog that prompts you to create a new one and give it a name and description. Name it anything you’d like. We’ll call ours “My First Dashboard.”
![Create Dashboard](images/CreateDashboard.png)
Dashboards are great when you have a set of questions and answers that you want to view together. Your saved questions will be displayed as cards on the dashboard, which you can resize and move around to your heart’s content.
So, after you click the button to create your dashboard, you should see your fancy saved question as a little card. Ain’t he cute?
![Saved Dashboard](images/SavedDashboard.png)
If you’re feeling up to it, you can click the edit button in the top-right of the screen (the one that looks like a pencil), and that’ll let you move and resize your saved question so you can get it looking just how you want it. Just click **Save** in the top-right when you’re done. We’ll make ours a bit wider to let those data points breathe.
![Resized Chart](images/ResizedChart.png)
### Sharing answers directly
One other thing: once you’ve asked a question or saved a dashboard, the URL in your browser will link directly to that question or dashboard. That means you can copy and paste that URL into an email or chat and let other people see what you’ve found. This will only work if Metabase is installed on a shared server, and will require creating Metabase accounts for the people you want to share with.
![shareableurl](./images/ShareableURL.png)
---
## That’s it!
You’ve done really well. You now have a dashboard with your question that you can share! At this point you know enough to be dangerous.
Want to learn more? Is your thirst for knowledge insatiable? Check out our [Users Guide](../users-guide/start.md) for more in-depth explanations of the ins and outs of Metabase.
## Step 1: Installing Metabase
### Getting Metabase
Metabase is a program that runs on the Java virtual machine (or JVM). There are two ways to run it, depending on which platform you use.
### Trying Metabase out with the Mac OS X App
If you're using OS X, we have a Mac app that you can find in the Mac App Store or [download directly](www.metabase.com/download/osx/latest). It comes bundled with everything you need to get started, so it’s a great way to just try Metabase out. Once you've downloaded the app, move it to your Applications folder and open it up. Once you see the loading screen, you can move on to the next step: [connecting Metabase to your database](02-connecting-metabase.md).
### Running the JAR directly
If you're fairly technical or planning on immediately setting up Metabase on a shared server, you can [download the latest JAR distribution](www.metabase.com/download/jar/latest). To run this JAR, you'll need to have Java installed on your machine.
**On Linux:**
Your Linux distribution might ship with Java pre-installed — you lucky dog, you. Try `java -version` to see if Java is set up. If not, you can install Java in a number of ways depending on your distribution.
On Ubuntu, or any other distribution with the Debian package manager,
apt-get install -Y openjdk-7-jre-headless
will install Java. For other distributions, check your distribution’s documentation.
**On Windows or Mac:**
Go to the [Java JDK downloads page](http://www.oracle.com/technetwork/java/javase/downloads/index.html) and download the latest JDK for your platform.
Once you've gotten Java installed on your machine, go to the command line and try typing `java` to make sure it's installed correctly.
The Metabase server creates temporary files when it runs, and so you'll probably want to place the metabase.jar file in its own directory. To get things started, run the command,
java -jar metabase.jar
After taking a few seconds to start up, you should have the Metabase server running on port 3000 of your computer. Go to [http://localhost:3000](http://localhost:3000) in a browser and you should see the screen below.
![welcomescreen](images/WelcomeScreen.png)
Now that you've installed Metabase, let's [connect it to your database](02-connecting-metabase.md).
\ No newline at end of file
## Step 4: Sharing answers with others
### Saving questions
Sometimes you’ll find yourself asking certain questions again and again, whether it’s running regular reports, looking up something about an important segment of users, or just answering the same question for other people in your company. To keep from repeating the same set of steps each time you want to ask the same question, you can save your questions to use later.
To do this, click on the **SAVE** button in the top-right of the screen.
![savebutton](images/SaveButton.png)
Metabase will take a stab at giving your question a meaningful name, but you can (and should) use your own naming scheme that helps you and others find your questions later on, after amnesia has sunk in.
![Save Question Dialog](images/SaveQuestionDialog.png)
Once you’ve saved your question, you can either go back to the home page, add your saved question to a dashboard, or keep asking questions. Let’s click **Add to a dashboard** and give that a try.
![Saved Question](images/SavedQuestion.png)
### Creating a dashboard
Unless you went off and did your own thing, you shouldn’t have any dashboards yet so you’ll see a dialog that prompts you to create a new one and give it a name and description. Name it anything you’d like. We’ll call ours “My First Dashboard.”
![Create Dashboard](images/CreateDashboard.png)
Dashboards are great when you have a set of questions and answers that you want to view together. Your saved questions will be displayed as cards on the dashboard, which you can resize and move around to your heart’s content.
So, after you click the button to create your dashboard, you should see your fancy saved question as a little card. Ain’t he cute?
![Saved Dashboard](images/SavedDashboard.png)
If you’re feeling up to it, you can click the edit button in the top-right of the screen (the one that looks like a pencil), and that’ll let you move and resize your saved question so you can get it looking just how you want it. Just click **Save** in the top-right when you’re done. We’ll make ours a bit wider to let those data points breathe.
![Resized Chart](images/ResizedChart.png)
### Sharing answers directly
One other thing: once you’ve asked a question or saved a dashboard, the URL in your browser will link directly to that question or dashboard. That means you can copy and paste that URL into an email or chat and let other people see what you’ve found. This will only work if you installed Metabase on a shared server, and will require creating Metabase accounts for the people you want to share with.
![shareableurl](./images/ShareableURL.png)
## That’s it!
You’ve done really well. You now have a dashboard with your question that you can share! At this point you know enough to be dangerous. If you haven’t already, this would be a good time to [connect your own database](../users-guide/02-connecting-metabase.md) to Metabase and start asking some real questions!
Want to learn more? Is your thirst for knowledge insatiable? Check out our [User Guide](../users-guide/start.md).
docs/getting-started/images/AccountSetup.png

63.5 KiB

docs/getting-started/images/AddDatabase.png

35.6 KiB

docs/getting-started/images/CreateDashboard.png

106 KiB

docs/getting-started/images/SaveButton.png

98.2 KiB

docs/getting-started/images/VisualizationMenu.png

21.5 KiB

docs/getting-started/images/WelcomeScreen.png

77 KiB

# Getting started with Metabase
Metabase lets you easily ask questions about your data, drill into specific records, and create dashboards to help keep you organized. We hope you love it.
**This guide will teach you:**
> [How to install Metabase on your laptop or server](01-installing-metabase.md)
> [How to connect Metabase to a database](02-connecting-metabase.md)
> [How to ask your first questions](03-asking-questions.md)
> [How to share the answers you find!](04-sharing-answers.md)
Let's [get started!](01-installing-metabase.md)
docs/images/AccountSetup.png

55.5 KiB | W: | H:

docs/images/AccountSetup.png

63.5 KiB | W: | H:

docs/images/AccountSetup.png
docs/images/AccountSetup.png
docs/images/AccountSetup.png
docs/images/AccountSetup.png
  • 2-up
  • Swipe
  • Onion skin
docs/images/AddDatabase.png

63.3 KiB | W: | H:

docs/images/AddDatabase.png

35.6 KiB | W: | H:

docs/images/AddDatabase.png
docs/images/AddDatabase.png
docs/images/AddDatabase.png
docs/images/AddDatabase.png
  • 2-up
  • Swipe
  • Onion skin
File moved
docs/images/CreateDashboard.png

109 KiB | W: | H:

docs/images/CreateDashboard.png

106 KiB | W: | H:

docs/images/CreateDashboard.png
docs/images/CreateDashboard.png
docs/images/CreateDashboard.png
docs/images/CreateDashboard.png
  • 2-up
  • Swipe
  • Onion skin
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment