weaver-e10-builder 1.6.12 → 1.6.14

package/skill-docs/references/ebuilder-designer/page-source/sdk-other.md

@@ -0,0 +1,242 @@
+# 其他
+
+ESB、群组、侧栏、截图及运行时布局调整分别使用各自接口。changeComLayout 改变运行时组件位置尺寸，不等于保存设计器布局。截图效果及侧栏行为以目标页面和宿主支持为准。
+
+查询本类接口：`e10-cli designer source sdk --query <方法名>`。
+
+## 接口目录
+
+- `ebSdk.openItemChart(itemData, opts);`：使用此接口可以创建并打开事项群聊
+- `ebSdk.callEsbFlow();`：使用此接口可以调用ESB动作流接口
+- `ebSdk.openHrmCombineResource(onOk, onCancel);`：使用此接口可以打开人员、群组的弹窗或面板
+- `pageSdk.toggleSidebar(options);`：使用此接口可以切换非主面板的左、右、中间分栏进行展开、收缩。
+- `pageSdk.downloadPageWithImage();`：使用此接口可以将页面存为图片
+- `pageSdk.changeComLayout(comId, layout)`：使用此接口可以设置组件位置和高、宽度
+
+## ebSdk.openItemChart(itemData, opts);
+
+使用此接口可以创建并打开事项群聊
+
+### 参数说明
+
+| 参数     | 类型     | 必需 | 说明                                                                   |
+| -------- | -------- | ---- | ---------------------------------------------------------------------- |
+| itemData     | object   | `是` | 详情见示例                                                             |
+| opts | object | `否` | 详情见示例 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+const itemData = {
+  module: 'mainline', // 选填(无appId时必填)：事项所属的模块名称。模块名称取值为：模块名称参数(模块)
+  moduleId: '112', // 选填(无appId时必填)：事项所属模块的类型ID。模块类型id的取值为：模块类型ID(模块)
+  appId: "", // 选填：EB应用id。可通过应用id获取应用的自定义消息模块配置
+  entityId: 'xxx', // 必填：需要创建或打开群聊的事项数据ID
+  // 必填：事项详情
+  entityInfo: {
+    type: 8, // 事项类型为8
+    entityId: "xxx", // 事项ID
+    entityName: "xxx", // 事项名称
+    imType: 111, // im中事项类型标识
+    module: "task", // 事项模块标识
+    ups: {
+      targetId: "xxx"
+    }, // 事项链接参数
+    lt: "1", // PC端打开事项的方式，0表示不需要点击打开，1表示内部组件打开，2表示新窗口打开
+    pu: "/xxx.html", // PC端打开的链接地址，当lt为2时使用
+    ht: "1", // 手机端打开事项的方式，0表示不需要点击打开，1表示新窗口打开，2表示系统默认浏览器打开
+    hu: "/xxx.html", // 手机端打开的链接地址
+    dsc: {
+      id18n: "110324",
+      kvs:{"%NAME%":"张三", "%UNUM%":"3"},
+      jvs:{
+        "%NAME%":{ c: "资源ID_1", u: "资源ID_2" }
+      },
+      v: "召集人：张三 | 参与人: 3人",
+    }, //描述信息，比如视频会议消息显示召集人、参与人个数等
+    sps:{
+      "xxx":"xxx"
+    } // 事项共享参数，即里面的参数值将传递给共享接口http://192.168.1.241:8076/web/#/3?page_id=710
+  },
+}
+
+const opts = {
+  name: 'xxx', // 选填：事项名称，将作为事项群名称使用
+  onCreateEntityGroupSuccess: (res) => {}, // 选填：创建群聊成功回调（仅在该群聊不存在时触发）
+  onCreateEntityGroupFail: (error) => {}, // 选填：创建群聊失败回调（仅在该群聊不存在时触发）
+  onJoinEntityGroupSuccess: (res) => {}, // 选填：加入群聊成功回调（仅在该群聊已存在但未加入时触发）
+  onJoinEntityGroupFail: (error) => {}, // 选填：加入群聊失败回调（仅在该群聊已存在但未加入时触发）
+  onOpenChatSuccess: (res) => {}, // 选填：打开群聊成功回调（仅在该群聊已存在且加入时触发）
+  onOpenChatFail: (error) => {}, // 选填：打开群聊失败回调（仅在该群聊已存在且加入时触发）
+}
+
+ebSdk.openItemChart(itemData, opts);
+```
+
+## ebSdk.callEsbFlow();
+
+使用此接口可以调用ESB动作流接口
+
+### 参数说明
+
+| 参数 | 类型   | 必需 | 说明                                         |
+| ---- | ------ | ---- | -------------------------------------------- |
+| esbFlowId  | string | `是` | 动作流Id                                 |
+| mainParams | object | `否` | 主表参数 |
+| detailParams | Array | `否` | 明细参数,根据数组下标来表示是明细1还是2等等 |
+
+### 返回值
+
+返回Promise对象
+
+### 示例
+
+```javascript
+const mainParams = {
+	name: "张三",
+	sex: "男",
+	idCardNumber: "资源ID_3"
+}
+const detailParams = [
+	[
+		{
+			learningExperience: "1996/09/01-1999/07/30就读于清华大学附属中学-初中部"
+		}
+	], //明细1
+	[
+		{
+			learningExperience: "1999/09/01-2002/07/30就读于清华大学附属中学-高中部"
+		}
+	], //明细2
+	// ...
+]
+ebSdk.callEsbFlow("资源ID_4", mainParams, detailParams).then(res => {
+  // ......
+});
+```
+
+
+## ebSdk.openHrmCombineResource(onOk, onCancel);
+
+使用此接口可以打开人员、群组的弹窗或面板
+
+### 参数说明
+
+| 参数 | 类型   | 必需 | 说明                                         |
+| ---- | ------ | ---- | -------------------------------------------- |
+| onOk  | function | `否` | 人员/群组弹窗确认事件                      |
+| onCancel | function | `否` | 人员/群组弹窗取消事件 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+const onOk = (val: any[]) => {
+  const users = []
+  const groups = []
+  val.forEach(el => {
+    if(el.type === 'resource') { /** 人员 */
+      users.push(el.id)
+    }else if(el.type === "channel") { /** 群组 */
+      groups.push(el.id)
+    }
+  })
+  const target = {
+    toUser: users.join(','),
+    toGroup: groups.join(','),
+  }
+  const msg = [
+    {
+      "type": 1,
+      "content": "测试Yit", // 消息文本内容
+      // "atType": 1, // 群组中@类型，1表示@指定人员，2表示@所有人
+      // "atUsers": "xxx,xxx" //@指定人员的ID，多个用逗号分隔，暂时不支持@外部人员
+    }
+  ]
+  // 发送消息
+  ebSdk.sendMessage(target, msg, res => {
+    console.log(res)
+  })
+}
+const onCancel = () => {
+    // xxxx
+}
+ebSdk.openHrmCombineResource(onOk, onCancel);
+```
+
+
+## pageSdk.toggleSidebar(options);
+
+使用此接口可以切换非主面板的左、右、中间分栏进行展开、收缩。
+
+### 参数说明
+
+| 参数       | 类型              | 必需 | 说明   |
+| :------- | :-------------- | :- | :--- |
+| type     | 'left'\|'right'\|'main' | 是  | 边栏类型 |
+| isExpand | boolean         | 否  | 是否展开 |
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+const opts = {
+  type:'left',
+  isExpand:true
+}
+
+pageSdk.toggleSidebar(opts);
+```
+
+## pageSdk.downloadPageWithImage();
+
+使用此接口可以将页面存为图片
+
+### 参数说明
+无
+### 返回值
+无
+
+### 示例
+
+```javascript
+ //将当前页面存为图片
+pageSdk.downloadPageWithImage();
+/*将指定页面存为图片*/
+ //获取指定页面SDK，资源ID_5是页面id
+const targetPageSdk = window.ebuilderSDK.getPageSDK('资源ID_5');
+ //执行将页面存为图片操作
+targetPageSdk.downloadPageWithImage();
+
+```
+
+## pageSdk.changeComLayout(comId, layout)
+
+使用此接口可以设置组件位置和高、宽度
+
+### 参数说明
+
+| 参数       | 类型              | 必需 | 说明   |
+| :------- | :-------------- | :- | :--- |
+| comId  | string | 是  | 组件id   |
+| layout | any    | 是  | 组件布局信息 |
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+const layout = { x: 0, w: 1 };
+
+pageSdk.changeComLayout('组件ID_6', layout);
+```

