Skip to main content

Using the Table Map

Distributor guide to the Table Map in Encompass: explore how tables relate (live ERD) to find where data lives, build Fusion reports, and create or edit custom tables and fields. v23.01+.

B
Written by Bailey Naas-Thornton

Minimum Version Required: 23.01

Steps

The Encompass Table Map is a live Entity Relationship Diagram (ERD) that shows how the tables in Encompass are related to each other. This can be very helpful in finding where data is stored, and how it relates to other data in the system.


It can also help with building fusion reports, and is where the functionality lives for creating/modifying/removing custom tables and custom fields (see the related Help Resource)

To use the table map:

  1. Navigate to the Table Map using the universal search at the top of any page
    ​
    ​

  2. Search for the table you would like to get information on
    ​
    ​

  3. Drag around and click the elements on the diagram to explore how the data relates to eachother
    ​
    ​

  • The ERD will draw out 2 layers of tables, unless the 'Show One Layer' option is turned at the top of the page.
    ​
    ​

  • The ERD will also only show common/default tables in the system, to show less common tables, turn on the 'Show More Tables' option at the top of the page

The Encompass database is designed in 3rd normal form.

Note: There are rare exceptions made to this for performance optimization reasons.

Fields And Definitions

Key: This contains a brief description of the color-coding used to designate parent vs child tables in the relationships

  • Options -> Center Table: This will center the table you last clicked on into view, often used if you scroll/pan too far and lose where you started
    ​
    ​

  • Options -> Map this Table: If selecting a table that is different than the one you originally search for
    ​
    ​

  • Options -> View Table: Will take you to the standard table view for this table (aka: will show the actual records in the table with the normal columns/filter options)
    ​
    ​

  • Options -> Audit: Will take you to all of the audit/change records for this table
    ​
    ​

  • Options -> Edit: Will take you to the table editor for this table. This is commonly used for Custom Tables but can be used to edit Custom Fields, Sub Tables displayed by default and more.
    ​
    ​

  • Options -> Delete: Only available on custom tables, will delete the table from the system. This is permanent. The system will prevent you from deleting a table that is used in any saved reports, or table import routines.

Fields: Lists all of the columns/fields on the table, their data type, and length of the field. More detailed information on columns/fields is available in the TableFields table.
​
Parent Tables: Listing of all of the tables that have this table as a 'Child Table/Sub-Table'

Did this answer your question?