注意

1. 不同模板展示对应模块类型的资源。 如: 看板管理、自助分析、数据集下面都有相同的文件夹，但是看板管理文件下面只能看到看板、自助分析文件夹下面只有图表
2. 数据源文件夹从1.4.3开始支持

提示

• 根文件夹ROOT右键只能进行创建子文件夹操作
• 从所有的包含文件夹弹窗的操作, 均能做文件夹新建操作

SELECT a, b, c, d
  FROM fact a
  JOIN dima ON ...
  JOIN dimb ON ...

SELECT a, b, c, e, f, g
 FROM fact a
 JOIN dima a ON ...
 JOIN dimb b ON ...

提示

您甚至可以更换一个数据源、完全重写查询，仅需要保证旧查询使用的字段都包含在修改之后的查询字段中

提示

• 维度列在图表设计时只能拖拽到维度栏；
• v1.5.1之前的版本指标(度量)列只能拖拽到指标栏，1.5.1之后的版本指标可以拖拽到维度用作直方图分析
• 聚合函数设计时可以改变, 默认为 sum 求和

建议

正常情况下我们建议让有基础数据仓库建模经验的技术人员进行维度建模，建好模型之后自助分析、看板设计阶段交付非技术、业务使用
这样做的好处是专业的人员统一管理模型，交付的模型更加利于后期多场景重用分析，查询性能也更加可控

注意

分组脚本不需要再指定别名;

注意

如果衍生维度的数据类型与原始字段的数据类型不一致，Clickhouse会报错，如下面所示，case 结构中同时出现字符与数字，在数据库没有 做兼容处理的情况下将引起报错, 解决方案为设置组外成员统一值，或者过滤组外成员

SELECT 
    `the_year` AS c_0,
    CASE
        WHEN `month_of_year` IN (1, 2, 3) THEN '上半年' -- 字符类型
        ELSE `month_of_year` -- 数字型
    END AS c_1,
... 

SOL 错误 [386] [07000]: Code: 386. DB:Exception: There is no supertype for types String, Int8 because some of them are String/FixedString and some of them are not;

聚合数据查询

维度字典的配置，不会改变汇总查询的结构，从上面的案例可以发现聚合字段依旧是region_id，region_id与country之间是多对一的的关系，即多个region_id对应同一个国家， 汇总查询按region_id汇总，但是我们的数据引擎会在此基础之前再进行一次汇总计算，实现按字典映射值sales_country的粒度汇总

SELECT `REGION_ID` AS c_0,
       SUM(`store_sales`) AS v_0
  FROM (
  -- dataset view
) cb_view
WHERE `REGION_ID` NOT IN (1)
GROUP BY `REGION_ID`

跨库、跨源关联

维度字典查询可以与数据集为不同的库或者数据源，因此可以利用维度字典实现跨库跨源数据关联，典型场景如: Elasticsearch数据集维度映射到关系数据的字典表

字典过滤

对有配置维度字典的维度过滤，维度成员输出按映射结果分组，选定值为映射值，多维分析引擎会把映射值还原为原值过滤
支持用户在选定值直接输入原始值
如果输入的选定值在字典表找不到映射关系，则不做映射直接用原值过滤

SELECT `REGION_ID` AS c_0, `sales_region` AS c_1,
       SUM(`store_sales`) AS v_0
  FROM (
-- dataset view
) cb_view
WHERE `REGION_ID` NOT IN (3,7,8,9,10,11,12,13 ....)
GROUP BY `REGION_ID`, `sales_region`

注意

聚合表达式中使用的字段必须与聚合函数成对出现，否则聚合表达式将会影响聚合颗粒度引起计算错误
如: 维度字段使用了年度，sql对应的聚合为group by year, 当聚合表达式中出现了不在group by中的字段则改查询就不正确了

-- 正确
select year, sum(cost)
 from t
group by year

-- 错误
select year, unit * sum(cost)
 from t
group by year

sql的count distinct

表达式里面的distinct(col)与sql的count(distinct col)等价, 直接写count(distinct col)是错误的写法

怎么实现count(case when col > 10 then 1 else 0 end)

加个引号就可以了, 表达式会把里面的语句当成一个整体 count("case when col > 10 then 1 else 0 end")

提示

使用自定义聚合函数时暂时忽略语法检测，后续版本中会完善语法检测功能

提示

数据集查询中数组变量获取建议使用arr.get()函数传参设置，因为carr.get()能够在变量为空白字符和null两种情况下更安全的设定默认值

• Kylin Project：对应Kylin本身的Project
• Data Model：对应Kylin Model

## 看板导出、邮件发送依赖插件
pkg_puppetter=/Users/xxx/cboard/pkg-puppeteer/build/pkg-puppeter-macos
pkg.puppetter.args=-DvpWidth=1920 -DvpHeight=1080 -DvpScale=1
## 导出插件模拟请求地址
frontend.baseurl=http://localhost:8026/cboard

mail.smtp.host=127.0.0.1
mail.smtp.port=8825
mail.smtp.from=test@test.com
##mail.smtp.username=test@test.com
##mail.smtp.password=111111
##mail.smtp.ssl.checkserveridentity=false

邮件标题与内容

从v1.6.0开始邮件标题和内容支持内置变量解析，如时间变量使用

DataX目录配置

在使用DataX任务之前，需要自行安装配置好DataX安装目录，管理员登陆系统，管理-> 系统配置 -> 定时任务 -> datax安装目录

日志查看

shell任务支持准实时的在任务日志窗口查看

## 该配置支持在application.properties和系统配置页面配置
mail.job.admin=aa@domain.com

用户列表

