跳到主要内容

数据处理

该分类包含 17 条以 system.data-processing. 开头的 Runtime 系统命令。

1. 列出任务​

完整命令：system.data-processing.job.list

列出数据处理任务。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 · 风险：读取

sl system data-processing job list \
  [--job-type value|--job-types-json '["import","export"]'] \
  [--status value] [--form-id <uuid>] [--keyword value] \
  [--latest-per-target] [--cursor value] [--limit n] [--json]

参数：

  • jobType|jobTypes（可选）— Use at most one. The task-record page normally requests import and export together
  • status（可选）— queued, running, succeeded, failed, or canceled
  • formId（可选）— Exact form UUID returned by system.form.schema.list
  • keyword（可选）— Matches job type/status, form, file, creator, and error text; at most 200 characters
  • latestPerTarget（可选）— Return only the latest job per target. Intended for target-based recalculation jobs, not the import/export task table
  • cursor（可选）— Opaque nextCursor returned by the previous request
  • limit（可选）— Maximum rows to return, 1-100; defaults to 20

2. 获取任务​

完整命令：system.data-processing.job.get

获取数据处理任务资源。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 · 风险：读取

sl system data-processing job get --job-id <uuid> [--json]

参数：

  • jobId（必填）— Job UUID returned by job.list or export.start

3. 启动导出​

完整命令：system.data-processing.export.start

启动数据处理导出资源。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 · 风险：写入

sl system data-processing export start \
  (--definition-json json|--definition-file path) [--json]

参数：

  • forms（必填）— 1-50 unique form export specifications. Each specification requires formId and may add record filters
  • fileMode（可选）— multiple_files creates a ZIP for multiple forms; single_workbook creates one workbook with multiple sheets. Defaults to multiple_files
  • includeRecordId（可选）— Include the Soln record ID column; defaults to true
  • fileNamePrefix（可选）— Optional batch output filename prefix, at most 160 characters
  • locale（可选）— Optional output locale used for labels and messages

4. 检查电子表格​

完整命令：system.data-processing.spreadsheet.inspect

检查租户文件资源中 XLSX 工作簿的具体工作表、表头、合并区域、维度、诊断信息与有限的预览行。 · 风险：读取

sl system data-processing spreadsheet inspect \
  --file-asset-id <uuid> [--sheet-name value] [--header-row n] \
  [--preview-row-limit n] [--json]

参数：

  • fileAssetId（必填）— Tenant File Bag XLSX asset UUID
  • sheetName（可选）— Exact worksheet name. Omit to inspect every worksheet
  • headerRow（可选）— 1-based header row; defaults to 1
  • previewRowLimit（可选）— Preview data rows per worksheet, 1-100; defaults to 20

5. 读取电子表格行​

完整命令：system.data-processing.spreadsheet.rows.read

按精确工作表读取带类型、可理解公式的行，并支持有限分页。 · 风险：读取

sl system data-processing spreadsheet rows read \
  --file-asset-id <uuid> --sheet-name value [--header-row n] \
  [--start-row n] [--limit n] [--json]

参数：

  • fileAssetId（必填）— Tenant File Bag XLSX asset UUID
  • sheetName（必填）— Exact worksheet name returned by spreadsheet.inspect
  • headerRow（可选）— 1-based header row; defaults to 1
  • startRow（可选）— First data row to return; defaults to the row after headerRow
  • limit（可选）— Rows to return, 1-1000; defaults to 200

6. 预览电子表格导入​

完整命令：system.data-processing.spreadsheet.import.preview

校验 XLSX 到表单的映射与每一行源数据，但不写入任何记录。 · 风险：读取

sl system data-processing spreadsheet import preview \
  (--definition-json json|--definition-file path) [--json]

参数：

  • fileAssetId（必填）— Tenant File Bag XLSX asset UUID
  • sheetName（必填）— Exact worksheet name
  • formId（必填）— Exact target form UUID
  • titleColumn（必填）— Exact source header used as the record title
  • mappings（必填）— Unique sourceColumn to writable fieldApiName mappings with exact conversion and emptyPolicy
  • previewRowLimit（可选）— Valid converted rows returned in the preview, 1-100; all rows are still validated

7. 启动电子表格导入​

完整命令：system.data-processing.spreadsheet.import.start

基于最近一次成功的预览哈希，启动异步的 XLSX 导入表单任务。 · 风险：写入

sl system data-processing spreadsheet import start \
  (--definition-json json|--definition-file path) [--json]

参数：

  • fileAssetId|sheetName|formId|titleColumn|mappings（必填）— Must exactly match the validated preview definition
  • previewHash（必填）— SHA-256 previewHash returned by spreadsheet.import.preview
  • dataStatus（可选）— draft, active, or archived; defaults to active
  • createdByMemberId（可选）— Optional tenant member UUID used as creator audit identity
  • submitApproval（可选）— Queue approval submission for each created row when true

8. 启动电子表格转换​

完整命令：system.data-processing.spreadsheet.transform.start

启动租户侧的异步 XLSX 转换任务，支持单元格、条件查找替换、行、工作表、样式、列宽、拆分列与合并操作；不会覆盖源工作簿。 · 风险：写入

sl system data-processing spreadsheet transform start \
  (--definition-json json|--definition-file path) [--json]

参数：

  • fileAssetId（必填）— Source tenant File Bag XLSX asset UUID. The source is never overwritten
  • sheetName（必填）— Exact worksheet name returned by spreadsheet.inspect
  • headerRow（可选）— 1-based header row; defaults to 1
  • operations（必填）— 1-100 ordered splitColumn, mergeRange, mergeAdjacent, locateAndApply, setCells, appendRows, insertRows, deleteRows, addSheet, renameSheet, setColumnWidth, or setStyle operations
  • output.fileName（必填）— New output file name ending in .xlsx

