Custom Fields

Add Custom Fields to your leads list to display additional information of a lead in the agent portal.

Add a New Custom Field:

To add Custom Fields to a list, go to the sub-menu link "List Custom Fields", located under Lists, then select the list you would like to add your custom field to.

Below is a defined list of fields you can modify and configure in the Custom Fields section.

Field Rank:
This is the order in which the fields are displayed to the agent from lowest on top to highest on the bottom.

Field Order:
If more than one field has the same rank, they will be placed on the same line, in order by this value from lowest to highest, left to right.

Field Label:
This is the database field identifier for this field. This needs to be a unique identifier within the custom fields for this list. Do not use any spaces or punctuation for this field.  Must be between 2 and 50 characters.

You can also include the default fields in a custom field setup, and you will see them in red in the list. These fields will not be added to the custom list database table. Instead, the agent interface will reference the list table directly.

The labels that you can use to include the default fields are:

vendor_lead_code, source_id, list_id, gmt_offset_now, called_since_last_reset, phone_code, phone_number, title, first_name, middle_initial, last_name, address1, address2, address3, city, state, province, postal_code, country_code, gender, date_of_birth, alt_phone, email, security_phrase, comments, called_count, last_local_call_time, rank, owner

Field Name:
This is the name of the field as it will appear to an agent through their interface. You can use spaces in this field, but no punctuation characters. Must be between 2 and 50 characters.

Field Name Position:
If set to LEFT, this field name will appear to the left of the field, if set to TOP the field name will take up the entire line and appear above the field. Default is LEFT. 

Field Description:
The description of this field as it will appear in the administration interface. This is an optional field with a maximum of 100 characters.   

Field Help:
Optional field, if you fill it in, the agent will be able to see this text when they click on a help link next to the field in their agent interface. 

Field Type:
This option defines the type of field that will be displayed. TEXT is a standard single-line entry form, AREA is a multi-line text box, SELECT is a single-selection pull-down menu, MULTI is a multiple-select box, RADIO is a list of radio buttons where only one option can be selected, CHECKBOX is a list of checkboxes where multiple options can be selected, DATE is a year month day calendar popup where the agent can select the date and TIME is a time selection box. The default is TEXT. For the SELECT, MULTI, RADIO and CHECKBOX options you must define the option values below in the Field Options box. DISPLAY will display only and not allow for modification by the agent. SCRIPT will also display only, but you are able to use script variables just like in the Scripts feature. SCRIPT fields will also only display the content in the Options, and not the field name like the DISPLAY type does. HIDDEN will not show the agent the field, but will allow the field to have data imported into it and exported from it, as well as have it available to the script tab and web form address. READONLY will display the value of the data in the field, but will not allow the agent to alter the data. HIDEBLOB is similar to HIDDEN except the data storage type on the database is a BLOB type, suitable for binary data or data that needs to be secured. 

Field Options:
For the SELECT, MULTI, RADIO and CHECKBOX field types, you must define the option values in this box. You must put a list of comma separated option label and option text here with each option on its own line. The first value should have no spaces in it, and neither values should have any punctuation. For example - electric_meter, Electric Meter 

Option Position:
For CHECKBOX and RADIO field types only. If set to HORIZONTAL the options will appear on the same line possibly wrapping to the line below if there are many options. If set to VERTICAL there will be only one option per line. Default is HORIZONTAL. 

Field Size:
This setting will mean different things depending on what the field type is. For TEXT fields, the size is the number of characters that will show in the field. For AREA fields, the size is the width of the text box in characters. For MULTI fields, this setting defines the number of options to be shown in the multi select list. For SELECT, RADIO, CHECKBOX, DATE and TIME this setting is ignored. 

Field Max:
This setting will mean different things depending on what the field type is. For TEXT, HIDDEN and READONLY fields, the size is the maximum number of characters that are allowed in the field. For AREA fields, this field defines the number of rows of text visible in the text box. For MULTI, SELECT, RADIO, CHECKBOX, DATE and TIME this setting is ignored. 

Field Default:
This optional field lets you define what value to assign to a field if nothing is loaded into that field. Default is NULL which disables the default function. For DATE field types, the default is always set to today unless a number is put in, in which case the date will be that many days plus or minus today. For TIME field types, the default is always set to the current server time unless a number is put in in which case the time will be that many minutes plus or minus current time. For RADIO and SELECT field types, the default must be one of the options defined for the field or NULL.