metabase-tools

Configuration tools for Metabase when working with large journal collections without a common editorial team.

In a hosting environment that uses OJS installations with multiple journals, hosts might want to support Metabase as a way for editors to build and run reports or explore the workflow data. However, hosts need to ensure that data from other journals is not exposed to editors. This toolset uses views to segment the main OJS database into derived databases that Metabase can explore freely without exposing unwanted data.

To use:

Configure config/config.php with details from your environment.
Use generate-views.sql (adapted as necessary) to create a database with a set of views in it:
1. Generate the SQL:
```
JOURNAL_PATH=abc php generate-views.sql
```
2. Review the output to make sure it's correct
3. Run the SQL as e.g. root (because of required CREATE DATABASE / GRANT privileges):
```
JOURNAL_PATH=abc php generate-views.sql | sudo mysql
```
Create the new database in Metabase: You can get a Metabase API key by creating it in the Metabase web interface.
```
METABASE_API_KEY="abcdefg" JOURNAL_PATH=abc php create-metabase-database.php
```
Sync the database: Note that METABASE_MB_API_KEY is NOT the same thing as the API key you create in the web interface for Metabase. It needs to be provided to Metabase when it is started using the MB_API_KEY environment variable. It can be anything you like.
```
METABASE_MB_API_KEY="xyz123" JOURNAL_PATH=abc php sync-database.php
```
Set the visibility for all tables in the new database:
```
JOURNAL_PATH=abc php set-table-visibility.php
```
Sync the database again as in step 4.
Run configure-metabase.php to update Metabase's configuration. (This can also be used to sync changes back to Metabase after e.g. an addition to config.inc.php or an inadvertent change in the Metabase configuration.)
```
JOURNAL_PATH=abc php configure-metabase.php
```
Run create-default-cards.php to create a set of reports/queries for the new database.
```
METABASE_API_KEY="abcdefg" JOURNAL_PATH=abc php create-default-cards.php
```

asmecher/metabase-tools

metabase-tools