麦粉社区
>
帖子详情

[系统运维] SmartBI OEM相关修改操作指南

动态中心 发表于 半小时前
发表于 半小时前

本指南专为SmartBI V11产品品牌定制(OEM) 需求编写,核心覆盖两类定制场景:



  1. 简易定制:仅需替换企业 Logo、系统名称、页面图片等基础品牌元素,无界面模块屏蔽 / 隐藏需求;

  2. 深度定制:需全面替换品牌标识、修改界面文字、屏蔽系统功能模块、自定义页面样式、修改引擎名称等高级 OEM 需求。指南提供可视化系统配置(零代码、快速修改)与扩展包定制(标准化、不修改原生 war 包)两种方案,覆盖登录页、主界面、管理员配置页、Office 插件、移动端、数据引擎等全模块,保障系统升级兼容与运行稳定。


OEM定制内容快速总览表
































定制分类



核心 OEM 内容



对应下方内容



适用场景



简易定制


(系统配置)



浏览器页签 LOGO / 名称、登录页 LOGO / 背景 / 左侧图、首页标题 / 导航 LOGO、管理员配置页 LOGO



一、通过系统配置可直接修改



基础替换



深度定制


(扩展包)



全场景 LOGO / 标题、界面图标 / 菜单屏蔽、关于页面信息、自定义登录页、水印 / 帮助地址、多语言配置



二、使用ChangeLogo_V11.ext 扩展包



高级定制



组件 OEM



Office 插件、移动端、OLAP / 导出引擎 / 数据挖掘引擎名称 / 脚本修改



三、其他组件OEM



全组件品牌统一



一、通过系统配置可直接修改


应用场景:需要对企业logo、名称等相关信息进行简单修改。


以下为系统内可直接更换名称、图片及相关设置的具体操作,按登录前后的场景分类说明,步骤清晰可直接对照操作。


(一)登录前相关修改操作


从登录页面开始,可修改浏览器页签、登录页的logo、名称、图片等内容,



 


具体步骤如下:


1、修改浏览器页签的LOGO


以tomcat为例:替换文件favicon.ico,文件路径为:\Tomcat\webapps\ROOT


温馨提示:\tomcat\webassp路径下没有ROOT文件夹,可自行手动创建。若是其他中间件,建议咨询中间件厂商配置入口,或使用nginx等代理进行设置。



 


2、修改登录页浏览器页签的“Smartbi”名称


操作路径:运维设置 → 界面设置 → 登录页面设置,在“登录页标题”栏修改即可,可实时查看效果预览。



 


3、修改URL中默认的“smartbi”名称


只提供tomcat服务器的修改方式,参考链接:修改Tomcat服务器的应用名称


温馨提示:若不想中间件设置或中间件没有配置入口,可通过部署nginx等代理处理url显示。


 


4、修改登录页的LOGO图片


操作路径:运维设置 → 界面设置 → 主界面,找到“LOGO图片”选项进行修改。



 


5、修改“一站式大数据分析平台”文本


操作路径:运维设置 → 界面设置 → 主界面,修改“LOGO文本”栏内容即可替换该标题。



 


6、修改登录页左侧图片


操作路径:运维设置 → 界面设置 → 主界面,找到“左侧图片”选项进行修改。


建议图片尺寸:506*388,透明背景。



 


7、修改登录页背景图


操作路径:运维设置 → 界面设置 → 主界面,找到“背景图片”选项进行修改。


可选择系统默认背景(如海滩、日出、花草等),也可上传自定义图片;建议自定义图片尺寸:1920*1080,透明背景。



 


8、修改登录页输入框的位置及大小


操作路径:运维设置 → 界面设置 → 自定义样式。



代码说明如下(仅供参考):修改登录页输入框的位置及大小参考代码.txt (2.59 K)


 


(二)输入用户名密码登录后相关修改操作


登录系统后,可对首页、导航栏等相关显示内容进行修改,



 


具体步骤如下:


1、修改首页浏览器页签的“smartbi”名称


操作路径:运维设置 → 界面设置 → 主界面,修改“主界面标题”栏内容即可。



 


2、修改首页左侧导航的“SMARTBI”LOGO


