Introduction

TGPX allows you to have an unlimited number of user defined fields to store additional information about the partner accounts that are created. This document provides an overview of how to enable and use the user defined partner fields.

Viewing User Defined Partner Fields

To see the currently defined partner fields use the Database > User Defined Partner Fields function from the control panel menu. This will load a page which will show you all of the partner fields you have defined thus far. You will see an overview of the field name, label, field type, the options you have set on the field, and functions that can be run.

Special Field Names

There are currently a few special field names that you can use to get some added functionality. The available special field names and the addition feature(s) that they unlock are listed below.

aim_login	Create a field with this name to store a partner's AIM screen name. When you add this field and assign a screen name for a partner, you will see the icon appear in the Manage Partners interface. You will be able to click on that icon to open AOL Instant Messenger to start a chat session with that partner.
icq_login	Create a field with this name to store a partner's ICQ number. When you add this field and assign a ICQ number for a partner, you will see the icon appear in the Manage Partners interface. You will be able to click on that icon to open ICQ to start a chat session with that partner.
yahoo_login	Create a field with this name to store a partner's Yahoo! Messenger screen name. When you add this field and assign a Yahoo! screen name for a partner, you will see the icon appear in the Manage Partners interface. You will be able to click on that icon to open Yahoo! Messenger to start a chat session with that partner.

Adding A User Defined Partner Field

To add a new user defined partner field, click on the icon in the header bar of the user defined partner fields interface. This will display a window where you will be able to enter all of the information for the new field you are adding. Each of those fields are described below.

Field Name	The name to use for the database field. This should contain only English letters, numbers, and the underscore character.
Label	The label that will appear next to this field on the submission form
Type	The type of HTML input field to use
Tag Attributes	Any custom attribute values you want to appear in the HTML form field tag
Options	A comma separated list of options the user will be presented with (for select fields only)
Validation	The type of validation that should be done on this field
Validation Error	The error message to display if the data provided does not validate
	Show on partner account request form Check this box to display this field on the partner account request form
	Use this field only for partner account requests Check this box if this field is being used only for partner account requests and will not be used after an account is approved
	Field is required for partner account request Check this box if this field required for a partner account request
	Show on partner account editing form Check this box if this field should be shown on the end-user partner account editing form
	Field is required for partner account editing Check this box if this field is required when a partner edits their account

Once you have filled in all of the fields as you want them, press the Add Partner Field button. This will add the new partner field to the database.

Field Types

There are four different field types that you can select from when adding/updating a user defined partner field. Each of those are described below.

Text	A standard one line text input field
Textarea	A multi-line text input field
Select	A drop down selection box
Checkbox	A standard checkbox

Editing a Partner Field

Locate the partner field you want to delete using the user defined partner fields interface. When you locate the partner field you want to edit, click on the icon to bring up the partner field editing interface. This interface is nearly identical to the partner field creation interface, and has the same form fields with the same properties. You can make the changes that you want, and then press the Update Partner Field button to save your changes.

Deleting a Partner Field


Locate the partner field you want to delete using the user defined partner fields interface. When you locate the partner field you want to delete, click on the icon, which will ask you to confirm the deletion.

You can also delete several partner fields at once by putting a check in the box next to the partner fields you want to delete and pressing the Delete button at the bottom of the user defined partner fields interface.