View Custom Fields

Purpose:

This viewer provides the following functionality:

a. An alternative way of relabeling field names.

b. A way to define Quick Pick lists that can be used to control values entered in text fields.
c. A way to define a Default Value for a text field.

d. Set the initial default value of Check Boxes, Radio Buttons, Integer, Decimal, Date and Time fields for new records.

Usage:

This function should be restricted to system-level client users and support.

Relabeling done via this function overrides labeling specified via the Field Label Remap functionality.

Custom Field Enhancements - Version 9.1 and Above

In previous releases, the Custom Fields functionality was label-specific. In other words, if you changed a common label such as "Email Address:" in one viewer (say, the Client record) to "Client Email:" it would appear in all Viewers (e.g, Job, Client Site, etc.) as "Client Email".  A new v.cus field is required to see this new functionality: contact your Support Representative if needed.

In this release the Custom Fields functionality has been enhanced to be viewer-specific with the following exceptions:

Id Field Labels:
Custom Field Labels for record Id's are used wherever that record is reference. For example, if you change the label "Client Id:" to "Customer#" the label Customer# will appear in the Client viewer as well as in the Job viewer.

Labels to the right of the field:
This release does not support the customization of labels that appear to the right of the fields, as is the case with most Checkbox (boolean) fields.

Fields without Standard Labels:
Some fields do not have a standard label defined; these may not be customized.

Address Fields:
Address fields may not be changed via Custom Fields but may be changed for all instances via Start Field Label Remap.

Standard Labels Appear On Status Pane:
The ability to rename Field Labels is a good thing, but the user and/or support may need to see the Standard Label.  The Standard Label and been added to the Status Pane display to the left of the internal field name and database name and will be displayed when the mouse hovers over or selects the field.

Important Fields: Main Tab

Custom Field Id:
This value must uniquely identify a specific field in SAMPRO.  Note that Rn-type fields are not permitted, as well as any Field Id that contains 'cstmfld'. The system will check for the validity of the field name when you tab out of the field, and alert you if it is not valid.

Getting the Field Id:

A simple mechanism (right-click) helps to define Custom Fields; it can be launched and pre-filled for a specific field.  Note that this option is only available to users that are allowed access to the View Custom Field function. For example, open the Vendor viewer to the form view and right-click on the Zip Code field: the system will ask if you want to customize this field. If you click ‘Yes’, the Custom Field viewer will launch with the select Field Id completed.

Examples of Field Names:

Custom Field Label:
The field provides an alternative label for a field.  If not specified, the standard label is used.

Example: Changing the Dispatcher Id Label

In this case, let’s assume that we want the Dispatch Id label to display as Acct Coordinator:

Custom Field Id: dsptchr.id
Custom Field Label: Acct Coordinator:

Default Value:
This field provides the initial value for a text field when starting a new record.  If not specified, the standard default value is used. 

The Custom Fields Default Value functionally may also be applied to Check Boxes, Radio Buttons, Integer, Decimal, Date and Time fields. These fields should only be set on record header fields.

Note: Certain fields are hard-coded to specific values. In these cases, the Default Value you entered will be overridden by the hard-coded value.

Set the Default Value of a Check Box

1. Go to the viewer you wish to customize, and select and right-click on the check box you wish to set to checked. Click 'Yes' when the system asks if you wish to customize this field.

2. When the Custom Fields viewer opens, enter a Y in the Default Value header field, and save the Custom Fields record (NOTE: for Boolean-type fields, only the first character of the Default Value field is evaluated. If the first character is 't', 'T', 'y' or 'Y', then the field defaults to True.)

3. Close and re-open your original viewer. When you click the New button, the check box you customized should now default to checked when you start a new record.

Set the Default Value of a Radio Button

1. Go to the viewer you wish to customize. Carefully note the exact spelling of the radio button you wish to select as the default. Select and right-click on the radio button, and then click 'Yes' when the system asks if you wish to customize this field.

2. Set the Default Value in the Custom Fields viewer to the exact spelling of the radio button. Specifying an unsupported value results in no button being selected. Save the Custom Fields record.

3. Close and re-open your original viewer. When you click the New button, the radio button you set as default should be selected when you start a new record.

Set the Default Value of a Integer or Decimal Field

1. Go to the viewer you wish to customize. Carefully note the format of the field so that the default value you enter does not exceed the size of the field. Select and right-click on the field, and then click 'Yes' when the system asks if you wish to customize this field.

2. Set the Default Value in the Custom Fields viewer to the integer or decimal value desired. Errors WILL occur if the user-specified default value isn't appropriate for the field type.

3. Close and re-open your original viewer. When you click the New button, the integer or decimal field should be set to the default value you specified.

Set the Default Date / or Time

Date and Time include special support for now entered in the Default Value which sets the default value the current system date/time.

1. Go to the viewer you wish to customize, and select and right-click on the date or time field you wish to default. Click 'Yes' when the system asks if you wish to customize this field.

2. When the Custom Fields viewer opens, enter now in the Default Value header field, and save the Custom Fields record

3. Close and re-open your original viewer. When you click the New button, the date/time field you customized should now to the current system value when you start a new record.

WARNING: Default values such as '30 days' in a Date Field are NOT currently supported and may result in a 'index out of bounds' error when accessing a record with a date or time field set incorrectly.

Field Type: Field Size: Standard Label: Table Name DB: Column Name DB:
When you select a Field Id, these display-only fields will show the standard attributes for the field.

Important Fields:

Values Tab

The 'Values' child table can be used to specify the list of acceptable values that can be entered into a customized text field. Note that the Field Values that you specify in this table will not impact the values in the existing data in this field. However, if you change the contents of a custom field, the system will require that you select a valid value, as defined by the Values tab.

Custom Field Values:
Custom Values are only permitted for fields of type 'text' or 'textbox'.  A Value may not contain more characters than the customized field can hold.

Example: Setting the Job User 2 field to specify market segments

In this example, only values of Residential, Commercial and Industrial may be entered in the Job User 2 field (named Market Segment).

Custom Field Id: jb.usr2
Custom Field Label: Market Segment:

Example: Allowing a Blank in the Job User 2 field

In this example, the values of Residential, Commercial, Industrial and blank may entered in the Job User 2 field (named Market Segment).  In this case, in the last line, the Value field is empty, but the Description is completed so that the software knows to save the last row.

Custom Field Id: jb.usr2
Custom Field Label: Market Segment:|

In this example, the field may be changed to blank. When you double-click on the field, the following selector box will be displayed.

Values in DB Tab

The 'Values in DB' tab has been included so that the user can see what values are currently in the database.