• 模块设计
    • 概念定义
    • 属性定义

什么是模块

模块

  1. 模块:是指系统中存放功能的容器。这里说的功能不是泛指,而是本系统将所有业务内容,划分为4种类型:功能模块、业务流程、数据报表、图形看板。

  2. 备注:左侧栏只是一个容器,在左侧栏中需要装入具体的“功能模块”等,这个左侧栏才会有内容。只有具有内容的左侧栏才会显示出来,空的左侧栏会被系统自动隐藏起来。

模块设计的属性定义

  1. 后台配置属性:

  1. 属性列表
项目名称 定义 详细解释
基本信息
模块名称 表示左侧栏显示的中文标识。 表示模块名称可以根据实际需求任意取名,建议不要重复。
模块NameKey 表示模块唯一的英文标识。 表示模块NameKey在整个系统的所有模块项之间必须是唯一不重复的。
模块描述 表示对当前模块的解释说明。 表示对于特殊的模块,需要添加详细的备注说明,方便与其他人员信息共享。
是否启用 表示前台是否可视当前模块。 =启用:表示将在角色候选列表中出现,供用户分配权限。
=一般用户不启用:表示该模块不会出现在角色候选列表中,仅管理员操作。
是否跨租户显示 表示针对多租户的情况,主平台是否可以查看租户记录。 =显示:表示平台可以查看所有租户的记录,但仅针对档案、事实表模块有意义,也只在平台用户上生效,租户不能查看其他租户记录。
=不显示:表示主平台也无法查看租户信息记录。
数据来源
模块类型 表示指系统首先判断在哪个类型下面去查找数据,有一个大的分类。 =档案:表示系统会在档案(Dim)中查找数据。
=事实记录:表示系统会在事实记录(Cube)中查找数据。
=档案分类:表示系统会在档案分类(Struc)中查找数据。
=内部页:表示系统内部指定的页面。
=外部页:表示系统外部指定的页面。
内容NameKey/CubeID 表示所引用的“档案/单据”的唯一英文标识。 =档案NameKey:表示引用的是哪一个档案,因为NameKey是档案的唯一英文标识,所以这里填入引用档案的NameKey即可。
=单据CubeID:表示引用的是哪一个事实记录,因为CubeID是事实记录的唯一英文标识,所以这里填入引用事实记录的CubeID即可。
使用主表 表示只有模块类型为“事实记录”时,才会有本选项。 因为只有单据才会存在表头和明细表,所以也只有在模块类型为“事实记录”的时候才会有此选项。
=使用主表:表示将会启用对应单据的表头数据。
=明细表1-9:表示将启用对应单据的明细数据。
时间类型 表示前台工具条上的时间类型。 表示时间类型分为:年、季度、月、日、钟点,显示的数据会根据时间类型来汇总显示。
时间列 表示对应查询的时间指定列。 表示这个查询显示,是根据单据中的哪个时间字段来查询显示的。
视图号 表示具体使用的是指定内容NameKey的哪一个视图。 表示档案和事实记录都存在多个视图,不同的视图用于不同的场景,模块中需要指定使用哪个视图来作为查询显示的最终数据。
查询KPI 表示使用全局KPI查询返回一个值。 表示如果这里使用了全局KPI,前台在每次进入到这个模块的时候,系统都会实时计算,然后返回指定的列值。
内部页TableID/外部页网址 表示内部页/外部页的唯一标识。 =内部页TableID:表示在整个系统的所有内部页项之间必须是唯一的。
=外部页网址:表示在整个系统的所有外部页项之间必须是唯一的。
注:仅针对模块类型为内部页/外部页有意义。
是否显示单据号 表示系统中自带的单据号。 =显示:表示前台模块会自动显示系统单据号这一个列,不需要另外取值单据号的配置。
=不显示:表示前台模块不显示这个系统单据号。
注:这个单据号显示仅针对事实表模块有意义。
编辑属性
允许新增 指前台是否存在“新增”这个按钮。 =否:表示前台不会出现“新增”这个按钮。
=是:表示前台有新增按钮,点击新增会弹出新增的表格。
=是,直接新增行:表示前台有“新增”按钮,点击新增会直接增加一行记录。
=是,批量新增:表示前台有“新增”按钮,配置根据那个列来批量新增。点击新增会弹出新增表格,并允许勾选多个记录,并同时插入选定的行记录。
允许修改 指前台是否存在“编辑”这个按钮。 =否:表示前台不会出现“编辑”这个按钮。
=是:表示前台有“编辑”按钮,点击编辑按钮,会弹出这个可编辑的表格,可以对表格的字段进行编辑或修改。
=是,仅表上修改:表示前台没有“编辑”按钮,可以直接在表格上修改,但是这个修改前提是这个字段上要有“表外编辑”的配置。
允许删除 指前台是否存在“删除”这个按钮。 =否:表示前台不会出现“删除”按钮。
=是:表示前台有“删除”按钮,选中目标后,点击删除按钮,可以直接删除选中记录。
允许导入 指前台是否存在“导入”这个按钮。 =否:表示前台不会出现“导入”按钮。
=是:表示前台有“导入”按钮,可以直接将准备好的excel表格导入到系统中,导入的时候需要遵守导入规则。
允许导出 指前台是否存在“导出”这个按钮。 =否:表示前台不会出现“导出”按钮。
=是:表示前台有“导出”按钮,点击“导出”按钮,可以直接从系统中导出一张excel表格,导出表格可以存为模板,以供导入的时候作为参考模板。导出的时候可以选中全部字段的导出或者导出指定的一些字段。
锁死列 表示满足某个条件锁定整行记录。 表示配置对应的sql条件,当满足这个公式条件的时候锁定整行记录。
注:锁死列仅对事实表有意义。
工具条参数 表示前台显示的查询按钮。 表示前台的查询按钮可以有多个,根据需求而定,每个查询按钮都需要在后台配置。现有的参数类型:有模糊查询,按档案筛选,简单选项,界面勾选,时间天数。
=模糊查询:表示选择全模糊查询,查询结果就是包含用户输入的信息的所有结果。
=按档案筛选:表示填写档案/单据中的档案内部字段,并选择正确的查询对象、查询节点(叶子节点还是父节点)和汇总查询(汇总/不汇总)。
=简单选项:表示填写档案/单据中的简单选项内部字段,并插入选项(1表示未指定(即全部),其他为选项键值)。
=界面勾选:表示填写档案/单据中的界面勾选内部字段,并插入选项(1表示选中,0表示未选中,2表示全部)。
=时间天数:表示填写档案/单据中的时间内部字段(可以是本表也可以是关联表中的字段),并插入选项(填写时间范围)。
数据筛选参数 表示限定前台查看模块的范围。 表示通过不同的条件类型的sql语句,来限定前台查看模块的范围。条件类型现有:SQL,等于,不等于,大于等于,小于等于,in,like. 利用这些条件类型来编写适合的sql语句。
批量编辑参数 表示前台显示“批量编辑”的按钮。 表示后台通过不同的编辑模式配置,前台点击这个“批量编辑”按钮,就可以对选中的记录行进行批量的修改和调整了。当前后台的编辑模式有:用户填写和取固定值两种。
导入模版参数 表示利用“锁定记录字段”对导入表进行控制。 表示后台配置“锁定记录字段”,前台针对锁定记录字段的判断行为是,
1.如果锁定记录字段都相同,则系统只需要修改原有表格中不同的数据参数(导入表和原表格中存在差异的地方)。
2.如果锁定记录字段任何一个字段不同,系统则认为是一个新的数据,会自动在原有表格上增加记录行。
多级表头参数 表示针对表格的表头做合并表头处理,层次、范围划分更明确。 表示通过后台参数配置(需要配置目标开始字段,跨越列数以及显示名称,可以有插入多个列属性配置)。前台效果就类似于excel表格中,针对列进行的合并单元格。
加载自定义脚本 表示前台显示的是一个动作按钮。 表示事先编辑好自定义脚本,然后通过这里的参数配置,使前台的动作按钮在点击的时候自动执行这个脚本定义的程序内容。
批量加载列 表示批量新增时需要绑定的字段。 表示在批量新增的时候需要指定以哪个列来批量处理。注:批量加载列,仅对允许新增行为“批量新增”时有意义。
显示属性
左侧栏显示 表示模块是否在左侧栏显示。 =勾选:表示该模块会在左侧栏下显示,但是必须填写左侧栏NameKey。
=不勾选:表示该模块不会在左侧栏显示,隐藏。
左侧栏NameKey 表示在勾选了显示左侧栏时填写。 表示因为左侧栏的NameKey是左侧栏的唯一英文标识,所以这里只能填写对应左侧栏NameKey。 注:仅对勾选左侧栏显示时有意义。
左侧栏顺序 表示左侧栏显示前后顺序。 表示显示顺序可以根据实际需求调整。
排序列 表示根据档案/事实表中哪个字段进行排序。 表示具体填写档案/事实表中排序字段的内部字段,只能有一个。排序字段可以根据实际需求填写。
排序方式 表示模块在前台的排序方式。 =倒序(desc):表示从大到小排序。
=顺序(asc):表示从小到大排序。
=未指定:表示系统自动排序,没有指定列。
移动端启用 表示模块是否在移动端启用。 =勾选:表示允许移动端同步启用。
=不勾选:表示移动端不启用。
注:一般用户不启用的情况下,移动端也不能勾选启用的。