Skip to main content

Data Processing

This category lists the 17 Runtime system commands under system.data-processing..

1. List jobs​

Full name: system.data-processing.job.list

List data processing job records. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

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]

Parameters:

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

2. Retrieve job​

Full name: system.data-processing.job.get

Retrieve data processing job resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

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

Parameters:

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

3. Start export​

Full name: system.data-processing.export.start

Start data processing export resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

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

Parameters:

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

4. Inspect spreadsheet​

Full name: system.data-processing.spreadsheet.inspect

Inspect the exact sheets, headers, merged ranges, dimensions, diagnostics, and bounded preview rows of a tenant File Bag XLSX workbook. · Risk: Read

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

Parameters:

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

5. Read spreadsheet rows​

Full name: system.data-processing.spreadsheet.rows.read

Read one exact XLSX worksheet as typed, formula-aware rows with bounded pagination. · Risk: Read

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

Parameters:

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

6. Preview spreadsheet import​

Full name: system.data-processing.spreadsheet.import.preview

Validate an XLSX-to-form mapping and every source row without writing records. · Risk: Read

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

Parameters:

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

7. Start spreadsheet import​

Full name: system.data-processing.spreadsheet.import.start

Start an asynchronous XLSX-to-form import from a current successful preview hash. · Risk: Write

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

Parameters:

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

8. Start spreadsheet transform​

Full name: system.data-processing.spreadsheet.transform.start

Start an asynchronous tenant-side XLSX transformation job for structured cell, conditional locate-and-apply, row, sheet, style, width, split-column, and merge operations. The source workbook is never overwritten. · Risk: Write

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

Parameters:

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

9. Inspect Word document​

Full name: system.data-processing.word.inspect

Inspect the data processing word Runtime operation. This tenant-scoped command validates its input against the registered command schema. · Risk: Read

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

Parameters:

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

10. Preview Word document transform​

Full name: system.data-processing.word.transform.preview

Preview data processing word transform resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

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

Parameters:

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

11. Start Word document transform​

Full name: system.data-processing.word.transform.start

Start data processing word transform resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Write

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

Parameters:

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

12. Preview Word document template​

Full name: system.data-processing.word.template.preview

Preview data processing word template resource. This tenant-scoped Runtime command validates its input against the registered command schema. · Risk: Read

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

Parameters:

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

13. Render Word document template​

Full name: system.data-processing.word.template.render

Render the data processing word template Runtime operation. This tenant-scoped command validates its input against the registered command schema. · Risk: Write

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

Parameters:

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

14. Create import record​

Full name: system.data-processing.import.record.create

Create data processing import record resource. This tenant-scoped Runtime command validates its input against the registered command schema. The Runtime checks the corresponding button permission and runs configured before/after scripts, including each child-table write. A failed before script prevents the transaction. Inspect afterScript and childScripts: an after-script failure does not roll back committed data and must not trigger a repeat write. Delete through preset:detail.delete or preset:listBatch.delete; never set dataStatus to trashed in an update. Submit approval is determined by server configuration. · Risk: Write

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

Parameters:

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

15. Batch-create import record​

Full name: system.data-processing.import.record.batch-create

Batch-create data processing import record resource. This tenant-scoped Runtime command validates its input against the registered command schema. The Runtime checks the corresponding button permission and runs configured before/after scripts, including each child-table write. A failed before script prevents the transaction. Inspect afterScript and childScripts: an after-script failure does not roll back committed data and must not trigger a repeat write. Delete through preset:detail.delete or preset:listBatch.delete; never set dataStatus to trashed in an update. Submit approval is determined by server configuration. · Risk: Write

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

Parameters:

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

16. Batch-create master-detail records​

Full name: system.data-processing.import.record.master-detail-batch-create

Master detail batch create the data processing import record Runtime operation. This tenant-scoped command validates its input against the registered command schema. The Runtime checks the corresponding button permission and runs configured before/after scripts, including each child-table write. A failed before script prevents the transaction. Inspect afterScript and childScripts: an after-script failure does not roll back committed data and must not trigger a repeat write. Delete through preset:detail.delete or preset:listBatch.delete; never set dataStatus to trashed in an update. Submit approval is determined by server configuration. · Risk: Write

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

Parameters:

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

17. Update import record​

Full name: system.data-processing.import.record.update

Update data processing import record resource. This tenant-scoped Runtime command validates its input against the registered command schema. The Runtime checks the corresponding button permission and runs configured before/after scripts, including each child-table write. A failed before script prevents the transaction. Inspect afterScript and childScripts: an after-script failure does not roll back committed data and must not trigger a repeat write. Delete through preset:detail.delete or preset:listBatch.delete; never set dataStatus to trashed in an update. Submit approval is determined by server configuration. · Risk: Write

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

Parameters:

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