FineBI如何在web页面中嵌入式集成

Posted 2020-09-22

1. API嵌入集成

1.1 描述

FineBI是基于B/S架构的浏览器/服务器模式，现在用户开发的系统基本上趋向于B/S架构的浏览器/服务器模式，因此有些页面完全可以直接采用web页面嵌入式集成的简易方式完成集成。而且些因为框架的原因可以采用json的调用方式进行集成。通过集成，用户从自己的系统通过链节使用浏览器访问FineBI的服务器，从而在自己系统内调用BI的web页面，来实际嵌入式集成。这种集成通常会有两种方式：一种是直接使用URL链节，另一种方式是通过js的调用json来获得分析模板。下面先提供各部分的URL链接接口、json格式的API

1.2 API插件

FineBI的各种接口开放是以插件的形式来实现的，同时通过插件来实现跨域的集成。因此在集成前，要在FineBI的系统中，安装API插件。下载好后，在BI管理系统的插件管理中，选择本地安装即可。安装完成，重起BI服务器即可。

2. 公共API

2.1 登录API

登录的API接口为?op=api&cmd=bi_login&bi_username=name&bi_password=password&callback=myfunction

其中bi_username=name与bi_password=password中“name”、“password”是用户名与密码，在浏览器上以此API可以返回值为“Login success”如下图：

 

注：当前的URL是由“布署路径”+“接口”；其中“布署路径”通常为http://localhost:端口号/工程名/ReportServer，“接口”为 ?op=fr_bi&cmd=bi_init&id=9&createby=-999#  

以下均相同，不再赘述。

2.2 模板分析

（1）URL界面

单个模板分析通常会被集成到门户网站上，集成模板析的API可以直接使用URL使用iframe框架来集成。其URL可以直接在浏览器的控制台来查找。下面简介一下，控制台查找方式。按F12打开控制台，使用选择器，放在右上角点击，可以跳到该界面的框架；如图：

 

从该框架向上找就可以找到URL，其iframe的src值即是该URL

 

（2）参数格式

其API是?op=fr_bi&cmd=bi_init&id=模板id&createBy=创建者id。

2.3 新建分析

新建分析的API?op=api&cmd=add_report&reportName=NewReport

其中repoartName为参数，NewReport为新建分析的名子。在浏览器上以此API访问，返回值为“reportId”

2.4 我创建的

（1）界面

我创建的是指当前用户创建的所有即时分析都会显示在我创建的列表中，URL链接API接口如下：

?op=api&cmd=get_page_created_by_me,其效果如下：

 

（2）JSON返回值

我创建的API?op=fr_bi&cmd=get_folder_report_list在浏览器上返回当前登录用户的我创建的模板分析的详细信息（包括文件夹和模板），其中还包括该模板的分享信息。

 

3. 仅非管理员API

3.1 分享模板

分享模板的是指其他用户将即时分析分享给当前用户。

注：分享模板这个功能只有非管理才能有，因此只有在非管理员的界面才会有。

3.2 分享给我的

分享给我的是非管理员特有的，是非管理员之间分享模板后，将分享模板放置的文件目录。其API接口?op=api&cmd=get_shared_to_me_reports，通过该API可以获得得当前用户的所有分享模板的信息。

3.3 已分享模板

当然某张模板被分享给不同的人，也可以通过API来获得。该API为?op=api&cmd=get_shared_users_by_report&createdBy=模板创建者ID&reportId=模板ID，通过该API可以获得，该ID的模板被分享给哪些人。其中参数为：createByID和reportid。

注：其中模板ID与创建人ID可以通过当前人我创建的API获得。

4. 仅管理员可用API

4.1 所有模板

在管理员界面，管理员可以通过“所有模板”来管理整个平台所有用户设计的模板分析。

4.1.1界面

界面的API为?op=api&cmd=get_page_all_reports效果如下图：

 

 4.1.2 JSON

JSON的格式的API为?op=api&cmd=get_all_template_4_admin，其返回值为所有模板信息。

4.2 所有用户信息

在集成的时候，用户想要获取所有的用户、部门职位、角色等信息时，可以通过该API接口返回json值来获取。该API

?op=api&cmd=get_all_reports_data，如下图：

 

4.3 报表管理目录

除了可以通过输入模板id返回模板信息外，我们还可以通过接口?op=fs_main&cmd=module_getrootreports&id=-1获取到报表管理目录的url。

4.4 数据配置界面

数据配置是BI数据管理的核心界面，即是业务包的管理界面，当前我们的业务包管理界面可以直接通过URL来集成进来。

其API为?op=fr_bi_configure&cmd=init_configure_pane，效果如下图：

 

4.5 全局更新

Cube全局更新，顾名思义，是指Cube中的数据全部都更新一遍，包括所有业务包中的所有的表和字段?op=api&cmd=update_cube，以便于直接集成到自己的系统中进行全局更新操作。其返回值结果为：function({"result":"global cube updated success!"})；

注：在url后面加上&bi_username=用户名&bi_password=密码，可实现在非登录情况下全局更新。 

4.6 单表更新

单表更新，顾名思义，就是说cube更新时，单独将其中某一张表进行更新，其他表不更新。除了在“单表更新设置”中进行更新外，FineBI还开了相应的接口

?op=api&cmd=update_cube&packageName=业务包名字&tableName=转义名  

以便于直接集成到自己的系统中进行单表更新操作。URL访问地址如下：

注：（1）单纯只有packageName时，则是对当前业务包中所有表进行更新。

（2）在url后面加上&bi_username=用户名&bi_password=密码，可实现在非登录情况下单表更新。 
（3）这里的单表更新是默认做的全量的更新，不做增量更新。

4.7 单个模板的详情

管理员可以通过单个模板的模板ID与创建人的ID可以获得当前模板的详细信息。其API为?op=api&cmd=get_template_by_ids&ids=[{reportId: 1, createBy: -999}]。

5. 总结

1、FineBI操作细分的四个部分：创建业务包、新建分析、我创建的和分享给我的中，一般来说，只有创建业务包才是管理员操作，其他的三项是非管理员操作，故，在使用API进行集成的时候要注意创建业务包API链接节点只能对管理员可见，如果对其他用户可见，那么，该用户登录系统之后，点击节点，不会有任何反应，如果一定要给其他用户以创建业务包的权限，首先需要将配置BI数据源的权限给该用户。

2、上述所有接口中的${servletURL}表示http://localhost:端口号/工程名/ReportServer，如果用户系统跟FineBI在同一系统中，可以使用FR.ServletURL获取，如果FineBI也是用户系统，那么可以直接使用${servletURL}，否则，需要写绝对路径。