diff --git a/src/pages/docs/metadata-object.mdx b/src/pages/docs/metadata-object.mdx index e03abc4..ff8267f 100644 --- a/src/pages/docs/metadata-object.mdx +++ b/src/pages/docs/metadata-object.mdx @@ -185,71 +185,3 @@ summary_type: sum - **formula_blank_value**: zeroes表示将空白字段视为零,blanks表示将空白字段视为空白,默认为zeroes 。 - **write_requires_master_read**: 此字段仅适用于master_detail字段类型。true--允许具有'读取'访问权限的用户创建、编辑或删除子记录。false = 允许具有'读取/写入'访问权限的用户创建、编辑或删除子记录的权限。此设置比 true 更严格,并且是默认值。 - -## 列表视图 .listview.yml - -定义对象的列表显示,包括:显示的列、过滤条件、排序规则、默认搜索字段。 - -```yaml -name: all -label: 所有合同 -columns: - - field: 'no' - width: '150' - wrap: true - - field: name - width: '220' - wrap: true - - field: contract_type - width: '150' - wrap: true - - field: amount - width: '150' - wrap: true - - field: signed_date - width: '150' - wrap: false - - field: owner - width: '150' - wrap: false - - field: created - width: '150' - wrap: false -filter_fields: - - contract_type - - signed_date - - othercompany - - instance_state - - owner -filter_scope: space -filters: - - is_default: true - field: instance_state - operation: <> - value: - - terminated - is_required: false -shared: true -show_count: false -sort: - - field_name: 'no' - order: desc -``` - -| 属性名 | 属性值类型 | 属性含义 | -|----|----|----| -| name | string | API 名称 | -| label | string | 视图显示名称 | -| type | string | 列表显示类型,默认为grid | -| filter_scope | string | 范围 | -| columns | array | 列表显示的字段 | -| mobile_columns | array | 手机模式下列表显示的字段 | -| extra_columns | array | 额外在列表显示的字段 | -| sort | array | 排序 | -| filters | array, string | 过滤条件 | -| filter_fields | array | 过滤的字段 | -| sort_no | number | 显示顺序,从小到大 | -| options | object | 额外选项 | -| show_count | boolean | 显示条目数 | -| shared | boolean | 是否共享 | -| scrolling_mode | string | 滚动条样式 | \ No newline at end of file diff --git a/src/pages/docs/metadata-ui.mdx b/src/pages/docs/metadata-ui.mdx index dafe3d0..4adc7b2 100644 --- a/src/pages/docs/metadata-ui.mdx +++ b/src/pages/docs/metadata-ui.mdx @@ -11,4 +11,208 @@ description: 定义界面相关元数据 - 页面布局 - 自定义按钮 - 自定义记录详情页 -- 自定义微页面 \ No newline at end of file +- 自定义微页面 + +## 应用 +### 应用 .app.yml +可以设置应用的名称、显示名称、应用图标,以及在应用中显示的对象、选项卡清单。 +```yaml +name: 合同 +code: contracts +description: 管理合同及收付款。 +icon_slds: contract_line_item +mobile: true +mobile_objects: + - contracts + - finance_invoice + - finance_receive + - finance_receipt + - finance_payment + - contract_types +oauth2_enabled: false +oauth2_logout_enabled: false +objects: + - contracts + - finance_invoice + - finance_receive + - finance_receipt + - finance_payment + - contract_types +saml_enabled: false +saml_logout_enabled: false +sort: 50 +tabs: + - contract_analysis +visible: true +``` +### 应用属性 +| 属性名 | 属性值类型 | 属性含义 | +|----|----|----| +| _id | string | 应用的唯一标识。 | +| url | string | 应用地址 | +| name | string | 应用显示名称。 | +| code | string | 应用的唯一标识。 | +| description | string | 应用描述。 | +| icon | string | 应用图标。 | +| icon_slds | string | 应用图标。 | +| sort | number | 排序 | +| tabs | array | 用于指定此应用下的选项卡 | +| objects | array | 用于指定此应用下有多少对象。 | +| mobile_objects | array | 用于指定此应用在手机上显示的对象。 | +| admin_menus | array | 管理员菜单 | +| visible | boolean | 启用 | +| is_new_window | boolean | 新窗口打开 | +| mobile | boolean | 在手机端显示 | +| oauth2_enabled | boolean | 启用OAuth2认证 | +| oauth2_logout_enabled | boolean | 启用OAuth2单点注销 | +| saml_enabled | boolean | 启用SAML | +| saml_logout_enabled | boolean | 启用SAML单点注销 | +| is_use_iframe | boolean | 使用iframe打开 | +| is_use_ie | boolean | 使用IE打开(需使用Steedos桌面客户端) | + + +## 选项卡 +### 选项卡.tab.yml +选项卡可以绑定到一个对象,也可以绑定到一个网址或是自定义页面。 +```yaml +name: contract_analysis +desktop: true +icon: dashboard +label: 合同分析 +mobile: true +page: contract_analysis +type: page +``` +### 选项卡属性 +| 属性名 | 属性值类型 | 属性含义 | +|----|----|----| +| label | string | 显示名称 | +| name | string | API 名称 | +| icon | string | 图标 | +| parent | string | 上级选项卡 | +| type | string | 类型 | +| mobile | boolean | 显示在手机菜单中 | +| desktop | boolean | 显示在桌面菜单中 | +| frame_height | number | 选项卡框架的高度 | +| has_sidebar | boolean | 显示侧边栏面板 | +| object | string | 对象 | +| url | string | 外部链接 | +| is_new_window | boolean | 在新窗口打开 | +| page | string | 页面 | +| action_overrides | string | 分配给选项卡的操作替代列表 | +| description | string | 描述 | +| is_system | boolean | 系统 | + +## 列表视图 +### 列表视图.listview.yml +定义对象的列表显示,包括:显示的列、过滤条件、排序规则、默认搜索字段。 +```yaml +name: all +label: 所有合同 +columns: + - field: 'no' + width: '150' + wrap: true + - field: name + width: '220' + wrap: true + - field: contract_type + width: '150' + wrap: true + - field: amount + width: '150' + wrap: true + - field: signed_date + width: '150' + wrap: false + - field: owner + width: '150' + wrap: false + - field: created + width: '150' + wrap: false +filter_fields: + - contract_type + - signed_date + - othercompany + - instance_state + - owner +filter_scope: space +filters: + - is_default: true + field: instance_state + operation: <> + value: + - terminated + is_required: false +shared: true +show_count: false +sort: + - field_name: 'no' + order: desc +``` +### 列表视图属性 +| 属性名 | 属性值类型 | 属性含义 | +|----|----|----| +| name | string | API 名称 | +| label | string | 视图显示名称 | +| type | string | 列表显示类型,默认为grid | +| filter_scope | string | 范围 | +| columns | array | 列表显示的字段 | +| mobile_columns | array | 手机模式下列表显示的字段 | +| extra_columns | array | 额外在列表显示的字段 | +| sort | array | 排序 | +| filters | array, string | 过滤条件 | +| filter_fields | array | 过滤的字段 | +| sort_no | number | 显示顺序,从小到大 | +| options | object | 额外选项 | +| show_count | boolean | 显示条目数 | +| shared | boolean | 是否共享 | +| scrolling_mode | string | 滚动条样式 | + +## 页面布局 +### 对象名.页面布局.layout.yml +定义对象的记录显示,包括:所属简档、操作按钮、显示的字段、相关子表。 +``` +name: customer +buttons: + - button_name: standard_new + - button_name: standard_edit + - button_name: standard_delete +fields: + - field_name: name + is_required: true + - field_name: start + - field_name: end +label: 客户 +object_name: events +profiles: + - customer +related_lists: + - related_field_fullname: tasks.related_to + field_names: + - name + - due_date + - state + - priority + - assignees + - related_to + sort_order: asc + page_size: 5 +type: record +``` +### 页面布局属性 +| 属性名 | 属性值类型 | 属性含义 | +|----|----|----| +| name | string | API 名称 | +| label | string | 页面布局名 | +| object_name | string | 对象 | +| profiles | array | 简档 | +| buttons | grid | 操作按钮 | +| fields | grid | 字段 | +| related_lists | grid | 相关子表 | + +## 自定义按钮 + +## 自定义记录详情页 +## 自定义微页面 \ No newline at end of file diff --git a/src/pages/docs/overview.mdx b/src/pages/docs/overview.mdx index 1b1598a..71d4e59 100644 --- a/src/pages/docs/overview.mdx +++ b/src/pages/docs/overview.mdx @@ -13,13 +13,13 @@ import SteedosPackages from './diagrams/Steedos Packages.drawio.svg' 本协议是低代码平台的底层协议,需遵循以下原则。 -- 微内核设计,内核只包含三个核心微服务: +- 微内核设计,内核只包含三个核心微服务。核心微服务可以使用任何语言实现。 - [软件包服务](./service-package) - [Metadata 服务](./service-metadata) - [Records 服务](./service-records) -- 与开发语言无关,可以使用任何语言实现以上三个微内核。 -- 设计一套 [数据源](./datasource) 模型,内核不依赖具体的数据库。 -- 通过插件形式扩展元数据的能力,例如接入多种报表引擎、流程引擎。 +- 插件式扩展,除核心微服务外,其他功能均以插件形式叠加。 + - 基于 [数据源](./datasource) 模型,编写驱动支持不同类型的数据库。 + - 通过插件形式扩展元数据的能力,接入多种页面引擎、报表引擎、流程引擎。 ## DevOps流程 diff --git a/src/pages/docs/permissions.mdx b/src/pages/docs/permissions.mdx index 047c472..88cb771 100644 --- a/src/pages/docs/permissions.mdx +++ b/src/pages/docs/permissions.mdx @@ -36,7 +36,7 @@ import SteedosPermissions from './diagrams/Steedos Permissions.drawio.svg' 当内置简档不够用时,可以在软件包中自定义简档/权限集。并设定好对应的权限。项目实施时,只需要为简档/权限集设置具体的人员就可以。 - 定义简档类型元数据(.profile.yml),增加自定义简档。 -- 定义权限集类型元数据(.permission_set.yml),增加自定义权限集。 +- 定义权限集类型元数据(.permissionset.yml),增加自定义权限集。 ## 记录查看权限