商业智能FineBI使用教程：[49]集成API接口

电脑软件

1.支十嵋壬描述

从上一节可知，FineBI操作可细分为四个部分，或者说四个操作界面芟坳葩津，每个部分均有一个接口，下面详细介绍这四个API接口。

2.FineBI操作API接口

启动FineBI工程所在的tomcat，即8080端口号的tomcat。

2.1创建业务包

FineBI创建业务包是在管理系统>BI数据源配置选项中进行的，BI数据源配置的API接口为：

${servletURL}?op=fr_bi_configure&cmd=init_configure_pane

也可以写成

http://localhost:8080/FineBI/ReportServer?op=fr_bi_configure&cmd=init_configure_pane

效果查看

启动tomcat服务器，地址栏中输入创建业务包API接口http://localhost:8080/FineBI/ReportServer?op=fr_bi_configure&cmd=init_configure_pane，如果还没登录系统，则要先跳转到op=fs系统的登录界面，登陆成功之后，再回到创建业务包界面，如下图：

创建业务包的具体操作过程请查看创建业务包。

注：创建业务包页面需要权限才能访问，一般为管理员，非管理员如果没有权限则不能打开页面，如果要使非管理员拥有创建业务包的权限，首先得给非管理员配置BI数据源的使用权限，详细权限分配过程请查看多级权限分配，创建业务包界面可以分配业务包的使用权限，业务包权限设置请查看业务包权限分配。

2.2新建即时分析

业务包创建好之后，就可以在新建分析页面添加即时分析了，新建即时分析API接口如下：

${servletURL}?op=fr_bi_dezi&cmd=init_dezi_pane

也可以写成

http://localhost:8080/FineBI/ReportServer?op=fr_bi_dezi&cmd=init_dezi_pane

效果查看

在浏览器地址栏中输入http://localhost:8080/FineBI/ReportServer?op=fr_bi_dezi&cmd=init_dezi_pane，即可打开新建即时分析页面，如下图：

新建即时分析的具体操作过程请查看新建分析。

注：即时分析内容显示可以根据用户角色进行权限控制，集成的FineBI和单独使用的FineBI关于即时分析内容权限的配置过程是一模一样的，详细请参照访问BI即时分析内容的权限

2.3我创建的

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

${servletURL}?op=fr_bi_dezi&cmd=my_bi_saved

也可以写成

http://localhost:8080/FineBI/ReportServer?op=fr_bi_dezi&cmd=my_bi_saved

效果查看

在新建即时分析页面新建2个即时分析BITest1和BITest2，在浏览器地址栏中输入http://localhost:8080/FineBI/ReportServer?op=fr_bi_dezi&cmd=my_bi_saved，即可看到该即时分析：

2.4分享给我的

分享给我的是指其他用户将即时分析分享给当前用户，该即时分析就会显示在分享给我的目录中，API接口如下：

${servletURL}?op=fr_bi_dezi&cmd=my_bi_shared

也可以写成

http://localhost:8080/FineBI/ReportServer?op=fr_bi_dezi&cmd=my_bi_shared

注：由于管理员账户不能分享即时分析，所以只有非管理员账号才拥有分享给我的目录列表，如果管理员账号打开分享给我的目录列表，其显示为空。

效果查看

用非管理员账号Anna登录系统，创建2个即时分析BITest1和BITest2，根据BI即时分析的分享中的操作，在我创建的页面中将这两个即时分析分享给Cherry，退出系统，在浏览器地址栏中输入http://localhost:8080/FineBI/ReportServer?op=fr_bi_dezi&cmd=my_bi_shared，用Cherry的账号登录，可以通过接口在浏览器中直接看到分享给我的即时分析列表，如下图：

2.5其他API接口

上面提到的四大操作部分中，我创建的和分享给我的目录中均是显示已经完成的即时分析列表，如果在集成FineBI时，需要获取列表的详细信息，将某一个即时分析的链接地址放在用户系统的某一节点上，此时，该如何获取具体即时分析的详细链接地址呢？

我创建的

获取我创建的目录中的即时分析列表代码如下：

$.ajax({

url:${servletURL}?op=fr_bi_dezi&cmd=get_my_report_list,

dataType:"jsonp",

jsonp:"callback",

success:function(data){

varlist=FR.jsonDecode(data);

varurl=list[0].buildurl;

}

})

其中返回的结果list是一个数组，按照最后编辑时间进行排序，数组里面的每一个对象的数据结构如下：

{

id:保存的BI报表ID,

text:BI报表名字

lastModify:最后的修改时间,

buildurl:打开BI报表的链接，使用方法：${servletURL}+buildurl,编辑状态为${servletURL}+buildurl+"&edit=_bi_edit_",

}

用管理员账号登录系统，在上面，管理员创建了2个即时分析BITest1和BITest2，在浏览器地址栏中直接输入获取我创建的目录列表API接口，如下图：

注：获取了具体即时分析的buildurl的值，由于该值不是完整的url，实际使用时，需要将其补全，补全部分为http://localhost:端口号/工程名/ReportServer，如果用户系统跟FineBI在同一系统中，可以使用FR.ServletURL获取补全部分，此时就需要引入FineReport的finereport.js，引入方法如下：

<scripttype="text/javascript"src="ReportServer?op=emb&resource=finereport.js"></script>

我创建的即时分析目录列表API接口的使用方式详情请查看用户系统集成FineBI简单示例。

分享给我的

获取分享给我的目录中的即时分析列表代码与我创建的类似，只需要将API接口的url修改为${servletURL}?op=fr_bi_dezi&cmd=get_share_2_me_report_list即可，代码如下：

$.ajax({

url:${servletURL}?op=fr_bi_dezi&cmd=get_share_2_me_report_list,

dataType:"jsonp",

jsonp:"callback",

success:function(data){

varlist=FR.jsonDecode(data);

varurl=list[0].buildurl;

}

})

其中返回的结果list也是一个数组，按照最后编辑时间进行排序，与我创建的返回的数组结果结构一模一样，这里不再赘述。

注：其他使用方式均匀我创建的类似，这里不再详述。

3.总结

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

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