@qingflow-tech/qingflow-cli 1.1.57 → 1.1.59
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/npm/lib/runtime.mjs +13 -29
- package/package.json +1 -1
- package/pyproject.toml +1 -2
- package/skills/qingflow-cli/SKILL.md +319 -90
- package/skills/qingflow-cli/manifest.yaml +1 -1
- package/skills/qingflow-cli/reference/00-INDEX.md +4 -4
- package/skills/qingflow-cli/reference/QINGFLOW_CLI_ADMIN_CHEATSHEET.md +1 -1
- package/skills/qingflow-cli/reference/QINGFLOW_CLI_DATA_RETRIEVAL_WORKFLOW.md +137 -3
- package/skills/qingflow-cli/reference/QINGFLOW_CLI_EXPLORATION_REPORT.md +4 -6
- package/skills/qingflow-cli/reference/QINGFLOW_CLI_FIELD_DATA_TYPES.md +14 -14
- package/skills/qingflow-cli/reference/QINGFLOW_CLI_MEMBER_CHEATSHEET.md +19 -20
- package/skills/qingflow-cli/reference/QINGFLOW_CLI_ONE_SHOT_CHEATSHEET.md +14 -18
- package/skills/qingflow-cli/reference/QINGFLOW_CLI_RECORD_CREATE_WORKFLOW.md +12 -7
- package/skills/qingflow-cli/reference/QINGFLOW_CLI_RECORD_UPDATE_WORKFLOW.md +1 -2
- package/skills/qingflow-cli/reference/builder/20-build-complete-system.md +2 -2
- package/skills/qingflow-cli/reference/builder/30-schema-fields.md +5 -9
- package/skills/qingflow-cli/reference/builder/reference/app-delivery-sop.md +3 -3
- package/skills/qingflow-cli/reference/core/QINGFLOW_CLI_ADMIN_CHEATSHEET.md +1 -1
- package/skills/qingflow-cli/reference/core/QINGFLOW_CLI_DATA_RETRIEVAL_WORKFLOW.md +95 -76
- package/skills/qingflow-cli/reference/core/QINGFLOW_CLI_EXPLORATION_REPORT.md +4 -6
- package/skills/qingflow-cli/reference/core/QINGFLOW_CLI_FIELD_DATA_TYPES.md +13 -13
- package/skills/qingflow-cli/reference/core/QINGFLOW_CLI_MEMBER_CHEATSHEET.md +19 -20
- package/skills/qingflow-cli/reference/core/QINGFLOW_CLI_ONE_SHOT_CHEATSHEET.md +14 -18
- package/skills/qingflow-cli/reference/record/QINGFLOW_CLI_RECORD_UPDATE_WORKFLOW.md +1 -2
- package/skills/qingflow-cli/reference/record/analysis/README.md +113 -21
- package/skills/qingflow-cli/reference/record/analysis/analysis-gotchas.md +10 -10
- package/skills/qingflow-cli/reference/record/analysis/analysis-patterns.md +9 -9
- package/skills/qingflow-cli/reference/record/analysis/business-context.md +1 -1
- package/skills/qingflow-cli/reference/record/analysis/confidence-reporting.md +10 -10
- package/skills/qingflow-cli/reference/record/analysis/data-access-playbook.md +80 -52
- package/skills/qingflow-cli/reference/record/analysis/pandas-recipes.md +2 -2
- package/skills/qingflow-common/SKILL.md +4 -7
- package/src/qingflow_mcp/app_form_compat.py +0 -3
- package/src/qingflow_mcp/app_form_validator.py +17 -69
- package/src/qingflow_mcp/builder_facade/app_form.py +100 -497
- package/src/qingflow_mcp/builder_facade/models.py +2 -2
- package/src/qingflow_mcp/builder_facade/schemas/app_form/manifest.json +0 -1
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/complete.json +30 -64
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/address.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/amount.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/attachment.json +10 -6
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/code_block.json +10 -6
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/data_relation.json +18 -11
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/date.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/datetime.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/department.json +10 -6
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/email.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/link.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/long_text.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/member.json +10 -6
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/multi_select.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/number.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/phone.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/q_linker.json +10 -6
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/relation.json +15 -46
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/single_choice.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/single_select.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/subtable.json +27 -61
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/text.json +8 -4
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/formula.json +0 -43
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/summary.json +12 -7
- package/src/qingflow_mcp/builder_facade/schemas/views/v1alpha1/complete.json +3 -4
- package/src/qingflow_mcp/builder_facade/schemas/views/v1alpha1/details/data-permission.json +3 -3
- package/src/qingflow_mcp/builder_facade/schemas/views/v1alpha1/summary.json +2 -3
- package/src/qingflow_mcp/builder_facade/service.py +6 -43
- package/src/qingflow_mcp/builder_facade/views_extract.py +12 -2
- package/src/qingflow_mcp/cli/commands/__init__.py +1 -2
- package/src/qingflow_mcp/cli/commands/record.py +1 -1
- package/src/qingflow_mcp/cli/context.py +0 -3
- package/src/qingflow_mcp/cli/formatters.py +1 -97
- package/src/qingflow_mcp/public_surface.py +0 -5
- package/src/qingflow_mcp/response_trim.py +1 -2
- package/src/qingflow_mcp/server.py +0 -2
- package/src/qingflow_mcp/server_app_user.py +0 -4
- package/src/qingflow_mcp/tools/record_tools.py +46 -11
- package/skills/qingflow-cli/reference/data/README.md +0 -32
- package/skills/qingflow-cli/reference/record/QINGFLOW_CLI_RECORD_SPECIALIZED_WORKFLOW.md +0 -50
- package/src/qingflow_mcp/builder_facade/schemas/app_form/v1alpha1/fields/rich_text.json +0 -146
- package/src/qingflow_mcp/cli/commands/data.py +0 -134
- package/src/qingflow_mcp/tools/csv_export.py +0 -168
- package/src/qingflow_mcp/tools/data_tools.py +0 -284
|
@@ -1,5 +1,139 @@
|
|
|
1
|
-
# Qingflow CLI
|
|
1
|
+
# Qingflow CLI:获取数据工作流(应用记录)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
> **用途**:使用当前 CLI 会话,从「选定应用」到「读懂列含义 + 样本/模糊定位 / 单条详情」的**推荐闭环**;下表 **左列**可与常见 **编排/内部接口**命名对照,**右列**仅为本 CLI 命令。
|
|
4
|
+
> **新版口径**:`record_list` 不是批量分析入口,而是样本浏览和模糊定位入口;`record_get` 是前端详情页首屏上下文入口;全量日志用 `record logs`;分析取数统一转 `qingflow-record-analysis` 的 `record_access -> Python/pandas`。
|
|
5
|
+
> **关联**:权限、`view_id` 选取雷区、成员最短路径速查见 **[QINGFLOW_CLI_MEMBER_CHEATSHEET.md](./QINGFLOW_CLI_MEMBER_CHEATSHEET.md)**;**字段 `kind` / 数据类型**见 **[QINGFLOW_CLI_FIELD_DATA_TYPES.md](./QINGFLOW_CLI_FIELD_DATA_TYPES.md)**;**新建记录**见 **[QINGFLOW_CLI_RECORD_CREATE_WORKFLOW.md](./QINGFLOW_CLI_RECORD_CREATE_WORKFLOW.md)**;**更新记录**见 **[QINGFLOW_CLI_RECORD_UPDATE_WORKFLOW.md](./QINGFLOW_CLI_RECORD_UPDATE_WORKFLOW.md)**;最终统计结论统一使用 **`qingflow-record-analysis` 的 `record_access -> Python/pandas`**;主技能规则见 **[../SKILL.md](../SKILL.md)**。
|
|
4
6
|
|
|
5
|
-
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 概念步骤 → CLI 映射
|
|
10
|
+
|
|
11
|
+
| 习惯概念名(编排/文档) | CLI 等价命令 | 必填要点 |
|
|
12
|
+
| --- | --- | --- |
|
|
13
|
+
| `app_get`(列应用内可访问视图) | `qingflow --json app get --app-key <APP_KEY>` | 从返回体的 **`data`(若存在)** 内取 `accessible_views[]` |
|
|
14
|
+
| `record_schema_get`,`schema_mode=browse` | `qingflow --json record schema browse --app-key <APP_KEY> --view-id <VIEW_ID>` | 子命令 **`browse`** 即「浏览视图」表结构 |
|
|
15
|
+
| `record_list` | `qingflow --json record list --app-key <APP_KEY> --view-id <VIEW_ID> [--query 文本] [--query-field FIELD_ID] [--page-size N]` | 样本浏览 / 模糊定位,默认最多返回 10 条;`query_fields` 是全文搜索字段范围 |
|
|
16
|
+
| `record_get` | `qingflow --json record get --app-key <APP_KEY> --record-id <RECORD_ID> [--view-id <VIEW_ID>]` | 前端详情页首屏上下文:字段、首屏日志、引用、关联资源、图片与文件资产 |
|
|
17
|
+
| `record_logs_get` | `qingflow --json record logs --app-key <APP_KEY> --record-id <RECORD_ID> [--view-id <VIEW_ID>]` | 单条记录全量可见数据日志 + 流程日志;自动分页写本地 JSONL,响应只返回摘要和文件路径 |
|
|
18
|
+
|
|
19
|
+
**补充**:若尚未持有 `APP_KEY`,先做 `qingflow --json app list [--query <关键词>]`,在 `items[].app_key` 里选应用;带 `--query` 时读取 `matched_count` / `unfiltered_count` 判断是否命中。
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## 推荐执行顺序
|
|
24
|
+
|
|
25
|
+
```text
|
|
26
|
+
app get(解析 accessible_views,选定 VIEW_ID)
|
|
27
|
+
→ record schema browse(对齐字段 id/类型/展示名;也是 list/access/get 的视图字段口径)
|
|
28
|
+
→ record list(样本浏览或 query 模糊定位候选)
|
|
29
|
+
→ (可选)record get(对单条 record_id 拉详情页首屏上下文)
|
|
30
|
+
→ (可选)record logs(需要完整审计日志时再拉全量日志 JSONL)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
- **仅当你只需要「快速确认有无数据」**时,可以省略 `schema browse`,直接 `app get` → `record list`(与成员速查表「最短路径」一致)。
|
|
34
|
+
- **当你需要稳定映射列名、写过滤条件或对接自动化**时,应按上表**显式**走 `schema browse`,避免对着 `list` 里中文列名猜字段定义。
|
|
35
|
+
- **当用户只给出模糊信息定位单条数据**时,走 `record schema browse` 确认可搜索字段,再用 `record list --query ... --query-field ...` 返回候选;只有候选明确后才 `record get`。
|
|
36
|
+
- **需要分组/聚合统计、最终统计结论、分析报告、趋势/排名/比例/分布**时,必须切换到 **`qingflow-record-analysis`**,按 `app_get -> record_browse_schema_get(view_id=...) -> record_access -> Python/pandas -> final answer` 执行。
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## 命令模板(占位符替换即可)
|
|
41
|
+
|
|
42
|
+
**1)应用与视图**
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
qingflow --json app get --app-key <APP_KEY> > tmp/qingflow_app_get.json
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
从 `tmp/qingflow_app_get.json` 解析:`$.data.accessible_views`(无 `data` 时再试顶层 `accessible_views`)。每个元素含 `view_id`、`name`、`kind` 等。
|
|
49
|
+
|
|
50
|
+
若响应 `warnings[]` 含 `CUSTOM_VIEW_LIST_UNAVAILABLE`,表示 custom view 列表读取被权限或后端限制降级;这不是应用整体不可读。优先使用已返回的 `system:*` 视图继续 `schema browse` / `record list`,或从前端 URL 的 `viewgraphKey` 补充明确 `view_id`。
|
|
51
|
+
|
|
52
|
+
**2)浏览视图表结构(= `record_schema_get` browse)**
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
qingflow --json record schema browse \
|
|
56
|
+
--app-key <APP_KEY> \
|
|
57
|
+
--view-id <VIEW_ID> \
|
|
58
|
+
> tmp/qingflow_schema_browse.json
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
实跑样例响应顶层键包含:`status`、`app_key`、`schema_scope`、`fields`、`suggested_dimensions` 等(**以实际 JSON 为准**)。
|
|
62
|
+
|
|
63
|
+
**3)记录列表**
|
|
64
|
+
|
|
65
|
+
```bash
|
|
66
|
+
qingflow --json record list \
|
|
67
|
+
--app-key <APP_KEY> \
|
|
68
|
+
--view-id <VIEW_ID> \
|
|
69
|
+
> tmp/qingflow_records.json
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
列表默认最多返回 10 条,行数据常见于 `$.data.items`;每条一般有 `record_id`(及业务字段键值)。需要调整样本量时加 `--page-size <N>`;它只影响浏览/候选定位样本,不替代分析取数。响应会给出总数/下一步建议;如果是模糊定位,优先看 `lookup.total_count`、`lookup.next_action`。
|
|
73
|
+
|
|
74
|
+
`record_list.data.items[]` 是**字段平铺行对象**,不是 `fields[]` 数组。定位候选或做名称到记录 ID 映射时直接读字段标题键:
|
|
75
|
+
|
|
76
|
+
```python
|
|
77
|
+
rows = payload["data"]["items"]
|
|
78
|
+
name_to_record_id = {row["客户名称"]: row["record_id"] for row in rows}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
只有 `record_get` 详情使用 `fields[]` 来表示字段列表。
|
|
82
|
+
|
|
83
|
+
**模糊定位示例**:
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
qingflow --json record list \
|
|
87
|
+
--app-key <APP_KEY> \
|
|
88
|
+
--view-id <VIEW_ID> \
|
|
89
|
+
--query "北京和路元" \
|
|
90
|
+
--page-size 20 \
|
|
91
|
+
--query-field 6299262 \
|
|
92
|
+
> tmp/qingflow_record_lookup.json
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
`--query-field` 对应 `record_browse_schema_get.fields[].field_id`,表示后端全文搜索范围;它不是输出列控制。
|
|
96
|
+
|
|
97
|
+
**4)单条记录详情**
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
qingflow --json record get \
|
|
101
|
+
--app-key <APP_KEY> \
|
|
102
|
+
--record-id <RECORD_ID> \
|
|
103
|
+
--view-id <VIEW_ID> \
|
|
104
|
+
> tmp/qingflow_record_get.json
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
已知前端视图时必须传同一个 `--view-id`;未知时 CLI 会先试默认详情 route,再在权限/不可见类错误下尝试可访问视图。`record_get` 现在返回详情页首屏上下文,重点看:`fields[]`、`references[]`、`data_logs`、`workflow_logs`、`associated_resources`、`media_assets`、`file_assets`、`semantic_context`。其中 `data_logs` / `workflow_logs` 只表示详情页首屏日志,不是全量审计历史。若 `unavailable_context[]` 中出现 `detail_schema`、`audit_info`、`data_logs`、`workflow_logs` 等,只说明这些辅助详情上下文读取受限;只要顶层 `status=ok` 且 `fields[]` 有目标字段,就不要把辅助 40002 当作记录不可读。图片读 `media_assets.items[].local_path`;文档/表格/PDF 等附件读 `file_assets.items[].local_path` 和 `file_assets.items[].extraction.text_path`。**不要直接访问远端 Qingflow 附件 URL**。
|
|
108
|
+
|
|
109
|
+
**5)全量日志(仅在用户明确需要完整审计/日志历史时)**
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
qingflow --json record logs \
|
|
113
|
+
--app-key <APP_KEY> \
|
|
114
|
+
--record-id <RECORD_ID> \
|
|
115
|
+
--view-id <VIEW_ID> \
|
|
116
|
+
> tmp/qingflow_record_logs.json
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
响应重点看:`data_logs.local_path`、`workflow_logs.local_path`、`items_count`、`pages_fetched`、`complete`、`context_integrity.safe_for_full_log_conclusion`。完整日志在本地 JSONL 文件中,默认目录为 `~/.qingflow-mcp/record-logs/<run_id>/`;不要把 JSONL 全文直接塞进上下文,按需用脚本读取、筛选或汇总。
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## `view_id` 选取(成员侧必读摘要)
|
|
124
|
+
|
|
125
|
+
- **`system:all` 等业务系统视图**:实跑可用于 `schema browse` + `record list`(具体以租户配置为准)。显式传入的 `view_id` 必须按前端当前视图忠实执行;`system:all` 报 40002 / 40027 / 404 / 500 时,不要自动换成 `system:initiated`、`system:todo` 等其它系统视图,除非用户或前端 URL / `app get.accessible_views` 重新指定了那个视图。
|
|
126
|
+
- **`CUSTOM_VIEW_LIST_UNAVAILABLE`**:只说明 `app get` 没能列出 custom view;若已有 `system:*` 可用,不要把它当作应用或记录读取失败。
|
|
127
|
+
- **`custom:` 后仅数字**(如 `custom:1`):成员侧常见 **`schema browse` / `list` / `access` 均 40038**,应**跳过**,改选 **`custom:` 带字母后缀**或其它可用视图(详见成员速查表「先有通路、再要有数据」)。
|
|
128
|
+
- **待办 / 已办 / 抄送「任务箱」**:不要用旧文档里的 `system:todo` 等视图充当任务中心;应使用 **`task list --task-box …`**(见主技能 **待办 SOP**)。
|
|
129
|
+
|
|
130
|
+
---
|
|
131
|
+
|
|
132
|
+
## 落盘与解析
|
|
133
|
+
|
|
134
|
+
- `schema browse`、`record list`、`record get`、`record logs` 体量大时,**必须**重定向到文件,勿将整段 JSON 直接塞进 LLM 上下文(规则见主技能「输出落盘规则」)。`record_get` 下载的本地图片/文件路径可以再交给图片理解、文档解析或 Python 读取;`record logs` 的全量日志读 `*.jsonl` 文件。
|
|
135
|
+
- 解析前**先 unwrap `data`**:多数业务成功响应为 `{ "data": { ... } }`,与 `schema browse` 部分字段在顶层的形态可能不同,以每次响应为准。
|
|
136
|
+
|
|
137
|
+
---
|
|
138
|
+
|
|
139
|
+
*维护:CLI 升级后请用 `qingflow record schema browse -h`、`qingflow record list -h`、`qingflow record get -h`、`qingflow record logs -h` 复核选项名;概念名 `record_schema_get` / `schema_mode=browse` 在 CLI 中固定对应子命令 `record schema browse`。*
|
|
@@ -6,11 +6,11 @@
|
|
|
6
6
|
|
|
7
7
|
## 1. 当前能力树摘要
|
|
8
8
|
|
|
9
|
-
-
|
|
9
|
+
- 顶层:`qingflow {auth|workspace|app|portal|view|chart|record|import|export|task|builder|build} ...`
|
|
10
10
|
- `builder` 与 `build` 等价;默认写法仍推荐 `builder`。
|
|
11
11
|
- `record schema`:公开主路径为 `browse`、`insert`、`update`、`import`、`code-block`;`applicant` 仅为兼容保留入口,不作为推荐链路。
|
|
12
12
|
- `record` 公开执行入口:`list`、`access`、`get`、`logs`、`insert`、`update`、`delete`、`code-block-run`。
|
|
13
|
-
-
|
|
13
|
+
- 最终统计结论统一由 `qingflow-record-analysis` 走 `record_access -> Python/pandas`,不要寻找或使用其它聚合捷径。
|
|
14
14
|
|
|
15
15
|
---
|
|
16
16
|
|
|
@@ -37,15 +37,13 @@
|
|
|
37
37
|
| 入口 | 当前定位 |
|
|
38
38
|
| --- | --- |
|
|
39
39
|
| `record list` | 样本浏览 / 模糊定位候选;默认最多返回 10 条,返回 `data.pagination.total_count`,带 `--query` 时看 `lookup.total_count` 与 `lookup.next_action` |
|
|
40
|
-
| `record access` |
|
|
40
|
+
| `record access` | 默认分析取数入口;自动分页写本地 CSV;不暴露 `page/page_size/limit/max_rows/profile` |
|
|
41
41
|
| `record get` | 前端详情页首屏上下文;字段、引用、首屏数据日志、首屏流程日志、关联资源、`media_assets`、`file_assets` |
|
|
42
42
|
| `record logs` | 单条记录全量可见数据日志 + 流程日志;自动分页写本地 JSONL,响应给路径和完整性 |
|
|
43
43
|
| `record insert` | 批量 `items` JSON;单条也是 `items` 数组一行;CLI 用 `--items-file` |
|
|
44
44
|
| `record update` | 单条 `--record-id + --fields-file` 或批量 `--items-file`;不要混用 |
|
|
45
45
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
`record_get` 下载本地附件的规则仅适用于用户明确要求旧 CLI 兼容入口的场景。
|
|
46
|
+
`record_get` 下载到本地的图片读 `media_assets.items[].local_path`;文档、表格、PDF 等读 `file_assets.items[].local_path` 与 `extraction.text_path`。不要直接访问远端 Qingflow 附件 URL。
|
|
49
47
|
|
|
50
48
|
---
|
|
51
49
|
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
# Qingflow CLI:字段数据类型(Schema / 列表 / 写入)
|
|
2
2
|
|
|
3
|
-
>
|
|
4
|
-
> **依据**:当前
|
|
5
|
-
>
|
|
3
|
+
> **用途**:说明 **`record schema …`** 的 **`fields[]`**、**`record list` / `record get` / `record access`** 行内值、以及 **insert/update 写入 payload** 的常见对应关系;并单独说明 **选项联动、关联记录、引用填充、公式/系统题、AI 与受限类型** 等在 CLI 下的表现与处置。
|
|
4
|
+
> **依据**:当前 CLI 在 **`--json`** 下会对 **schema** 响应做 **裁剪**:通常只保留本节列出的键;**`kind`** 由内部写入类别归并而来(见下表)。**`que_type` 等若未出现在输出中**,以 **`kind` + 实跑预检** 为准。
|
|
5
|
+
> **关联**:写入值细节与成员/部门见 **[QINGFLOW_CLI_RECORD_CREATE_WORKFLOW.md](./QINGFLOW_CLI_RECORD_CREATE_WORKFLOW.md)**;更新流程见 **[QINGFLOW_CLI_RECORD_UPDATE_WORKFLOW.md](./QINGFLOW_CLI_RECORD_UPDATE_WORKFLOW.md)**;只读见 **[QINGFLOW_CLI_DATA_RETRIEVAL_WORKFLOW.md](./QINGFLOW_CLI_DATA_RETRIEVAL_WORKFLOW.md)**;**搭建侧** AppForm 的 `type`(与本文 `kind` 命名体系不同)及其 CLI 命令见 **[builder/30-schema-fields.md](./builder/30-schema-fields.md)**;主技能 **[../SKILL.md](../SKILL.md)**。
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
-
## 1.
|
|
9
|
+
## 1. `fields[]` 通用结构(`--json` 精简后)
|
|
10
10
|
|
|
11
11
|
| 字段 | 含义 |
|
|
12
12
|
|------|------|
|
|
13
|
-
| **`field_id`** | 内部题 id
|
|
13
|
+
| **`field_id`** | 内部题 id(数字);**`record_access.columns` / `where-file` / `order-by-file` 等 DSL** 常以此引用列。 |
|
|
14
14
|
| **`title`** | 题目标题;insert/update 的 `fields` map 键通常与之一致。 |
|
|
15
15
|
| **`kind`** | 见 **§2 `kind` 枚举**;决定读写时值的形态。 |
|
|
16
16
|
| **`options`** | 可选;**`kind=select`** 时常为允许选项的字符串列表。 |
|
|
@@ -20,13 +20,13 @@
|
|
|
20
20
|
| **`required`** | 部分场景(如 **`record schema update`** 拆出的 `required_fields` / `optional_fields`)出现。 |
|
|
21
21
|
| **`template`** | 少数响应里与 **`payload_template`** 联动出现,供生成初稿。 |
|
|
22
22
|
|
|
23
|
-
|
|
23
|
+
**browse 与 detail**:`browse` 产出视图表头的精简 **`fields[]`**;`record get` 产出当前记录详情字段。一般 **不含** 完整 **`que_type`/`writable`** 元数据。更新主链路先用 **`record get`** 的字段信息组 payload,再执行 **`record update`**;只有更新失败、字段歧义或需要诊断可写范围时,再结合 **`record schema update`**(按记录)或写入返回判断。
|
|
24
24
|
|
|
25
25
|
---
|
|
26
26
|
|
|
27
27
|
## 2. `kind` 枚举(CLI 对外)
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
内部写入类别经归并后形成下表 **`kind`**(与 `qingflow` 当前实现一致;升级后请以 **`record schema … --json` 实跑** 为准):
|
|
30
30
|
|
|
31
31
|
| CLI `kind` | 维护侧常见内部类别(参考) | 在 `record list` / `record get` / `record access` 中(常见) | insert/update 写入值 |
|
|
32
32
|
|------------|-----------------------------------|--------------------------------------------|----------------------------------|
|
|
@@ -63,7 +63,7 @@
|
|
|
63
63
|
**选项联动(控制显隐、必填等)**
|
|
64
64
|
|
|
65
65
|
- 实现上来自 **题目关系 + 选项上的联动题 id**(如其它题因当前选项而被激活)。
|
|
66
|
-
-
|
|
66
|
+
- **`record schema browse` 的 `--json`**:精简 `fields[]` 可能不展示完整 `linkage` / 联动明细;新建记录以 `qingflow-record-insert` 的 `record_insert_schema_get`(CLI `record schema insert`)为准,不要用兼容保留的 applicant schema 入口替代。
|
|
67
67
|
- **写入时**:若更新返回提示 **上游未选、联动未激活、字段尚未显示**,应 **先写或改 payload 里处于上游的选项(或其它驱动题)**,再写下游;必要时用 **`record schema update --record-id …`** 诊断当前记录下 **`required_fields` / `optional_fields` / `payload_template`**。
|
|
68
68
|
|
|
69
69
|
### 3.2 关联字段(关联记录)
|
|
@@ -110,20 +110,20 @@
|
|
|
110
110
|
## 4. 与 `field_id` / 列选择
|
|
111
111
|
|
|
112
112
|
|
|
113
|
-
- **`
|
|
114
|
-
- **`
|
|
113
|
+
- **`record list --column`**:参数为 **数字列 id**,用于样本/候选列表展示列,须与 **`fields[].field_id`** 一致。
|
|
114
|
+
- **`record get`**:默认读取前端详情页首屏上下文;不要把 `--column` 当成详情字段投影主路径,单条字段、首屏日志、引用、图片/文件资产以 `record_get` 的结构化上下文为准。若用户要完整数据日志/流程日志历史,用 `record logs`。
|
|
115
115
|
- **标题重复**:同一 `title` 可能对应多个 `field_id`(极少见);列表 DSL 应用 **`field_id`** 消歧。
|
|
116
116
|
|
|
117
117
|
---
|
|
118
118
|
|
|
119
119
|
## 5. 读者操作建议
|
|
120
120
|
|
|
121
|
-
1.
|
|
122
|
-
2. **数据分析**:最终统计结论、分析报告、趋势/排名/比例/分布必须走
|
|
121
|
+
1. **按场景取上下文**:只读/定位视图列用 `record schema browse --view-id …`;新建用 `record schema insert --app-key …`;更新用 `record get --record-id …` 先读当前记录详情,再用 `record update` 写入;`record schema update --record-id …` 只在失败、字段歧义或显式诊断时使用。
|
|
122
|
+
2. **数据分析**:最终统计结论、分析报告、趋势/排名/比例/分布必须走 **`qingflow-record-analysis` 的 `record_access -> Python/pandas`**。
|
|
123
123
|
3. **看 `kind` + `options` / `row_fields` / `target_app_key`**,并对照 **§3 特殊字段** 判断是否存在联动、引用或只读带出。
|
|
124
124
|
4. **选项联动 / 引用带出**:先写 **驱动题**,再写 **被带出的题**;只读带出列 **不要强写**。
|
|
125
|
-
5. **写入前缩小 payload
|
|
125
|
+
5. **写入前缩小 payload**;insert 默认用 `record insert --items-file`,单条也是 `items` 数组一行。根据 **`status` / `blockers` / `field_errors` / `failed_fields` / `created_record_ids`** 迭代(`--json` 在 stdout)。
|
|
126
126
|
|
|
127
127
|
---
|
|
128
128
|
|
|
129
|
-
|
|
129
|
+
*维护:`kind` 集合与精简字段以当前 CLI 的 `record schema … --json` 实跑为准;内部 `que_type` 枚举随轻流版本变化,文档只稳定描述对外 **`kind`** 桶。*
|
|
@@ -1,31 +1,31 @@
|
|
|
1
1
|
# Qingflow CLI 普通成员命令速查表
|
|
2
2
|
|
|
3
3
|
> **适用对象**:当前会话为 **普通/基本成员**(`permission_level` 非租户/应用管理员、`import_capability` 常为无导入权等)。Wingent Momo runtime 下不要先跑 `auth whoami`;只有业务失败、账号不确定或排障时才核对身份。
|
|
4
|
-
> **与主技能关系**:请以 **[SKILL.md](../SKILL.md)
|
|
4
|
+
> **与主技能关系**:请以 **[SKILL.md](../SKILL.md)**(本目录上一级)的规则与命令速查表为准。**本表**:成员侧最短读数与高概率通路;**租户/管理员向差异**请参阅同目录 **[QINGFLOW_CLI_ADMIN_CHEATSHEET.md](./QINGFLOW_CLI_ADMIN_CHEATSHEET.md)**。
|
|
5
5
|
> **可选补充**:同一目录 **[QINGFLOW_CLI_ONE_SHOT_CHEATSHEET.md](./QINGFLOW_CLI_ONE_SHOT_CHEATSHEET.md)** 收录 **全体角色通用**的子命令逐项模板(与本文分工:本文偏「成员能跑通的策略」,ONE_SHOT 偏「参数逐项闭合示例」)。
|
|
6
6
|
|
|
7
7
|
> **实证**:以下结论以会话内 `qingflow …` 为准;换账号/环境请以 `qingflow … -h` 与必要的身份核对结果为准。
|
|
8
8
|
|
|
9
9
|
**统一习惯**
|
|
10
10
|
|
|
11
|
-
-
|
|
11
|
+
- **只读拉取表单记录的最短链路**:见本节 **「最短路径:普通成员只读记录数据」**(可省略 `schema browse`)。**需先拉浏览视图表结构**时见 **[QINGFLOW_CLI_DATA_RETRIEVAL_WORKFLOW.md](./QINGFLOW_CLI_DATA_RETRIEVAL_WORKFLOW.md)**;最终统计结论统一使用 **`qingflow-record-analysis` 的 `record_access -> Python/pandas`**;**字段 `kind` / 数据形态**见 **[QINGFLOW_CLI_FIELD_DATA_TYPES.md](./QINGFLOW_CLI_FIELD_DATA_TYPES.md)**;**新建记录默认批量 JSON 链路**请用 **`qingflow-record-insert`**(`record_insert_schema_get -> record_insert(items)`,CLI 为 `record insert --items-file`,成员/部门/关联优先自然语言);**浏览视图下更新记录**见 **[QINGFLOW_CLI_RECORD_UPDATE_WORKFLOW.md](./QINGFLOW_CLI_RECORD_UPDATE_WORKFLOW.md)**。
|
|
12
12
|
- 避免无必要地先绕 `workspace`、`view get`。
|
|
13
13
|
- 加 `--json`,便于区分 **CONFIG_ERROR**(少参)与 **backend**(权限/业务)。
|
|
14
14
|
- `app get` / `portal list` 等业务体常在 `**{ "data": { ... } }`** 里:取 `accessible_views`、`items` 前先 unwrap `data`。
|
|
15
15
|
|
|
16
16
|
---
|
|
17
17
|
|
|
18
|
-
##
|
|
18
|
+
## 最短路径:普通成员「只读记录数据」
|
|
19
19
|
|
|
20
|
-
> **目标**:直接使用当前 CLI 会话,用**最少 RPC
|
|
20
|
+
> **目标**:直接使用当前 CLI 会话,用**最少 RPC、无多余子命令**,走到 `**record list` 成功返回样本/候选 JSON**;找应用用 `**app list [--query 关键词]`**,在读数前**不必**调用 `auth whoami` / `workspace get` / `view get` / `record schema browse`(除非你另需结构、query field 或排障)。
|
|
21
21
|
|
|
22
22
|
### 调用次数
|
|
23
23
|
|
|
24
24
|
|
|
25
25
|
| 前置 | 命令数 | 说明 |
|
|
26
26
|
| ------------ | ------ | ---------------------------------------- |
|
|
27
|
-
| 从零选应用 | **
|
|
28
|
-
| 已知 `APP_KEY` | **
|
|
27
|
+
| 从零选应用 | **3** | `app list` → `app get` → `record list` |
|
|
28
|
+
| 已知 `APP_KEY` | **2** | `app get` → `record list` |
|
|
29
29
|
| 排障 | **+1** | 业务命令明确提示会话不可用、账号不确定时,再追加 `auth whoami` |
|
|
30
30
|
|
|
31
31
|
|
|
@@ -37,9 +37,12 @@ qingflow --json app list
|
|
|
37
37
|
qingflow --json app list --query <关键词>
|
|
38
38
|
# 在 items 中取 app_key → APP_KEY
|
|
39
39
|
|
|
40
|
-
qingflow
|
|
41
|
-
|
|
42
|
-
|
|
40
|
+
qingflow --json app get --app-key <APP_KEY>
|
|
41
|
+
# 从返回 JSON 中取出应用对象(若存在顶层 .data 则先用 .data);在 accessible_views 里选 view_id,见下文「先有通路、再要有数据」
|
|
42
|
+
|
|
43
|
+
qingflow --json record list \
|
|
44
|
+
--app-key <APP_KEY> \
|
|
45
|
+
--view-id <VIEW_ID>
|
|
43
46
|
```
|
|
44
47
|
|
|
45
48
|
大 JSON 按规范 **重定向落盘**(`> tmp/qingflow_records.json`)。
|
|
@@ -49,9 +52,9 @@ qingflow --json data query --app-key <APP_KEY>
|
|
|
49
52
|
|
|
50
53
|
| 关注点 | 说明 |
|
|
51
54
|
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
52
|
-
| **连通性优先** |
|
|
53
|
-
| **不一定有明细行** |
|
|
54
|
-
| **读不到数据时** |
|
|
55
|
+
| **连通性优先** | 从 `app get.accessible_views` 选择表格类业务视图,优先 `system:all` 或明确可读的 `custom:*`。`record list` 默认最多 10 条,只用于样本/候选。 |
|
|
56
|
+
| **不一定有明细行** | 业务视图可能因视图筛选为空;`items` 为空不等于 CLI 坏了。若目标是任务中心待办/已办/抄送,应换 `task list --task-box …`。 |
|
|
57
|
+
| **读不到数据时** | 在同一应用的 `accessible_views` 里切换其它表格类视图,跳过 **纯数字后缀** `custom:*`;不要用 `system:todo/done/cc` 当业务记录入口。 |
|
|
55
58
|
|
|
56
59
|
|
|
57
60
|
**普通成员不要使用「自定义 + 纯数字 id」去读数:** 形如 `**custom:1`、`custom:2`、`custom:12`**(`custom:` 后**仅数字**)。此类在实测中 `**record schema browse` / `list` / `access` 一致 40038**(`Object not exist`),**不可用其作为换源备选**——应直接跳过并在 **其它视图 id** 上取样。
|
|
@@ -62,16 +65,12 @@ qingflow --json data query --app-key <APP_KEY>
|
|
|
62
65
|
| 不先调 | 原因 |
|
|
63
66
|
| ---------------------------------- | -------------------------------------------------------- |
|
|
64
67
|
| `workspace get` / `workspace list` | 读应用记录**不依赖**;徒增一次往返,且 list 在部分环境受 **59004** 等影响。 |
|
|
65
|
-
| `view get` |
|
|
66
|
-
| `record schema browse` |
|
|
68
|
+
| `view get` | `**record list` 不前置要求**;读后仍要看 `app get` 给的 `view_id` 才稳。 |
|
|
69
|
+
| `record schema browse` | 只读「有哪些列」才需要;纯拉数据 **list 足够**。 |
|
|
67
70
|
|
|
68
71
|
|
|
69
72
|
---
|
|
70
73
|
|
|
71
|
-
## 旧 record 兼容参考
|
|
72
|
-
|
|
73
|
-
以下旧 `record` 规则只在用户明确要求兼容入口时使用,不得作为 data query/get/insert/update/delete 失败后的自动回退。
|
|
74
|
-
|
|
75
74
|
## 1. 优先使用(成员场景下实测高概率 exit 0)
|
|
76
75
|
|
|
77
76
|
|
|
@@ -146,7 +145,7 @@ qingflow --json data query --app-key <APP_KEY>
|
|
|
146
145
|
|
|
147
146
|
## 5. 扩展链路(含 workspace / schema)
|
|
148
147
|
|
|
149
|
-
若你还要 **核对当前工作区** 或
|
|
148
|
+
若你还要 **核对当前工作区** 或 **先看 browse 字段**,在 **§「最短路径」** 之外可增加(顺序仍建议 **先最短再扩展**)。注意:最终统计结论、分析报告、趋势/排名/比例/分布必须使用 `qingflow-record-analysis` 的 `record_access -> Python/pandas`:
|
|
150
149
|
|
|
151
150
|
```bash
|
|
152
151
|
qingflow --json auth whoami # 仅业务失败、账号不确定或需要写清当前租户上下文时
|
|
@@ -192,5 +191,5 @@ qingflow --json record list --app-key <APP_KEY> --view-id <VIEW_ID>
|
|
|
192
191
|
| §1 表内多数「高概率 exit 0」命令 | 在典型成员会话下过 help/试跑对齐;仍以当前 CLI 与服务端为准。 |
|
|
193
192
|
| `custom:*` 与 `system:*` 在 browse/list/access 上差异 | 同上;`custom:+纯数字` 读数常 40038 已在上文单列。 |
|
|
194
193
|
| `workspace select` 可能 59004 | 流币等配额与其它失败区分;非每次必现。 |
|
|
195
|
-
|
|
|
194
|
+
| **§「最短路径」**(app list→get→record list;优先表格类业务视图;空数据则换其它可读表格视图;**勿用 `custom:<仅数字>`**) | 不包含多余 `workspace get`/`schema browse`,除非另行需要。 |
|
|
196
195
|
| 本文未逐条自动化验证的项 | `task get`/`log`/`report`(缺 id)、`chart get`(缺真实 id)、**写路径** `record insert` 等 — 按通用表与业务策略,需有数据/权限时再测 |
|
|
@@ -4,13 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
> **本文档目的**:按**场景**给出**形态正确、参数闭合**时的命令模板,便于复制后替换占位符即跑,减少「缺参 / 引号 / 根级选项」类返工。
|
|
6
6
|
> **不是**「任何账号、任何租户、任何时刻都 100% HTTP 200」——若遇 `59004`(流币/AI 配额)、401、或目标资源不存在,仍可能失败;那种情况属于**环境与权限**,不是本表要解决的「命令写对一次成」问题。
|
|
7
|
-
> **数据默认入口**:普通 query/get/insert/update/delete 统一阅读 [data 操作说明](./data/README.md) 并使用 `qingflow data ...`;本文保留的旧 `record` 命令只供用户明确要求兼容入口时查阅。
|
|
8
7
|
|
|
9
8
|
**统一建议**
|
|
10
9
|
|
|
11
10
|
- 自动化读取命令优先加 `**--json`**;builder 写入/apply 命令默认只输出 JSON,不需要额外选择格式;展示写入结果时优先读 `operation + summary + resources[]`,不要按不同工具分别解析旧字段。
|
|
12
11
|
- 需要稳定 profile 时加 `**--profile default`**(或与你的会话一致的名字)。
|
|
13
|
-
- `task` / `
|
|
12
|
+
- `task` / `record` 的大 JSON 查询类输出,按团队规范**落盘**(例如 `> tmp/qingflow_*.json`),本表为简洁只写核心参数。
|
|
14
13
|
|
|
15
14
|
---
|
|
16
15
|
|
|
@@ -67,26 +66,23 @@
|
|
|
67
66
|
|
|
68
67
|
---
|
|
69
68
|
|
|
70
|
-
## 5.
|
|
69
|
+
## 5. 记录:`record`(区分「仅需 app-key」与「必须 view-id」)
|
|
71
70
|
|
|
72
|
-
|
|
71
|
+
下面「一次成功」指 **CLI 不会因缺参报错**;服务端仍可能因权限返回错误 JSON。
|
|
73
72
|
|
|
74
73
|
|
|
75
74
|
| 场景 | 一次成功写法 | 必填/注意 |
|
|
76
75
|
| ----------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
|
|
77
|
-
|
|
|
78
|
-
| Data get | `qingflow --json data get --app-key <APP_KEY> --record-id <RECORD_ID>` | 单条读取默认入口;记录 id 必须来自已确认上下文。 |
|
|
79
|
-
| Data insert | `qingflow --json data insert --app-key <APP_KEY> --items-file items.json` | 新建记录按 data 操作说明执行;字段键与值以 data schema 和当次工具响应为准。 |
|
|
80
|
-
| Data update | `qingflow --json data update --app-key <APP_KEY> --record-id <RECORD_ID> --fields-file fields.json` | 写入前检查 access 与字段能力;结果不明或已执行时不得重放。 |
|
|
81
|
-
| Data delete | `qingflow --json data delete --app-key <APP_KEY> --record-ids <RECORD_ID>` | 删除前确认精确目标与影响范围。 |
|
|
76
|
+
| Insert schema | `qingflow --json record schema insert --app-key <APP_KEY>` | 新建记录默认走 `qingflow-record-insert`;CLI 用 insert-ready schema + `record insert --items-file`。 |
|
|
82
77
|
| Import / code-block schema | `qingflow --json record schema import --app-key <APP_KEY>` / `qingflow --json record schema code-block --app-key <APP_KEY>` | 仅在导入或代码块任务明确需要时使用。 |
|
|
83
|
-
|
|
|
84
|
-
|
|
|
85
|
-
| 分析取数 | `qingflow --json
|
|
86
|
-
|
|
|
78
|
+
| Schema:browse(浏览态字段) | `qingflow --json record schema browse --app-key <APP_KEY> --view-id <VIEW_ID>` | **必须 `--view-id`**;不要用引号包住 `record schema browse` 整段。 |
|
|
79
|
+
| 列表/候选定位(运行时强校验) | `qingflow --json record list --app-key <APP_KEY> --view-id <VIEW_ID>` | **必须 `--view-id`**;默认最多返回 10 条,适合样本/模糊定位;可加 `--query` / `--query-field`。 |
|
|
80
|
+
| 分析取数 | `qingflow --json record access --app-key <APP_KEY> --view-id <VIEW_ID> --columns-file columns.json --where-file where.json` | 最终统计结论统一使用 `qingflow-record-analysis` 的 `record_access -> Python/pandas`。 |
|
|
81
|
+
| 单条读取 | `qingflow --json record get --app-key <APP_KEY> --record-id <RECORD_ID>` | **必须** `--record-id`;返回前端详情页首屏上下文、引用、图片/文件资产。 |
|
|
82
|
+
| 全量记录日志 | `qingflow --json record logs --app-key <APP_KEY> --record-id <RECORD_ID> [--view-id <VIEW_ID>]` | 仅在需要完整审计/日志历史时使用;全量数据日志和流程日志写本地 JSONL。 |
|
|
87
83
|
|
|
88
84
|
|
|
89
|
-
|
|
85
|
+
**高风险写操作**(本表不保「业务上你希望的一次成功」,只列形态):`record insert/update/delete`、`record code-block-run`(可能写回)需按 `-h` 逐项带齐文件类参数与安全开关。
|
|
90
86
|
|
|
91
87
|
---
|
|
92
88
|
|
|
@@ -152,11 +148,11 @@
|
|
|
152
148
|
|
|
153
149
|
在满足账号权限的前提下:
|
|
154
150
|
|
|
155
|
-
1. `qingflow --json app list [--query <关键词>]` → 选一个
|
|
156
|
-
2. `qingflow
|
|
157
|
-
3. `qingflow --json
|
|
151
|
+
1. `qingflow --json app list [--query <关键词>]` → 选一个 `**app_key`**
|
|
152
|
+
2. `qingflow --json app get --app-key <APP_KEY>` → 选一个 `**view_id`**
|
|
153
|
+
3. `qingflow --json record list --app-key <APP_KEY> --view-id <VIEW_ID>`
|
|
158
154
|
|
|
159
|
-
若要落盘再给第 3 步加 `> tmp/
|
|
155
|
+
若要落盘再给第 3 步加 `> tmp/qingflow_records.json`。只有业务命令明确返回会话不可用、账号不确定或工作区异常时,才回到第 2 节做会话恢复。
|
|
160
156
|
|
|
161
157
|
---
|
|
162
158
|
|
|
@@ -1,15 +1,20 @@
|
|
|
1
|
-
# Qingflow CLI
|
|
1
|
+
# Qingflow CLI:创建记录 SOP(申请节点)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
---
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
**创建记录 SOP 见 skill:`qingflow-record-insert`。**
|
|
6
|
+
|
|
7
|
+
CLI 对应主路径:
|
|
6
8
|
|
|
7
9
|
```bash
|
|
8
|
-
qingflow
|
|
10
|
+
qingflow --json record schema insert --app-key <APP_KEY> > tmp/qingflow_insert_schema.json
|
|
11
|
+
qingflow --json record insert --app-key <APP_KEY> --items-file tmp/records.json > tmp/qingflow_insert_result.json
|
|
9
12
|
```
|
|
10
13
|
|
|
11
|
-
|
|
14
|
+
不要用 `record schema applicant` 代替 `record_insert_schema_get` 的主路径;新建记录需要 insert-ready schema 里的 `required_fields`、`optional_fields`、`payload_template`、`format_hint`、`expected_format`、`example_value` 和字段级 `options`。
|
|
15
|
+
|
|
16
|
+
成员、部门、关联记录、选项、附件等特殊字段按 `qingflow-record-insert` 的 **Special Field Write Cheatsheet** 写:先读 insert schema;部门/成员不能自造候选;选项值必须来自 schema `options` 的文本或 id;关联记录批量写入优先 `record_id`,自然名称只在唯一匹配时使用;附件先上传再写返回值。
|
|
12
17
|
|
|
13
|
-
|
|
18
|
+
追加样例数据时也必须 schema-first:按 `required_fields` 补齐必填;按 `expected_format/example_value` 选择数值、金额、日期等格式;按 `options` 生成选项值。不要按业务常识自造“正常/已完成/高优先级”等 schema 里不存在的选项。比例、完成率、评分、百分比等字段也按 schema 示例写;如果字段被建成金额/整数类而不接受小数,不要强塞 decimal,改用符合 schema 的整数值,或回到 builder 阶段把字段建模为 `number`。
|
|
14
19
|
|
|
15
|
-
|
|
20
|
+
录入数据时不要填写轻流系统字段:`数据ID`、`编号`、`申请人`、`申请时间`、`创建人`、`创建时间`、`提交人`、`提交时间`、`更新时间`、`更新人`、`当前流程状态`、`当前处理人`、`当前处理节点`、`流程标题`。这些字段由平台生成;需要确认时在创建成功后读取记录详情,不要把它们写进 `fields` / `items[].fields`。
|
|
@@ -1,8 +1,7 @@
|
|
|
1
1
|
# Qingflow CLI:更新记录工作流(详情后直接写入)
|
|
2
2
|
|
|
3
|
-
> **兼容范围**:本文仅限用户明确要求旧 CLI `record` 兼容入口时使用。默认更新必须切换到 [data 操作说明](./data/README.md) 的 `data get` → `data update`;禁止在 data update 失败后自动回退本文链路。
|
|
4
3
|
> **用途**:使用当前 CLI 会话读取目标记录详情后,用 **`record update`** 直接提交差异字段。主链路是 `record get -> record update`;字段范围不清、候选歧义或失败排查时,才追加 **`record schema update`**。
|
|
5
|
-
>
|
|
4
|
+
> **关联**:只读列表/详情见 **[QINGFLOW_CLI_DATA_RETRIEVAL_WORKFLOW.md](./QINGFLOW_CLI_DATA_RETRIEVAL_WORKFLOW.md)**;**字段 `kind` 与写入值总表**见 **[QINGFLOW_CLI_FIELD_DATA_TYPES.md](./QINGFLOW_CLI_FIELD_DATA_TYPES.md)**;最终统计结论统一使用 **`qingflow-record-analysis` 的 `record_access -> Python/pandas`**;**成员 / 部门等** 的细颗粒写入见 **[QINGFLOW_CLI_RECORD_CREATE_WORKFLOW.md](./QINGFLOW_CLI_RECORD_CREATE_WORKFLOW.md)**;主技能 **[../SKILL.md](../SKILL.md)**。
|
|
6
5
|
|
|
7
6
|
---
|
|
8
7
|
|
|
@@ -22,7 +22,7 @@ package apply/get -> AppForm schema/get/apply per app -> app readback -> workflo
|
|
|
22
22
|
- Do not call the retired `builder schema apply` or `builder layout apply` routes, and do not use their `add_fields`, `apps-file`, or `form-file` payloads as the current path.
|
|
23
23
|
- For relations, create relation-independent apps first, read back their published `appKey`s, then submit complete declarations using the canonical relation shape and known target app keys.
|
|
24
24
|
- One app may contain multiple `relation` fields when the business model needs them.
|
|
25
|
-
- Relation selectors use the AppForm camelCase shape, not bare strings: write
|
|
25
|
+
- Relation selectors use the AppForm camelCase shape, not bare strings: write `config.displayField: {"name":"产品编码"}` and `config.visibleFields: [{"name":"产品名称"}]`. `config.targetAppKey` must be a target app key confirmed by readback.
|
|
26
26
|
- If AppForm apply times out or returns uncertain write state, perform draft/published form readback before retrying. Do not recreate apps with `V2`, `测试`, or random suffixes.
|
|
27
27
|
- If a same/similar package or app set already exists and the user did not say whether to extend, repair, replace, or create new, stop and ask. Do not start probing with new names.
|
|
28
28
|
- If readback shows part of the requested system already exists, list existing apps/fields/views/charts/portal, identify gaps, and patch only the missing or incorrect slices.
|
|
@@ -73,7 +73,7 @@ A complete system is not just several created apps. Before reporting completion,
|
|
|
73
73
|
|
|
74
74
|
- Package exists, and its `package_id` is known.
|
|
75
75
|
- Every core business object is a separate app with `app_key`, `app_name`, `icon`, `color`, and exactly one readable data title field.
|
|
76
|
-
- Cross-app relation fields are present where the business model needs them; each relation uses a confirmed `targetAppKey` and object selectors in `config.
|
|
76
|
+
- Cross-app relation fields are present where the business model needs them; each relation uses a confirmed `targetAppKey` and object selectors in `config.displayField` / `config.visibleFields`.
|
|
77
77
|
- Core apps were created with complete AppForm declarations, so fields and readable form sections/rows were submitted together.
|
|
78
78
|
- Core operating views exist and their `query_conditions` and `action_buttons` are verified; list-row buttons and detail-page buttons are both configured through the view.
|
|
79
79
|
- Each new app has 5 realistic sample records unless the user explicitly skipped sample data.
|
|
@@ -185,7 +185,7 @@ current CLI payload.
|
|
|
185
185
|
| 负责人、审批人、参与人 | `member` | 不要创建“申请人/提交人”等平台系统字段 |
|
|
186
186
|
| 部门、组织 | `department` | 可按需要补 `config.departmentScope` |
|
|
187
187
|
| 图片、文件、附件 | `attachment` | 只有顶层 `attachment` 可被应用级 `dataCoverField` 选择 |
|
|
188
|
-
| 跨应用业务对象关系 | `relation` | 使用已确认的 `targetAppKey
|
|
188
|
+
| 跨应用业务对象关系 | `relation` | 使用已确认的 `targetAppKey`;`displayField` / `visibleFields` 必须写对象选择器 |
|
|
189
189
|
|
|
190
190
|
禁止创建平台系统字段:`数据ID`、`编号`、`申请人`、`申请时间`、`创建人`、`创建时间`、`提交人`、`提交时间`、`更新时间`、`更新人`、`当前流程状态`、`当前处理人`、`当前处理节点`、`流程标题`。需要引用系统字段时,只在工具明确支持的位置引用,例如按钮 `source_field: "数据ID"`。
|
|
191
191
|
|
|
@@ -243,7 +243,7 @@ current CLI payload.
|
|
|
243
243
|
|--------|----------|-----------------|
|
|
244
244
|
| 标量与选择器 | `name` + `questionType`(+ 业务 `beingRequired` 等) | `questionDescription`、`beingRequired`;数据标题和封面在应用级 `dataTitleField/dataCoverField` 中选择;**`single_select` / `multi_select` 的 `config.options` 是非空字符串数组**,如 `["A", "B"]` |
|
|
245
245
|
| `department` | 同左 | **`config.departmentScope`**:`mode: all \| custom`;`custom` 时 **`departments[]`**(含 `deptId` 等) |
|
|
246
|
-
| `relation` | **`targetAppKey`**;另需 **`
|
|
246
|
+
| `relation` | **`targetAppKey`**;另需 **`displayField`**、**`visibleFields[]`** | **`relationMode`**;目标应用元数据不可读时先读已发布表单,不要猜目标 key |
|
|
247
247
|
| `subtable` | **`subfields[]` 非空** | 子列递归同父级规则;使用 Schema 返回的 camelCase 子字段配置 |
|
|
248
248
|
| `q_linker` | **`config.qLinkerBinding`**:`inputs`、`request`、**`outputs[]` 每项须含 `targetField`**(能解析到本表单字段) | `request.url` 等须符合**租户/后端远程查询策略**;以字段类型 Schema 返回的配置为准 |
|
|
249
249
|
| `code_block` | **`config.codeBlockBinding`**:`inputs`、`code`、**`outputs[]` + `targetField`**;配置 outputs 时,代码必须显式写 **`qf_output = {...}`**,仅 `return {...}` 不会产生可回写结果,且每个 `outputs[].path` 必须从 `qf_output` 取值 | 以字段类型 Schema 返回的 camelCase 配置为准 |
|
|
@@ -265,17 +265,13 @@ current CLI payload.
|
|
|
265
265
|
"config": {
|
|
266
266
|
"targetAppKey": "PRODUCT_APP_KEY",
|
|
267
267
|
"relationMode": "single",
|
|
268
|
-
"
|
|
269
|
-
"
|
|
270
|
-
{"field": {"name": "产品编码"}, "auth": "visible"},
|
|
271
|
-
{"field": {"name": "产品名称"}, "auth": "hidden"},
|
|
272
|
-
{"field": {"name": "产品线"}, "auth": "visible"}
|
|
273
|
-
]
|
|
268
|
+
"displayField": {"name": "产品编码"},
|
|
269
|
+
"visibleFields": [{"name": "产品名称"}, {"name": "产品线"}]
|
|
274
270
|
}
|
|
275
271
|
}
|
|
276
272
|
```
|
|
277
273
|
|
|
278
|
-
只在目标应用已经创建并通过 readback 确认后填写 `targetAppKey`。如果返回选择器校验错误,修复 `config.
|
|
274
|
+
只在目标应用已经创建并通过 readback 确认后填写 `targetAppKey`。如果返回选择器校验错误,修复 `config.displayField` / `config.visibleFields`,不要重建应用或改 `appKey`。
|
|
279
275
|
|
|
280
276
|
引用字段的公式默认值写在 `config.defaultValueFormula`,表达式必须符合固定版本 `relation` 字段详情中的 `FormulaExpression`。不要把后端 `referenceConfig` 字段名或其他 Schema 版本的公式写法直接放进声明。
|
|
281
277
|
|
|
@@ -201,8 +201,8 @@ qingflow builder schema apply \
|
|
|
201
201
|
- 如果返回 `MULTI_APP_STATIC_VALIDATION_FAILED`,读取 `details.issues[]` 的 `path/error_code/fix_hint` 修 payload;这是写入前失败,通常可以修正后重试,不需要 readback。
|
|
202
202
|
- 多应用 schema apply 不做事务回滚;如果部分失败,只补失败的 `apps[].row_number`,不要整批重复提交。
|
|
203
203
|
- 这个模式只负责应用壳与字段;视图、按钮、关联资源、报表仍拿返回的 `app_key` 继续走各自 apply 工具。
|
|
204
|
-
- `target_app_ref`、`as_data_title`、`display_field` 等只属于旧载荷。迁移时将关系改写为 AppForm `config.targetAppKey`、`config.
|
|
205
|
-
- 历史 schema adapter 写入后可读 `details.relation_readback_matrix[]`:逐项核对旧 `target_app_key`、`relation_mode`、`display_field`、`visible_fields`。迁移到当前 AppForm 后,改为读取 draft/published form 的 `config.targetAppKey`、`config.relationMode`、`config.
|
|
204
|
+
- `target_app_ref`、`as_data_title`、`display_field` 等只属于旧载荷。迁移时将关系改写为 AppForm `config.targetAppKey`、`config.displayField`、`config.visibleFields`,并使用已确认的真实 app key。
|
|
205
|
+
- 历史 schema adapter 写入后可读 `details.relation_readback_matrix[]`:逐项核对旧 `target_app_key`、`relation_mode`、`display_field`、`visible_fields`。迁移到当前 AppForm 后,改为读取 draft/published form 的 `config.targetAppKey`、`config.relationMode`、`config.displayField`、`config.visibleFields`,不要提交旧 `update_fields` patch。
|
|
206
206
|
- 一个应用可以包含多个 `relation` 字段;不要因为 relation 数量超过 1 就降级成文本。若真实写入失败或 relation readback mismatch,只按实际错误和 `details.relation_repair_plan[]` 做最小修复。
|
|
207
207
|
- 完整系统遇到超时、`partial_success`、`write_executed=true`、`safe_to_retry=false` 或 readback 不完整时,先按 §3.4 读回,不要直接拆成单应用创建。
|
|
208
208
|
|
|
@@ -349,7 +349,7 @@ qingflow builder flow apply \
|
|
|
349
349
|
| **`address`** | 地址复合字段。 |
|
|
350
350
|
| **`attachment`** | 附件。 |
|
|
351
351
|
| **`boolean`** | 是否。 |
|
|
352
|
-
| **`relation`** | 旧载荷使用 `target_app_key` / `target_app_ref`;当前 AppForm 使用 `config.targetAppKey`、`config.relationMode`、`config.
|
|
352
|
+
| **`relation`** | 旧载荷使用 `target_app_key` / `target_app_ref`;当前 AppForm 使用 `config.targetAppKey`、`config.relationMode`、`config.displayField`、`config.visibleFields`。 |
|
|
353
353
|
| **`subtable`** | 当前 AppForm 使用 `subfields[]` 及 Schema 返回的 camelCase 配置;旧 `subfield_updates` 只作迁移线索。 |
|
|
354
354
|
| **`q_linker`** | 当前 AppForm 使用 `config.qLinkerBinding`,其 `outputs[].targetField` 必须按字段 Schema 配置。 |
|
|
355
355
|
| **`code_block`** | 当前 AppForm 使用 `config.codeBlockBinding`,其 `outputs[].targetField` 必须按字段 Schema 配置。 |
|
|
@@ -43,7 +43,7 @@
|
|
|
43
43
|
|
|
44
44
|
## 4. 记录数据
|
|
45
45
|
|
|
46
|
-
与 **[成员速查](./QINGFLOW_CLI_MEMBER_CHEATSHEET.md)** 及 **[SKILL.md](../../SKILL.md)**
|
|
46
|
+
与 **[成员速查](./QINGFLOW_CLI_MEMBER_CHEATSHEET.md)** 及 **[SKILL.md](../../SKILL.md)**「命令速查」一致:`record schema browse`、`record list`、`record access` **必须** `--view-id`。查询类遵守 **SKILL 落盘**:`record list`、`get`、`access`、`schema browse` 等。最终统计结论、分析报告、趋势/排名/比例/分布统一使用 **[record/analysis](../record/analysis/README.md) 的 `record access -> Python/pandas`**。
|
|
47
47
|
|
|
48
48
|
---
|
|
49
49
|
|