package/skill-docs/references/ebuilder-designer/page-source/sdk-refresh.md

@@ -0,0 +1,132 @@
+# 刷新相关
+
+整页刷新、当前页面组件刷新、上一页面组件刷新分别调用。组件 ID 必须属于对应目标页面，避免在 compLoad 内无条件刷新自身而形成循环。
+
+查询本类接口：`e10-cli designer source sdk --query <方法名>`。
+
+## 接口目录
+
+- `pageSdk.reload();`：使用此接口可以刷新整个页面
+- `pageSdk.refreshPrevPageComp();`：使用此接口可以刷新前一个页面上的组件
+- `pageSdk.refresh();`：使用此接口可以刷新当前页面的组件
+
+## pageSdk.reload();
+
+使用此接口可以刷新整个页面
+
+### 参数说明
+
+无
+
+### 返回值
+
+用于刷新页面，不将返回值作为日期或时间读取。
+
+### 示例
+
+```javascript
+pageSdk.reload(); //刷新当前页面
+
+/*刷新指定页面*/
+const targetPageSdk = window.ebuilderSDK.getPageSDK('资源ID_1'); //获取指定页面SDK，资源ID_1是页面id
+targetPageSdk.reload(); //执行刷新操作
+```
+
+
+## pageSdk.refreshPrevPageComp();
+
+使用此接口可以刷新前一个页面上的组件
+
+### 参数说明
+
+| 参数      | 类型     | 必需 | 说明                 |
+| --------- | -------- | ---- | -------------------- |
+| compId    | string   | `是` | 组件 id              |
+| condition | object   | `否` | 过滤条件             |
+| callback  | function | `否` | 刷新完成后的回调函数 |
+
+### 返回值
+
+返回 Promise 对象
+
+### 示例
+
+```javascript
+/*刷新前一个页面的组件*/
+pageSdk.refreshPrevPageComp('组件ID_2');
+
+/*返回并刷新前一个页面的组件*/
+pageSdk.refreshPrevPageComp('组件ID_2').then(function () {
+  ebSdk.backPage();
+});
+
+/*返回并指定参数刷新前一个页面的列表*/
+pageSdk
+  .refreshPrevPageComp('组件ID_2', {
+    type: 'and',
+    filter: [
+      {
+        fieldName: 'prjName',
+        relation: 'eq',
+        value: '项目一期',
+      },
+    ],
+  })
+  .then(function () {
+    ebSdk.backPage();
+  });
+```
+
+
+## pageSdk.refresh();
+
+使用此接口可以刷新当前页面的组件
+
+### 参数说明
+
+| 参数      | 类型     | 必需 | 说明                 |
+| --------- | -------- | ---- | -------------------- |
+| compId    | string   | `是` | 组件 id              |
+| condition | object   | `否` | 过滤条件             |
+| callback  | function | `否` | 刷新完成后的回调函数 |
+
+### 返回值
+
+返回 Promise 对象
+
+### 示例
+
+```javascript
+/*刷新当前页面的组件*/
+pageSdk.refresh("组件ID_2");
+
+/*刷新当前页面的组件*/
+pageSdk.refresh("组件ID_2",{},function(){
+	//刷新完成后的回调
+})
+
+// 刷新组件并替换页面参数
+pageSdk.refresh("组件ID_2", {
+	date: "2022-12-27",
+	name: "张三"
+}, function(){
+ //刷新完成后的回调
+});
+
+/*刷新当前页面的组件并传递过滤条件*/
+pageSdk.refresh("组件ID_2", {
+	type: "and",
+	filter: [
+		{
+			fieldName: "prjName",
+			relation: "eq",
+			value: "项目一期"
+		}
+	],
+comId: "组件ID_3", // 当前ｒｅｆｒｅｓｈ触发组件id
+    // filterIsNull: true,  // 变量值为空时不参与条件过滤
+    // isOverrideFilter: false // 是否覆盖列表本身条件
+}, function(){
+	//刷新完成后的回调
+})
+```

