从第三方系统中新建Smartbi资源

1.说明

在第三方系统中新建 Smartbi 的某种资源，其访问地址如下。通过在 URL 后带各种参数，创建不同类型的资源。

http://localhost:18080/smartbi/vision/createresource.jsp

上述方式支持的资源类型有：数据模型、交互式仪表盘、即席查询、透视分析、自助ETL、WEB电子表格、数据挖掘、Excel导入模板、业务主题以及旧数据集（自助数据集、可视化数据集、原生SQL数据集、SQL数据集、JAVA数据集、存储过程数据集）、即席查询（旧）、透视分析（旧）、仪表分析、多维分析。

使用旧数据集需拥有授权包含相应模块功能的License文件，否则会提示License验证失败，如尝试打开新建JAVA数据集：

License

2.基本参数

下面的三个参数是创建任何资源类型时，都必须传入的参数。但如果已经单点登录过，就不需要在 URL 中再传递用户名和密码了，除非希望以一个新的用户去创建资源。

2.1基本参数描述

参数	描述
user	登录 Smartbi 的用户名
password	登录 Smartbi 的密码
restype	资源类型。具体取值说明，请参看“附加参数”部分，资源分类说明表中的第三列 restype 值。

2.2基本参数使用示例

传递上述三个参数，创建 Smartbi 可视化数据集的访问地址，如下所示。

http://localhost:18080/smartbi/vision/createresource.jsp?restype=VISUAL&user=admin&password=manager

3.可选参数

除了基本参数外，各种资源类型还有一些其它参数可供设置。分别说明如下。

Field	Description
resid	指定资源ID，该值为空时新建资源，指定相应资源ID时则进入该资源的编辑界面
saveFolderId	保存资源的目录id，传递该参数后，保存资源时直接定位到该目录节点下
sourceid	表示基于以sourceid为资源ID的数据集（或者旧数据集、业务主题、数据源）新建资源。
bizqueryid	业务查询ID，在新建分析报表时可以选用。如果bizqueryid为空，则出现选择已有数据集（包括可视化数据集、SQL数据集、存储过程数据集）的页面；否则直接进入新建分析报表页面。
datasourceid	对于业务查询是数据源ID，对于多维分析是立方体ID，新建业务查询和多维分析时可以选用。如果datasourceid为空，则出现选择数据源或立方体的页面；否则直接进入新建页面。
bizthemeid	业务主题ID，在新建业务查询时可以选用。如果bizthemeid为空，则出现选择业务主题的页面；否则直接进入新建业务查询的页面。

4.各资源类型对应的 restype 值及可选参数

restype 可取的值对应的各种资源类型，及其可选参数见下表：

restype	资源类型	可选参数	特别说明
AUGMENTED_DATASET	数据模型	resid	resid 为模型id，不指定则新建，指定则打开
SMARTBIX_PAGE	交互式仪表盘	resid sourceid saveFolderId isLargeScreen	sourceid 对应数据模型、旧数据集或者业务主题id isLargeScreen=true（默认）为自由布局；isLargeScreen=false为自适应布局
DETAILED_QUERY	即席查询	resid sourceid tableId saveFolderId fieldsConfig	sourceid 对应数据模型、数据源的id tableId 对应数据源下表或者是业务视图id fieldsConfig 初始创建选择的字段数组信息，需要对字段信息数组进行JSON序列化（支持传入fieldsConfig=all_fields代表全选所有字段，若是来源数据源的需要同时指定tableId）即席查询fieldsConfig 格式在下文中可见详细说明
AD_HOC_ANALYSIS	透视分析	resid sourceid saveFolderId fieldsConfig(仅支持基于数据模型的)	sourceid 对应数据模型id fieldsConfig 初始创建选择的字段数组信息，需要对字段信息数组进行JSON序列化（支持传入fieldsConfig=all_fields代表全选所有字段）透视分析fieldsConfig 格式在下文中可见详细说明
SMARTBI_DATAPROCESS	自助ETL	resid	无
WEB_SPREADSHEET_REPORT	WEB电子表格	resid saveFolderId	无
SMARTBI_MINING	数据挖掘	resid	无
excelimport	Excel导入模板	无	无
themewizard	业务主题	saveFolderId	无
SMARTBIX_DATASET	自助数据集	无	无
VISUAL	可视化数据集	datasourceid bizthemeid saveFolderId	无
RAWSQL	原生SQL数据集	datasourceid saveFolderId	无
SQL	SQL数据集	datasourceid saveFolderId	无
JAVA	JAVA数据集	saveFolderId	无
PROC	存储过程数据集	datasourceid saveFolderId	datasourceid对应存储过程ID
COMBINED_QUERY	即席查询（旧）	saveFolderId	无
INSIGHT	透视分析	saveFolderId	无
meter	仪表分析	saveFolderId	无
olap_report	多维分析	datasourceid saveFolderId	无