9. 检查Word 文档​

完整命令：system.data-processing.word.inspect

检查数据处理Word 文档资源。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 · 风险：读取

sl system data-processing word inspect \
  --file-asset-id <uuid> [--preview-character-limit n] [--json]

参数：

  • fileAssetId（必填）— Tenant File Bag DOCX asset UUID
  • previewCharacterLimit（可选）— Maximum combined body/header/footer preview characters, 1-100000; defaults to 30000

10. 预览Word 文档转换​

完整命令：system.data-processing.word.transform.preview

预览数据处理Word 文档转换资源。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 · 风险：读取

sl system data-processing word transform preview \
  (--definition-json json|--definition-file path) [--json]

参数：

  • fileAssetId（必填）— Source tenant File Bag DOCX asset UUID. The source is never overwritten
  • operations（必填）— 1-100 ordered replaceText or setProperties operations
  • output.fileName（必填）— New output filename ending in .docx

11. 启动Word 文档转换​

完整命令：system.data-processing.word.transform.start

启动数据处理Word 文档转换资源。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 · 风险：写入

sl system data-processing word transform start \
  (--definition-json json|--definition-file path) [--json]

参数：

  • fileAssetId|operations|output（必填）— Must exactly match the validated transform preview definition
  • previewHash（必填）— SHA-256 previewHash returned by word.transform.preview

12. 预览Word 文档模板​

完整命令：system.data-processing.word.template.preview

预览数据处理Word 文档模板资源。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 · 风险：读取

sl system data-processing word template preview \
  (--definition-json json|--definition-file path) [--json]

参数：

  • template（必填）— Strict semantic DOCX document containing {{variable}} placeholders in text fields
  • values（可选）— Up to 1000 scalar values keyed by exact placeholder name

13. 渲染Word 文档模板​

完整命令：system.data-processing.word.template.render

渲染数据处理Word 文档模板资源。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 · 风险：写入

sl system data-processing word template render \
  (--definition-json json|--definition-file path) [--json]

参数：

  • template（必填）— Strict semantic DOCX document containing {{variable}} placeholders in text fields
  • values（可选）— Up to 1000 scalar values keyed by exact placeholder name
  • fileName（必填）— Output DOCX filename stored as a new tenant File Bag artifact
  • strictMissing（可选）— Reject unresolved placeholders when true; defaults to true

14. 创建导入记录​

完整命令：system.data-processing.import.record.create

创建数据处理导入记录资源。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 Runtime 会检查对应的按钮权限并执行配置的前置/后置脚本（包含每个子表写入）；前置脚本失败会阻止整个事务。请检查 afterScript 与 childScripts：后置脚本失败不会回滚已提交数据，也不要因此重复写入。删除请使用 preset:detail.delete 或 preset:listBatch.delete，不要在更新里把 dataStatus 置为 trashed。提交审批由服务端配置决定。 · 风险：写入

sl system data-processing import record create \
  (--definition-json json|--definition-file path) [--json]

参数：

  • formId（必填）— Target form UUID
  • title（必填）— Record title
  • data（必填）— Object keyed by exact writable field API names
  • dataStatus（可选）— draft, active, or archived
  • createdByMemberId（可选）— Optional tenant member UUID used as the imported creator audit identity
  • submitApproval（可选）— Queue approval submission after creation when true

15. 批量创建导入记录​

完整命令：system.data-processing.import.record.batch-create

批量创建数据处理导入记录资源。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 Runtime 会检查对应的按钮权限并执行配置的前置/后置脚本（包含每个子表写入）；前置脚本失败会阻止整个事务。请检查 afterScript 与 childScripts：后置脚本失败不会回滚已提交数据，也不要因此重复写入。删除请使用 preset:detail.delete 或 preset:listBatch.delete，不要在更新里把 dataStatus 置为 trashed。提交审批由服务端配置决定。 · 风险：写入

sl system data-processing import record batch-create \
  (--definition-json json|--definition-file path) [--json]

参数：

  • records（必填）— 1-100 import records. The entire batch is written in one tenant transaction

16. 批量创建主子表记录​

完整命令：system.data-processing.import.record.master-detail-batch-create

批量创建主子表记录数据处理导入记录资源。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 Runtime 会检查对应的按钮权限并执行配置的前置/后置脚本（包含每个子表写入）；前置脚本失败会阻止整个事务。请检查 afterScript 与 childScripts：后置脚本失败不会回滚已提交数据，也不要因此重复写入。删除请使用 preset:detail.delete 或 preset:listBatch.delete，不要在更新里把 dataStatus 置为 trashed。提交审批由服务端配置决定。 · 风险：写入

sl system data-processing import record master-detail-batch-create \
  (--definition-json json|--definition-file path) [--json]

参数：

  • records（必填）— 1-100 parent records with 1-50 child-table groups each. Parent and children are created atomically

17. 更新导入记录​

完整命令：system.data-processing.import.record.update

更新数据处理导入记录资源。此租户级 Runtime 命令会按已注册的命令 schema 校验输入。 Runtime 会检查对应的按钮权限并执行配置的前置/后置脚本（包含每个子表写入）；前置脚本失败会阻止整个事务。请检查 afterScript 与 childScripts：后置脚本失败不会回滚已提交数据，也不要因此重复写入。删除请使用 preset:detail.delete 或 preset:listBatch.delete，不要在更新里把 dataStatus 置为 trashed。提交审批由服务端配置决定。 · 风险：写入

sl system data-processing import record update \
  --record-id <uuid> (--definition-json json|--definition-file path) \
  [--json]

参数：

  • recordId（必填）— Existing record UUID discovered with system.form.record commands
  • title|data|dataStatus（必填）— Provide at least one changed value. data uses exact writable field API names