Relationship Definition Scanning
Relationship definition scanning reads application metadata that says which forms and fields reference each other. Use it when those relationships are not represented by ordinary database foreign keys.
A relationship definition identifies the source form, target form, and optional matching field pairs. It does not merge business tables or replace the form's data reading rule.
Configure A Rule
- Open Relationship definition scanning and create a rule.
- Enter the rule name.
- Select the relationship definition source and choose columns, JSON, or XML reading.
- Configure the source form identifier and whether it is an external ID or form code.
- Configure the target form identifier, or add rules that specify target forms.
- If the metadata supplies field pairs, configure the source and/or target field identifiers.
- Fetch the relationship matching results and resolve missing or ambiguous matches.
- Click Save and start scanning.
The save button remains available when required values are missing. Clicking it shows a global prompt for a missing rule name, incomplete mappings, or missing matching results. It is disabled while loading, saving, or scanning.
Read Definitions From Several Tables
Use additional definition sources when a relationship's metadata is spread across several tables. Choose an existing source, add the supplemental table, and match corresponding columns.
For example, one table may contain the owning form ID while another contains reference-field settings. These joins complete the relationship definition; they are separate from joins used to read business records.
Specify Target Forms
Some applications store a reference type instead of a target form ID. Configure target rules for those values.
| Metadata value | Example target form |
|---|---|
member | member |
department | department |
organization | organization |
These are examples. Use the exact stored values and actual scanned form codes for your source.
All conditions within one target rule must match. A matched target rule takes priority over the target identifier read from the source. If no rule matches, the configured target identifier is used. Conflicting matched targets cause the scan to fail.
Interpret Matching Results
| Result | Meaning and action |
|---|---|
| Matched | The supplied identifier resolves to one discovered form or field |
| Not found | Check the identifier value and ID/code selection; scan the form or field first if necessary |
| Multiple results match | Remove the ambiguity in source definitions or matching configuration |
| Match the owning form first | Resolve the form before matching its fields |
An external field ID must have been read during field discovery before it can be used to match a relationship. The scan does not infer unknown IDs.
If multiple rows describe the conditions of one relationship, configure the relationship identifier used to group those rows. Use the field-list location when one JSON/XML relationship contains several field pairs.
After Scanning
Check the published relationships in the structure view. Related field values can then resolve display names in previews, and declared relationships can help configure datasets. Verify the resulting join conditions before saving the dataset.
Configure a schedule for regular updates. Deleting a relationship scan rule also removes relationships published by that rule; relationships from other rules are retained.
Next, configure data reading rules.