Custom Fields Definition Form

Please first review User Defined Fields & Forms for general information. This section will provide in depth knowledge on the custom fields definition form.

The custom field definition form contains 3 tabs:

  • General

  • Table Options

  • Advanced

General

Active: Indicates that this field is in use for reporting and data entry. This would be unchecked if use of the field was discontinued, but you wish to retain the existing data in case the requirement for its use resurfaces.

Field Name: The default name of the field displayed on the form.

Help Text: Text can be added to help users understand the meaning of the data in the column.

Input control types

  • Checkbox
  • Checkbox list (multiple)
  • Combobox
  • Combobox (multiple)
  • Date selector
  • Dropdown list
  • File Download
  • HTML Editor
  • HTML Editor (condensed)
  • HTML Editor (simple)
  • Listbox (multiple)
  • Radio button list
  • Read Only Text
  • Table Grid
  • Textarea
  • Textbox
  • Company Selector
  • Department Selector
  • Group Selector
  • User Assignment Selector
  • User Assignment Selector (multiple)
  • User Selector

Data Type: Defaults to 'string' but will be editable for certain Input Control types.

Input Location: Controls the location of the display on the input form. The "Normal" tab will place the field into a "Custom Fields" section for data entry, which is the default setting. For data fields which are used in most newly created items, the preference is more likely in the Details/General Tab on the default tab/display for new items.

Display Location: Controls the location of the display on the detail display for the item. Custom fields will default to "Normal" which is a section of the display for all custom fields and is separate from the default data fields for the item. Choose Details/General to combine the data field within the display of the pre-configured data fields for out-of-the-box items.

Input Row/Order: The row where the field will be displayed on the add/edit form.

Display Row: The row where the field will be displayed on the display form.

Required: Enables the field to be required on the input form.

Required Inline: Enables the field to be required during inline adding/editing (i.e.Task List).

Show as Report Filter?: Enables the field to be filter choice in your reports.

Enable Group By: Enables the Group By function in your reports.

Enable Sum Column: Enables the field to be totaled on your reports. (applies to numeric field types only)

Hide on Print Friendly: Enables the field to be hidden when printing.

Table Options

Enable as Column: Enables the field as a selectable column on your reports.

Default Column: Enables the field to be a default on all your reports. Any existing saved reports and saved displays will remain unchanged.

Table Column Name: The name of the field that shows up at the top of the column for your reports and in the column selector for choosing which columns to display in the report. Sometimes the column name needs to be shorter than the input form name to make better use of horizontal space when using the field in a report. For example, you may want to use a column display name of "St" instead of "State" if the column is set to use a two character USA state abbreviation. This will prevent the column display from requiring additional width just to accommodate the column heading.

Table Column Width: The default pixel width when using the data field in a column display. For example, setting the default column width to 100 for a task custom field will make the column default to 100 pixels wide when it is displayed in task lists and reports. It does not set the width of the input box when using the data field in a form.

Column Wrap Text: Enables the field to text wrap. Text wrap will lengthen the vertical size of the display row to as long as necessary to fit 100% of the text in this field within the specified column width onto multiple text lines. Report rows with text wrap data in them will typically display at different row heights throughout the report to accommodate the varying amounts of text in the different text wrap column records.

Advanced

Enable Comment Logs: Enables changes to the data field to be logged in system comments. (applies only to items)

Read Only: Enables the field to be read-only. The value of the field will be set programatically.

Edit Permissions: Enables the item assignees (people assigned to the item) or anyone with only read permissions to the item to edit this field on the display form. This setting does not affect users who already have edit permissions on the item.

Advanced Formatting & Style

Input Label Orientation: The orientation of the label in relation to the input field on the form.

Display Label Orientation: The orientation of the display label in relation to the display field on the form.

Display Name: The name of the field displayed on the display form. If blank, the field name is used.

Default Value: The default value for the control to pre-populate if not set.

Input CSS Class: The CSS class or classes to be applied to the input control.

Display CSS Class: The CSS class or classes to be applied to the display control.

Control Cell CSS Style Text: The CSS style text that is applied to the table cell which contains the input or display control.

Control Input CSS Style Text: The CSS style text that is applied to the table cell which contains the input control.

Control Display CSS Style Text: The CSS style text that is applied to the table cell which contains the display control.

Header Cell CSS Style Text: The CSS style text that is applied to the header table cell which contains the Field name and Display name on a form.

Header CSS Style Text: The CSS style text that is directly applied to Field name and Display name on a form.

JS OnChange: The JavaScript code to execute when the input onchange is fired.

Max Length: The maximum number of characters that can be entered into the control.

Columns: The number of columns to display for the control.

Format Mask: The format mask to use for types that are converted to strings upon display of the information.

Input Column Span: The number of columns the input will span on the add/edit form.

Input Row Span: The number of rows the input will span on the add/edit form.

Input Label Hide Colon: Enables the colon to be hidden on the input label.

Input Label Apply No Wrap: Enables no wrapping on the cell holding the input label.

Display Column Span: The number of columns the field will span on the display form.

Display Row Span: The number of rows the field will span on the display form.

Display Label Hide Colon: Enables the colon to be hidden on the display label.

Display Label Apply No Wrap: Enables the display label to not be wrapped.

Online 10/12/2016