How to Extend Client Contacts Table Through Custom Data?

A Custom Data model can be used to add additional fields to the Clients table. This allows storing additional information about clients that is not included in standard system fields.

When Needed

  • You need to add additional fields to the Clients table (for example, date of birth, additional contacts, special tags).
  • You need to display custom data directly in the Clients table.
  • You need to integrate additional client information from Custom Data.

What's Important to Know

  • Extending contacts — option in a Custom Data model that allows adding fields to the Clients table.
  • You need to add a reg_user_id field of type INTEGER with parameter unique: true.
  • User ID is not displayed in the interface — it can be found through the browser console.
  • Data from the Custom Data table will appear in the Clients table for the corresponding client.

Prerequisites

  • You are logged in with administrator rights.
  • You have navigated to the Custom Data module via Apps -> Custom Data.
  • You know which additional fields need to be added to the Clients table.

Step-by-Step Instructions

  1. In the Custom Data module, go to the "Create/Update" tab.
  2. Create a new model or edit an existing one.
  3. Enable the "Use for extending contact fields" option.
  4. Add the required field:
    • Field Name: reg_user_id
    • Field Type: INTEGER
    • Uniqueness: enable the unique: true option
  5. Add other fields that need to be displayed in the Clients table:
    • Field name (for example, "Date of Birth", "Additional Phone")
    • Field type (TEXT, DATE, INTEGER, etc.)
    • Display settings (name, icon, color)
  6. Save the model.

Filling Data

After saving the model:

  1. Go to the "Data" tab in the Custom Data module.
  2. Create records for clients:
    • In the reg_user_id field, specify the client ID (it can be found through the browser console)
    • Fill in other additional fields
  3. Save records.

💡 Tip: User ID is not displayed in the interface. It can be found through the browser console (F12 → Console → find client ID).

What Happens After

After saving the model with the enabled "Use for extending contact fields" option, added fields will be displayed in the "Clients" menu. In Custom Data records, you need to specify the client ID in the reg_user_id field. Data from the Custom Data table will appear in the Clients table for the corresponding client.

How to Verify It Worked

  • Check that the "Use for extending contact fields" option is enabled.
  • Make sure the reg_user_id field is added with type INTEGER and uniqueness.
  • Check that added fields are displayed in the Clients table.
  • Create a test record with the correct reg_user_id and check that data is displayed in the Clients table.