• 用户列表
• 点击＋号添加`新建用户`: 新建用户的权限目前只对管理员开放, CAS, OAuth2.0系统接入之后, 通过认证登录能够自动创建新用户
• `编辑与删除`: 只有选中单个用户的时候右上角的编辑与删除菜单才会出现
• 搜索用户：默认通过用户名（包含登陆名）搜索，点击搜索框前面的按名称按钮可以切换为按用户组搜索
• 企业版多选checkbox选中用户或者角色(社区版暂时为按住Ctrl鼠标左键选中多个用户或者角色)
• 用户<->权限：从版本1.2开始直接对用户进行授权
• 用户<->角色：授权或者回收权限
• 选中一个用户之后，该用户对应的角色可以被联动选中，同时该用户所有的权限列表(包含用户权限与该用户所属角色具有权限合集)也会实时联动

角色(Role)

• 点击＋号添加角色, 并为该角色分配一个管理员(角色管理员所在组需要有管理功能菜单权限)
• `编辑与删除`: 只有选中单个角色的是右上角的编辑与删除菜单才会出现
• 角色管理员用于管理当前角色所属
• 除了Admin之外，角色管理员只能管理的角色, 其他的角色为不能编辑状态
• 每次只能更新一个角色的资源权限

资源

• `菜单`：一级菜单与二级菜单分开控制，没有级联
• `文件夹`: 子文件夹会继承父文件夹的权限, 文件夹的详细解释请参考[文件夹资源管理^(企业版)](zh-cn/manual/foldersystem.md)
• 合理的按照文件夹组织资源之后`看板`/`数据集`/`图表`都可以不用另行控制权限; 特殊需求可以单独控制
• 文件夹下的子节点在没有单独选中修改权限的情况下集成最近父节点权限，选中状态下以自身状态为主，如父节点为可读写删除权限，当前节点只读权限，则最终为只读。
• `资源的查改删`: 资源的权限包含`查,改,删`, 右键点击资源节点可以切换`改,删`状态
• 角色管理员只能管理owner为自己的角色

select country
  from your_rule_table
 where user = '${loginName}'

Tips

设置完成之后记得点击确认保存, 关闭窗口哦!

Tips

• 填写完毕之后可以点击测试按钮，输入简单的sql查询测试数据源与CBoard之间的连通性
• 是否使用连接池 设置数据源是否通过druid连接池的方式连接数据源,
• 数据源聚合 默认配置，即引擎每次会解析用户的拖拽配置动态的生成查询语句下推数据源执行, 详细解释请参考性能优化

String driver = dataSource.get(DRIVER);
String jdbcUrl = dataSource.get(JDBC_URL);

Class.forName(driver);
// 获取用户自定义properties
Properties props = new Properties(getDsrProps());
return DriverManager.getConnection(jdbcUrl, props);

关于Hive

理论上Hive也可以通过JDBC的方式连接，考虑到查询延迟太高不适合做及时交互查询引擎，不推荐引入。

目录权限

建议配置的基础目录有新建文件与删除文件操作权限， 如果没有新建与操作权限，仅有只读权限，也是能够使用的，只是文件上传会失败

Driver ：org.apache.kylin.jdbc.Driver
JdbcUrl：jdbc:kylin://<host>:<port>/<project>

注意

非数据源聚合的连接，切记注意数据集或者Query查询结果集大小。

关于Kylin1.6对子查询支持结果异常问题：

CBoard中采用的基于数据集定义的子查询嵌套之后group by的形式聚合下推数据源。 我们在实际使用中遇到过查询结果不准的bug，遇此情况可以通过图表设计模块下预览查询功能查看调试实际执行的Query。

或者改用下面Kylin原生数据源

重要提示

• 从v1.6.0开始所有请求取消.do后缀，1.6之前的版本添加.do后缀
• post 请求时使用form-data或x-www-form-urlencoded
• 前端请求示例

axios.create({
    baseURL: baseServerUrl, // http://ip:port/cboard
    headers: {
        'Content-Type': 'application/x-www-form-urlencoded',
    }
}).post('auth', {username: '', password: ''})

• 服务端请求示例

import cn.hutool.http.HttpUtil;

Map<String, Object> body = new HashMap<>();
body.put("username", arguments[0]);
body.put("password", arguments[1]);
String response = HttpUtil.post(baseServerUrl + "auth", body);

{
    "token": "VhzJp0k6",
    "user": {
        "password": "ee11cbb19052e40b07aac0ca060c23ee",
        "username": "user",
        "authorities": [],
        "accountNonExpired": true,
        "accountNonLocked": true,
        "credentialsNonExpired": true,
        "enabled": true,
        "userId": "244e8c1c-ec29-44de-ab37-f32f78825514",
        "company": "公司",
        "department": "研发",
        "name": "别名",
        "title": "前端"
    },
    "msg": null,
    "valid": true
}

{
    "token": null,
    "user": null,
    "msg": null,
    "valid": false
}

重要提示

从1.4.3开始，采用jwt认证，token较长, 支持放到header中, 当然url中的token也会兼容

axios.create({
    headers: {
        token: 244e8c1c-ec29-44de-ab37-f32f78825514 
    }
})

[
    {
        "id": 10000,
        "name": "Root",
        "parentId": -1,
        "isPrivate": 0,
        "userId": "1",
        "userName": "超级管理员",
        "loginName": "peter",
        "createTime": "2018-07-04 10:22:59.0",
        "updateTime": "2018-07-04 10:22:59.0"
    },
    ...
]

{
    "resList": [
        {
            "folderId": 10036,
            "folderPath": "Root\\foodmart\\看板",
            "id": 91,
            "userId": "1",
            "folderName": "看板",
            "folderIsPrivate": 0,
            "name": "Foodmart综合分析看板",
            "userName": "超级管理员",
            "loginName": "peter",
            "createTime": "2019-09-27 11:48:36.0",
            "updateTime": "2020-02-19 11:59:46.0",
            "layoutType": "freelayout",
            "layout": null,
            "edit": false,
            "delete": false
        },
        ....
    ],
    "folderList": [
        {
            "id": 10000,
            "name": "Root",
            "parentId": -1,
            "isPrivate": 0,
            "userId": "1",
            "userName": "超级管理员",
            "loginName": "peter",
            "createTime": "2018-07-04 10:22:59.0",
            "updateTime": "2018-07-04 10:22:59.0",
            "edit": false,
            "delete": false
        },
        ....
    ]
}

