Skip to main content

VStitcher Error Codes and Error Diagnostics

When working with VS-CLI through BwApi, errors are reported using VStitcher error codes. Understanding how and where these codes appear is essential for effective debugging.

Updated this week

How VStitcher Error Codes Are Reported

1. UI Error Dialogs

  • When an error occurs in VStitcher UI or Python Playground, an error dialog is displayed

  • The dialog includes:

    • A human-readable message

    • A VStitcher error code

These UI dialogs often provide more context than VS-CLI output.

2. Programmatic Access via BwApi

After a failed operation, the last error can be queried directly from the backend:

BwApi.GetLastError()

This returns:

  • The last error code generated by the VStitcher backend

  • Useful when:

    • Debugging step-by-step in Python Playground

    • Validating error handling logic in scripts

    • Investigating silent failures in headless execution

3. VS-CLI Behavior

  • VS-CLI may exit with:

    • A non-zero exit code

    • Limited console output

  • The underlying VStitcher error code is still generated internally and can often be found:

    • In CLI log files

    • By reproducing the failing operation in Python Playground and calling BwApi.GetLastError()


Authoritative List of Error Codes

The complete and up-to-date list of VStitcher error codes is maintained on Browzwear Zendesk:

This page includes:

  • Error code values

  • Meaning of each error


Recommended Debugging Workflow

  1. Observe the error code shown in UI (if applicable)

  2. If using Python Playground, call:

    BwApi.GetLastError()
  3. Look up the error code in the Zendesk reference

  4. Adjust API usage, parameters, or operation order

  5. Re-test before running scripts in VS-CLI


Key Notes

  • Error codes are generated by the VStitcher backend

  • Python Playground is the best environment to inspect errors interactively

  • Always rely on the Zendesk error code reference as the source of truth

Did this answer your question?