Overview
Functions
Currently, many users have completed system integration based on the open platform and applied it to actual business, which has successfully solved their business problems and meet their needs.
This document introduces how to achieve deep integration between FineReport and users’ data middle platform to make the best of the data middle platform by applying the open platform in actual business.
Note: The front-end page introduced below has been developed by users. This document only introduces the interface docking logic, and does not cover the actual system development logic. The related effects are for reference only.
Expected Effect
The data middle platform of users has launched data modeling. It is expected to replace the original data model in FineBI data preparation through the open platform, and develop reports only by the design function of FineBI.
Example
Preparing Environment
Install FineBI of 5.1.18 or above versions.
Install Client API for FineBI6 plugin.
Configuring Open Platform
1. In Manage, go to Open Platform > Manage Clients, and click Add to add a client.
2. Click the edit button to obtain the automatically generated Client ID and Key.
3. In Manage Permissions, enable the permission of Client API for FineBI6.
Note: When calling APIs in subsequent steps, you need to add the following parameters in Header.
decUser: Username (users who have BI editing permission)
client_id: the Client ID obtained in step two
secret: the Key obtained in step two
Docking Data Middle Platform
In the data middle platform, business personnel can select specific dimension and indicator information.
At this time, the page will generate corresponding SQL in the background according to the selected information. When developing the data middle platform, you need to dock the SQL information and other prepared information to the following APIs:
1. Creating a SQL Dataset API in BI
The API document address: https://console-docs.apipost.cn/preview/8235cdbf59160235/261d4ec087ce3925?target_id=6cd43991-55ad-4895-990d-99eefa840ab1
API URL:
Write direct or spider in engineName according to the actual situation.
For details, see: https://console-docs.apipost.cn/preview/8235cdbf59160235/261d4ec087ce3925?target_id=440b0363-08cf-4f09-aa81-8dd5a2a33ef7
Note: There is no English version at the moment, but it will be maintained later. You can use the browser to translate the web page to view the document.
Body request parameter:
Create a SQL dataset through this API using the SQL information, known folders, data connection information obtained in step one.
In actual operation, developers need to save the relevant information of the created dataset for subsequent system queries and calls while developing.
Response:
Record the dataset name transferName, which will be used for subsequent dashboard creation.
2. Creating an API in BI Dashboard
The API document address: https://console-docs.apipost.cn/preview/8235cdbf59160235/261d4ec087ce3925?target_id=e6215617-603e-4eb0-a17e-5338b598447f2
Note: There is no English version at the moment, but it will be maintained later. You can use the browser to translate the web page to view the document.
For details, see section "Creating a SQL Dataset API in BI". This API is relatively complex, so this section only introduces some important parameters.
Body request parameter:
Based on the transferName in the feedback information of the previous step and other information, create a dashboard and default components. The tablename in the parameter is the return value of transfername of the previous step.
Response:
The system creates a corresponding dashboard and a default component in the background.
Developing
After completing the above steps, you can splice the dashboard ID returned by the API of the final step according to the fixed structure. Then you can go to the BI development page for self-service BI analysis.
Summary
Currently, the overall docking process of the open platform is clear, and the permission setting is relatively simple. When developing pages, you can easily manage and use APIs.
In terms of the docking effect, omitting intermediate steps through APIs gives business personnel a better interactive experience. Deep integration can weaken or even eliminate the sense of disconnection between different systems.
