| name | cmw-platform-process-record-fill |
| description | Fills or updates running process instance records (work orders, events, form.oa) on Comindware Platform via Records API or create_edit_record. Use for process instance, work order, running process, demo fill, or placeholder message text on in-progress rows. Instance-agnostic via CMW_BASE_URL. Prefer OpenAPI and GET/PUT before browser; browser only for workflow buttons/transitions. |
CMW Platform — Process record demo fill
Update existing process-owned template rows (e.g. work-order / event templates) with target-locale demo text in place. Do not clone source record ids, workflow state, or source-locale copy onto the target unless a spec explicitly requires new instances via ProcessObjectService.
Workflow order: OpenAPI → get record tools → Attribute/List → PUT/create_edit_record → verify GET → browser only for workflow buttons/transitions. See cmw-platform § Workflow order.
Instance progress: log in {instance_progress_dir} — localization/migration_progress/YYYYMMDD_phaseN_process_demo_fill.json, findings in docs/localization/progress_reports/. Do not store instance batch JSON in cmw-platform-agent.
How it works (technical)
- Process instances are records on a template (e.g.
{App}.{WorkOrderTemplate}) bound to a process. UI URL: #form/oa.{appId}/form.{formId}/{recordId}.
- Discover aliases:
GET webapi/Attribute/List/Template@{App}.{Template} → use PascalCase API aliases in PUT/create_edit_record, not lowercase keys from GET webapi/Record/{id}. Wrong casing often returns 200 with no field change.
- GET full record first — read current state, process binding, status refs, assignees. Preserve workflow-related ids and status unless intentionally advancing the process.
- PUT/PATCH via Records API or
create_edit_record (operation=edit, numeric record_id) with minimal changed fields + preserved ids/status.
- Do not clone source process state — edit existing target rows; optional source list harvest is read-only for message patterns. Create new instances via ProcessObjectService only when the spec requires it.
- Indicator widgets (e.g.
dwc.{N} Active count) are query-driven on template rows (e.g. status not complete/cancelled). Filling in-progress rows updates dashboards without editing widget JSON.
Discovery checklist
| Step | Action |
|---|
| URL → template | #form/oa.* → object app; GET webapi/Record/{id} for template/process hints (lowercase in body) |
| Writable fields | GET webapi/Attribute/List/Template@{App}.{Template} → PascalCase aliases |
| KPI / indicator | #indicator/id=dwc.{N} → backup WidgetConfigs/*.json or export: QueryRule, Template, AggregationMethod |
| Source patterns (optional) | GET webapi/Records/Template@{App}.{Template} or list_template_records on source host — patterns only |
Edit pattern
GET webapi/Record/{recordId}
GET webapi/Attribute/List/Template@{App}.{WorkOrderTemplate}
PUT webapi/Record/{recordId}
Content-Type: application/json
{ "<PascalCaseMessageAlias>": "...", "<PascalCaseAssigneeNoteAlias>": "..." }
Tool path (preferred):
create_edit_record(
operation=edit,
application_system_name={App},
template_system_name={WorkOrderTemplate},
record_id=<numeric>,
values={ <PascalCase aliases> }
)
Verify: GET webapi/Record/{id} — compare lowercase keys in response to intended text.
Demo content
- Tone: Operational English (or target locale per instance spec) for tenant-facing and dispatcher fields.
- Scenarios: Synthetic facility-management scenarios (HVAC, lighting, exhaust, SLA overdue) — not verbatim translated source copy unless the instance spec requires it.
- Personas: Leave existing requester/assignee refs unless the batch spec changes them.
- Picklists: Keep existing status/type refs unless advancing workflow is in scope.
Discover field aliases from Attribute/List on your template — do not assume alias names from another tenant export.
Pitfalls
| Issue | Mitigation |
|---|
| PUT 200 but fields unchanged | PascalCase from Attribute/List, not lowercase GET keys |
_put_request argument order | Body first, endpoint second |
| Location empty after PUT | Likely derived or blocked while process active; use building/space refs in a later batch |
| Advancing workflow | May require UI user commands — API fill is data-only by default |
| Source→target ids | Do not map source record ids onto target; edit pre-existing target rows |
Indicator KPIs
Usually no API action on dwc.* — populate underlying work-order rows so filters match (e.g. status not complete/cancelled). Edit widget config only when label or query rule is wrong.
Verification
GET webapi/Record/{id} for each edited id.- Open form URLs and optional
#indicator/id=dwc.{N} for visual proof.
- Append edits and verification URLs to instance progress JSON.
Scripts and references
Cross-links
