由于很多客户对Logo文字，图片等有较多个性化需求，我们就在产品中增加了界面设置，但产品中个性化配置项有限，本文介绍的扩展包方式适用更广范围。

如果您需要了解如何查找定位对应图片、css或js，便于扩展本文中没有涉及到的修改，见Smartbi前端框架介绍，调试定位入门等。

在客户的生产环境中部署 Smartbi 程序时，通常需要需要对其做一些简单的客户化定制，比如替换登录界面、以及主界面顶部的LOGO和图片、或者修改程序名称标识等。如果您遇到类似需求，请参考下面的步骤修改和部署 ChangeLogo 扩展包。

所有第三方对smartbi的修改，必须放在扩展包中，不能直接修改war包里面的文件。

更多关于产品的OEM定制，譬如移动端换logo请见：Smartbi产品OEM修改



修改扩展包

扩展包修改方法

请首先下载 ChangeLogo 扩展包，下载地址：ChangeLogoV9.ext（此扩展包适用于V9以上版本）。如果需要修改其中的某个文件，请参照如下步骤进行。

  • 首先用 WinRAR 之类的压缩工具，打开 ChangeLogo.ext 文件。
  • 然后将需要修改的文件从 WinRAR 窗口中拖出来，对其进行修改。
  • 接着将修改后的文件，拖放回 WinRAR 窗口中，覆盖以前的旧文件。
  • 关闭 WinRAR 窗口保存修改即可。

浏览器标题栏title

修改浏览器标题栏上显示的名称，对应的文件路径是：ChangeLogo.ext\vision\js\ext\ConfigurationPatch.js 。其中 loginTitle 是登录界面的标题、configTitle是配置界面的标题。

注意：当标题栏title出现乱码时，是由于该JS文件编码格式不对，

请采用UTF-8编码格式，将文件编码格式改成UTF-8，最简单的方式是使用Uedit工具打开ConfigurationPatch.js 文件，将文件另存为UTF-8文件，使用转码后文件即可。

登录界面LOGO

登录界面的图片文件路径是：ChangeLogo.ext\vision\img\login\logo.png 。直接将项目上所用的 LOGO 文件拖放到对应路径中，覆盖同名文件即可。

注意！如果是替换图片，则要求图片文件的名称、扩展名、图片的大小尺寸必须完全一致。

主界面、Config配置界面和仪表盘界面logo

Smartbi 主界面的顶部logo文件、Config配置界面和仪表盘界面logo是同一个：

大LOGO路径是：ChangeLogo.ext\vision\img\baseframe\logo.png，尺寸为180*50

小LOGO路径是：ChangeLogo.ext\vision\img\baseframe\logo-mini.png，尺寸为40*40


更改主页面最顶端的颜色，对应的文件路径为ChangeLogo.ext\vision\css\patch.css，修改background-color参数，如background-color:#0000ff;

Config登录界面

LOGO路径是：ChangeLogo.ext\vision\img\config-login-logo.png，尺寸为183*23

Config页面左上角图标

LOGO路径是：ChangeLogoV9.ext\vision\img\mainframe\logo.png，尺寸为270*40

屏蔽右上角图标以及下拉框菜单

系统右上角的功能图标入口及管理员的下拉菜单选项：

用户可以根据需求进行屏蔽和释放，通过修改文件“BannerView.js.patch”中的代码实现。

该文件对应的路径是：ChangeLogo.ext\vision\js\bof\baseajax\common。

修改定制详情如下表：

修改内容修改详情
搜索图标（）

找到如下代码：

this.elemSearchText.style.display='none';

将这段代码的注释取消则屏蔽了“搜索”图标。


新建图标（）

找到如下代码：

this.elemCreateAnalysis.style.display='none'; 

将这段代码的注释取消则屏蔽了“新建”图标。


我的任务图标（）

添加如下代码：

this.bannertask.style.display='none';

添加位置如下图所示：




管理员

找到如下代码：

this.elemItemDropdown.style.display='none'; 

将这段代码的注释取消则屏蔽了“管理员”。


管理员下拉菜单

流程监控
登录二维码
用户日志
系统监控

流程监控、登录二维码、用户日志、系统监控这四个菜单的处理方法一致，在文档最后添加如下代码：

BannerView.prototype._changeLogo_addMenu = BannerView.prototype.addMenu;
BannerView.prototype.addMenu = function(text, cmd, parentElem) {
if ( cmd == "MY_INSTANCE" || cmd == "QRCode" || cmd == "USER_LOGS" || cmd == "SYS_MONITOR") {
return ;
}
this._changeLogo_addMenu(text, cmd, parentElem);
};

该代码中，对象关系如下：

  • MY_INSTANCE：流程监控
  • QRCode：登录二维码
  • USER_LOGS：用户日志
  • SYS_MONITOR：系统监控

