从第三方系统中打开Smartbi资源

1.说明

将报表或页面嵌入到第三方系统中（资源集成），是系统集成中最为常见的一种方式。Smartbi 可以方便地集成到客户现有的门户系统中，或者是其它任意系统中。通常做法是在页面中放置一个 iframe 标签，然后通过 src 属性访问 Smartbi 的资源链接即可。详述如下。

1.1资源访问地址

在外部系统中集成 Smartbi 的资源，全部通过下面的 URL 地址来访问。Smartbi 将其所有类型资源的访问全部整合到了 openresource.jsp 之中。

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

使用移动设备通过“openresource.jsp”打开交互式仪表盘、电子表格的资源时，访问页面将默认切换至移动端效果

1.2支持的资源类型

目前支持被集成的资源类型有：交互式仪表盘、数据模型、指标模型、即席查询、透视分析、自助ETL、数据挖掘、ETL自动化、作业流、自助数据集、多维分析、即席查询（旧）、透视分析（旧）、Web链接、电子表格、WEB电子表格、可视化查询、SQL数据集、存储过程查询、原生SQL查询，以及Excel导入模版等。

1.3基本参数

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

传递上述参数，打开某个 Smartbi 资源的访问地址。

如何获取 Smartbi 资源的 resid 值。打开对应资源的“资源属性”对话框，将其上的“节点ID”拷贝出来即可。

2.可选参数

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

2.1 交互式仪表盘可选参数说明

2.2 即席查询可选参数说明

2.3 透视分析可选参数说明

2.4 web电子表格可选参数说明

2.5 电子表格可选参数说明

2.6 业务查询可选参数说明

业务查询指的是 可视化数据集、SQL数据集、原生SQL数据集、存储过程数据集、多维数据集、 Java数据集

2.7 Excel导入模版可选参数说明

2.8 灵活分析可选参数说明

2.9 多维分析可选参数说明

2.10 即席查询（旧）可选参数说明

2.11 透视分析（旧）可选参数说明

3.打开资源示例（不带查询参数）

3.1.说明

下面仅介绍基本参数传递，不带任何可选参数。

3.2.设置方法

• 在外部系统中使用 IFrame 方式打开 Smartbi 资源。通常做法是在页面中放置一个 iframe 标签，然后通过 src 属性访问 Smartbi 的资源链接即可。

• 可使用如下两种方法打开资源。

  • 方式一：每次打开资源时，都传递用户名、密码、资源ID过去。为了安全原因，也可以用 POST 方式传递上述参数值。

  http://localhost:18080/smartbi/vision/openresource.jsp?resid=I2c949eaf1a942102011a9561f7e7015d&user=admin&password=manager
  

  • 方式二：系统初始化时采用单点登录方式登录 Smartbi，之后通过链接打开资源，就不需要再传递用户名和密码了。

  http://localhost:18080/smartbi/vision/openresource.jsp?resid=I2c949eaf1a942102011a9561f7e7015d
  

• gif演示示例源码请参考：打开资源示例（不带查询参数）.rar

4.打开资源示例（带查询参数）

4.1.说明

在一些系统集成中，用户可能希望从外部传入参数值来打开 Smartbi 资源，动态刷新数据。动态传递参数的方法，说明如下。

4.2.设置步骤

• 将下面这段 JavaScript 代码拷贝到第三方系统的某个页面里，因为后面我们需要使用其中的 function toJSONString(obj) 方法对传递的参数值进行处理。

function parseJSON (jsonString) { //FROM: json.org,json.js
    return eval('(' + jsonString + ')');
};
 
