Fixing Workflow Errors¶
Step-by-Step¶
1. Check the error log¶
Review for instances marked as "Errored".
2. Retry errored instances¶
Management Studio → Workflows → Search Instances → filter by status: Errored.
For each errored instance: 1. Click the instance → click Retry. 2. Refresh the page after retrying to confirm whether it is now running.
Read errors without the UI:
ms_workflow_errors.py list/show <id>returns the same Search-Instances data (full error, stack, step history, initial Task XML) as JSON — no screenshots needed. Read-only; Retry/Abort/Cancel are not wired. See platform/management-studio-api.md.
3. If retry fails — start a new instance¶
- Copy the workflow data from the errored instance.
- Use the copied data to start a new workflow instance.
4. Check quarantined tasks¶
Management Studio → Tasks → Quarantined Tasks. These may be preventing users from working.
Investigate and resolve the underlying causes.
5. Edit erroneous data¶
Click View on an errored instance → use Data view or Raw XML view to edit incorrect values.
After editing, retry the currently faulted workflow step.
6. Monitor¶
Check results to confirm the workflow completed or identify further errors.
Known Error Patterns¶
Client Visit Basic Load — "path expression did not result in any value"¶
Symptoms:
- Client Visit form does not load tasks after user selects Arrears → tenant → "send task"
- Workflow Errors view shows "Client visit basic load errors"
- Error messages reference XPath expressions GenBP_Insight_kind and GenBP_Insight_red_flags not returning values
Root cause: GenBP_key (the property key/ID) was missing from the initial context of the Client Visit Basic Load workflow. Without it, all downstream steps that use property data fail.
Diagnosis:
1. Go to Management Studio → Workflows → Search Instances → filter by "Client Visit Basic Load" with status "Errored"
2. Open the errored instance → inspect initial data
3. Look for GenBP_key — if absent or empty, this is the cause
Fix (applied in dev May 2026 by Mark Wright):
1. In the Client Visit Basic Load workflow, add an "Append Data Item" step before the first step that uses property data
2. Set the step to copy QLCL_PropertyID (or QL_CL_PropertyID) → GenBP_key
3. Source: "Previous Workflow Step" / "Workflow Subform Loaded" — the property search step that has the property ID
4. This same fix must be applied to all related workflows that suffered the same missing-data issue: Client Visit Basic Load, Schedule Preload Client Visit, Search Areas, Search Contact, Client Load Basic Details
5. Also add GenBP_key as a hidden, read-only, calculated FormItem in the Client Visit form itself (shrunk/invisible, with archivable=True) so the value is sent in task XML
Note: This error only existed in Dev — Live did not have the bug because the code path that introduced it had only been applied in Dev.
Quick Tips¶
- Always refresh after retrying — the UI doesn't auto-update.
- Use error messages as guidance — they usually point to the specific step and parameter that failed.
- Be careful when editing data in Raw XML view — validate the format before saving.
- Workflow instances can be retried without re-submitting a form from a device.