package/skill-docs/references/ebuilder-designer/page-source/sdk-sql.md

@@ -0,0 +1,39 @@
+# sql相关
+
+SQL 接口使用已配置 SQL 数据集的 ID 和参数，不是传任意 SQL 文本执行；数据集及访问权限仍需平台配置。
+
+查询本类接口：`e10-cli designer source sdk --query <方法名>`。
+
+## 接口目录
+
+- `ebSdk.SQL();`：使用此接口可以向服务端发送请求执行指定的SQL语句
+
+## ebSdk.SQL();
+
+使用此接口可以向服务端发送请求执行指定的SQL语句
+
+### 参数说明
+
+| 参数     | 类型     | 必需 | 说明                                                                   |
+| -------- | -------- | ---- | ---------------------------------------------------------------------- |
+| datasetId     | string   | `是` | sql数据集id                                                             |
+| params | json | `否` | 参数 |
+| callback | function | `否` | 回调函数 |
+
+### 返回值
+
+无
+
+### 示例
+
+```javascript
+/* 请求id为资源ID_1的sql数据集，执行相关sql */
+ebSdk.SQL("资源ID_1", function(result){
+  //result[0].name;
+});
+
+/* 请求id为资源ID_1的sql数据集，传递参数date1，date2并执行相关sql */
+ebSdk.SQL("资源ID_1", {"date1":"2021-01-01", "date2": "2021-01-05"}, function(result){
+  //result[0].name;
+});
+```