function toJSONString (obj) { //FROM: json.org,json.js
    var m = {   '\b': '\\b',
                        '\t': '\\t',
                        '\n': '\\n',
                        '\f': '\\f',
                        '\r': '\\r',
                        '"' : '\\"',
                        '\\': '\\\\'    };
    var s = {
        array: function (x) {
            var a = ['['], b, f, i, l = x.length, v;
            if(l == 0) {
                var isNull = true;
                for(var i in x) {
                    // Fenet's code begin
                    if ( i == "remove" || i == "indexOf" ) {
                        delete x[i];
                        continue;
                    }
                    if( x.toJSON)
                        return x.toJSON();
                    // Fenet's code end
                    isNull = false;
                    break;
                }
                if(!isNull) {
                    //throw null;
                    var a = ['{'], b, f, i, v;
                    for (i in x) {
                        v = x[i];
                            f = s[typeof v];
                            if (f) {
                                v = f(v);
                                if (typeof v == 'string') {
                                    if (b) {
                                        a[a.length] = ',';
                                    }
                                    a.push(s.string(i), ':', v);
                                    b = true;
                                }
                            }
                        }
                    a[a.length] = '}';
                    return a.join('');
                }
            } else {
                for (i = 0; i < l; i += 1) {
                    v = x[i];
                    f = s[typeof v];
                    if (f) {
                        v = f(v);
                        if (typeof v == 'string') {
                            if (b) {
                                a[a.length] = ',';
                            }
                            a[a.length] = v;
                            b = true;
                        }
                    }
                }
            }
            a[a.length] = ']';
            return a.join('');
        },
        'boolean': function (x) {
            return String(x);
        },
        'null': function (x) {
            return "null";
        },
        number: function (x) {
            return isFinite(x) ? String(x) : 'null';
        },
        object: function (x) {
            if (x) {
                if (Object.prototype.toString.call(x) === "[object Array]") {
                    return s.array(x);
                }
                var a = ['{'], b, f, i, v;
                for (i in x) {
                    v = x[i];
                        f = s[typeof v];
                        if (f) {
                            v = f(v);
                            if (typeof v == 'string') {
                                if (b) {
                                    a[a.length] = ',';
                                }
                                a.push(s.string(i), ':', v);
                                b = true;
                            }
                        }
                    }
                a[a.length] = '}';
                return a.join('');
            }
            return 'null';
        },
        string: function (x) {
            if (/["\\\x00-\x1f]/.test(x)) {
                x = x.replace(/([\x00-\x1f\\"])/g, function(a, b) {
                        var c = m[b];
                        if (c) {
                            return c;
                        }
                        c = b.charCodeAt();
                        return '\\u00' + Math.floor(c / 16).toString(16) + (c % 16).toString(16);
                });
            }
            return '"' + x + '"';
        }
    };
    return s[typeof obj](obj);
};

• 构建参数信息对象数组。每个参数都是一个 JavaScript 对象，可设置如下属性。

• 将参数列表对象转换成 JSON 字符串。通过调用步骤1中的 toJSONString() 函数可以将 JavaScript 对象序列化成 json 字符串，将此部分代码写在集成页面中。注意下图中红色矩形框内代码写法，如果一次传递多个参数就向 paramsInfo 数组中添加多个对象。

//生成Smartbi链接
function generate(){
    //生成待传递的参数数组对象
    var paramProductName = {
        "name": paramName.value,
        "value": realValue.value,
        "displayValue": displayValue.value
    };
    var paramsInfo = [];
    paramsInfo.push(paramProductName);
      
    //生成form表单的action属性并赋值
    var urlStr = "http://" + address.value + "/smartbi/vision/openresource.jsp"
                + "?resid=" + resid.value
                + "&showtoolbar=true"
                + "&refresh=true"
                + "&user=" + user.value
                + "&password=" + password.value;
    url.value = urlStr + "\n以及form表单提交的参数：paramsInfo=" + toJSONString(paramsInfo);
    form.action = urlStr;
      
    //给form表单添加参数
    //传递的参数对象
    paramsInfoForm.value = toJSONString(paramsInfo);
}

• 将user、password、resid、paramsInfo 等信息传递到 openresource.jsp 地址，即可打开相关资源。如下所示。

http://localhost:18080/smartbi/vision/openresource.jsp?paramsInfo=[{"name":"产品名称参数","value":"汽水","displayValue":"汽水"}]&resid=I2c949e8e1ac2d5e6011ac380971301b8&showtoolbar=true&refresh=true&user=admin&password=manager

• gif演示示例的源码请参考：打开资源示例（带查询参数）.rar

注意：

• 本示例不适用于交互式仪表盘。
• 上述这种将 paramsInfo 放在URL链接中的方式，一定要将其放到 ？后面作为第一个参数。否则在某些浏览器上会出错，&p 被显示成了一个乱码。
• 另外需要用 encodeURIComponent() 函数对 paramsInfo 进行编码，对其中的中文、特殊符号进行处理。Smartbi 小工具用来生成 paramsInfo 并编码：http://localhost:18080/smartbi/vision/getparamsinfo.html
• 这种将参数直接放到URL中的方式，在实际项目上不太合适的，一方面 URL 长度有限制；再者如果参数中有中文和特殊符号时，就很容易出错。因此建议：最好通过 POST 的方式将参数值传递到 URL 地址上。
• 在Tomcat高版本部署smartbi时，如果请求的URL在编码后的中文字符串带反斜杠，根据RFC文档中规定反斜杠是不安全字符，Tomcat在高版本中增加的安全验证，凡是RFC 3986中非URL可携带的字符，都会返回400错误，详细说明文档请看：Tomcat高版本部署smartbi通过URL拼接参数打开报表报400

5.简易参数传递方式

5.1说明

paramsInfo 在实际项目中使用时稍显麻烦，需要构造参数对象数组，并生成 json 字符串。因此在 Smartbi 2.5 以后版本上提供了新的简易参数传递方式，以param. 作前缀表示参数实际值，paramDisplay. 前缀作为参数显示值。（打开自助仪表盘资源时，参数名（查询参数对象key）对应为筛选器组件的标题）

5.2设置步骤

• 后台表单如下所示。

<form action="http://localhost:18080/smartbi/vision/openresource.jsp?resid=I2c90903e114f6f9601114f70e09d000e&refresh=true" method="POST">
    <input type="text" name="param.开始日期" value="1996-03-17">
    <input type="text" name="paramDisplay.开始日期" value="1996-03-17">
    <input type="text" name="param.结束日期" value="1996-09-19">
    <input type="text" name="paramDisplay.结束日期" value="1996-09-19">
    <input type="text" name="param.产品目录" value="8">
    <input type="text" name="paramDisplay.产品目录" value="饮料">
    <input type="submit">
</form>

• gif演示示例的源码请参考：简易参数传递方式.rar

这样就比较简单了，也无需在项目中使用 JSON 作为类库，调用其中的 toJSONString() 方法了。但是需要注意，如果在URL中直接传递参数，参数值和名称等存在中文时容易出现问题。最好使用 POST 方式，或者在URL中以UTF-8编码传递，并修改 tomcat/conf/server.xml 中Connector 中添加URIEncoding="UTF-8" 属性。

6.集成异常排查

• 可参考资源集成传参异常排查指南解决参数传递异常、登录闪退等问题；
• 在Chrome内核浏览器中遇到跨域问题，可参考单点登录集成，通过谷歌浏览器80版本及以上访问Smartbi报表，有时会跳转到Smartbi登录界面，其中使用nginx代理解决方案参考 nginx解决跨域问题方案参考

当Smartbi环境与第三方系统集成环境的域名、端口、协议有任意一个不同，那么就有可能发生跨域问题