How to Add a New Field

What is a Field?
A field is an area where you can specify information needed for a form. In the example below you will see fields being used when creating a new Account.




Creating a New Field
Step 1. Access the New Field Page

Click "Entity" in the left side menu. You will be presented with a list of different Entities, for the purpose of this tutorial select the "Account" entity. Next select the "Fields" option from the left side menu. You should now be at a screen similar to below.




Step 2. Create or Edit Fields

From here you may either make an entirely new field or alter your existing fields. To edit an existing field select edit instead of new then follow the directions below.


Step 3. Create a New Field

Select the new button above the list. The following form will appear. Here we will go over the different fields in the form and what they mean.



Field Name  Description 
Field Name A name for the new field, this must conform to XML format, meaning no spaces or special characters.
Display Label This will be what you field is actually displayed as when being used.
Description A detailed description of what purpose this field performs.
Description Add a short description of the use for this field.
Active Check whether or not the field is being used or not.
Data Type How you would like your field to be presented, this can be a check-box as shown above, or a text field, drop-down menu, etc.
For more information refer the detail section of look ups located here.
Note: A divider is a dividing line on the field.
Data Length Determine the usable length of the field.
Create Searchable Index This will make it become part of a search form, make it a searchable entry.
Allow Create Allows the user to set the initial value for the field.
Allow Update Allows the user to change the field after the initial setup.
Default Value Have the field prepopulated or preselected with this value.
External Key You can use this alternatively as an ID for the record. If you are integrating you can use your own identifier to bind to this entry.
Default Value If you would like this field to have a value already in place when the page loads, fill this part in with the said value.
Required Checking this will put an asterisk next to the field name to denote this field must be populated in order to proceed.
Unique Value Require the entry to be a unique value.
Lookup Entity Use the drop down menu to select the entity in which you would like to lookup information. Note this field should only be used to new fields of type "Lookup". For more information on lookups please reference the article here.
Custom Validation If the field needs to in a certain format, define those requirements here using the selections.
References Means this is a referential, and you can attach a foreign key.
Pick List If your field is made to be a SELECT1 (drop-down) menu, define what options the drop-down menu will contain.
Display Attributes 
  • Display After - This dropdown menu will determine where in the list of fields your new field will be displayed, click the dropdown to show a list of available options.
  • Display Mode - Determines when the field is displayed depending on the current state of the form e.g. upon creation, editing, viewing.
Role Permissions  This menu will allow you to choose how each level of user will be able to interact with your new field. Click the "read" and "update" entries to allow or disallow the selected user the action in that column.
Fields   This is used as a formula area to combine other fields.
Cascading Field Rules Configure the visibility setting for this field. Select a VISIBILITY SETTING such as editable. Next, define the conditions that must be met for the visibility setting to trigger. This is useful for configuring field that will display when other fields are equal to certain values.
Help System
  • Short Help Content - First line of help that displays when user hovers over  next to field
  • Long Content Help - Add a more detailed description that displays for user when hovering over  next to this field. More advanced formatting is permitted here.


After filling in all necessary fields click submit to save the entry.

Step 4. Check the Entry

To check your work head to a section that uses the form you made a field for. For example, if we had made a new field for the Account entity. So we would create a new account to assure that our field works the way we expect. If it does not, bring up the list of fields again, and click edit to change what you need to.

Have more questions? Submit a request

Comments

Powered by Zendesk