1. 说明
在第三方系统中新建 Smartbi 的某种资源,其访问地址如下。通过在 URL 后带各种参数,创建不同类型的资源。
代码块 | |
---|---|
|
...
| |
http://localhost:18080/smartbi/vision/createresource.jsp |
基本参数
...
上述方式支持的资源类型有:数据模型、业务主题、即席查询、透视分析、自助ETL、Excel导入模板、自助仪表盘、WEB电子表格、数据挖掘以及旧数据集(自助数据集、可视化数据集、原生SQL数据集、SQL数据集、JAVA数据集、存储过程数据集)、仪表分析、多维分析、页面定制。
注意 |
---|
使用旧数据集需拥有授权包含相应模块功能的License文件,否则会提示License验证失败,如尝试打开新建JAVA数据集: |
2. 基本参数
下面的三个参数是创建任何资源类型时,都必须传入的参数。但如果已经 单点登录 过,就不需要在 URL 中再传递用户名和密码了,除非希望以一个新的用户去创建资源。
资源分类 | 基本参数(必选项) |
---|---|
所有资源类型 |
|
...
传递上述三个参数,创建 Smartbi
...
可视化数据集的访问地址,如下所示。
代码块 | |
---|---|
|
...
| |
http://localhost:18080/smartbi/vision/createresource.jsp?restype=VISUAL&user=admin&password=manager |
3. 附加参数
...
除了基本参数外,各种资源类型还有一些其它参数可供设置。分别说明如下。
参数名称 | 说明 |
---|---|
bizqueryid |
...
业务查询ID,在新建分析报表时可以选用。如果bizqueryid为空,则出现选择已有数据集(包括可视化数据集、SQL数据集、存储过程数据集)的页面;否则直接进入新建分析报表页面。 | |
datasourceid | 对于业务查询是数据源ID,对于多维分析是立方体ID,新建业务查询和多维分析时可以选用。如果datasourceid为空,则出现选择数据源或立方体的页面;否则直接进入新建页面。 |
bizthemeid | 业务主题ID,在新建业务查询时可以选用。如果bizthemeid为空,则出现选择业务主题的页面;否则直接进入新建业务查询的页面。 |
saveFolderId |
...
...
保存资源的目录id,传递该参数后,保存资源时直接定位到该目录节点下 | |
resid | 指定资源ID,该值为空时新建资源,指定相应资源ID时则进入该资源的编辑界面 |
subtype | 只对交互式仪表盘有效。当在链接中增加“subtype=big”时新建的是自由布局的交互式仪表盘。 |
上述参数,与各种资源类型间的交叉关系,请参见下表。
大类 | 小类 | restype | bizqueryid | datasourceid | bizthemeid | saveFolderId | resid |
...
业务查询
...
...
VISUAL
...
此参数对业务查询无效
...
有效
...
有效
...
保存目录id
...
无效
...
SQL查询
...
SQL
...
有效
...
无效
...
...
PROC
...
此处应使用存储过程ID
...
无效
...
...
RAWSQL
...
有效
...
无效
...
分析报表
...
仪表分析
...
meter
...
无效
...
此参数对分析报表无效
...
此参数对分析报表无效
...
保存目录id
...
subtype | sourceid | ||||||||
数据准备 | 可视化数据集 | VISUAL | 无效 | 有效 | 有效 | 保存目录id | 无效 | 无效 | 无效 |
SQL数据集 | SQL | 有效 | 无效 | ||||||
原生SQL数据集 | RAWSQL | 有效 | 无效 | ||||||
JAVA数据集 | JAVA | 无效 | 无效 | ||||||
存储过程数据集 | PROC | 此处应使用存储过程ID | 无效 | ||||||
自助数据集 | SMARTBIX_DATASET | 无效 | 无效 | 无效 | |||||
业务主题 | themewizard | 无效 | 无效 | 保存目录id | 该值为空时新建资源,指定相应资源ID时进入该资源的编辑界面 | ||||
自助ETL | SMARTBI_DATAPROCESS | 无效 | 无效 | 无效 | |||||
作业流 | SMARTBI_JOBFLOW | 无效 | 无效 | 无效 | |||||
数据模型 | AUGMENTED_DATASET | 无效 | 无效 | 无效 | |||||
数据挖掘 | 数据挖掘 | SMARTBI_MINING | 无效 | 无效 | 无效 | 无效 | |||
分析展现 | 仪表分析 | meter | 无效 | 无效 | 无效 | 保存目录id | 无效 | ||
多维分析 | olap_report | 有效 | |||||||
即席查询 | COMBINED_QUERY | 无效 | 指定数据模型创建 | ||||||
透视分析 | INSIGHT | 无效 | 无效 | ||||||
交互式仪表盘 | SMARTBIX_PAGE | 无效 | 无效 | 该值为空时新建资源,指定相应资源ID时进入该资源的编辑界面 | 在新建自助仪表盘的基础上,当“subtype=big”时指定交互式仪表盘为自由布局,不传递时为自适应布局 | 指定数据模型(或旧据集)创建 | |||
WEB电子表格 | WEB_SPREADSHEET_REPORT | 无效 | 保存目录id | 该值为空时新建资源,指定相应资源ID时进入该资源的编辑界面 | 无效 | 无效 | |||
Excel导入模板 | excelimport | 无效 | 无效 | 无效 | 无效 |
例如编辑业务主题资源:
代码块 | ||
---|---|---|
| ||
http://localhost:18080/smartbi/vision/createresource.jsp?restype=themewizard&resid=THEME.demo2019.CSAC |
4. 注意事项
新建存储过程数据集时,datasourceid 应该设置为存储过程ID,而不是数据源ID。存储过程ID可以通过点击存储过程的右键"属性 -> 节点ID"取得。
5. 集成示例
5.1. 数据模型
① 新建数据模型
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=AUGMENTED_DATASET |
② 编辑数据模型
格式为:http://localhost:18080/smartbi/vision/createresource.jsp?restype=AUGMENTED_DATASET&resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=AUGMENTED_DATASET&resid=I8aaa804b017940fc40fc8cf001794180ce7c0030 |
5.2. 自助数据集
① 新建自助数据集
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_DATASET |
② 编辑自助数据集
格式为:http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_DATASET&resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_DATASET&resid=Iff80808101651d3f1d3fd3fb01651dcd3cdf0125 |
5.3. 自助仪表盘
① 新建自助仪表盘
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE |
② 编辑自助仪表盘
格式为:http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&resid=40f98c8a91c0e33f811b7837fd48bf03 |
③ 新建大屏可视化
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&subtype=big |
④ 编辑大屏可视化
格式为:http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&subtype=big&resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&subtype=big&resid=40f98c8a91c0e33f811b7837fd48bf03 |
5.4. 自助ETL
① 新建自助ETL资源
代码块 |
---|
http://localhost.:3000/smartbi/vision/createresource.jsp?restype=SMARTBI_DATAPROCESS |
② 编辑自助ETL资源
格式为:http://localhost.:3000/smartbi/vision/openresource.jsp?restype=SMARTBI_DATAPROCESS&resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost.:3000/smartbi/vision/openresource.jsp?restype=SMARTBI_DATAPROCESS&resid=I8a8a9f02017989b089b01c0701798c7c79dd000c |
5.5. 数据挖掘
① 新建数据挖掘
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBI_MINING |
② 编辑数据挖掘
格式为:http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBI_MINING&resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBI_MINING&resid=I8aaa804b017940fc40fc8cf001794180ce7c0070 |
1. 说明
在第三方系统中新建 Smartbi 的某种资源,其访问地址如下。通过在 URL 后带各种参数,创建不同类型的资源。
代码块 | ||
---|---|---|
| ||
http://localhost:18080/smartbi/vision/createresource.jsp |
上述方式支持的资源类型有:数据模型、业务主题、即席查询、透视分析、自助ETL、Excel导入模板、自助仪表盘、WEB电子表格、数据挖掘以及旧数据集(自助数据集、可视化数据集、原生SQL数据集、SQL数据集、JAVA数据集、存储过程数据集)、仪表分析、多维分析、页面定制。
注意 |
---|
使用旧数据集需拥有授权包含相应模块功能的License文件,否则会提示License验证失败,如尝试打开新建JAVA数据集: |
2. 基本参数
下面的三个参数是创建任何资源类型时,都必须传入的参数。但如果已经 单点登录 过,就不需要在 URL 中再传递用户名和密码了,除非希望以一个新的用户去创建资源。
资源分类 | 基本参数(必选项) |
---|---|
所有资源类型 |
|
传递上述三个参数,创建 Smartbi 可视化数据集的访问地址,如下所示。
代码块 | ||
---|---|---|
| ||
http://localhost:18080/smartbi/vision/createresource.jsp?restype=VISUAL&user=admin&password=manager |
3. 附加参数
除了基本参数外,各种资源类型还有一些其它参数可供设置。分别说明如下。
参数名称 | 说明 |
---|---|
bizqueryid | 业务查询ID,在新建分析报表时可以选用。如果bizqueryid为空,则出现选择已有数据集(包括可视化数据集、SQL数据集、存储过程数据集)的页面;否则直接进入新建分析报表页面。 |
datasourceid | 对于业务查询是数据源ID,对于多维分析是立方体ID,新建业务查询和多维分析时可以选用。如果datasourceid为空,则出现选择数据源或立方体的页面;否则直接进入新建页面。 |
bizthemeid | 业务主题ID,在新建业务查询时可以选用。如果bizthemeid为空,则出现选择业务主题的页面;否则直接进入新建业务查询的页面。 |
saveFolderId | 保存资源的目录id,传递该参数后,保存资源时直接定位到该目录节点下 |
resid | 指定资源ID,该值为空时新建资源,指定相应资源ID时则进入该资源的编辑界面 |
subtype | 只对交互式仪表盘有效。当在链接中增加“subtype=big”时新建的是自由布局的交互式仪表盘。 |
上述参数,与各种资源类型间的交叉关系,请参见下表。
大类 | 小类 | restype | bizqueryid | datasourceid | bizthemeid | saveFolderId | resid | subtype |
数据准备 | 可视化数据集 | VISUAL | 无效 | 有效 | 有效 | 保存目录id | 无效 | 无效 |
SQL数据集 | SQL | 有效 | 无效 | |||||
原生SQL数据集 | RAWSQL | 有效 | 无效 | |||||
JAVA数据集 | JAVA | 无效 | 无效 | |||||
存储过程数据集 | PROC | 此处应使用存储过程ID | 无效 | |||||
自助数据集 | SMARTBIX_DATASET | 无效 | 无效 | 无效 | ||||
业务主题 | themewizard | 无效 | 无效 | 保存目录id | 该值为空时新建资源,指定相应资源ID时进入该资源的编辑界面 | |||
自助ETL | SMARTBI_DATAPROCESS | 无效 | 无效 | 无效 | ||||
数据模型 | AUGMENTED_DATASET | 无效 | 无效 | 无效 | ||||
数据挖掘 | 数据挖掘 | SMARTBI_MINING | 无效 | 无效 | 无效 | 无效 | ||
分析展现 | 仪表分析 | meter | 无效 | 无效 | 无效 | 保存目录id | 无效 | |
多维分析 | olap_report |
...
此参数对多维分析无效
...
有效 | ||
即席查询 | COMBINED_QUERY | 无效 |
透视分析 | INSIGHT | 无效 |
...
透视分析
...
INSIGHT
...
交互式仪表盘 | SMARTBIX_PAGE | 无效 | 无效 | 该值为空时新建资源,指定相应资源ID时进入该资源的编辑界面 | 在新建自助仪表盘的基础上,当“subtype=big”时指定交互式仪表盘为自由布局,不传递时为自适应布局 |
WEB电子表格 | WEB_SPREADSHEET_REPORT | 无效 | 保存目录id | 该值为空时新建资源,指定相应资源ID时进入该资源的编辑界面 | 无效 |
...
Excel导入模板 |
...
excelimport |
...
无效 | 无效 | 无效 | 无效 |
...
例如编辑业务主题资源:
...
代码块 |
---|
...
|
...
| |
http://localhost:18080/smartbi/vision/createresource.jsp?restype=themewizard&resid= |
...
注意事项
...
THEME.demo2019.CSAC |
4. 注意事项
新建存储过程数据集时,datasourceid 应该设置为存储过程ID,而不是数据源ID。存储过程ID可以通过点击存储过程的右键"属性 -> 节点ID"取得。
...
创建smartbix自助资源
自助数据集和自助仪表盘作为v8.0后的新资源类型,其新建方式有区别
...
5. 集成示例
5.1. 数据模型
① 新建数据模型
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=AUGMENTED_DATASET |
② 编辑数据模型
格式为:http://localhost:18080/smartbi/vision/createresource.jsp?restype=AUGMENTED_DATASET&resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=AUGMENTED_DATASET&resid=I8aaa804b017940fc40fc8cf001794180ce7c0030 |
5.2. 自助数据集
① 新建自助数据集
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_DATASET |
② 编辑自助数据集
格式为:http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_DATASET&resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_DATASET&resid=Iff80808101651d3f1d3fd3fb01651dcd3cdf0125 |
5.3. 自助仪表盘
① 新建自助仪表盘
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE |
② 编辑自助仪表盘
格式为:http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&resid=40f98c8a91c0e33f811b7837fd48bf03 |
③ 新建大屏可视化
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&subtype=big |
④ 编辑大屏可视化
格式为:http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&subtype=big&resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBIX_PAGE&subtype=big&resid=40f98c8a91c0e33f811b7837fd48bf03 |
5.4. 自助ETL
① 新建自助ETL资源
代码块 |
---|
http://localhost.:3000/smartbi/vision/createresource.jsp?restype=SMARTBI_DATAPROCESS |
② 编辑自助ETL资源
格式为:http://localhost.:3000/smartbi/
...
vision/openresource.jsp?
...
restype=
...
SMARTBI_DATAPROCESS&
...
resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost.:3000/smartbi/vision/openresource.jsp?restype=SMARTBI_DATAPROCESS&resid=I8a8a9f02017989b089b01c0701798c7c79dd000c |
5.5. 数据挖掘
① 新建数据挖掘
代码块 |
---|
http://localhost:18080/smartbi/ |
...
vision/createresource.jsp? |
...
restype=SMARTBI_MINING |
② 编辑数据挖掘
格式为:http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBI_MINING&resid=【替换为需要编辑的资源ID】
代码块 |
---|
http://localhost:18080/smartbi/vision/createresource.jsp?restype=SMARTBI_MINING&resid=I8aaa804b017940fc40fc8cf001794180ce7c0070 |