Quick Start Guide

Welcome to Civis!  Now that you've set up your Civis password and enabled two-factor authentication, you're almost ready to get started.  But first let's go over some of the basics about navigating the platform.

The Basics 

• The current version of Google Chrome is the browser officially supported by Civis.  Other browsers may work but are not explicitly tested.
• Our account recovery policy and process can be found here.
• Review the Client Handbook to understand how we, the Client Success team, partner with you. 

Navigating Platform 

What's on the Home Page

You'll see two tabs related to your Civis work:

• Dashboard: A collection of widgets that helps you find important work and monitor the status of recently run jobs.
• Activity: A list of jobs and their statuses.  You can filter to specific job statuses by clicking on the appropriate label.  You can change the sorting and filtering options to best suit your needs.

Navigation

This is your menu for accessing all Civis functionality. Click on each functionality to get more details and instructions. 

• Home: Return to the Civis home page.
• Query: Our in-browser SQL client where you can write and execute ad hoc queries.
• Data
  • Imports: Import data into your Platform Database cluster.
  • Exports: Export data from your Platform Database cluster.
• Code
  • Notebooks: Use Jupyter Notebooks to explore, visualize and iterate with your data.
  • Scripts: Create and save SQL, R, Python, and Javascript scripts that can be integrated into workflows.
• Tools
  • Workflows: Create chains of jobs to further automate your work.
  • Models: Build predictive models.
  • Labs: Additional advanced user features.
  • Enhancements: Access address correction jobs.
• Publish
  
  • Reports: Create and view visualizations of your data.
  • Services : Create services such as Shiny Apps.

Projects

Below the navigation menu on the left is the projects pane that displays favorited and recently worked on Projects. From here, you can search for or view Projects as well as create a new Project. Learn more about Projects here.

Data Pane

The left-side Pane can be toggled from Projects information to Data information. The data pane view displays the data on your Platform Database cluster. You can search for specific tables, expand schemas to see table names, expand tables to see column names, and click on table names to view detailed information about the data in a table.

Additional Features

• Search: Search for any of your work in Civis, including column names, jobs, results, tables, Tableau reports, and usernames.
• Announcements: Get notified of recent changes to Civis. Release notes can also be found here in the help desk.
• Settings: Change your password, update 2FA settings, or generate a Civis API Key . 

Help Documentation

Help documentation is available by clicking on the Help button in the bottom-right corner of the page. For more information about the Help Center Portal, click here . 

Getting Started

Not quite ready to start your own project? Complete our self-guided tutorial to walk through a project workflow step by step.