项目详情配置
项目详情配置主要用于配置项目详情页显示的模块
可根据实际分类情况,可以自定义创建不同的项目详情模板
展示
配置展示
效果展示
配置说明
主要分为三部分,配置的先后顺序为最终呈现的先后顺序
config
"config":{ "enable_share":true }
main_col
对应中间主体内容
type对应关系
type 对应的组件 使用方向 预览 编辑或其它操作 project-info ProjectInfo 展示基本信息 meta-form MetaForm 项目信息 finance Finance 财务信息 project-list ProjectList 发票申请 发起流程 customer-binding CustomerBinding 客户绑定情况 生成绑定码 comment-list CommentList 评论 发布评论 代码:
{ "type":"project-info", // 类型 "title":"基本信息", // 标题 "config":{ // 具体config配置详见对应的示例代码 } }
side_col 对应侧边目录
type对应关系如下:
type 对应组件 使用方向 预览 编辑或其它操作 step-log StepLog 流程日志 环节上的操作 attachment-list AttachmentList 附件 点击查看附件 CustomFormList CustomFormList 表单 project-list ProjectList 子流程 发起子流程 代码:
{ "type":"project-list", // 类型 "title":"子流程", // 标题 "config":{ // 具体config配置详见对应的示例代码 "flow_key":"" } }
示例代码
{
"config":{
"enable_share":true
},
"main_col":[
{
"type":"project-info",
"title":"基本信息",
"config":{
// "showProjectMsgBtn": false // 是否显示查看详情按钮
}
},
{
"type":"meta-form",
"title":"项目信息",
"config":{ // 不用配置
}
},
{
"type":"finance",
"title":"财务信息",
"permission":"finance.list",
"config":{ // 不用配置
}
},
{
"type":"project-list",
"title":"发票申请",
"config":{
"flow_key":"flow233810562", // 环节key值
"btn_text":"发起申请", // 按钮文本
"format":"table", // 展示类型,以表格的形式
"template_id":"672890427" // 模板id
}
},
{
"type":"project-list",
"title":"子业务项目",
"config":{
"flow_key":"flow744083397", // 环节key值
"btn_text":"创建项目", // 按钮文本
"format":"table", // 展示类型,以表格的形式
"template_id":"" // 模板id
}
},
{
"type":"customer-binding",
"title":"客户绑定情况",
"config":{ // 无
"fields":{
}
}
},
{
"type":"delay-reason",
"title":"逾期原因",
"config":{
"fields":{
"flowKey":"flow553651588",
// "btn_text":"xxxx", // 按钮文本
// "table_template":"xxxx", // table模板
}
}
},
{
"type":"comment-list",
"title":"评论",
"config":{ // 无
}
}],
"side_col":[
{
"type":"step-log",
"title":"流程日志",
"config":{
"fields":{
// "showEdit": false, // 是否显示编辑按钮
// "showEnterStep" // 是否显示进行下一步按钮
}
}
},
{
"type":"attachment-list",
"title":"附件",
"config":{ // 无
"fields":{
}
}
},
{
"title":"表单",
"type":"CustomFormList",
"config":{ // 无
}
},
{
"type":"project-list",
"title":"子流程",
"config":{
"flow_key":"" // 如上 "type": "project-list"
}
}]
}
模块配置说明
目录
- 模块配置说明
- 目录
- 项目基本信息
ProjectInfo
- 项目列表(子流程项目列表)
ProjectList
- 项目日志
StepLog
- 项目表单信息
MetaForm
- 项目表单信息
StepForm
- 财务模块
Finance
- 评论模块
CommentList
- 附件模块
AttachmentList
- 客户绑定码模块
CustomerBinding
- 环节配置模块
StepArrange
- 显示阶段进度
Periods
- 显示周期生成项目信息
AutoReplayInfo
- 传阅模块
Circulate
- 延期原因
DelayReason
- 生成报告
GenerateReport
- 项目详情面板
ProjectDetailPanel
- 项目元信息
ProjectMetaInfo
- 项目重启
ProjectReopen
项目基本信息 ProjectInfo
功能说明:展示和编辑项目的基本信息,包括项目名称、负责人、说明、开始时间、计划完成时间等。支持根据角色和环节控制编辑权限。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
showProjectMsgBtn | Boolean | 是否显示查看更多按钮 |
canEditUserRolesKey | Array | 可编辑的用户角色key |
canEditStepIdAfter | Array | 可编辑的环节ID(之后) |
canEditUserIdsAfter | Array | 可编辑的用户ID(之后) |
canEditStepIdBefore | Array | 可编辑的环节ID(之前) |
canEditUserIdsBefore | Array | 可编辑的用户ID(之前) |
editable | Boolean | 是否可编辑 |
editonly | Boolean | 是否仅编辑模式 |
parentEditable | Boolean | 父组件是否可编辑 |
示例:
{
"type": "project-info",
"title": "基本信息",
"config": {
"showProjectMsgBtn": true,
"canEditUserRolesKey": ["admin"],
"canEditStepIdAfter": ["1", "2"],
"canEditUserIdsAfter": ["1", "2"],
"canEditStepIdBefore": ["3", "4"],
"canEditUserIdsBefore": ["3", "4"],
"editable": true,
"editonly": false,
"parentEditable": true
}
}
项目列表(子流程项目列表)ProjectList
功能说明:展示项目关联的子流程项目列表。支持表格和列表两种展示模式,可配置是否显示创建按钮、筛选功能等。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
mode | String | normal(默认)或project(项目页模式,有更多的功能,使用ES数据源) |
flow_type | String | 流程type |
flow_key | String | 子流程key |
btn_text | String | 按钮文案 |
disable_add | Boolean | 隐藏normal模式的添加按钮 |
format | String | 如果值为table,则以列表模式展示 |
template_id | String | 要使用的模板ID |
growY | Boolean | 是否自适应高度 |
table_template | Object | 表格模板配置 |
mode为project参数:
参数名 | 数据类型 | 说明 |
---|---|---|
disableSearch | Boolean | 隐藏筛选功能 |
disableCreate | Boolean | 隐藏创建功能 |
disableFilter | Boolean | 隐藏功能条 |
emptyText | String | 空白时的文案 |
query | Object | 查询逻辑,见示例 |
示例:
{
"type": "project-list",
"title": "子流程",
"config": {
"mode": "normal",
"flow_key": "",
"flow_type":"flow727052674",
"disableSearch":true,
"disableCreate":true,
"disableFilter":false,
"emptyText":"暂无记录",
"growY": true,
"query":{
"__p_id":{
"value":{
"$template":"ctx.$route.params.id",
"eval":true
},
"type":"term"
}
}
}
}
项目日志 StepLog
功能说明:展示项目各环节的执行日志,包括环节状态、处理人、处理时间等信息。可配置是否显示编辑和进入环节按钮。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
showEdit | Boolean | 是否显示编辑按钮 |
showEnterStep | Boolean | 是否显示进入环节按钮 |
isLoading | Boolean | 是否加载中 |
示例:
{
"type": "step-log",
"title": "项目日志",
"config": {
"showEdit": true,
"showEnterStep": true,
"isLoading": false
}
}
项目表单信息 MetaForm
功能说明:展示和编辑项目的自定义表单信息。支持只读模式和编辑模式,可用于收集项目相关的结构化数据。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
readonly | Boolean | 是否只读 |
editonly | Boolean | 是否仅编辑模式 |
示例:
{
"type": "meta-form",
"title": "项目表单信息",
"config": {
"readonly": false,
"editonly": false
}
}
项目表单信息 StepForm
功能说明:展示指定环节的表单信息。用于查看环节处理过程中填写的表单数据。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
flow_step_id | String | 环节ID |
示例:
{
"type": "step-form",
"title": "环节表单信息",
"config": {
"flow_step_id": ""
}
}
财务模块 Finance
功能说明:管理项目相关的财务信息,包括合同金额、收款记录、支出记录等。支持根据角色和环节控制编辑权限。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
canEditUserRolesKey | Array | 可编辑的用户角色key |
canEditStepIdAfter | Array | 可编辑的环节ID(之后) |
canEditUserIdsAfter | Array | 可编辑的用户ID(之后) |
canEditStepIdBefore | Array | 可编辑的环节ID(之前) |
canEditUserIdsBefore | Array | 可编辑的用户ID(之前) |
示例:
{
"type": "finance",
"title": "财务信息",
"config": {
"canEditUserRolesKey": ["admin"],
"canEditStepIdAfter": ["1", "2"],
"canEditUserIdsAfter": ["1", "2"],
"canEditStepIdBefore": ["3", "4"],
"canEditUserIdsBefore": ["3", "4"]
}
}
评论模块 CommentList
功能说明:展示项目相关的评论记录,支持用户添加新的评论,实现项目相关人员的交流讨论。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
无 |
示例:
{
"type": "comment-list",
"title": "评论模块",
"config": {
}
}
附件模块 AttachmentList
功能说明:管理项目相关的附件文件,支持按环节分类展示附件,并可查看历史版本。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
enableChoose | Boolean | 是否启用选择模式 |
list | Array | 附件列表 |
示例:
{
"type": "attachment-list",
"title": "附件模块",
"config": {
"enableChoose": false,
"list": []
}
}
客户绑定码模块 CustomerBinding
功能说明:生成和管理项目的客户绑定码,用于将项目与客户关联。支持查看绑定状态和过期状态。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
无 |
示例:
{
"type": "customer-binding",
"title": "绑定码模块",
"config": {
}
}
环节配置模块 StepArrange
功能说明:配置项目环节的处理人员,支持根据项目表单值动态分配环节处理人。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
无 |
示例:
{
"type": "step-arrange",
"title": "环节配置模块",
"config": {
}
}
显示阶段进度 Periods
功能说明:以时间轴的形式展示项目各阶段的进度状态,支持通过过滤条件控制显示的阶段。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
filter | String | 过滤条件表达式 |
示例:
{
"type": "periods",
"title": "显示阶段进度",
"config": {
"filter": "return true"
}
}
显示周期生成项目信息 AutoReplayInfo
功能说明:展示和配置项目的自动生成规则,用于设置定时任务自动创建子项目。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
readonly | Boolean | 是否只读模式 |
示例:
{
"type": "auto-replay-info",
"title": "显示阶段进度",
"config": {
"readonly": false
}
}
传阅模块 Circulate
功能说明:管理项目的传阅记录,支持选择传阅对象并添加传阅说明,实现项目信息的知会传达。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
无 |
示例:
{
"type": "circulate",
"title": "传阅记录",
"config": {
}
}
延期原因 DelayReason
(已弃用)
功能说明:记录和展示项目延期的原因说明,当项目状态为延期时可查看。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
fields.flowKey | String | 流程key |
示例:
{
"type": "delay-reason",
"title": "延期原因",
"config": {
"fields": {
"flowKey": "flow_key"
}
}
}
生成报告 GenerateReport
功能说明:根据配置的模板生成项目报告,支持不同类型流程的报告生成。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
flow_key | String | 流程key |
flow_type | String | 流程类型 |
示例:
{
"type": "generate-report",
"title": "生成报告",
"config": {
"flow_key": "",
"flow_type": ""
}
}
项目详情面板 ProjectDetailPanel
功能说明:展示项目的详细信息面板,可自定义配置展示内容和样式。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
无 |
示例:
{
"type": "project-detail-panel",
"title": "项目详情",
"config": {
}
}
项目元信息 ProjectMetaInfo
功能说明:展示项目的基本信息和自定义表单信息的组合展示,支持侧边栏模式。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
side | Boolean | 是否侧边栏模式 |
示例:
{
"type": "project-meta-info",
"title": "项目元信息",
"config": {
"side": false
}
}
项目重启 ProjectReopen
功能说明:对已结束的项目进行重启操作,仅当项目状态为已结束且有结束环节时可用。
参数:
参数名 | 数据类型 | 说明 |
---|---|---|
无 |
示例:
{
"type": "project-reopen",
"title": "项目重启",
"config": {
}
}