[
    {
        "id": 1,
        "userId": "1",
        "name": "foodmart",
        "type": "jdbc",
        "config": null,
        "edit": false,
        "delete": false,
        "userName": "超级管理员",
        "loginName": "peter",
        "createTime": "2018-07-04 10:27:06.0",
        "updateTime": "2020-03-03 22:23:29.0"
    },
    ....
}

{
    "resList": [
        {
            "folderId": 10030,
            "folderPath": "Root\\ES",
            "id": 41,
            "userId": "1",
            "name": "es-bank",
            "categoryName": "默认分类",
            "userName": "超级管理员",
            "loginName": "peter",
            "createTime": "2018-09-21 16:47:07.0",
            "updateTime": "2020-02-20 18:13:48.0",
            "data": null,
            "edit": false,
            "delete": false
        },
        ....
    ],
    "folderList": [
        {
            "id": 10000,
            "name": "Root",
            "parentId": -1,
            "isPrivate": 0,
            "userId": "1",
            "userName": "超级管理员",
            "loginName": "peter",
            "createTime": "2018-07-04 10:22:59.0",
            "updateTime": "2018-07-04 10:22:59.0",
            "edit": false,
            "delete": false
        },
        ....
    ]
}

{
  "resList": [
    {
      "folderId": 10004,
      "folderPath": "Root\\foodmart\\图表\\交叉表",
      "id": 9,
      "userId": "1",
      "name": "2.3-行占比-开销占比",
      "categoryName": null,
      "userName": "超级管理员",
      "loginName": "peter",
      "createTime": "2018-07-04 11:42:01.0",
      "updateTime": "2020-03-07 14:51:19.0",
      "dataset": null,
      "data": null,
      "edit": false,
      "delete": false
    },
    ...
  ],
  "folderList": [
    {
      "id": 10042,
      "name": "ddd",
      "parentId": 10032,
      "isPrivate": 0,
      "userId": "1",
      "userName": "超级管理员",
      "loginName": "peter",
      "createTime": "2018-12-06 12:08:19.0",
      "updateTime": "2018-12-06 12:08:41.0",
      "edit": false,
      "delete": false
    },
    ...
  ]
}

@RequestMapping(value = "/exportCockpit")
public ResponseEntity<byte[]> exportCockpit(
    @RequestParam Long boardId,
    @RequestParam(defaultValue = "15") Integer timeout, // 等待截图时长，单位s
    @RequestParam(defaultValue = "1") float scale, // 图片解析率
    @RequestParam(defaultValue = "png") String type // png/jpeg/pdf
) 

 {resId: 1,  pid:-1, name: "配置",          }
 {resId: 2,  pid:1,  name: "数据源管理",    }
 {resId: 3,  pid:1,  name: "数据集管理",    }
 {resId: 4,  pid:-1,  name: "自助分析",      }
 {resId: 41, pid:-1,  name: "复杂报表",      }
 {resId: 5,  pid:-1, name: "看板",          }
 {resId: 51, pid:5,  name: "看板管理",      }
 {resId: 52, pid:5,  name: "网格布局",      }
 {resId: 53, pid:5,  name: "驾驶舱布局",    }
 {resId: 7,  pid:-1, name: "管理",          }
 {resId: 71, pid:7,  name: "权限模板",      }
 {resId: 8,  pid:7,  name: "用户管理",      }
 {resId: 81, pid:8,  name: "用户资源管理",  }
 {resId: 9,  pid:1,  name: "定时任务",      }
 {resId: 91, pid:1,  name: "邮件发送",      }
 {resId: 10, pid:-1, name: "资源分享",      }

_this.updateUserRes = function (userIds, resIds) {
    return _axios.post('admin/updateUserRes', {
        userIdArr: JSON.stringify(userIds),
        resIdArr: JSON.stringify(resIds),
    });
};

["uid1", "uid2"]

[
  {
    "resId": 1,
    "resType": "menu",
    "edit": false
  },
  {
    "resId": 1,
    "resType": "datasource",
    "edit": false
  },
  {
    "resId": 7,
    "resType": "widget",
    "edit": false
  },
  {
    "resId": 1,
    "resType": "dataset",
    "edit": false
  },
  {
    "resId": 6745078,
    "resType": "folder",
    "edit": false
  }
]

{
    "status": "1",
    "msg": "success", 
    "obj": 4,
    "id": null
}

{
    "status": "2",
    "msg": "No Module Permission!",
    "obj": null,
    "id": null
}

[
    {
        "userResId": "034f6429-cff6-4274-b5ff-2f9df9f8e1c4",
        "userId": "244e8c1c-ec29-44de-ab37-f32f78825514",
        "resId": 10042,
        "resType": "folder",
        "edit": false,
        "delete": false,
        "createTime": null
    },
    {
        "userResId": "123ee3dc-44f8-4c58-8f68-c56c78a239a4",
        "userId": "244e8c1c-ec29-44de-ab37-f32f78825514",
        "resId": 47,
        "resType": "widget",
        "edit": false,
        "delete": false,
        "createTime": null
    },
    ...
]

userIdArr: '["BoNSmgq5"]'
roleIdArr: '["kZKs0eAB","mW7MgbRi"]'

{
    "status": "1",
    "msg": "success", 
    "obj": 4,
    "id": null
}

[
    {
        "roleId": "9yp5FYGV",
        "roleName": "Foodmart国家访问规则",
        "userId": "admin"
    },
    {
        "roleId": "afff8e98-c223-4b71-8a44-946b9eeb9585",
        "roleName": "体验账号",
        "userId": "1"
    },
    ...
]

