Schema - Data - Bidirectional Relationships

  • Updated

Overview

This feature allows users to create shared relationships between records, making the details of the relationship available from both sides instead of requiring separate configurations.

With this, when two records are connected, the relationship remains consistent as information is updated.

This allows the user to visualize related information from either record while reducing the need for maintenance or configuration.

Prerequisites & Dependencies

Before configuring a bidirectional relationship:

  • The user must enable bidirectional behavior on the relationship field.
  • A connected object must be selected.
  • A compatible relationship field from the connected object must be selected as the inverse field.
  • Each relationship field can belong to only one bidirectional pair.
  • Existing relationship fields must be compatible before they can be paired.
  • Bidirectional relationship fields must be available in the relevant forms when users need to manage the relationship through the interface.

When bidirectionality is enabled on relationship fields that already contain data, existing relationships are synchronized to establish the inverse connections.

Required Permissions

  • Users must have access to Control Center -> Schema.
  • Permission in the Objects section must be granted.

Limitations

  • A relationship field cannot belong to more than one bidirectional pair.
  • Only compatible relationship fields can be selected as inverse fields. This can be by list or by type.
  • Synchronization stops when bidirectional behavior is disabled.
  • Removing bidirectional configuration preserves the existing relationship data but stops future synchronization between both sides.
  • Deleting a relationship removes the corresponding inverse relationship automatically.
  • Deleting a relationship field configured as bidirectional requires administrator confirmation.
  • Configuration on each side of the relationship may be managed independently where supported.
  • Visual indicators for bidirectional relationship fields may depend on the available interface implementation.
  • Relationship Types: Bidirectional Relationships are limited to compatible relationship types. One-to-many relationships and list-based relationship fields may have restrictions when used as inverse fields.
  • Field Compatibility: Only relationship fields with compatible types can be paired. Records that do not correspond with the defined structure cannot be related and the relationship will be denied.
  • Single Pairing: A relationship field can belong to only one bidirectional relationship pair at a time.

Configuration Steps

Existing Objects:

To configure a bidirectional relationship there are three main steps:

  1. Configuring the fields in both objects
  2. Creating the relationship
  3. Giving visibility to the data in forms
  1. Configuring the fields

*Reference image of the Data section with two Objects that will be related.

Users must identify two objects that will be related.This example will use two objects: Settlement and Claim.

  1. Navigate to Schema and enter the Data Section.
  2. Go to the first Object, in this case Settlement.
  3. On the Fields list, look for the +NEW button.
  4. In the added new field, open the Field Setup.
  5. Name the field and give it an API Name.
  6. Select the Field Type: Search for Relationship.
  7. This will open the Related Object selection field.
  8. Look for the second object. For this example, a Claim.
  9. There will be an option to open the Claim fields in another browser tab.
  10. Open Claims and the Field Setup on the other tab.
  11. Create a new field by clicking +NEW.
  12. Name the field and set the API Name.
  13. Select the Field Type: Search for Relationship
  14. This will open the Related Object selection field.
  15. Look for the first object, in this example, Settlement.

NOTE: If any other object is selected, a warning is likely to be displayed. This is because there are not any available relationship fields inside the object.

Now that the relationship fields have been created in both objects, we can create the Bidirectional Relationship.

  1. Creating the relationship

*Reference image of the Field Editor, with the configured field for the Relationship.

  1. Open the Settlement 
  2. Select the Relationship Field to open the Field setup. 
  3. Turn on the Bidirectional Relationship option.This will bring a Related Field selection.
  4. Select the field created in the Claim (Object 2).
  5. Click SAVE.

The Bidirectional Relationship has been created after both objects have the bidirectional field activated and the related fields configured.

  1. Giving visibility to the data in forms

*Reference Image of the DISPLAY Tab in the Data -> Object Builder.

Now that the relationship between the objects has been created, the user must add it to a form to get the related data.

  1. Go to Data -> Forms
  2. Select Settlement form where the field will be inserted.
  3. Add the relationship by clicking it or drag and drop it in the Canvas. This will show the field on display.
  4. Click SAVE.
  5. Now users must add a new form in the Claim.
  6. After creating the form and adding the required fields.
  7. Look for the Relationship in the form elements.
  8. Add the relationship by clicking it or drag and drop.
  9. This will show the field on display.
  10. Click SAVE.

Now both forms show the relationship.

Note: To learn more about the creation of a form go to: schema – forms overview
 

*Reference image of the Field Setup Drawer with the Warning.

Validation

  1. Go to Cases.
  2. Navigate to the Projects section.
  3. Select the project in which the relationship was created.
  4. Look for the Label added to the Contextual Menu.
  5. Enter the Form.
  6. The Relationship field must be displayed.
  7.  

Legal example | Veterans Affairs

Consider a Veteran who files a Veteran Affairs (VA) disability claim seeking compensation for a service-connected condition. After reviewing the claim and the supporting evidence, the U.S. Department of Veterans Affairs issues a Decision that determines the outcome of that claim. This decision may grant, partially grant, or deny the requested benefits.

A law firm representing Veterans may manage Claims and Decisions as separate records because each one contains different information while remaining directly connected.

 

For example:

VA Claim → PTSD Disability Compensation Claim

↳ VA Decision → Disability Compensation Decision

 

From the other direction:

VA Decision → Disability Compensation Decision

↳ VA Claim → PTSD Disability Compensation Claim

 

A Bidirectional Relationship makes the connection available from both sides. When reviewing the VA Claim, legal professionals can quickly identify the related Decision. Likewise, when reviewing the Decision, they can immediately identify the Claim to which it belongs.

This demonstrates the value of Bidirectional Relationships: when two related legal records represent different parts of the same process, the relationship can be accessed and maintained from either side without creating separate relationships for each direction.

 

Troubleshooting

  • Go to the list of permissions related to Control Center.
  • Make sure the Object Permissions are active and assigned.
  • If there are some fields that do not change, this could be a cache problem. Reload the page.
  • If there are no records in the object that are not able to bring information, go to Cases -> Projects and select a form in the context menu to add data into the object records.