You can create you own Table view in Report and Dashboard by BellaDati Extensions feature. This tutorial describes how to create customized Table view with following specification:
- custom look & feel (e.g. colors, padding, borders, resizing table columns, etc.)
- displays data from existing DataSet by selected options in Filter view
- user can select multiple table rows
- user can invoke specific Client API endpoints and use selected table rows as parameters
Table of Contents:
- Environment Setup
- Step 1. Import and setup basic Table Renderer extension
- Step 2. Get familiar with basic Table Renderer extension
- Step 3. Add new parameters
- Step 4. Create DIV containers in HTML body for controls
- Step 5. Add checkbox as first column
- Step 6. Register events for checkboxes
- Step 7. Add specific functionality into column with file path
- Step 8. Add functionality to hide column with file path
- Step 9. Make table columns resizable
- Step 10. Replace source table view with extension page
Imagine situation that you have a list of PDF files somewhere on your filesystem and metadata about each PDF file stored in the DataSet, e.g.:
|Germany||Berlin||2016-02-22||D:\Rechnung\Berlin\Akte 22. Februar 2016.PDF|
|Germany||Düsseldorf||2016-02-22||D:\Bestellen\Düsseldorf\Akte 22. Februar 2016.PDF|
Users want to access (open/download) these files directly from BellaDati Report through their web browsers. User's second use case is to select multiple PDF files, merge them into one PDF file and download only this one PDF file. Of course, users want to filter PDF files displayed in the table by various attributes (e.g. country, city, date, etc.).
We will create Report with Filter view and Table view. Then we will create Extension that will act as customized table renderer. It will use Client API endpoints to load JSON data of existing Table view and render new table with customized CSS styles and additional features. Extension will have type "Create new page" and therefore we will embed this new page into Custom content in Report. The last step will be just hide original Table view.
- You have BellaDati instance in version 2.7.18+.
- You have role Super Admin in multi-domain environment or Domain Admin in single-domain environment.
- You have set of test PDF files and metadata stored in some file or database.
- You read our user's documentation related to extensions.
- Enable Developer mode in your user profile. Please see section Appearance settings at Managing User Profile for more details.
Prepare DataSet with data. Prepare Report with Table view and Filter view. This step is not covered by this tutorial. Please see our documentation for more details.
- Prepare testing PDF files in some directory.
- To enable file access in your BellaDati instance and domain go to Administration and then Configuration. Please check option Enable file access. Then:
- For single-domain environment please set specific files paths (directory where PDF files are located) into Allowed file paths.
- For multi-domain environment please click Edit on Manage Domain page, go to Restrictions tab. Then check option Enable file access and set specific files paths (directory where PDF files are located) into Allowed file paths.
Please refresh extension page after each step to verify that your changes were applied correctly.
Step 1. Import and setup basic Table Renderer extension
We will use basic Table Renderer extension provided by BellaDati on GitHub. It creates a new BellaDati page with table. This table contains data from source table view that is specified as parameter. We will customize this extension to bring new features.
- Please download this ready–made extension from GitHub.
- Go to Manage extensions page that is available in the Extensions section, under Administration menu, and import this extension into your BellaDati instance.
- Go to your report and determine ID of source table view - Click on API button located at the top left corner of table view and see API URL value. Table view ID is a text after last "/".
- Set ID of table view as extension parameter called tableViewID.
At the end of this step please verify setup of extension. Go to Extension Gallery and click on name of imported extension. You should see new page with table that contains data from source table.
Step 2. Get familiar with basic Table Renderer extension
We will customize basic extension in next steps and therefore you need to get familiar with it at first.
- Go to Manage extensions page and click on extension name. You will be redirected to the Edit extension page.
Step 3. Add new parameters
Our extension should be parametrized to allow users to change extension behavior without changing implemented code, therefore we need to add these parameters:
|enableResizingColumns||Boolean||Enable/disable resizing columns in table||false|
|hideColumnWithPath||Boolean||Show/hide column where file path is located||false|
|indexOfColumnWithPath||Integer||Index of column where file path is located||3|
|linkGetFile||String||Link to our Client API endpoint that returns file from given absolute path||/bi/utils/api:file?path=|
|linkMergePdfFiles||String||Link to our Client API endpoint that merges PDF files into one PDF file||/bi/utils/api:mergePdfFiles?paths=|
|linkViewDetail||String||Link to our Client API endpoint that loads the view detail with data||/bi/report/api:viewDetail/|
Step 4. Create DIV containers in HTML body for controls
Set following code into Content of HTML body:
Add new CSS styles for new elements into text resource called table-styles.css:
Step 5. Add checkbox as first column
Update code of table-renderer.js before both loops over header columns and body columns.
Step 6. Register events for checkboxes
Add following code into table-renderer.js at the end of success function that handles response from Client API:
Create function in table-renderer.js:
Step 7. Add specific functionality into column with file path
At first we need to know which column should be customized, and therefore we will add this helper function into table-renderer.js:
Based on result from this function we will customize column title in table header:
Based on result from this function we will customize cell content in table body:
Step 8. Add functionality to hide column with file path
At first we need to know which column should be hidden and also recalculate colspans, and therefore we will add these helper functions into table-renderer.js:
Based on results from these functions we will customize rendering of table header cells:
Based on results from these functions we will customize rendering of table body cells:
Step 9. Make table columns resizable
Step 10. Replace source table view with extension page
- Go to Extension Gallery, click on name of this extension and copy URL from address bar of your web browser.
Go to Report and create new Custom Content view with following code (use copied URL from previous step instead of "XXX"):
- Go to Table appearance settings of source table view and select checkbox Hide view in view mode in Options section.