--- title: Miscellaneous Contracts — Validation Rules aliases: [misc validation, utility-contract validation, lightweight-contracts] sources: [ rcg-mobile-dev-agent/raw/006-contract-types-matrix.md, rcg-mobile-dev-agent/wiki/contracts/bohelper.md, rcg-mobile-dev-agent/wiki/contracts/locale.md, rcg-mobile-dev-agent/wiki/contracts/validation-messages.md, rcg-mobile-dev-agent/wiki/contracts/domain-repository.md, rcg-mobile-dev-agent/wiki/contracts/image.md, rcg-mobile-dev-agent/wiki/contracts/global-labels.md, rcg-mobile-dev-agent/wiki/contracts/package.md, rcg-mobile-dev-agent/wiki/contracts/actor-repository.md, ] last_updated: 2026-04-26 status: seed --- # Miscellaneous Contracts — Validation Rules Covers authoring-facing validation for the lightweight contract types: **BusinessObjectHelper**, **Locale**, **ValidationMessages**, **DomainRepository**, **Image**, **GlobalLabels**, **Package**, and **ActorRepository**. These types have simpler validation surfaces than BO/LO/DS/UI but still share cross-cutting rules. They're grouped on one page because each type has only a handful of authoring rules — a dedicated page per type would be over-weighting them. ## Cross-cutting rules (apply to every contract type) Two workspace-wide rules fire during every validation run, regardless of contract type: - Contract names must be unique across the whole workspace. If two files — even of different contract types — share the same root `@name`, both are rejected. - A deployment may declare at most 5 "platform objects" (business objects tagged for quick-action surfaces). Exceeding this cap is rejected. Files must also be readable, well-formed XML with a recognized root element, otherwise a fatal error fires before any type-specific rule runs. ## BusinessObjectHelper (BoHelper) A BOHelper (`.businessobjecthelper.xml`) is a reusable set of SimpleProperties and Methods that BOs can compose. It's technically a "partial-validation" type in the framework catalog but has a full cross-contract validator anyway. ### Must - Root element is ``; the root `@name` must match the pattern `BoHelper.+`. - File name starts with `BoHelper` and ends with `.businessobjecthelper.xml`. Custom BOHelpers start with `My` (or your customizing prefix) in both the file name and the root `@name`. - Each SimpleProperty's `@type` must resolve either to a JavaScript base type or to a Domain declared in DomainRepository. - Each non-standard `` (except `createAsync`) must have a matching BL file — missing BLs are warned. ### Must not - Two SimpleProperties within a BOHelper cannot share a name; two Methods cannot share a name. - Reserved method names (`loadAsync`, `beforeLoadAsync`, `saveAsync`, etc.) are disallowed inside a BOHelper — those belong on BOs. ### Coerced - `xmlns="*.xsd"` on the root is stripped. ## Locale Each Locale (`.locale.xml`) file holds translations for one language. The XSD is large (eight translation sections, 18 declared types), but the authoring-level rules are thin. ### Must - Root element is ``. - Custom Locales start with the customizing indicator in the file name. - Every `_` combination must be unique across all Locale contracts in the workspace — two files claiming the same locale are rejected. - `Label @id` values must be unique inside each translation section (per-section uniqueness, not global); component ids (UI / process / BO / AdvancedSearchObject / PrintLayout) must be unique; image ids in the `Images` section must be unique. ### Must not - Duplicate `_` across Locale contracts. ### Coerced - `xmlns="*.xsd"` on the root is stripped. ## ValidationMessages The ValidationMessages contract is tiny — a flat list of named messages. Its XSD is 18 lines and its validator is 60. ### Must - Root element is ``. - File name starts with the core or customizing prefix and ends with `.validationmessages.xml`. Custom files start with the customizing prefix in both the file name and the root `@name`. - Every `ValidationMessage @name` is unique within the file. ### Must not - Two messages cannot share a name. ### Coerced - `xmlns="*.xsd"` on the root is stripped. ## DomainRepository DomainRepository is the dictionary of Domain types that tables, BOHelpers, and BO SimpleProperties reference by name. There's only ever one `Domains.xml` per workspace. ### Must - Root element is ``; every `` declares `@name`, `@baseType`, and `@length`. - Each `` contains exactly one `` and one `` (the XSD uses `xs:all`, so the order is free but both must be present). - File name must be exactly `Domains.xml` — no prefix, no customizing variant. - Inside each ``, either `value` or `nullable` must be set. ### Must not - A Domain cannot have a `@name` that is missing, empty, or starts with `__` (reserved for framework-internal domains). ### Coerced - Missing `@length` is warned; missing `@baseType` is warned. Add both rather than relying on the warning. - `xmlns="*.xsd"` on the root is stripped. ## Image An Image contract (`.image.xml`) declares a 3-tier platform/device hierarchy: OS-specific image → device-specific image → default image. ### Must - Root element is ``. - File name ends with `.image.xml`. Custom images start with the customizing indicator in both the file name and the root `@id`. - Every `` must have `id`; every `` must have `mimetype`. ### Must not - Within a single container, there can be only one of each OS variant, one of each device variant, and one default entry — duplicates are rejected. ### Coerced - The XSD intentionally leaves `@mimetype` as an open `xs:string` (the enum is commented out in `Image.xsd`) — any value is accepted. - `xmlns="*.xsd"` on the root is stripped. ## GlobalLabels GlobalLabels is the simplest contract type — its XSD maps to a root `` (note: not ``) that holds a flat list of labels. ### Must - Root element is `` (not ``, despite the contract-type name). ### Must not - Two `