[
    {
        "userRoleId": 5297009885287913052,
        "userId": "cf592eb2-91fd-4319-925e-141d5a1b58b3",
        "roleId": "afff8e98-c223-4b71-8a44-946b9eeb9585"
    },
    {
        "userRoleId": 2139519606675883725,
        "userId": "cf592eb2-91fd-4319-925e-141d5a1b58b3",
        "roleId": "o7OfQhTB"
    }
    .....
]

{
  "loginName": "biuser",
  "userName": "爱分析",
  "userPassword": 'xxxx',
  "company": "公司名称", 
  "department": "BI",
  "title": "分析师",
  "validDate": 4073990400000,
  "enabled": true
}

{
    "status": "1",
    "msg": "success",
    "obj": {
        "userId": "Sl4LqKFe",
        "loginName": "api-new",
        "userName": "新建api",
        "userPassword": "f561aaf6ef0bf14d4208bb46a4ccb3ad",
        "userStatus": null,
        "company": "公司名称",
        "department": "BI",
        "title": "分析师",
        "validDate": 4073990400000,
        "enabled": true
    },
    "id": null
}

{
    "status": "2",
    "msg": "No Module Permission!",
    "obj": null,
    "id": null
}

{
  "userId": "cf592eb2-91fd-4319-925e-141d5a1b58b3",
  "loginName": "biuser",
  "userName": "爱分析",
  "userPassword": null, // 密码为空则不修改密码
  "company": "楚果", 
  "department": "BI",
  "title": "分析师",
  "validDate": 4073990400000,
  "enabled": true
}

{
    "status": "1", // 接口是否调用成功
    "msg": "success",
    "obj": 1, // 0 为接口调用成功，但是没有删除数据
    "id": null
}

[
    {
        "userId": "a18033335555",
        "loginName": "a18033335555",
        "userName": "18033335555",
        "userPassword": null, // 不返回密码
        "userStatus": null,
        "company": null,
        "department": null,
        "title": null,
        "validDate": null,
        "enabled": false
    },
    {
        "userId": "admin",
        "loginName": "admin",
        "userName": "admin",
        "userPassword": null, // 不返回密码
        "userStatus": null,
        "company": null,
        "department": null,
        "title": null,
        "validDate": null,
        "enabled": true
    },
    ....
]

