Getting Started - Administrators

👤 This documentation is intended for Site Administrators.

Site Administrators have control over all of the settings and user-permissions throughout their Periscope instance. In order to get started with Periscope, an Admin will need to add a database, add more users, and configure other settings for their site. This page will guide Periscope Admins through all of the feature and account settings necessary to set up a successful site.

<div>
<UL>
<LI><a href="#TrainingVid">Watch the Administrators Training Video</a></LI>
<LI><a href="#ConnectDatabase">Connect a Database</a></LI>
<LI><a href="#AddUsers">Add Users</a></LI>
<LI><a href="#RolesGroups">Add Roles and Groups</a></LI>
<LI><a href="#CacheTable">Cache a Table</a></LI>
<LI><a href="#SitePreferences">Manage Site Preferences</a></LI>
<LI><a href="#BillingAuthentication">Billing and Authentication</a></LI>
<LI><a href="#Git">Connecting to Git</a></LI>
</UL>
</div>
<HR>
<a name="TrainingVid"></a>

Watch the Administrators Training Video

<html>
<body>
<iframe width="560" height="315" src="https://www.youtube.com/embed/e-cZgf6zzlQ" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</body>
</html>
<a name="ConnectDatabase"></a>

Connect a Database

The first thing a Site Admin will do when they first login to Periscope is connect a Database. The option to connect a database is given when a Site Administrator first logs into a site that doesn’t already have a database connected. It can also be added by navigating to the Database Settings page after clicking the gear icon on the bottom of the left hand menu bar.

Select access must be granted to the schemas and tables in the database in order to query them in Periscope.

If the database is in a private network or behind a firewall, an SSH tunnel will need to be created. Below is more documentation on creating an SSH tunnel.

Here’s additional documentation on managing Databases.

<a name="AddUsers"></a>

<a href="#top">Back to top</a>

Add Users

The next thing an Administrator will do is add other users to Periscope.In order to add other users, the Administrator will go to the Permissions Settings page after clicking the gear icon in the left-hand menu bar. Then in the right hand top corner there is an Add User button. Enter the User’s name and email to send them an invite to Periscope.

If SSO is enabled on this site, the Add User button will not be there. Users can then join Periscope through their SSO provider.

The User Management API allows for bulk addition and edits of users. This is particularly helpful for sites that need to invite and permission many users at once.

<a name="RolesGroups"></a>

<a href="#top">Back to top</a>

Add Roles and Groups

There are two different user management settings. There is the Legacy Permissions and the Role Based Access Control (RBAC).

RBAC

All sites with RBAC start with an Everyone, Admin, Analyst, Business User and Read Role. Additional roles can be created with a custom combination of access by checking and unchecking access in the Permissions page.

Every user will automatically be added to the Everyone role. The Everyone role starts with SQL access, granting all users the ability to create and edit SQL and Discovery charts. This can be modified by clicking the Everyone role in the Permissions page and unchecking the boxes.

The Everyone role should have the lowest level of access that any user can have on the site. Additional access can be granted by adding the user to more roles.

Legacy

All sites start with an Administrators group and an All Users group. Every user on a site will automatically be added to the All Users category. The All Users group should have the lowest level of access a user can have on the site. More access can then be added on by other group memberships.

<a name="CacheTable"></a>

<a href="#top">Back to top</a>

Cache a Table

With the Periscope Cache, SQL users are able to upload CSVs, perform cross-database joins, and use materialized views. In order to run queries on Periscope’s cache, all of the underlying tables in the query must be cached. Site Administrators are able to Cache tables according to different update strategies that best fit their data.  

To cache a table from a connected database, navigate to the Cache Settings by clicking the gear icon on the left-hand menu bar.

There are 4 different types of caching strategies. Site Administrators will have to carefully determine which strategies best fit each table being cached. Click here for more details on each caching strategy.

  1. Full Updates
  2. Full and Incremental Updates
  3. Modified Updates
  4. Bounded Updates

Here’s more information on Caching Data on Periscope.

For sites that require more customizability, Periscope Data offers both a Cache and Warehouse infrastructure.

  • For the Cache infrastructure, Periscope offers both a Snowflake and Redshift option.
  • For the Warehouse infrastructure, Periscope currently only offers a Redshift Warehouse option.
    Click here for more information on our different Infrastructure Options.

<a name="SitePreferences"></a>

<a href="#top">Back to top</a>

Manage Site Preferences

Site Administrators can customize their Periscope instance by enabling other features available to them from the Preferences page. From the Site Preferences page Administrators can do the following:

  • Set a site-wide timezone.
  • Assign the dashboard shown at login and enable external sharing of dashboards.
  • Manage access to CSV downloads and choose the delimiter used on downloaded CSVs.*
  • Allow new custom filters to be available on all dashboards.
  • Enable Auto Archive for dashboards, views, CSVs, and datasets.*
  • Create custom color palettes that can be used site-wide for style and consistency with Color Themes.*

Click here for more details on the Site Preferences.

* This feature is available on select plans. Site Administrators can contact their Account Manager for additional information.

<a name="BillingAuthentication"></a>

Billing and Authentication

<a name="Git"></a>

From the Billing and Authentication page, Site Admins can see billing details, get their API Key, enable the Slack integration and enable site-wide SSO and 2FA.

Connecting to a Git Repository

With Periscope's Git Integration, Admins can connect a private Git Repo to their Periscope instance. Periscope can connect to repositories hosted in GitHub, GitLab, and Bitbucket.

<a href="#top">Back to top</a>

Our support team is ready to help