操作路径:运维设置 → 界面设置 → 主界面,找到“LOGO图片 - 左侧导航默认LOGO”选项进行修改。



 


3、修改系统首页为其他页面


操作路径:运维设置 → 系统选项 → 公共设置,在“系统首页设置”栏选择需要设置的页面即可。



 


4、修改收起导航栏后显示的红色“SMARTBI”LOGO


当点击“收起导航栏”后,若出现默认红色“SMARTBI”LOGO,可通过以下步骤修改:


操作路径:运维设置 → 界面设置 → 主界面,找到“LOGO图片 - 顶部导航默认LOGO”选项进行修改。


建议图片尺寸:136*46,透明背景。



 


(三)管理员配置页面相关LOGO修改


管理员身份登录后,进入配置页面(http://ip:port/smartbi/vision/config.jsp),该页面及相关位置的LOGO修改步骤如下:


操作路径:运维设置 → 界面设置 → 配置页面,修改“LOGO图片”“首页LOGO”选项,即可完成该页面所有LOGO的替换。



 


二、使用ChangeLogo_V11.ext扩展包


应用场景:对产品OEM定制需求(如 Logo、文字、界面模块屏蔽 / 自定义等)较高。


核心注意事项:所有对 Smartbi 的第三方修改,均需放在扩展包中,禁止直接修改 war 包内文件;


若需自行定位图片、css 或 js 文件做扩展修改,可参考《Smartbi 前端框架介绍》《调试&定位技巧》、《二次开发》相关文档。


 


(一)扩展包基础操作


1、扩展包下载


下载地址:PC端自定义Logo(适用于 V11 版本)


 


2、扩展包修改方法



  1. 使用 WinRAR 等压缩工具,直接打开 ChangeLogo_V11.ext 文件;

  2. 将需要修改的文件从压缩工具窗口拖出,完成编辑修改;

  3. 将修改后的文件拖回压缩工具窗口,覆盖原有旧文件;

  4. 关闭压缩工具窗口,保存修改即可。


(二)具体OEM修改操作


1、浏览器标题栏 title 修改


 



  1. 对应文件路径:ChangeLogo_V11.ext\vision\js\ext\ConfigurationPatch.js

  2. 配置项说明:

    • loginTitle:登录界面的标题

    • applicationTitle:主界面的标题

    • configTitle:配置界面的标题



  3. 异常处理:若标题栏出现乱码,如下,因 JS 文件编码格式错误导致,需将文件转为UTF-8 编码(推荐用 Uedit 工具打开文件,另存为 UTF-8 格式即可)。



 


 


2、登录界面 LOGO 修改




  1. 对应文件路径:ChangeLogo_V11.ext\vision\img\login\logo.png

  2. 操作要求:直接将自定义 LOGO 拖放至对应路径覆盖同名文件,图片的名称、扩展名、尺寸必须与原文件完全一致。


 


3、主界面LOGO修改



  1. 大 LOGO(登录后左上角默认logo):路径为 ChangeLogo_V11.ext\vision\img\baseframe\logo.png,尺寸 180*40


 


 


    2.小 LOGO(收起导航栏左上角logo):路径为          ChangeLogo_V11.ext\vision\img\baseframe\logo-light.png,尺寸 198*33;



 


4、Config 登录界面 LOGO 修改




  1. 对应文件路径:ChangeLogo_V11.ext\vision\img\config-login-logo.png

  2. 固定尺寸:183*23,替换时保持尺寸、名称、扩展名一致。


 


5、Config 页面左上角图标修改




  1. 对应文件路径:ChangeLogo_V11.ext\vision\img\mainframe\logo.png

  2. 固定尺寸:230*52,替换时保持尺寸、名称、扩展名一致。


 


6、屏蔽右上角图标




  1. 对应文件路径:ChangeLogo_V11.ext\vision\js\bof\baseajax\common\BannerView.js.patch

  2. 操作方法:找到对应图标代码,取消代码前的注释(//) 即可屏蔽该图标,各图标对应代码:


搜索图标:// 'SEARCH'
首页图标://'HOME'
导航页图标:// 'GUIDE_PAGE'
代办图标:// 'TODO_LIST'
消息中心图标:// 'MESSAGE_CENTER'
管理员:// 'LOGIN_USER'

 


 


7、屏蔽右上角更多下拉框菜单




  1. 对应文件路径:ChangeLogo_V11.ext\vision\js\bof\baseajax\common\dialog\BannerMoreMenusDialog.js.patch

  2. 操作方法:找到对应菜单代码,取消代码前的注释(//) 即可屏蔽该菜单,各菜单对应代码:


帮助文档:// 'ONLINE_HELP'
用户日志:// 'USER_LOGS'
系统监控:// 'SYS_MONITOR'
登录二维码:// 'QRCode'
插件下载:// 'PLUGIN_DOWNLOAD'
关于:// 'ABOUT_SMARTBI'
注销:// 'LOGOUT'

 


8、关于页面信息修改



可修改 “关于” 对话框的 LOGO 图片、公司名称、官网、联系邮箱等信息,


“麦粉社区、版本发布说明”会被扩展包默认隐藏,不支持修改。



  1. 图片 LOGO 修改:路径为 ChangeLogo_V11.ext\vision\img\about\logo.png,直接替换同名文件即可;

  2. “关于 Smartbi” 标识修改:

    • 对应文件:ChangeLogo_V11.ext\META-INF 下的 extension_lang_en.properties(英文)、extension_lang_zh_CN.properties(中文)、extension_lang_zh_TW.properties(繁体);

    • 操作方法:在 3 个文件中分别添加两行配置:UpperProduceName=标识、LowerProduceName=标识;

    • 编码要求:标识含非英文字符时,需转为unicode 编码(可通过在线工具 “unicode 在线编码” 转换);

    • 填写示例:标识为“思迈特公司”,则分别在这 3 个文件中填写以下内容:

    • extension_lang_en.properties (英文):




UpperProduceName=SmartBI Company
LowerProduceName=SmartBI Company




    • extension_lang_zh_CN.properties (中文):




UpperProduceName=\u601D\u8FC8\u7279\u516C\u53F8
LowerProduceName=\u601D\u8FC8\u7279\u516C\u53F8




    • extension_lang_zh_TW.properties (繁体):




UpperProduceName=\u601D\u9081\u7279\u516C\u53F8
LowerProduceName=\u601D\u9081\u7279\u516C\u53F8

 


    3.公司名称 / 官网 / 联系邮箱修改:





    • 对应文件:同上 3 个多语言配置文件;

    • 操作方法:分别在文件中添加单行配置,Smartbi=公司名称、WebAddress=官网地址、邮箱默认隐藏,不支持修改;

    • 编码要求:非英文字符需转为 unicode 编码。




 


9、隐藏导航页的帮助 / 社区 / 官网 / 在线咨询列表



对应文件路径:ChangeLogo_V11.ext\vision\js\smartbi\baseframe\module\navigationpage\NavigationPageTaskPanel.js.patch


操作方法:扩展包文件中已内置屏蔽代码,若需部分显示,将代码中屏蔽相关的 3 行代码注释即可。


 


10、隐藏个人中心右侧资讯栏



对应文件路径:ChangeLogo_V11.ext\vision\js\freequery\mycenter\MyCenter.js.patch


操作方法:文件中已内置屏蔽代码,若需显示资讯栏,将代码中屏蔽相关的 3 行代码注释即可。


 


11、屏蔽搜索弹窗的帮助文档列 / 麦粉社区列




  1. 对应文件路径:ChangeLogo_V11.ext\vision\js\bof\baseajax\common\dialog\SearchDialog.js.patch

  2. 默认效果:扩展包默认屏蔽帮助文档和麦粉社区,仅显示内部资源;

  3. 自定义显示:将该文件的内容替换为以下内容,则搜索弹框会显示内部资源、帮助文档、麦粉社区这 3 列,其中第 4 行的 3 个 id 分别代表:innerResource: 内部资源;helpDocument: 帮助文档;forum: 麦粉社区


SearchDialog.prototype.getAction_oem = SearchDialog.prototype.getAction;
SearchDialog.prototype.getAction = function() {
  var action = this.getAction_oem();
  var actionIds = ['innerResource', 'helpDocument', 'forum'];
  action = action.filter(e => actionIds.includes(e.id));
  return action;
}

 


12、自定义登录界面


支持完全替换登录界面风格,核心保留登录逻辑代码即可,步骤如下:



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

  2. 增加登录界面 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进行登录,再重新刷新本页面。


 


13、试用版水印修改



  1. 对应文件路径:ChangeLogo_V11.ext\vision\js\ext\ConfigurationPatch.js

  2. 配置项说明:修改waterMarkName属性值,即为自定义的试用版水印标题。


 


14、帮助文档指定访问地址




  1. 对应文件路径:ChangeLogo_V11.ext\vision\js\ext\ConfigurationPatch.js

  2. 配置项说明:修改onlineHelpAddressConfig属性值,即为自定义的帮助文档跳转地址(示例:onlineHelpAddressConfig: "https://www.baidu.com/")。


 


15、隐藏消息中心 - 社区




  1. 对应文件路径:ChangeLogo_V11.ext\vision\js\ext\ConfigurationPatch.js

  2. 配置项说明:添加 / 修改isComunityMsgHidden属性,true=隐藏、false=显示,默认值为 false。


 


16、隐藏收起导航栏后左上角LOGO




  1. 对应文件路径:ChangeLogo_V11.ext\vision\js\ext\ConfigurationPatch.js

  2. 配置项说明:添加 / 修改isTopLeftCornerIconHidden属性,true=隐藏、false=显示,默认值为 false。


 


(三)扩展包部署


完成所有自定义修改后,将修改后的 ChangeLogo_V11.ext 扩展包部署至 Smartbi 系统,完整的部署流程和操作步骤,请参考《部署扩展包》官方文档。


 


三、其他组件OEM


(一)Office插件参考


具体参考:《Office插件OEM》


(二)移动端参考


具体参考:《移动端OEM》


(三)数据挖掘引擎、OLAP、导出引擎


前端并未显示相关内容,不建议对后台其他内容进行修改。若一定要修改,可参考


1、数据挖掘引擎


只能修改数据挖掘安装包的名称,其他内容无法OEM


 


2、OLAP



 


改名






























原始名 修改名 脚本
smartbi_olap_deamon_env pilot_olap_deamon_env mv smartbi_olap_deamon_env pilot_olap_deamon_env
smartbi_olap_env pilot_olap_env mv smartbi_olap_env pilot_olap_env
SmartbiOLAPDeamon.jar BIOLAPDeamon.jar mv SmartbiOLAPDeamon.jar BIOLAPDeamon.jar
SmartbiOLAPServer.jar BIOLAPServer.jar mv SmartbiOLAPServer.jar BIOLAPServer.jar

 



 


改脚本


















文件名



修改内容


startup_deamon.sh
startup_olap.sh

 


3、导出引擎


前提:导出引擎oem需要有docker环境。


 


3.1 目录结构



改名



































原始名 修改名 脚本
smartbi_images pilot_images mv smartbi_images pilot_images
smartbi_data pilot_data mv smartbi_data pilot_data
uninstall_SmartbiExport.sh uninstall_BIExport.sh mv uninstall_SmartbiExport.sh uninstall_BIExport.sh
start_SmartbiExport.sh start_BIExport.sh mv start_SmartbiExport.sh start_BIExport.sh
stop_SmartbiExport.sh stop_BIExport.sh mv stop_SmartbiExport.sh stop_BIExport.sh

 



 


改脚本

























文件名 修改内容
uninstall_SmartbiExport.sh
start_SmartbiExport.sh
stop_SmartbiExport.sh
uninstall_docker.sh

 


3.2 Smartbi_images


改名















原始名 修改名 脚本
Smartbi-Export.tar Pilot-Export.tar mv Smartbi-Export.tar Pilot-Export.tar

 



 


重新打包镜像













文件名 修改内容
Smartbi-Export.tar

 


3.3 Smartbi_data


改名















原始名 修改名 脚本
smartbi-export pilot-export smartbi-export pilot-export

 



 


改脚本













文件名 修改内容
smartbi-export/package.json

 


 最后,走过路过,不要错过,领个任务领取麦豆吧 ——>点击领取任务

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 | 立即注册

0回帖数 0关注人数 23浏览人数
最后回复于:半小时前

社区

指南

AI

搜索

快速回复 返回顶部 返回列表