1、概述

接口查询主要场景是客户不想或者没有办法连接到数据源，需要通过接口的方式获取数；更多的是作为数据集的存在，并且返回的数据是基本都是一个大宽表。

Smartbi 数据模型支持添加 2 种接口查询：Java查询、脚本查询.种接口查询：Java查询、脚本查询。

信息

title	前置条件

1、Java查询、脚本查询只支持抽取模式，如果模型原先是直连模式，加入了Java查询会强制变成抽取模式！详情可查阅：直连&抽取。

2、如果Java查询、脚本查询有定义参数，可参考参数设置进行参数映射。

3、可参考自定义JavaBean示例获取数据。

4、可参考：带参数Java查询示例。

2 Java查询

Java查询是指由用户通过二次开发，自定义JavaQueryData接口实现类，以实现自定义数据结构；Java查询是指由用户通过二次开发，自定义JavaQueryData接口实现类，以实现自定义数据结构。

...

支持以下几种方式：支持以下几种方式：

读取客户放在服务器上文件：CSV查询、Txt查询。
读取客户放在服务器上文件：CSV查询、Txt查询通过http方式获取数据：WebService作为数据源。
WebService作为数据源：通过http方式获取数据
需要写java代码从接口获取不开放数据库取数的场景：自定义类。自定义类：一般都是需要写java代码从接口获取不开放数据库取数的场景

2.1 示例说明

2.1

...

获取文件数据

下面通过一个简单的示例要演示通过下面示例演示通"CSV查询"获取文件数据。

刘老师想基于把学生的每个月的考试分数进行一个趋势分析，所以把线下数据上传到服务器上进行分析。

下载示例数据：StudentScore.xls

具体步骤如下：

1)需要先把CSV格式的文件上传到服务器上,如下图所示:

Image Removed

文件存放路径不限，存放的文件夹可以是自己新建的，也可以是已有的文件夹中。

存放好之后再去模型中建【Java查询】，选择”CSV查询“，操作如下图：

Image Removed

文件存放路径：绝对路径;填写时要注意，如果不是绝对路径，会查找不到文件；
编码：一般GBK或UTF-8，也可以根据需求填写其他的编码比如Unicode、ASCII；
上传的文件如果没有列头，则默认第一行数据为列头；
“TXT查询”与”CSV查询“操作逻辑是一致的，不再另写示例说明；其中“TXT查询”需要写“分割符”，分隔符需要与文件保持一致，才能正常取数。
获取到数据，想回到数据模型，建议先点击【保存】之后再点击【回到模型】；可以在模型修改数据类型、修改别名、设置与其他查询的关系或者构建数据模型Image Removed

信息
Java查询只支持抽取模式。如果模型原先是直连模式，加入了Java查询会强制变成抽取模式！

2.2 示例2

一般WebService 查询的使用场景是：调用外部第三方系统的WSDL接口获取外部系统数据；

在使用 WebService 作为数据源时，在模型中如何获取WebService的数据呢，这样要怎么实现呢？下面以一个例子进行说明.

为了方便举例，本文用产品内置的WSDL地址测试，以获取用户接口（本质是查询smartbi知识库数据）为例。

其中接口地址可从系统监控-wsdl地址中获取，具体可参考wiki文档：系统监控-wsdl地址

Image Removed

在"WSDL地址“输入: http://xx.xx.xx.xx:端口号/smartbi/vision/services/UserManagerService?wsdl ,
方法名称输入：getAllUsers(在WSDL地址内容一定能找到对应的方法)
点击执行Image Removed按钮，如果有“方法名称”有参数，则需要填写参数；没有，则直接显示数据
回到数据模型，建议先点击【保存】之后再点击【回到模型】；可以在模型修改数据类型、修改别名、设置与其他查询的关系或者构建数据模型

2.3 示例3

对于技术能力比较强的客户，Smartbi提供了灵活的接口，方便用户自定义Java文件，实现某些业务需求。

Java查询自定义类示例，可参考：Java查询介绍

...

刘老师想基于把学生每个月的考试分数进行一个趋势分析，所以把线下数据上传到服务器上方便读取分析。

注意

title	前置条件

1、如果想复现示例时，可以把数据先导入到模型中，详细请参考：导入文件数据。

2、可以下载示例数据：StudentScore.csv 。

具体步骤如下：

1、先把 StudentScore.csv 文件上传到 部署Smartbi war包 的服务器上，并且文件上传到home目录下；
以Linux服务器为例，可以把文件上传到home目录下; 路径不限，存放的文件夹可以是自己新建的、也可以是已有的文件夹。

2、去建数据模型，并在模型中建 Java查询 ，并选择 CSV查询 ，操作如下图：

文件存放路径：输入刚存放的路径"/home/StudentScore.csv"; 注意: 一定要输入 绝对路径 (即指目录下的绝对位置，直接到达目标位置，通常是从盘符开始的路径)，如果不是绝对路径，会查找不到文件。
编码：一般填写GBK或UTF-8，也可以根据需求填写其他的编码比如Unicode、ASCII；另外，上传的文件如果没有列头，则默认以第一行数据为列头。
执行：填写配置信息点击 执行，可以预览到文件的数据。

Image Added

3、如果想回到数据模型，建议先点击 保存，再点击 回到模型；回到模型，在关系视图可以选中查询，右键菜单 可以进行更多操作，具体可查看：设置及修改查询。

Image Added

4、基于模型去建 交互式仪表盘, 最终效果如下，可以查看”学生每个月考试分数趋势分析“：

Image Added

由于 txt查询 与 CSV查询 都是获取文件数据，逻辑一致，不再单独说明 txt查询。