package/skill-docs/references/form/guide-form-permission.md

@@ -0,0 +1,185 @@
+# 表单创建权限 / 共享权限
+
+表单权限分两块：
+
+- **创建权限**：谁能新建这张表单的记录（`codeType=obj`）。
+- **共享权限**：谁能看到、编辑、删除已有记录，以及附件、布局、条件和跨表单同步（`codeType=obj_data_admin` 等）。
+
+共享权限除了「通用对象」，还支持**创建人相关 / 字段相关 / 矩阵相关 / 政务单位相关**四类；归档权限按流程单独配置，见 `guide-form-archive-permission.md`，不要和这里混用。
+
+## 命令
+
+```bash
+# 查看全部权限（创建 + 共享 + 评论 + 导入导出 + 归档）
+e10-cli form permission list <objId> <appId>
+
+# 创建权限
+e10-cli form permission create add <objId> <appId> \
+  --org-type <类型> [--org-id <id>] [--org-name <名称>] \
+  [--layout <布局id>] [--same-layout on|off] [--layout-order 0] [--desc "描述"]
+
+e10-cli form permission create update <objId> <appId> --right-id <权限id> [同上设置项]
+e10-cli form permission create show <objId> <appId> --right-id <权限id>
+
+# 共享权限
+e10-cli form permission data add <objId> <appId> \
+  --target <general|creator|field|matrix|govern> \
+  --rights <view/edit/delete/comment...> [设置项]
+
+e10-cli form permission data update <objId> <appId> --right-id <权限id> [要改的项]
+e10-cli form permission data show <objId> <appId> --right-id <权限id>
+
+# 删除（创建/共享/其余分类通用）
+e10-cli form permission remove <objId> <appId> --right-id <id[,id...]>
+```
+
+修改采用「读整行 → 只改点名项 → 整体回写 → 回读点名键」，没点名的布局、条件、同步列表保持原样。
+
+## 授权对象类型
+
+### 通用对象（`--target general`，默认）
+
+| `--org-type` | 含义 |
+|---|---|
+| `all` | 所有人（orgId 自动 0） |
+| `employee` | 人员 |
+| `department` | 部门 |
+| `company` | 分部 |
+| `role` | 角色 |
+| `group` | 群组 |
+| `post` | 岗位 |
+| `partTime` | 兼职岗位 |
+| `grade` | 职级 |
+| `external` | 外部联系人 |
+| `externalAll` | 所有外部联系人（orgId 自动 0） |
+
+除 `all` / `externalAll` 外都要给 `--org-id`，名称只用于回显，缺省用类型名。
+人员/部门/分部授权可加 `--creator-related 0~7` 指定上下级关系；岗位/角色等可加
+`--contain-extra on` 表示含兼职人员。
+
+### 创建人相关（`--target creator`）
+
+```bash
+e10-cli form permission data add <objId> <appId> --target creator \
+  --creator-related 1 --rights view edit
+```
+
+`--creator-related`：0 本人/本部门/本分部；1 直接上级及所有下级；2 所有上级；
+3 所有下级；4 所有上级；5 本岗位；6 直接下属；7 上级部门。
+
+### 字段相关（`--target field`）
+
+```bash
+e10-cli form permission data add <objId> <appId> --target field \
+  --field 负责人 --rights view edit
+```
+
+`--field` 可给字段 id 或字段名（重名会报错，改用 id）。字段属于明细表时补 `--sub-form-id`。
+`orgType` 由字段组件类型推出（人员/部门/分部/岗位/关联 ebuilder 等）；其余字段类型用
+`--org-type field_xxx` 显式指定，可选值见 `form permission archive` 文档。
+
+### 矩阵相关（`--target matrix`）
+
+```bash
+# 真矩阵：取值字段按名称取矩阵自己配置的值字段
+e10-cli form permission data add <objId> <appId> --target matrix \
+  --matrix 部门负责人矩阵 --matrix-value 负责人 --rights view
+
+# e-Builder 表单当矩阵：默认取「创建者」，也可指定人员字段
+e10-cli form permission data add <objId> <appId> --target matrix \
+  --eb-form 项目任务 --matrix-value 负责人 --rights view
+
+# 取值字段/条件特殊时用原始 JSON
+--matrix-value-raw '[{"valueId":"...","valueName":"...","valueType":"resource"}]'
+--matrix-condition-raw '{"...":"..."}'
+```
+
+### 政务单位相关（`--target govern`）
+
+```bash
+e10-cli form permission data add <objId> <appId> --target govern --rights view \
+  --govern-json '{"objectType":"1","object":"1","dimensionId":"<维度id>","relationType":"1"}'
+```
+
+`governDataRelation` 直接按条件 JSON 写入；`objectType`：1 指定单位、2 指定职务、3 表单字段。
+
+## 通用设置
+
+| 选项 | 权限字段 | 说明 |
+|---|---|---|
+| `--layout <id>` | `layoutId` | 关联 PC 布局 |
+| `--mobile-layout <id>` | `mobileLayoutId` | 关联移动布局 |
+| `--edit-layout <id>` | `editLayoutId` | 编辑布局 |
+| `--mobile-edit-layout <id>` | `mobileEditLayoutId` | 移动端编辑布局 |
+| `--same-layout on\|off` | `isPcMobileSameLayout` | PC 移动统一布局；开时移动布局自动沿用 PC 布局 |
+| `--layout-order <n>` | `layoutOrder` | 优先级，0 最高；同一个人命中多条权限时按它决定用哪个布局 |
+| `--desc <文本>` | `rightDesc` | 权限描述 |
+| `--desc-label-id <id>` | `rightDescLabelId` | 多语言描述标签；纯文本描述留空 |
+| `--condition <json>` | `conditionData` | 权限条件（条件树 JSON 或 `@文件`）；写入前按平台算法压缩 |
+| `--clear-condition` | `conditionData` | 清空条件 |
+| `--org-virtual-type <type>` | `orgVirtualType` | 组织维度 |
+| `--contain-extra on\|off` | `containExtra` | 岗位/角色等授权时是否含兼职人员 |
+| `--min-seclevel <n>` / `--max-seclevel <n>` | `minShowlevel` / `maxShowlevel` | 安全级别范围 0~100 |
+| `--exclude-obj <json\|@file>` | `excludeObj` | 排除项 |
+| `--file-rights view download edit` | `fileRight` | 附件权限 401 查看 / 402 下载 / 403 编辑；给下载或编辑会自动补查看 |
+| `--file-right-type temporary\|insert` | `fileRightType` | 临时赋权（不插入权限数据）/ 插入赋权 |
+| `--sync-forms <objId...>` | `syncPermissionList` | 同步至其他表单（整体替换） |
+
+创建权限没有附件权限；共享权限默认 `401,402`（查看 + 下载）、`temporary`。
+
+### 权限条件
+
+`--condition` 的内容就是权限页「条件设计器」保存的条件树，原样给 JSON 即可：
+
+```bash
+e10-cli form permission data update <objId> <appId> --right-id <id> \
+  --condition '{"type":"and","children":[...]}'
+```
+
+长条件建议落文件：`--condition @condition.json`。命令负责按平台算法压缩后再提交，读回时会解压比较，确保没有被改写或吞掉。
+
+### 同步至其他表单
+
+```bash
+e10-cli form permission data update <objId> <appId> --right-id <id> \
+  --sync-forms <目标表单objId> [更多objId...]
+```
+
+这是**整体替换**：给几个就同步到几个，之前同步过但这次没给的会被移除。
+`data show` 会列出当前同步到哪些表单。
+
+## 导入导出权限
+
+导入导出是**独立分类**（`data_imp_exp`），不在共享权限里。命令：
+
+```bash
+e10-cli form permission imp-exp list <objId> <appId>
+
+e10-cli form permission imp-exp add <objId> <appId> \
+  --org-type <类型> [--org-id <id>] \
+  --rights export import delete-import \
+  [--update-import] [--export-details] [--export-attachment] \
+  [--export-field-range listShowField|allField]
+
+e10-cli form permission imp-exp update <objId> <appId> --right-id <id> [要改的项]
+e10-cli form permission imp-exp show <objId> <appId> --right-id <id>
+```
+
+- `rights`：`export=8` 导出、`import=9` 导入、`delete-import=93` 删除导入数据；93 必须与 9 同选。
+- `--update-import`：允许更新导入（`importType` 加 1）；勾 93 时自动带更新导入。
+- 授权对象与共享权限同一套 11 种通用对象（含兼职岗位、职级、外部联系人、所有外部联系人）。
+- `--export-field-range`：`listShowField` 列表显示字段（默认）/ `allField` 全部字段。
+- `--export-details` / `--export-attachment`：导出明细、导出附件。
+- 修改只改点名项，整行回写并回读。
+
+导入导出权限**不提供**权限描述、更新导入校验数据编辑权限、导入关联布局、优先级、同步至其他表单这些配置项。
+
+## 保存后重构
+
+某些改动（尤其是字段相关、矩阵相关和条件）会让平台标记 `isShowRebuild=2`。命令会提示：
+
+```bash
+e10-cli form permission rebuild <objId> <appId> <权限id>
+```
+
+重构只影响权限数据的生效计算，不改权限配置本身。