Merge branch 'main' of https://github.com/steedos/low-code-protocol

src/pages/docs/formular.mdx

@@ -1,6 +1,6 @@
 ---
 title: 公式
-description: 公式引擎可以帮助非程序员快速实现一些简单的业务逻辑，类似Excel公式。
+description: 公式引擎可以帮助非程序员快速实现一些简单的业务逻辑，类似Excel公式，它是从其他字段、表达式或值派生其值的一种算法，可以帮助您根据其他字段自动计算一个字段的值。
 ---
 
 ## 公式实例

src/pages/docs/metadata-field-type.mdx

@@ -3,24 +3,25 @@ title: 字段类型
 description: 低代码平台基础字段类型、属性与功能描述。
 ---
 
- - 文本(text)：文字说明。
- - 长文本(textarea)：可输入多段文字说明。
- - HTML文本(html)：超文本标记语言，页面内可包含图片、链接等。
- - 选择框(select)：界面生成下拉框供用户选择，允许多选。
- - 复选框(boolean)：界面生成勾选框，勾上即可用。
- - 开关(toggle)：开启和关闭两种状态。
- - 日期(date)：用户可以选择时间(年--月--日)。
- - 日期时间(datetime)：用户可以选择更加具体的时间(年--月--日 时--分)。
- - 数值(number)：只能输入数值内容，可以指定小数位，默认保留2位小数。
- - 金额(currency)：类似数值字段类型，默认保留2位小数。
- - 百分比(password)：类似数值字段类型，提供百分比的显示方式。
- - 密码(password)：密码输入框。
- - 相关表(lookup)：引用其他对象，数据从关联表中选择，支持多选功能。
- - 主表/子表(master_detail)：主表子表字段类型是相关表的一种扩展，将当前记录链接到主表成为子记录。
- - 自动编号(autonumber)：由用户设置公式，设置后无需手动输入，由系统直接生成编号。
- - 网址(url)：在只读时，点击会以窗口形式打开相应的网址。
- - 邮件地址(email)：系统会校验邮件格式是否合法，点击会自动打开邮件客户端，并将字段值带入收件人中。
- - 图片(image)：图片上传及预览。
- - 附件(file)：图片、文档等上传及下载。
- - 公式(formula)：公式是通过用户定义的算法自动计算字段的值，系统会根据不同的数据类型来进行整合，取字段的时候要用“{ }”将字段名括起来，如：{字段1}+{字段2}。对于自动计算值的自定义公式字段，可以设置其字段类型为公式字段(formula)，并设置返回值类型和计算公式。如此设置后，这个字段无需用户手动输入，由系统自动计算得出值。有关具体如何使用及示例请参考如何构建公式字段。
- - 累积汇总(summary)：华炎魔方中目前支持五种汇总计算，分别是求和(sum)、求平均值（avg）、统计(count)、最大值(max)、最小值(min)。用户可以定义子表中的某个字段值，在主表中显示汇总值。累计汇总字段会计算相关记录中的值，例如统计子表中的数据。您可以创建累计汇总字段，它可根据某个子表中的字段值，在主表中显示汇总值。有关具体如何使用及示例请参考累积汇总的使用。
+## 字段类型介绍
+ - **文本(text)**：文字说明。
+ - **长文本(textarea)**：可输入多段文字说明。
+ - **HTML文本(html)**：超文本标记语言，页面内可包含图片、链接等。
+ - **选择框(select)**：界面生成下拉框供用户选择，允许多选。
+ - **复选框(boolean)**：界面生成勾选框，勾上即可用。
+ - **开关(toggle)**：开启和关闭两种状态。
+ - **日期(date)**：用户可以选择时间(年--月--日)。
+ - **日期时间(datetime)**：用户可以选择更加具体的时间(年--月--日 时--分)。
+ - **数值(number)**：只能输入数值内容，可以指定小数位，默认保留2位小数。
+ - **金额(currency)**：类似数值字段类型，默认保留2位小数。
+ - **百分比(password)**：类似数值字段类型，提供百分比的显示方式。
+ - **密码(password)**：密码输入框。
+ - **相关表(lookup)**：引用其他对象，数据从关联表中选择，支持多选功能。
+ - **主表/子表(master_detail)**：主表子表字段类型是相关表的一种扩展，将当前记录链接到主表成为子记录。
+ - **自动编号(autonumber)**：由用户设置公式，设置后无需手动输入，由系统直接生成编号。
+ - **网址(url)**：在只读时，点击会以窗口形式打开相应的网址。
+ - **邮件地址(email)**：系统会校验邮件格式是否合法，点击会自动打开邮件客户端，并将字段值带入收件人中。
+ - **图片(image)**：图片上传及预览。
+ - **附件(file)**：图片、文档等上传及下载。
+ - **公式(formula)**：公式是通过用户定义的算法自动计算字段的值，系统会根据不同的数据类型来进行整合，取字段的时候要用“{ }”将字段名括起来，如：{字段1}+{字段2}。对于自动计算值的自定义公式字段，可以设置其字段类型为公式字段(formula)，并设置返回值类型和计算公式。如此设置后，这个字段无需用户手动输入，由系统自动计算得出值。有关具体如何使用及示例请参考如何构建公式字段。
+ - **累积汇总(summary)**：目前支持五种汇总计算，分别是求和(sum)、求平均值（avg）、统计(count)、最大值(max)、最小值(min)。用户可以定义子表中的某个字段值，在主表中显示汇总值。累计汇总字段会计算相关记录中的值，例如统计子表中的数据。您可以创建累计汇总字段，它可根据某个子表中的字段值，在主表中显示汇总值。有关具体如何使用及示例请参考累积汇总的使用。

