ExtractBI allows you to create custom extractions using SQL queries to directly query the tables of your BoondManager database.
The application specifically addresses the following needs:
Custom extraction not natively provided by BoondManager
Construction of flat files (CSV)
Periodic extractions intended to be integrated into a BI tool
Prerequisites:
This app is only available starting from our ADVANCED offering.
Install and configure access to the application
Warning
The use of this app is reserved for advanced users with knowledge of SQL language and relational databases. Furthermore, configuring queries requires access rights to Administration.
Installation
Administration > Apps / Marketplace > Marketplace tab > ExtractBI
Configuration of resources access to the application
You must decide who will have the application installed by default:
Accessible only to authorized Managers: you choose which manager has the right to access the application. To do this, go to the Administration interface in the Managers / Roles module, open the relevant account/role records, then check the ExtractBI app in the Apps section.
Accessible by all managers: all managers will have the application installed by default.
Accessible only to authorized managers & all resources: This option is identical to the first and will have no effect for intranets that do not have access to reporting.
Accessible to all managers & resources: This option is identical to the second and will have no effect for intranets that do not have access to reporting.
Recommendation
We recommend choosing "Accessible only to authorized managers" so you can select which managers you want to activate the app for from Managers/Roles.
⠀
General configuration of the application
Choose the recipient of periodic extractions
ExtractBI allows you to configure queries that run on demand, or automatically according to a frequency of your choice. These queries will generate results in a CSV file that you can download.
If you choose to run them automatically, the CSV file generated will be stored in the Download Center. For this purpose, you need to choose the manager who will have access to these CSV files, so they can find them in their Download Center (We recommend choosing an administrator account here):
To go further:
You may need to transmit extractions to a third party who does not have access to BoondManager. For this, you will need to check "Anonymous access", which will allow you to use a sharing link usable by someone who is not logged in to BoondManager:
⠀
Using query templates
To make your task easier, we offer preconfigured query examples, available in the "Query templates" tab:
You can preview the queries there, and if one interests you, you can open it and click the "+" at the top right to create a new custom query from this template:
Once the query is created from the template, you can refer to the next chapter "Create a query" to modify it as you wish.
⠀
Create a query
Warning
Query creation is reserved for advanced users with knowledge of SQL language and relational databases. Furthermore, configuring queries requires access rights to Administration.
Query configuration is performed in Administration, in the application's configuration:
Administration > Apps / Marketplace > Apps tab > ExtractBI > Configuration button then Create button:
First, enter the title of the query, which allows you to easily identify which extraction it is. You can add a more complete description, then specify if the extraction will be automatically launched according to a given frequency:
Next, enter the actual query by respectively separating the SELECT, FROM, WHERE, ORDER BY (optional), and GROUP BY clauses:
Important
At each step of your query, a check is performed to ensure that the query contains no errors. You can view the result of this check using the icon at the top left of the screen. When your query is correct, a green check appears. If you do not see this green check but a red cross, your query cannot be executed by users:
You can then save and preview / launch the query by following the steps in the next chapter.
⠀
Preview results
Once your query is created, you can check the consistency of the results obtained by previewing them:
A sample of the first results is then displayed as a table, showing you the data as it will be extracted in the CSV file:
Run the query
To generate the complete results file, you need to run the query. You can perform this action in administration, in the same place as for query configuration, or directly in the Apps menu on the left, by selecting the ExtractBI app.
To the right of each query, a "Run query" button will allow you to generate the file:
You will then be offered to produce the file with column titles in French or English, and an encoding of your choice. Finally, click Extract to generate and download the file:
Share the query with another manager
Configured queries can be shared with another manager (for example, a co-leader). To do this, enter the query record and click "Shared with". You can then choose the second user who can run this query:
Nota Bene: The chosen user can run the query but cannot modify it.