The creation of a custom table allows users to compile additional contact information outside of the project, thus reducing database overloading.
For example, you could use a custom table to keep track of your contacts' consuming history or activities. When a project includes custom tables, it is possible to search these tables to find the corresponding records instead of finding related contacts. Therefore, searching a custom table finds in the table the records that correspond to the specified criteria. In addition, you can display information on the contact related to this data.
|Prerequisite||The custom table module must be activated to take advantage of the related functions.|
|Access Path|| > Configuration > Relational data|
Creating a custom table requires multiple steps:
- In the page listing the existing custom tables, click on Create a custom table.
- In the creation window, specify the name and the code of the new table and then click on Add.
Once the table is created, you need to add fields to it, which can be done right after creation or later on.
When configuring the table's fields, it is important to take into consideration the following points:
• The table MUST contain at least one field defined as a primary key.
• If the primary key is composed of only one field, this field must also be required.
• The table MUST contain at least one field defined as a foreign key.
- Once the table is created, click on Add a field.
- Specify information about the new field.
- Click on OK
- Repeat the previous steps for each field to add to the custom table.
- Once you have added all the desired fields to the table, you need to build the structure of the table and the data to include by clicking on Build.
A built table is always considered in preparation and cannot be used until it is published.
Custom tables offer additional configuration settings, all optional, that let you specify how data from the tables should be integrated in the application. The table below lists all the options offered under Configuration > Relational data > Configuration tab. Once the options have been selected, it is important to save your changes so that the custom tables are integrated as defined.
|Show menu entry dedicated to this table, with links to add and search features||This option displays the table in the left pane menu.|
|Include a link to this table in the "Database" menu||This option adds a link to the table in a section called Database in the left pane menu. In addition, you can specify which page to display when this link is selected, the page to add a field or the page to perform a search.|
|Display a form in the quick search||Activating this option adds the table in the shortcuts in the right pane, allowing you to quickly perform a search amongst the table fields.|
|Add a Timestamp field||This option is reserved to the exclusive usage of the development team to facilitate synchronization between custom tables and the client's external data.|
|Include a link to this table in the "Custom tables" section of the contact profile||When this option is selected, a section called Relational data is added to the contact information card and lists all related custom table data.|