sourceid 例如编辑业务主题资源：

http://localhost:18080/smartbi/vision/createresource.jsp?restype=themewizard&resid=THEME.demo2019.CSAC

## 基于模型的即席查询fieldsConfig 格式说明 

## 指定数据源数据表全选字段创建即席查询
## http://localhost:3000/smartbi/vision/createresource.jsp?restype=DETAILED_QUERY&sourceid=DS.SYSTEM知识库&tableId=TAB.SYSTEM知识库.null.t_offline_export&fieldsConfig=all_fields
## 指定数据模型全选字段创建即席查询
## http://localhost:3000/smartbi/vision/createresource.jsp?restype=DETAILED_QUERY&sourceid=数据模型ID&fieldsConfig=all_fields
## 指定数据模型指定字段创建即席查询
## http://localhost:3000/smartbi/vision/createresource.jsp?restype=DETAILED_QUERY&sourceid=I8a74a42f01909c3e9c3e216c01909fd957bf000c&fieldsConfig=

[  
  {  
    "id": "",   
    "name": "",  
    "alias": "",  
    // id, name, alias, 三选一可只传一个, 同时传递时候只有一个生效, 优先级是 id > name > alias  
    "num": 0,  
    // 序号，从 0 开始，小的在前面, 如果不存在, 则按照产品默认排序，在数组前面的放在前面  
  }  
]
// 如果根据名称或者是别名匹配到多个字段, 直接取第一个，而从数据集树上取获取的字段顺序优先级是维度>度量>命名集  // 如果匹配到多个字段, 以第一个为准

## 基于模型的透视分析fieldsConfig 格式说明
## 指定数据模型全选字段创建透视分析
## http://localhost:3000/smartbi/vision/createresource.jsp?restype=AD_HOC_ANALYSIS&sourceid=数据模型ID&fieldsConfig=all_fields

## 指定数据模型指定字段创建透视分析
## http://localhost:3000/smartbi/vision/createresource.jsp?restype=AD_HOC_ANALYSIS&sourceid=I8a74a42f01909c3e9c3e216c01909fd957bf000c&fieldsConfig=
[  
  {  
    "id": "",   
    "name": "",  
    "alias": "",  
    // id, name, alias, 三选一可只传一个, 同时传递时候只有一个生效, 优先级是 id > name > alias  
    pos:'', 
    // 'row/column/measure' 中的一种，指定字段所在的区域   
    "num": 0,  
    // 序号，从 0 开始，小的在前面, 如果不存在, 则按照产品默认排序，在数组前面的放在前面  
  }  
]
//如果根据名称或者是别名匹配到多个字段, 直接取第一个，而从数据集树上取获取的字段顺序优先级是维度>度量>命名集  // 如果匹配到多个字段, 以第一个为准

5.常见集成示例

5.1指定保存目录创建即席查询

http://localhost:18080/smartbi/vision/createresource.jsp?restype=DETAILED_QUERY&saveFolderId=SELF_ADMIN

5.2指定数据模型创建自助仪表盘

http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&sourceid=I8aaa8015017d97839783ea38017d980a686901b2

5.3创建自适应布局自助仪表盘

http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&isLargeScreen=false

6.注意事项

新建存储过程数据集时，datasourceid 应该设置为存储过程ID，而不是数据源ID。存储过程ID可以通过点击存储过程的右键 "属性 -> 节点ID" 取得。

关注我们

服务支持

页面树结构