How to Create a Data Model?

When you need to store data specific to your business that doesn't fit into standard system entities, creating a data model allows designing your own structure. This instruction will help create a new model with fields and data types.

When Needed

  • You need to store product or service catalogs.
  • You need to create a client database for a contact center with additional fields.
  • You need to organize storage of arbitrary data unique to the company.

What's Important to Know

  • Data model — table structure with defined fields and data types.
  • Model field — column in a table with a specific data type (text, number, date, etc.).
  • Model group — category for organizing models into logical groups.

Prerequisites

  • You are logged in with integrator or administrator rights.
  • You have navigated to the Custom Data module via Apps -> Custom Data.
  • There is at least one model group in the system (if you need to assign a model to a group).

Step-by-Step Instructions

  1. In the Custom Data module, go to the "Create/Update" tab — a form for creating a model opens.
  2. In the "Model Name" field, enter the model name (for example, "Product Catalog").
  3. In the "Model Description" field, enter a short description of the model's purpose (optional).
  4. In the "Group" field, select the group to which the model belongs, or leave it empty.
  5. In the "Model JSON" section, add model fields:
    • Click the "Add Field" button.
    • Enter a unique field name in Latin without spaces (for example, product_name).
    • Select the field type (text, number, date, etc.).
    • Specify the field label — name that will be displayed in the interface (for example, "Product Name").
  6. Repeat step 5 for all necessary fields.
  7. Click the "Create/Update" button — the model is saved and becomes available for use.

What Happens After

The model appears in the list of available models on the "Data" tab. Now you can add records to this model or import data from files.

How to Verify It Worked

  • Check that the model appears in the dropdown list on the "Data" tab.
  • Try selecting the model and make sure all fields display correctly.
  • Create a test record to verify the model works.