首次交易日期={FIXED `客户 id` : min(`订单日期`)}
用户最后交易日期={FIXED `客户 id` : max(`订单日期`)}
业务最新日期={FIXED : max(`订单日期`)} 
# R值取订单表最大日期与最后交易日期差异值, 实际使用中可以根据业务需求调整
R值=DATEDIFF('day', #{用户最后交易日期}, #{业务最新日期}) 

select sum(R) / count(distinct `客户ID`)
       -- 同 avg(R)
  from (
   select `客户ID`, 
          min(`R值`) R -- 这里因为每个客户的R值都相同，用min/max/avg都可以
     from t_order
    group by `客户ID`
  ) t

平均R值={FIXED : sum(#{R值}/#{客户记录数}) / distinct(`客户 id`)}

F值={FIXED `客户 id` : distinct(`订单 id`)}

平均F值={FIXED : sum(#{F值}/#{客户记录数}) / distinct(`客户 id`)}

M值={FIXED `客户 id` : sum(`销售额`)}

平均M值={FIXED : sum(#{M值}/#{客户记录数}) / distinct(`客户 id`)}

R=IF(#{R值} > #{平均R值}, 1, 0)
F=IF(#{F值} > #{平均F值}, 1, 0)
M=IF(#{M值} > #{平均M值}, 1, 0)
RFM=CONCAT(#{R}, #{F}, #{M})

#
# meta datasource 元数据
# Druid 连接池
#
datasource.meta.name=meta
datasource.meta.driver-class-name=com.mysql.jdbc.Driver
datasource.meta.url=jdbc:mysql://localhost:3306/cboard_dev?characterEncoding=utf-8&serverTimezone=Asia/Shanghai
datasource.meta.username=root
datasource.meta.password=xxx
datasource.meta.max-active=10
datasource.meta.min-idle=0
datasource.meta.initialSize=1
datasource.meta.breakAfterAcquireFailure=true
#
# log datasource 日志数据默认与meta元数据源一致
#
datasource.log.name=log
datasource.log.driver-class-name=${datasource.meta.driver-class-name}
datasource.log.url=${datasource.meta.url}
datasource.log.username=${datasource.meta.username}
datasource.log.password=${datasource.meta.password}
datasource.log.max-active=10
datasource.log.min-idle=0
datasource.log.initialSize=1
datasource.log.breakAfterAcquireFailure=true

# 连接端口与context
server.port=8026
server.servlet.context-path=/cboard
# https相关配置
#server.ssl.key-store=classpath:.xxxx.jks
#server.ssl.key-store-password=xxx
#server.ssl.keyStoreType=JKS

# 对应安装目录下user-files文件夹
file.userfiles-path=user-files
spring.web.resources.static-locations=classpath:/static,classpath:/webui,classpath:/${file.userfiles-path}
spring.web.resources.cache.cachecontrol.cache-public=true
spring.web.resources.cache.cachecontrol.max-age=30d

#
# 系统运行产生文件存储地址
#
runtime.base.filePath=${user.home}/.ibi
# 在线表格写转文件存储地址, 默认目录
dataprovider.onlineTable.filePath=${runtime.base.filePath}/online-tables
# 大屏导出临时文件存储地址
export.cockpit.screenshotPath=${runtime.base.filePath}/screenshot/cockpit

admin_user_id=1

# Service configuratin
#【谨慎配置】维度成员查询返回结果集大小限定, 默认:2000
dimension.member.resultLimit=2000
#【谨慎配置】聚合结果集大小限制，调大会增加服务端压力, 默认:1万
dataprovider.agg.resultLimit=10000
#【谨慎配置】离线数据集缓存大小限制, 默认:30万
dataprovider.resultLimit=300000
# 交叉表是否合并表头阈值=行维数量 * 数据行数
# pivot.table.mergeLimit=500

#
# 离线数据集聚合引擎配置
#
# Inner aggregator type: h2[default], clickhouse
#aggregator.type=clickhouse
# Set batch size load size, times by 1 thousand
aggregator.batchReadSize=50
aggregator.batchLoadSize=50
# 缓存定时任务清理quartz表达式默认每日0点清空所有缓存
# aggregator.cleanJob.quartz=0 0 0 * * ?

# h2 缓存相关配置
# Storage File Syatem
# 1 默认缓存数据存储到文件 Stores data in file system
aggregator.h2.driver-class-name=org.h2.Driver
aggregator.h2.url=jdbc:h2:~/H2Data/cboard;AUTO_SERVER=TRUE;MODE=MYSQL;CASE_INSENSITIVE_IDENTIFIERS=false
# 2 切到缓存数据到内存 Stores data outside of the VM's heap - useful for large memory DBs without incurring GC costs.
#aggregator.h2.url=jdbc:h2:nioMemFS:cboard;AUTO_SERVER=TRUE;MODE=MYSQL;CASE_INSENSITIVE_IDENTIFIERS=false
aggregator.h2.username=sa
aggregator.h2.password=!QAZ2wsx
aggregator.h2.max-active=10
aggregator.h2.testWhileIdle=false

# ClickHouse 缓存相关配置当aggregator.type=clickhouse时生效
aggregator.ck.driver-class-name=ru.yandex.clickhouse.ClickHouseDriver
aggregator.ck.url=jdbc:clickhouse://xxx:8123/ibi
aggregator.ck.username=xxx
aggregator.ck.password=xxx
aggregator.ck.min-idle=1
aggregator.ck.max-active=5
aggregator.ck.testWhileIdle=false


# 看板导出、邮件发送依赖插件
pkg_puppetter=/Users/xxx/cboard/pkg-puppeteer/build/pkg-puppeter-macos
pkg.puppetter.args=-DvpWidth=1920 -DvpHeight=1080 -DvpScale=1
# 导出插件模拟请求地址
frontend.baseurl=http://localhost:8026/cboard

# Max size for export file size by Megabyte ,
# 上传文件大小控制配置，影响单个看板导出最大大小，单个交叉表最大大小，单位兆
# 注：看板大小包含图表截图，交叉表数据，不包含明细表数据
export.maxUploadSize=50
export.maxInMemorySize=4
# export.detailTable.showTitle=true

mail.smtp.host=xxxx
mail.smtp.port=25
mail.smtp.from=cboard@sina.com
mail.smtp.username=xxx@sina.com
mail.smtp.password=xxxx
#mail.smtp.ssl.checkserveridentity=false


# formData.mango.connectionString=mongodb://peter:!QAZ2wsx@tcc2:27017


log.negativeFilter=List
log.positiveFilter=

#
# jwt configurations, support set in web page
#
#jwt.subject=ibi
# expire after hours
#jwt.expire=12
#jwt.secret=xxxx
#jwt.prefix=xxx

session.timeoutMinutes=300


spring.security.auth.type=jdbc

#cas
#caso.client.url=http://localhost:8026
#caso.client.check=${caso.client.url}/login/cas

caso.server.url=https://tcc4:8443/cas
caso.server.login=${caso.server.url}/login
caso.server.logout=${caso.server.url}/logout

#cas RestAPI
caso.server.tgt=${caso.server.url}/v1/tickets
caso.server.validate=${caso.server.url}/serviceValidate

#OAuth2
## implicit
oauth2.implicit.url=http://tcc4:8080/oauth2/oauth/authorize?response_type=token&scope=read
oauth2.userInfo=http://tcc4:8080/oauth2/m/user_info?access_token=
oauth2.client_id=ibi-app
oauth2.client_secret=client_secret
oauth2.redirect_uri=http://localhost:8088/login.html

#LDAP
ldap.url=ldap://www.zflexldap.com:389
ldap.base=dc=zflexsoftware,dc=com
ldap.userDn=cn=ro_admin,ou=sysadmins
ldap.password=zflexpass
ldap.principalPattern=uid=%s,ou=users,ou=guests
# "guest1", "guest1password"

spring.devtools.remote.restart.enabled=false
spring.devtools.livereload.enabled=false
spring.devtools.restart.enabled=false

提示

从安全层面考虑，用户在部署之后按自己的环境和安全等级要求修改配置

# jwt configurations, support set in web page

# subject可以任意修改
jwt.subject=ibi

# token过期时间(小时)
jwt.expire=12

# 加密秘钥secret可以任意修改
jwt.secret=xxxx

# 令牌前缀prefix可以任意修改
jwt.prefix=xxx

允许

xxx 公司 【允许】

禁止

Copyright © xxx 公司 . All rights reserved. 【不允许】
版权 © xxx 公司 . 保留所有版权. 【不允许】

为什么要使用配置注入，而不是直接修改html源代码？

1. 页面缓存: html页面为静态资源，修改之后用户需清理缓存才能生效，配置项注入为动态注入修改刷新页面直接生效
2. 多处维护: html页面有多个入口，index.html, render.html, render-lite.html, cockpit.html需要多处修改
3. 升级维护: html修改版本更新需要再次维护，注入方式配置信息存储在数据库，更新不受影响

[
  [
    "link",
    {
      "rel": "stylesheet",
      "href": "//at.alicdn.com/t/font_2677584_cfynubcr16f.css"
    }
  ]
]

<head>
    <!-- 注入的内容 -->
    <link href="//at.alicdn.com/t/font_2677584_cfynubcr16f.css" rel="stylesheet"></link>
</head>

提示

Font Family 请保持 尽量避免使用默认值icon佛那个以免和系统图标发生冲突

[
  [
    "link",
    {
      "rel": "stylesheet",
      "href": "//at.alicdn.com/t/font_2677584_cfynubcr16f.css"
    }
  ]
]

<head>
    <!-- 注入的内容 -->
    <link href="//at.alicdn.com/t/font_2410206_xxxx.css" rel="stylesheet"></link>
</head>

Tips

如果您后面添加了新的图标，请重新生成新的 CSS 地址并在 .vuepress/styles/index.styl 中覆盖旧的 CSS 地址。

font-class格式解释：

前缀为在步骤，新建项目输入的Font Fmaily名称，空格之后第二项为改图标在项目中的名称

留存率 = 某个时间段结束时仍然活跃的用户数 / 该实际的开始时的用户数

首次购买日期 = {FIXED `customer id` : min(`order date`)}
留存周期(月) = CONCAT(DATEDIFF('month', #{首次购买日期}, `order date`), '月')
留存周期(季度) = CONCAT(DATEDIFF('quarter', #{首次购买日期}, `order date`), '季度')

get('留存用户数') / max('留存用户数', null, [])

支持度 = 同时购买A和B订单数 / 总购买订单数

置信度 = 同时购买A和B订单数 / 购买A的订单数

A的购买比率 = 购买A次数 / 总购买订单数
B的购买比率 = 购买B次数 / 总购买订单数
提升度 = 支持度 / (A的购买比率 * B的购买比率)

商品A的订单数 = {FIXED `a_子类别` : distinct(`订单 ID`) }
商品B的订单数 = {FIXED `b_子类别` : distinct(`订单 ID`) }
同时购买商品AB订单数 = {FIXED `a_子类别`, `b_子类别` : distinct(`订单 ID`) }
总订单数 = {FIXED  : distinct(`订单 ID`)}

支持度 = max(`同时购买商品AB订单数`) / max(`总订单数`)
置信度 = max(`同时购买商品AB订单数`) / max(`商品A订单数`)
商品A购买占比 = max(`商品A订单数`) / max(`总订单数`)
商品B购买占比 = max(`商品B订单数`) / max(`总订单数`)
提升度 = ${支持度} / (${商品A购买占比} * ${商品B购买占比})

X轴分隔 = ${xSplit!0.1}
Y轴分隔 = ${ySplit!0.1}

去年销售额 = {EXCLUDE DATEADD(`订单日期`, -1, 'year') : sum(`销售额`)}
销售额增长率 = CHGRATE(${去年销售额}, sum(`销售额`), 0)
X轴分隔值 = max(`X轴分隔`)
Y轴分隔值 = max(`Y轴分隔`)

const s0 = option.options[0].series[0];
const _1stMetrics = s0.data[0].value[4].metrics;
const xSplit = _1stMetrics[0].value;
const ySplit = _1stMetrics[1].value;
console.log(xSplit, ySplit);
const maxX = Number.MAX_VALUE;
const maxY = maxX;
const minX = -1000000;
const minY = minX;

s0.markArea = {
    label: {
        position: 'inside',
        color: 'black',
        fontSize: 14,
        fontWeight: 'bold',
    },
    data: [  
        [{name: '瘦狗型', itemStyle: {color: 'rgba(203, 203, 203, 0.5)'}, coord: [minX, ySplit]}, {coord: [xSplit, minY]}],
        [{name: '问题型', itemStyle: {color: 'rgba(199, 164, 204, 0.5)'}, coord: [minX, ySplit]}, {coord: [xSplit, maxY]}],
        [{name: '现金牛', itemStyle: {color: 'rgba(234, 197, 183, 0.5)'}, coord: [xSplit, ySplit]}, {coord: [maxX, minY]}],
        [{name: '明星型', itemStyle: {color: 'rgba(190, 201, 166, 0.5)'}, coord: [xSplit, maxY]}, {coord: [maxX, ySplit]}],
    ]
}

.action-buttons {
    .el-button--primary {
        background-color: darkblue;
        color: white;
    }
}

引用图表样式改变了看板上为什么没有生效

当引用图表添加到看板时，系统会复制并应用该图表在加入时刻的样式配置。这种方式允许同一个引用图表在不同的看板中拥有独立且多样的配置设置。如果主图表进行了更新，直接同步这些更改会导致各看板上针对该引用图表所做的个性化调整丢失。

不过，您可以手动同步引用图表的样式配置，这样可以在保持个性化的前提下选择性地应用新的样式或功能更新。

引用图表的问题

• 从我们生产使用过程中与用户的实际反馈发现, 随着看板的增多, 图表的数据量会呈现急剧增长趋势;
• 起初为了图表可以在多个看板中重复引用, 特意把图表设计作为一个独立的模块维护与管理, 实际上这样的场景又非常的少见;
• 又或是用户在只需要发送仅包含一个图表的看板情况下不得不单独先设计与保存图表, 在看板废弃和删除之后, 还需要去图表管理模块找到对应图表手工删除;
• 另外, 由于看板与图表之间的权限是独立管理的; 在主题模块维护不太清晰的情况下经常会出现看板授权之后, 看板上的图表权限没有授权;

// params为js调用传参
const params = {
    event, // 点击事件对象 
    token, // 当前用户认证token
    _axios, // BI axios请求实例，用于BI自身服务请求，使用该实例可以不设置请求头
    boardParameters,  // 看板参数
    variables, // 环境变量
};

const target = params.event.target;
// console.log(_axios);
// 替换为加载图标
if (target.getAttribute('id') == 'download') {
    const url = target.getAttribute('url');
    if (target.isExport) {
        return;
    }
    const originalContent = target.innerHTML; // 保存原内容
    target.innerHTML = '<i></i> 下载中';
    target.isExport = true;
    
    // 传入reports对象数组则可以下载多个报表
    const reports = [{
        id: 230216164924406,
        name: 'Mexico',
        filters: [{
            datasetId: 1,
            columnName: 'sales_country',
            filterType: '=',
            values: ['Mexico'],
        }],
        // 环境变量
        variables: {
            foo: 'bar',
            month_range: '1,10'
        }
    }, {
        id: 230216164924406,
        name: 'Canada',
        filters: [{
            datasetId: 1,
            columnName: 'sales_country',
            filterType: '=',
            values: ['Canada'],
        }]
    }];
    
    // reportView/exportExcelById为根据报表ID下载Excel
    // 传入id则只下载一个报表
    // 传入reports对象数组则可以下载多个报表
    // 同一个报表可以在出现多次，filters控制过滤参数
    params._axios.post('reportView/exportExcelById', 
            {
                reports: JSON.stringify(reports)
                // id: 230216164924406
            }, {
                responseType: 'blob',
                headers: {
                // header这一段如果使用params._axios不需要设置
                // 如果使用原生axios请求外部服务根据需要设置
                    'Content-Type': 'application/x-www-form-urlencoded',
                    token: params.token
                }
            })
        .then(response => {
            // 创建 URL 并下载文件
            const url = window.URL.createObjectURL(response.data);
            const a = document.createElement('a');
            a.href = url;
            a.download = '报表.xlsx'; // 设置下载文件的名称
            document.body.appendChild(a);
            a.click();
            window.URL.revokeObjectURL(url); // 释放 URL
        }).catch(error => {
            console.error('下载失败', error);
        })
        .finally(() => {
            // 恢复原始内容和点击功能
            target.innerHTML = originalContent;
            target.style.pointerEvents = 'auto';
            target.isExport = false;
        });
}

iframe与看板联动交互

Iframe与看板直接可以通过postMessage消息机制交互，即iframe按约定格式发送消息，看板监听处理不同类别的消息， iframe支持的的消息格式如下:

window.parent.postMessage({
    name: 'ibi.widgetLink',
    params: [
        {type: 'env', val: {id: 'year', value: 2019}},
    ],
}, '*');

window.parent.postMessage({
    name: 'ibi.widgetLink',
    params: [
        {type: 'env', val: {id: 'year', value: 2019}},
        {type: 'env', val: {id: 'month', value: 10}},
    ],
}, '*');

window.parent.postMessage({
    name: 'ibi.widgetLink',
    params: [
        {
            type: 'popup-widget', 
            targetId: 1, // 图表ID
            val: { alias: '年', column: 'the_year', type: "=", values: ['2016'] }
        },
    ],
}, '*');

window.parent.postMessage({
    name: 'ibi.widgetLink',
    params: [
        {
            type: "dataset", 
            targetId: 1, // 数据集ID
            val: { alias: '年', column: 'the_year', type: "=", values: ['2016'] }
        },
    ],
}, '*');

window.parent.postMessage({
    name: 'ibi.widgetLink',
    params: [
        {
            type: "widget", 
            targetId: 'xp1lbw1j9cs', // 图表sid
            val: { alias: '年', column: 'the_year', type: "=", values: ['2016'] }
        },
    ],
}, '*');

联动到看板

联动到外部地址

弹窗联动

A1: A1单元格
A: A列所有单元格
1: 第1行所有单元格
A1,B,C: 多个匹配直接用英文逗号分隔

联动数据到环境变量

环境变量: ${envVars}
变量可以省略envVars前缀如：${year} == ${envVars.year}
联动信息: ${links}
列维度数组: ${groups}
行维度数组: ${keys}

-- 触发指标选择去年同期
// 通过变量表达式计算去年第一天日期
r_date >= ${cdt.startOfYear(cdt.addYear(-1), "yyyy-MM-dd")} 
// 通过变量计算去年今天日期
r_date <= ${cdt.addYear(-1, "yyyy-MM-dd")}

-- 触发指标选择今年销售额
// 通过变量表达式计算今年第一天
r_date >= ${cdt.startOfYear(cdt.now(), "yyyy-MM-dd")}

图表中没有使用字段

看板参数可以关联到数据集的所有字段，即使该字段没有在图表上使用，也能关联

SELECT * FROM orders WHERE DATE_FORMAT(order_date, 'yyyy') = '2024';

SELECT * FROM orders WHERE DATE_FORMAT(order_date, 'yyyy-MM') = '2024-08';

下拉框加载比较慢怎么办

默认行为

下拉框选项是通过关联的数据集字段构造子查询来获取的。如果这个数据集是一个性能较慢或比较大的事实表、视图，那么每次字段选项子查询都会带来较大的查询开销。

可选值查询设置

为了优化性能，用户可以启用“可选值查询”功能，并设置一个直接查询维度字典表的SQL语句。这种方法可以直接从专门设计用于快速查找的维度字典表中获取选项，从而显著提升选项加载速度和整体性能。

SELECT country_code AS option_value, 
       country_name AS option_name 
FROM countries;

下级开启`可选值查询`

SELECT sales_region -- 维度字段
FROM (
-- 数据集查询定义
) cb_view
WHERE sales_region like '%we%'
GROUP BY sales_region

我的常用看板参数组

我们从0-1支持了下列功能

• 背景配置：支持透明背景、纯色背景、天空盒子(白天/夜晚等)
• 摄像机配置：
  • 摄像机位置、朝向、Fov、Far
  • 自动旋转
• 灯光配置:
  • 环境光
  • 直线光：位置、照射目标、阴影、辅助器
• 辅助器：
  • 坐标轴辅助器
  • 地面网格辅助器
• 模型:
  • 支持glb、gltf、obj模型上传
  • glb模型支持带draco压缩模型解析
  • 根模型支持位置、旋转、缩放、投影、
    • 添加模型网格线
    • 光线扫描作色器(水平、横向、圆环扫描)
    • 支持添加标注
  • 支持BI查询数据标注绑定
    • 基于交叉表与模型名称的匹配的位置标注
    • 支持多指标展示
    • 支持边框、内边距、缩放、背景色等样式设置
• 钩子函数配置
• 支持看板联动配置
  • 联动可以改变看板上其他图形的数据
• 支持被联动配置
  • 被联动改变数据标签内容

使用须知

在使用3D场景之前，需要您对3D场景有一些基础认知，比如：

• 3D坐标系
• 摄像机
• 灯光
• 模型与材质
  • 3D美术常用的三维建模软件，比如Blender、3dmax、C4D、maya等等
• 3D项目中分工和流程
  • 3D美术：使用三维建模软件绘制3D模型，导出gltf等常见格式
  • 程序：加载解析三维软件导出的三维模型
  • 比如使用Blender三维建模软件导出gltf格式模型，然后再通过程序加载三维模型

注意

由于开启阴影计算会有性能开销，所以3D场景中物体产生阴影需要同时做三项设定

1. 灯光开启阴影
2. 物体(网格对象Mesh如机架)投射阴影
3. 物体(网格对象Mesh如地面)接受阴影

为了方便设置投射和接受阴影的网格对象，我提供了在上传的根模型至少通过名称规则设置阴影的配置属性，在下面的模型配置章节会有介绍

const plane = vm.scene.getObjectByName('polySurface136');
const texture = plane.material.map;

let count = texture.repeat.y;
if (count <= 10) {
  texture.repeat.x += 0.01;
  texture.repeat.y += 0.02;
} else {
  texture.repeat.x = 0;
  texture.repeat.y = 0;
}

几点说明

• 驾驶舱布局, 与普通的看板不同的地方在于, 大屏一个固定的画布大小, 常用于监控或者大屏展示
• 组件之间允许重叠, 可以设置图层, 图层值大的位于上层
• 组件大小能够根据屏幕大小自适应
• 组件的所有数据包含标题的文字内容修改, 都在右侧的配置栏里面(目前富文本编辑器除外), 点击不同的组件类型会激活相应的配置菜单
• 点击画布上的空白处, 取消当前激活的组件
• 图表组件依旧遵循数据集刷新间隔规则, 自动刷新
• 预览的时候注意, 确认浏览器不要阻止弹窗
• 驾驶舱布局新增了许多图表微调体验, 但是可能会成为一把双刃剑, 没有良好的设计, 最终的展现可能不会太好, 后续产品迭代我们会尽量追求让用户用最少的操作设计出效果最好的大屏

像素宽度与百分比宽度

百分比与像素高宽各有优劣势

• 百分比: 调整画布大小之后组件的位置与大小相对画布不会改变，如：大小50%的高宽，位置相对左边与上边10%的距离，无论画布如何调整组件的位置和大小都会动态的计算之后适应画布
• 像素: 调整画布大小之后，原来的像素位置与大小仅保持之前的大小，如：画布尺寸从之前的2K调整为4K之后，如果原来的高宽使用的像素定位，那么之前的元素仅占1/4大小的空间
  • 适用场景: 长图、长页面制作，宽度不变的情况下，随着内容不断增加，画布高度需要不断增加

锁定高宽

默认预览模式下，画布会缩放适应屏幕尺寸，如果用户需要取消在高度/宽度上的缩放行为，可以锁定高宽避免缩放，常用于允许出滚动条的长图展示场景

文本组件对应配置项

通用配置栏

多选组件配置

仅对齐选中组件

当画布上组件太多时，尤其是小组件需要对齐时，自动对齐便不太容易操作，甚至会出现不期望的对齐干扰
解决方案：

1. 中间画布底部菜单勾选仅对齐选中，然后选中目标组件(可多选)，拖拽需要移动的组件(移动组件不需要选中)
   
2. 使用多选对齐

this.linkCallback(paramArray);

this.linkCallback([
  {type: 'env', val: {id: 'year', value: 2019}},
]);

this.linkCallback([
  {type: 'env', val: {id: 'year', value: 2019}},
  {type: 'env', val: {id: 'month', value: 10}},
]);

this.linkCallback([
  {
    type: 'popup-widget',
    targetId: 1, // 图表ID
    val: { alias: '年', column: 'the_year', type: "=", values: ['2016'] }
  },
]);

this.linkCallback([
  {
    type: "dataset",
    targetId: 1, // 数据集ID
    val: { alias: '年', column: 'the_year', type: "=", values: ['2016'] }
  },
]);

this.linkCallback([
  {
    type: "widget",
    targetId: 'xp1lbw1j9cs', // 图表sid
    val: { alias: '年', column: 'the_year', type: "=", values: ['2016'] }
  },
]);

提示

当项目中有自己的UI设计师提供图片资源时，不建议通过文件上传的形式管理资源，而是建议用资源文件服务器的形式管理静态资源，这样在看板迁移的时候可以避免 上传资源文件访问不到的问题

API 方式读取组件数据

Query方式读取组件数据

{
    "text": false,
    "link": "https//xxxx"
}

{
    "text": "<span class=\"ql-align-center\"><span style=\"color: rgb(255, 255, 255);\">富文本编辑器我是动态的</span></span>"
}

{
    "images": [
        {
            "url": "https://cboard_beta.gitee.io/ibi-doc/assets/ds-test-es.png"
        },
        {
            "url": "https://cboard_beta.gitee.io/ibi-doc/assets/saiku_crtbl.png"
        }
    ]
}

{
    "url": "https://cn.bing.com/"
}

涉及到的新功能点

• 范围衍生维度起始值支持变量
• 衍生维度过滤组外循环
• 值类型，滞后比较
  • 行上计算
  • 显示原值
  • 滞后查找失败使用原值
• 维度展开隐藏项