src/pages/docs/metadata-permissions.mdx

@@ -4,11 +4,63 @@ description: 定义权限相关元数据
 ---
 
 
-## 概览
-
-- 简档
-- 权限集
-- 对象权限
-- 字段权限
-- 限制规则
-- 共享规则
+## 简档 .profile.yml
+
+简档只约定了一个名称，定义了简档之后，就可以在对象权限中定义此简档对具体对象的访问权限。
+
+一个用户只能属于一个简档。元数据中不能指定具体用户的具体简档。系统管理员可以在用户管理界面中设置用户的简档。
+
+系统有4个默认简档：
+
+* admin： 系统管理员，默认对所有对象有最高权限
+* user： 普通用户，通常对大部分对象拥有增删改权限
+* customer： 外部客户，默认无权限
+* supplier： 外部供应商，默认无权限
+
+```yaml
+name: user
+license: platform
+```
+
+## 权限集 .permissionset.yml
+
+权限集只约定了一个名称，定义了权限集之后，就可以在对象权限中定义此权限集对具体对象的访问权限。
+
+一个用户可以拥有多个权限集，最终权限为叠加之后的结果。
+
+元数据中未约定权限集并未绑定到具体用户，系统管理员可以在设置界面中配置适用此权限集的用户清单。
+
+```yaml
+name: contract_manager
+label: 合同管理员
+type: permission_set
+```
+
+## 对象权限 .permission.yml
+
+设定某一个简档（或权限集）对当前对象的访问权限。
+
+```yaml
+name: 合同.用户
+allowCreate: true
+allowDelete: true
+allowEdit: true
+allowRead: true
+modifyAllRecords: false
+modifyCompanyRecords: false
+permission_set_id: user
+viewAllRecords: false
+viewCompanyRecords: false
+```
+
+## 字段权限
+
+设定某一个简档（或权限集）对当前对象下的字段的访问权限。
+
+## 限制规则
+
+在对象上配置限制规则来收缩用户对业务对象记录级的查看权限，该规则并不是基于简档（或权限集）来配置，但是可以在指定条目条件中判断当前用户所属简档（或权限集）。
+
+## 共享规则
+
+在对象上配置共享规则来放大用户对业务对象记录级的查看权限，该规则并不是基于简档（或权限集）来配置，但是可以在指定条目条件中判断当前用户所属简档（或权限集）。

src/pages/docs/metadata.mdx

@@ -19,8 +19,8 @@ import SteedosMetadata from './diagrams/Steedos Metadata.drawio.svg'
 
 ### 对象元数据
 
-- 对象
-- 字段
+- [对象](/docs/metadata-object)
+- [字段](/docs/metadata-object#字段%20.field.yml)
 
 
 ### 界面元数据

src/pages/docs/permissions.mdx

@@ -23,10 +23,14 @@ import SteedosPermissions from './diagrams/Steedos Permissions.drawio.svg'
 
 - admin 管理员
 - user 用户
-- organization_admin 分部管理员
 - customer 客户
 - supplier 供应商
 
+### 内置权限集
+
+- organization_admin 分部管理员
+- workflow_admin 流程管理员
+
 ### 自定义简档/权限集
 
 当内置简档不够用时，可以在软件包中自定义简档/权限集。并设定好对应的权限。项目实施时，只需要为简档/权限集设置具体的人员就可以。
@@ -40,7 +44,7 @@ import SteedosPermissions from './diagrams/Steedos Permissions.drawio.svg'
 
 ### 查看我的记录
 
-对象中的每一条记录都默认有一个 owner 字段，代表记录所有者。当用户拥有指定对象 `我的记录` 权限时，表示用户可以访问指定对象中，所有 `owner = ${currentUserId}` 的记录。
+对象中的每一条记录都默认有一个 owner 字段，代表记录所有者。当用户拥有指定对象 `允许查看` 权限时，表示用户可以访问指定对象中，所有 `owner = ${currentUserId}` 的记录。
 
 ### 查看分部记录