Skip to main content

Developer Help

For developers writing Custom React Apps and Custom Controls against the Parsware Runtime SDK, and integrating external systems through Custom APIs. This is the public-facing API reference, distinct from the internal code docs that live alongside the platform source.

This persona also publishes the machine-readable artifact schemas — the canonical, versioned definitions (JSON Schema and BS Lang grammar) for every designer-backed artifact (processes, reports, forms/views, entity metadata, flows, custom APIs, and more). These are what let a hand-written or AI-generated definition be validated the same way the Designer UI's output is.

Start here: building a Custom App or Custom Control​

If you are writing code that runs inside the Parsware Platform Shell, read these in order. Each page is self-contained, but this is the path from an empty folder to a shipped app.

  1. Build a Custom React App — a whole hand-written screen: project setup, the Module Federation configuration that makes it hostable, the app component, running it standalone, testing it, and shipping it.
  2. Build a Custom Control — a PCF-style field editor that replaces a built-in control on a Model-Driven form: the fixed props contract, which field types a control may substitute for, and the value states it has to handle.
  3. Use the Runtime SDK — the one interface both of the above reach the platform through: identity, scopes, entity metadata, records, lookups, and logging.

Registering what you have built — the part a maker does in the Admin Control Center — is covered by Register a Custom React App and Register a Custom Control.

Reporting​

  • Query entity data for reporting — read a Model-Driven Apps entity's data through the read-only, scope-authorized reporting data source.