Skip to main content

Create a Custom Table

Distributor steps for creating a custom table in Encompass, either from the Table Map or from a spreadsheet Import Routine, including columns, data types and permissions. Requires v22.01+.

B
Written by Bailey Naas-Thornton

Minimum Version Required: 22.01

Pre-Conditions

To import a custom table, a spreadsheet must already be created. Structure a Spreadsheet to match the schema for your new table. The number of columns and their headers in the spreadsheet should match the number of table fields and their names, respectively.

Steps

How to create a custom table from the table map
​
​

1. Using Universal Search, navigate to the Table Map dashboard
​
​

2. Click the Create New Custom Table button

3. Enter values to the Basic Information and Permissions sections

4. Set Table values for default columns: ID, Time Updated, Updated By, Time Created, Created By

5. Click the Add Column button to add new Columns to table

a. Enter a Column Alias to give a custom field on the table a display name

b. Review column properties to ensure correct data type, maximum length, permissions, etc

c. For more column properties, click the Advanced Fields button

6. Repeat the Add Column process as needed until all columns for the Custom Table have been added

7. Click the Save Changes button

How to create a Custom Table from an Import Routine

1. Select the Import/Export tab on the left side of your screen to expand on the menu.

a. Select Table Import

b. Click Add New Table Import

c. Select a source

d. Supported file types are: *.xlsx, *.csv, *.zip

e. Click Create Custom Table

f. Enter the Basic Information for the table
​
​

g. Specify the Column Information

  • Data Type: Ensure that each column is of the correct Data Type. (Text, Integer, Decimal, Date, Currency, etc.)
    ​
    ​

  • If necessary, add an additional column
    ​
    ​

g. Click Save Changes

2. Select or make sure that the Custom Table created is showing in the destination table field

a. Select the desired Import Action for the desired import.

b. Click Save Changes to import records from the selected source.
​
​

c. Field Mapping: Map the source fields from the Spreadsheet to the destination fields on the table.

  • If necessary, add a Static Value. This value will be the same for all records imported into the new table.
    ​
    ​

d. Click Save Changes

3. Import Tasks: All pending and previous imports for the selected Table appear in the Import Tasks tab.

a. Click Execute
​
​

b. The import results will be displayed, click on View to see the created table
​
​

Best Practices

  • We recommend creating a Custom Table in different ways, for different conditions:
    ​
    - When no data exists and you need to start creating data, create the Custom Table from the Table Map and begin collecting data.
    ​
    - When data does exist and needs to be pulled into Encompass, create the Custom Table from an Import Routine to create and migrate data at the same time.
    ​
    ​

  • There are some Field Properties that once saved after the point of creation, cannot be changed.
    ​
    ​

  • The data type will have limited options after creation.
    ​
    ​

  • Length cannot be changed after creation.
    ​
    ​

  • Using a source file with the same column names as the created custom table will allow field mapping to work automatically and will streamline importing data.
    ​

  • Set Basic information permissions as well as column permissions as they are separate as will dictate what columns show
    ​
    ​

Did this answer your question?