若想屏蔽对应的菜单，只需要在if()语句中将菜单对应的对象加上即可。如以上代码中，表示将“流程监控、登录二维码、用户日志、系统监控”都屏蔽，效果如下：

屏蔽前屏蔽后


我的设置

找到如下代码：

this.addMenu('${My}${Settings}', 'MY_SETTINGS', parentElem); 

将这段代码注释即屏蔽了“我的设置”。

联机帮助

找到如下代码：

this.addMenu('${Onlinehelp}', 'ONLINE_HELP', parentElem); 

将这段代码注释即屏蔽了“联机帮助”。

帮助

找到如下代码：

this.addMenu('${smartbibbs}', 'GOTOBBS', parentElem); 

将这段代码注释即屏蔽了“帮助”。

插件下载

找到如下代码：

this.addMenu('${PluginDownload}', 'PLUGIN_DOWNLOAD', parentElem);

将这段代码注释即屏蔽了“插件下载”。

关于

找到如下代码：

this.addMenu('${About}', 'ABOUT_SMARTBI', parentElem);

将这段代码注释即屏蔽了“关于”。

注销

找到如下代码：

this.addMenu('${Logout}', 'LOGOUT', parentElem);

将这段代码注释即屏蔽了“注销”。

关于页面信息

Smartbi “关于”对话框上的图片LOGO、公司名称、网站等信息的修改。

  • 图片文件对应路径是：ChangeLogo.ext\vision\img/about/logo.png
    其上的公司名称、网址和邮箱等信息，对应文件是：ChangeLogo.ext\vision\js\bof\baseajax\common\BannerView.js.patch

  • 上图data可参考下面代码修改：

    var data = [ "公司名称", "公司网址", "mailto:公司邮箱", window ];

删除关于中的tab页

对应的文件路径是：ChangeLogo.ext\vision\js\freequery\main\AboutDialog.js.patch，将对应的红色框内代码，未屏蔽的部分代码进行屏蔽，原本屏蔽的//this.elemXXX.style.display='none'放出，则会删除对应的tab页

自定义登录界面

我们参照“1.3 登录界面图片”章节的方法，可以替换登录界面上的图片，但这在很多时候无法满足要求，客户希望把整个登录界面完全换成另外一种风格。针对此需求，可以参照如下步骤操作。

  • 编写登录界面的 jsp 文件。可以参考 ChangeLogo.ext\vision\login_demo.jsp 示例文件，其中 javascript 代码的登录逻辑部分可以不用修改（直接拷贝使用），该文件的其余部分可以任意修改，把界面修改为客户所要求的设计风格。

    <script type="text/javascript" src="js/freequery/lang/JSLoader.js"></script>
<script>
	<!-- 以下代码为登录 Smartbi 的处理逻辑，可直接拷贝使用 -->
	<!-- 直接修改 document.getElementById("user") 等代码段即可 -->
	var jsloader = new JSLoader();
	var util = jsloader.resolve("freequery.common.util");
	document.onkeydown = keydown;
	function init() {
		var userName = document.getElementById("user");
		if (userName)
			userName.focus();
	}
	
	function login() {
		var userName = document.getElementById("user"); //用户名输入框ID修改为实际HTML中的元素ID
		var password = document.getElementById("password"); //密码输入框ID修改为实际HTML中的元素ID
		var ret = util.remoteInvokeEx("UserService", "login", [userName.value, password.value]); //调用Smartbi登录方法
		
		if (!ret || !ret.result){
			alert("登录失败!");
			return;	
		} else {
			window.location.reload();
		}
	}
	
	function keydown(e) {
        var theEvent = e || window.event;
        var code = theEvent.keyCode || theEvent.which || theEvent.charCode;    
        if (code == 13) {
            login();
        }    
	}
	<!--------------------->
</script>


  • 增加登录界面 jsp 文件配置项。对应的配置文件路径是：ChangeLogo.ext\vision\js\ext\ConfigurationPatch.js，将其中的 loginJspPath 属性值改为登录界面 jsp 文件路径。注意：此路径为相对于smartbi.war/vision/ 的路径。



其它说明：

  • 系统统一访问入口仍然为 http://localhost:18080/smartbi/vision/index.jsp；访问 Smartbi 时如果用户未登录，会自动跳转到 login_demo.jsp 页面中。
  • 此登录界面的处理逻辑为：点击“登录”按钮时，调用 smartbi 的登录API进行登录，再重新刷新本页面。

自定义登录界面示例：


试用版水印修改

修改插件包/ChangeLogo/src/web/vision/js/ext/路径下的ConfigurationPatch.js文件，配置项说明如下：

waterMarkName——试用版水印标题

部署扩展包

根据项目上的客户化定制需求，修改完 ChangeLogo 扩展包后，需要将其部署系统中。完整的部署过程和操作步骤，请参考扩展包部署。