2.2 通过自定义类获取数据

对于技术能力比较强的客户，Smartbi提供了灵活的接口，方便用户自定义Java文件，实现某些业务需求。

为了方便举例，使用产品内置的类”获取某段日期范围的会话信息“为例进行查看”日期汇总信息“。

具体的操作如下:

1、创建数据模型并在添加 Java查询

自定义类名：输入”smartbi.session.SessionQueryData“ 类名。
在输入自定义类名之前，需要先参考二次开发文档，编写IJavaQueryData接口实现类，实现自己的JAVABean逻辑，并将编译好的class文件添加到系统中。相关内容请参考：IJavaQueryData。
输入了 自定义类名 之后，点击右侧的 获取默认配置 ，在配置信息中会出现java类中定义的一些配置信息，对此进行配置，如果没有则无需进行配置。
配置完毕之后，需要点击工具栏的执行按钮或鼠标移开，会根据输入的自定义类和配置信息，输出参数和结果集。
参数默认值：如果有参数，需要输入参数默认值；给参数”BeginTime“ 默认值设成 ”2023-05-01“, "EndTime"默认值设成”2023-06-01“，"Scale"默认值设成”1“。
点击执行在 数据预览 区域可以查看参数默认值的数据。

Image Added

2、执行成功之后，如果要回到数据模型，建议先点击 保存，再回到模型；回到数据模型，可以在关系视图可以选中查询，右键菜单 支持进行更多操作，具体可查看：设置及修改查询。

如果在模型中没有映射参数，会一直以默认值的结果集输出数据；如果在模型中的参数设置进行了关联映射，可以随着模型设置的默认值改变输出结果集；具体可参考：参数管理。

Image Added

3、基于建好的数据模型去建 交互式仪表，查看日期汇总数据：

Image Added

另外，Java查询自定义类示例，可参考：Java查询介绍。

2.3 通过WebService获取数据

示例可参考：WebService查询示例。

3 脚本查询

脚本查询是指通过编写代码脚本获取数据结果；

目前“脚本查询”支持的语言只有JavaScript，因此适用于熟悉JavaScript的技术人员，相关接口文档可参考IJavaQueryData。

为了方面理解，以产品自带的数据源“northwind”中的 “产品表” 为目标资源，展示了如何通过编写JavaScript脚本获取指定节点ID的数据源表数据的例子来进行说明。

具体操作如下：

1、在左侧 “系统导航栏”中的“数据连接” ，选择 “数据连接” > “northwind” > “产品表” ，右键打开扩展菜单，点击“属性”，找到 “产品表” 资源的节点ID，并且记录下来

Image Added

2、建数据模型并增加 脚本查询 , 把刚记录下来的资源节点复制到下图的变量中, 再写获取数据的代码，写完之后，点击执行执行成功之后可以看到已经获取到产品表 的数据：

Image Added

代码块

language	js
title	示例代码·读取指定节点资源的表数据
linenumbers	true
collapse	true


importPackage(Packages.smartbi.freequery.client.datasource);

var datasourceService = DataSourceService.getInstance();
var tableId = "TAB.northwind.null.products";   //目标资源的节点ID
var table = datasourceService.getTable(tableId);
var sql = "select";
var data;

function init() {
    var fieldList = table.getFields();
    var fields = [];
    for (var i = 0; i < fieldList.size(); i++) {
        var field = fieldList.get(i);
        sql = sql + " " + field.getName();
        fields[i] = {
            id: field.getId(), //字段ID
            name: field.getName(), //字段名称
            alias: field.getAlias(), //字段别名
            desc: field.getDesc(), //字段描述
            valueType: parseValueType(field.getDataType().getSQLType()) //字段数据类型：INTEGER | DOUBLE | LONG | STRING | DATETIME
        }
        if (i < fieldList.size() - 1) {
            sql = sql + ",";
        }
    }
    sql = sql + " from " + table.getName();
    return {
		// //参数列表
		// params: [{
			// id: 'Param.northwind.null.products', //参数ID
			// name: 'ParamName', //参数名称
			// alias: 'ParamAlias', //参数别名
			// desc: 'ParamDesc', //参数描述
			// nullable: true, //参数是否允许是空
			// valueType: 'STRING' //参数数据类型：INTEGER | DOUBLE | LONG | STRING | DATETIME
		// }],
		//输出字段
        fields: fields
    };
}

function getGridData(paramValues, from, count) {
    data = datasourceService.executeNoCacheable(table.getDataSource().getId(), sql);
    return data;
}


function getRowCount() {
    return data.getRowsCount();
}


/**
  关闭查询对象
*/
function close() {}

function parseValueType(type) {
    switch ("" + type) {
        case "LONG":
            return "LONG";
        case "BIGINT":
        case "INTEGER":
            return "INTEGER";
        case "BIGDECIMAL":
        case "DOUBLE":
            return "DOUBLE";
        case "TIME":
        case "DATE":
        case "DATETIME":
            return "DATETIME";
        default:
            return "STRING";
    }
}

3、执行成功后，如果想回到数据模型，建议先保存再回到数据模型；在模型的关系视图可以选中查询，右键菜单 支持进行更多操作，具体可查看：设置及修改查询。

如果在模型中没有映射参数，会一直以默认值的结果集输出数据；如果在模型中的参数设置进行了关联映射，可以随着模型设置的默认值改变输出结果集；具体可参考：参数管理。

在模型中 预览数据 可以查看 “产品表”的数据信息已获取成功。

Image Added

页面树结构

版本比较

旧版本 14

新版本当前版本

标识

1、概述

2 Java查询

2.1 示例说明