Minimum Version Required: 19.09
Pre-Conditions
1. Users must have CustomTableEdit Permission to view the table editor dashboard
2. Users must have permission to edit/view the system table to which they want to add the custom field
Customers, Chains: CustomerEdit
Products, Inventories: ProductEdit
Tasks: ObjectiveEdit
Promotions: PromoEdit
Accounts, JournalEntryTrans: GASetup
Jobs, Locations: PurchCostEdit
Steps
How to Use Custom Fields
1. Navigate to the Table Map using the universal search
2. Search for a table by typing in the table name and selecting "Map Table"
3. Mapping the table will create a schema map showing the relationships between the selected tables and other tables within Encompass
4. To edit a system table select Edit within the table or under the Options menu. Some permissions may be required and Encompass currently doesn't support custom fields on all system tables
Common system tables that can have custom fields are Customers, Products, Accounts, Account Types, Inventories, Jobs, and more
5. The Table Editor has 12 custom table slots that can be used to create custom columns on the system table. These columns can be renamed and have the field options changed to best fit the custom data
Column Alias - The name of the column that will show up in your custom field
Data Type - The Type that your column field will accept
- Custom fields on system tables can only have the following data types: Text, TextArea, Email, Password, Phone, UPC, HTML, Hyperlink
View Permission / Edit Permission - Specify the permissions necessary to view or edit this field in your table
Display By Default / Display By Default In Subs - Choose if you want this field to show in Table View by default and if you want this field to show in Sub Tables by default
Sort - Choose if you want the table to be sorted in Descending or Ascending order according to this field
Values - If you want the Custom Field to just be a text field, leave this blank.
- If the field will be a drop-down, enter the drop-down option you'd like to create, followed by a semi-colon and the next option. Do not enter any spaces. Example: Bronze;Silver;Gold
- If the field will use a drop-down stores one value but displays another, format the value list as Stored Value,Display Value;Stored Value,Display Value. Example: 1,Mon;2,Tue;3,Wed
Default Value - the value that this field will default to on new records. If Values are provided, this must be one of the options in the list of Values.
Under Advanced Fields, there are several more attributes that you can alter
6. Once the settings have been adjusted, input the table name and select Save Changes to apply the columns and settings
7. The custom column can now be added and viewed in the table view of the selected table
Best Practices
Ensure the Data Type field is correctly reflecting the type of data that will be input into the column
Set the View and Edit permissionsso that only people who need to see/edit the data can interact with it on the table