thelia / metabase-module
Metabase module for Thelia
Installs: 11
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 6
Forks: 0
Open Issues: 0
Type:thelia-module
Requires
- ipeevski/metabase-php: ^0.3.0
- symfony/http-client: *
- thelia/installer: ~1.1
README
This module was made to integrate Metabase Dashboard to your Thelia admin backOffice
Please check Metabase API Documentation for more detail about Metabase
With this module, you can connect to your Metabase account and print some statistics on the admin panel
You can also import your database, create default Metabase Dashboard and Cards and modify your metabase synchronization parameters
Installation
Composer
Add it in your main thelia composer.json file
composer require thelia/metabase-module:~1.0
Usage
Configuration
Go to the configuration panel
Configure Metabase with your Url, your mail metabase and your password metabase
To get your integration token: go to https://your-metabase-url/admin/settings/embedding-in-other-applications and activate Integration
Import your Database
Go to the Import Database Panel
The Name of the Metabase will be the name of your Metabase Collection
Then, Complete the form with your database info
The importation of your database can take a while.
Generate Metabase
Go to the Generate Metatable panel
complete the order status with the ids (2,3,4) (2 -> paid, 3 -> processing, 4-> sent)
You will have to click the check button first. If your datatable installation is complete, you will be able to generate default metabase cards and Dashboard
It will be split in two collections :
MainStatistic
- for last 30days Turnover, annual Turnover and Best Seller
SecondStatistic
- for Sales and Turnover by products, brands and categories products
note: all names can be changed in Metabase translation.
Update Syncing
Go to the Update Metabase Syncing Panel
By default, Metabase does a lightweight hourly sync and an intensive daily scan of field values. If you have a large database, you should modify syncing options.
Database syncing
This is a lightweight process that checks for updates to this database’s schema. In most cases, you should be fine leaving this set to sync hourly.
Scanning for Filter Values
Metabase can scan the values present in each field in this database to enable checkbox filters in dashboards and questions. This can be a somewhat resource-intensive process, particularly if you have a huge database.
Periodically re fingerprint tables
This enables Metabase to scan for additional field values during syncs allowing smarter behavior, like improved auto-binning on your bar charts.
Syncing option :
- Full Syncing: Activate Syncing and Scan
- On Demand: Activate Syncing and Scan on the new Filter Value
- Syncing Only: Scan is not activated
For Developers:
if you want to create our own Metabase using the module, see Developers Docs