Ruleworks developer reference
Integration boundary
Section titled “Integration boundary”Use Preview to inspect matches. TestRecord stamps configuration history; RunNow and activation can produce business effects. Rule packs are the appropriate portability boundary; plugin registrations are owned by the module.
pfx_RuleworksPreview
Section titled “pfx_RuleworksPreview”Read-only record matching. This example has no condition tree; constrain real queries to the intended business scope. The response also includes fetchXml. A render request uses a different optional branch of the same contract.
Transport: unbound Dataverse action; JSON string Request in, JSON string Response out. pfx_ is a prefix token, not a literal deployment name. Read the calling conventions first.
Request
Section titled “Request”{ "table": "account", "top": 5}table: required logical table name. top: requested sample size. tree: optional condition tree; omitted here.
Response
Section titled “Response”{ "count": 0, "countCapped": false, "records": [], "changeNodesIgnored": false}Permissions and failures
Section titled “Permissions and failures”The schema requires Write privilege on pfx_RuleSet. Prefix tokens in table names resolve with the installed publisher. Record access, module role checks and input validation can further restrict the call. Do not interpret a missing execute privilege as anonymous or unrestricted access.
Handle a Dataverse fault separately from validation findings in the response. Test invalid input and the intended non-administrator role. Do not treat an empty result as a grant of access or a guarantee that no configuration exists.
Plugin steps and customizations
Section titled “Plugin steps and customizations”Selected schema-declared registrations are shown for troubleshooting context. This is not a complete installed registration inventory. Preserve module-owned registrations; do not duplicate or disable them.
| Owned registration | Message / table | Declared stage / mode |
|---|---|---|
| Ruleworks lifecycle: pfx_ruleset Create | Create · pfx_ruleset |
Not specified in schema / Not specified in schema |
| Ruleworks lifecycle: pfx_ruleset Update | Update · pfx_ruleset |
Not specified in schema / Not specified in schema |
| Ruleworks lifecycle: pfx_ruleset Delete | Delete · pfx_ruleset |
Not specified in schema / Not specified in schema |
The full execution path may also include dynamically maintained registrations. Inspect the installed solution for exact stage, mode, filters and images before investigating interactions with your own plugins.
Before building against this preview
Section titled “Before building against this preview”Confirm the installed operation name and permissions. Test representative data, empty results and denied access. Keep your integration in its own solution, and review contract changes before upgrading.