Difference between revisions of "Fields"

From AgileApps Support Wiki
imported>Aeric
 
imported>Aeric
m (Text replace - 'Data & Presentation > Objects' to 'Data > Objects')
Line 1: Line 1:
'''Designer > Data & Presentation > Objects > {object} > Fields'''
'''Designer > Data > Objects > {object} > Fields'''


Fields are attributes of a {{Type|}}, and are used to contain many types of data:
Fields are attributes of a {{Type|}}, and are used to contain many types of data:

Revision as of 19:47, 2 June 2011

Designer > Data > Objects > {object} > Fields

Fields are attributes of a Custom Object, and are used to contain many types of data:

  • Fields created by Users are listed as Custom in the Type column


Lock-tiny.gif

Users that have the Customize Objects permission can edit Fields 

Add Fields

Fields can be added to an Object from the Fields tab. Forms can be designed via Form Layouts.

Add a Field from the Fields Tab

Add Field

To Remove a Field from a Layout:

  1. Click Designer > Data & Presentation > Object > {object}
  2. In the Form Layouts tab, hover the mouse over the field to remove, and click the Remove Field button Delete.gif in the floating toolbar
    Draggablefieldicons.gif

The field is removed from the layout, but it remains available in the object and is moved to the Pick Existing section of the Elements Sidebar. Fields can be reused in this layout or any new layouts.

Delete a Field

  1. Click the field name.
  2. Click [Delete].
    A confirmation dialog opens.
  3. Click [OK] to delete the field.

This is a permanent deletion, and cannot be restored.

Field Display Types

When a field is added to an object, the Field Display Type must be defined, as well as parameters specific to the field.

About the Field Display Types

A Picklist might have options like these:

  • Yes | No | Maybe
  • Strongly Disagree | Disagree | Not Sure | Agree | Strongly Agree
  • OK | Good | Better | Best
See Picklist for more information

A Date and Time fields might have data like this:

  • Date: 10/27/2008
  • DateTime: 10/27/2008 11:30pm
  • Time: 11:30pm
See Date Format for more information

A Checkbox field is used for a Yes / No or True / False choice.

Field Display Types

These are field types you can choose when creating a field.

Auto Number
  • Generates a unique number based on simple format rules and a specified starting value.
  • Auto Number fields default to YYYY-MM-DD-{0000}, where the number between the curly braces {0000} increments automatically.
  • Curly braces {} are required to generate an auto number. The number inside specifies the starting value, and the number of digits. (The default values will be 0001, 0002, ...)
  • The YYYY-MM-DD- prefix is optional. It generates values for year, month, and day.
  • Any text can be used as a prefix, as well.
Checkbox
  • A single check box, where the checked value is "Yes/True" and unchecked value is "No/False"
  • To apply a filter to a checkbox, or import a checkbox field, use:
Yes/True = 1 or No/False = 0
  • When specifying a formula for a default value, the formula must resolve to 1, 0, true, or false.
  • When typing a value into a formula, enter one of those values with no quotes around it.
Currency

Displays currency values in the format determined by the current Locale Settings.

Date and DateTime

A date (Date) or a date and a time (DateTime). Displayed using the current Locale Settings.

  • As Entered - The date/time is stored and displayed exactly as entered.
  • Convert to Local Date/Time - (Default) Value is presumed to be entered in user's local time zone. The value is converted to the System Time Zone for storage in the database. When displayed, it is converted the user's time zone.
Note:
These options are available for new fields in Custom Objects. They are not available for standard Date/Time fields (for example: modified_time) or for Date/Time fields in the System Objects. Those fields are always converted.
Learn more:
Dependent Picklist
  • A picklist that is dynamic based on values provided in another field.
  • For example, a Picklist for T-Shirt Sizes might include entries for Adult, Teen and Child.
  • The Adult list might include entries for S, M, L, XL, and XXL sizes.
  • A Teens list might include similar entries, while the Child list might include entries for 0 - 6 mos., 6 - 12 mos., 1T, 2T, and 3T.
  • The resulting hierarchy would be:
  • Size
  • Adult
  • Adult Small
  • Adult Medium
etc.
  • Child
  • Child 0 - 6 mos.
  • Child 6 - 12 mos.
  • etc.
  • Teen
  • Teen Small
  • etc.

Thumbsup.gif

Best Practice:
Include the entire hierarchy "path" in the entry, so that Adult Small is distinguished from Teen Small. (If the entries said simply, "Small", a shipping clerk might not be able to tell which size was intended.)

Email Address

A text string of the form {name}@{yourDomain}, or a comma-separated list of such strings.
Example: friend@somewhere.com

External Lookup
  • Lets a user select a record provided by Web Service.
  • Data returned from the Web Service is then copied into specified fields in the platform record.

File Field
  • Allows a file to be uploaded as part of the record.
  • When the user clicks on document in a file field, it is either downloaded or viewed immediately, depending on the Service Provider's networking.properties configuration. (In the cloud, the setting causes files to be viewed immediately.)
    Compare with Image Field.
Formula
  • If the formula return type is a DateTime or Time, then the time zone conversion options are available:
  • As Entered - The date/time is stored and displayed exactly as entered.
  • Convert to Local Date/Time - (Default) Value is presumed to be entered in user's local time zone. The value is converted to the System Time Zone for storage in the database. When displayed, it is converted the user's time zone.
Note:
These options are available for new fields in Custom Objects. They are not available for standard Date/Time fields (for example: modified_time) or for Date/Time fields in the System Objects. Those fields are always converted.
Geolocation

A Geolocation field is accompanied by two buttons:

  • [Update Current Location] stores current latitude and longitude in the field as a strong.
  • [View in Map] allows the viewer of a record to see the location on a map.
Global Picklist
  • A Global Picklist is a type of field that contains a list of values, and performs much the same as a Picklist field
  • Global Picklists contain the kind of default values commonly used in all applications
Example: US states, status level, priority, hat size, apparel size, component part numbers, etc.
  • These predefined fields save time and can be used in any object.
  • When adding a Global Picklist field to an object, you select from the set of Global Picklists that has been defined for this application.

Image Field
  • Allows an image file to be uploaded as part of the record.
  • When the user clicks an image, it is displayed immediately.
    Compare with File Field.

Lookup

Special considerations for a Lookup on a Many-to-Many Relationship:

  • The Lookup automatically becomes a Multi Value Lookup.
  • It cannot be made read only.
  • Layout Rules cannot test the set of selected values.
  • You can specify a record-filter, to limit the number of possible choices. However, post selection JavaScript is not supported here.
  • When displayed the chosen values cannot be clicked to visit the corresponding records.
Multiple Checkboxes
  • Multiple checkboxes are displayed and are associated with a single field.
  • For example, choose your favorite movie genres:
Action / Animation / Comedy / Drama / Romance / Documentary / Sport / Thriller / Western
  • Multiple checkboxes can be selected, for example: Comedy, Romance, Western
  • When you select this type for an object field, a text area lets you enter values.
    • Enter the names of the values, one per line, in the order they will be displayed.
    • When the user makes a selection, the value that is stored is the text entered on that line. So:
      1. If you change the order later, existing values are not affected.
      2. If you remove an entry at a later date, or change the spelling of a value, existing records that have that value are not affected. Either clean up the object data, or take that possible value into account in your design for backward compatibility.
Multi Object Lookup

A two stage-lookup where the user first selects the object to use, and then looks up a record in that object.

Multi Select Picklist
(Multi Select Global Pick List)
  • A picklist containing multiple values from a Global Picklist
  • Multiple values can be selected from the list and associated with a single field
Number

A numeric (integer) field, for which you specify minimum and maximum values. The default minimum is 0. To go lower, specify a negative number, like -20. The maximum value is 999999999 (999,999,999). That number can be varied as well, up to the maximum integer size 2,147,483,647. (The smallest possible negative value is -2,147,483,646.) Displayed using the current Locale Settings.

Number with decimals

A numeric field, for which you specify the number of decimal digits. Displayed using the current Locale Settings.

Percentage

A decimal field in the range 0 to 1, for which you specify the number of decimal digits. Displayed using the current Locale Settings.

Phone/Fax

If a string of digits is entered without formatting, that is the way it appears when editing, but the numbers are automatically formatted when the field is displayed:

  • 7 digits ("1234567") displays as "123-4567".
  • 10 digits "1234567890" displays as "(123) 456-7890".
  • 11 digits ("12345678901") displays 1-234-567-8901
Note:
If the field has more than 11 digits, they are displayed as entered.
In that case, it's helpful to provide the desired formatting.

Free-format text is displayed exactly as entered. For example:

  • 123.456.7890
  • 1-800-COMPANY
  • +44 7123 456 789
Picklist
  • A picklist is a type of field that contains a list of values, usually presented in a drop-down list; Examples:
  • Types of things: Animal, Vegetable, Mineral
  • T-Shirt Size: Extra Small, Small, Medium, Large, Extra Large
  • A single value can be selected from the list
  • When you select this type for an object field, a text area lets you enter values.
    • Enter the names of the values, one per line, in the order they will be displayed.
    • When the user makes a selection, the value that is stored is the text entered on that line. So:
      1. If you change the order later, existing values are not affected.
      2. If you remove an entry at a later date, or change the spelling of a value, existing records that have that value are not affected. Either clean up the object data, or take that possible value into account in your design for backward compatibility.

Radio Buttons

A list used to limit user selection to a single, specific value from a supplied list of values.

  • When you select this type for an object field, a text area lets you enter values.
    • Enter the names of the values, one per line, in the order they will be displayed.
    • When the user makes a selection, the value that is stored is the text entered on that line. So:
      1. If you change the order later, existing values are not affected.
      2. If you remove an entry at a later date, or change the spelling of a value, existing records that have that value are not affected. Either clean up the object data, or take that possible value into account in your design for backward compatibility.
Rich Text Area

An HTML-formatted text area

  • HTML formatting can include font styles, such as Bold, Italics, numbered lists and bullets or images (logos or art)
  • Formatting tools are provided

Considerations:

  • <wbr> and </wbr> tags are not supported, as they are problematic when switching between edit and display modes. (To prevent issues, those tags are therefore removed before the content is displayed.)
  • The RTA field can contain approximately 16MB of data and the system has a limitation on the search fields in the Record Locator to 1024 characters. If RTA field is included as a search field in the object's Record Locator, the search keyword which appears after 1024 characters is not considered by the search engine.
Text Area
  • A multi-line Text area that can contain alphanumerics (A-Z, a-z, 0-9) and special characters: / @ . - $ %
  • Height and width are defined when the field is created
Text Field
  • A single-line Text that can contain alphanumerics (A-Z, a-z, 0-9) and special characters: / @ . - $ %
Time

A time. Displayed using the current Locale Settings. For example, "6:50 PM".

  • As Entered - The date/time is stored and displayed exactly as entered.
  • Convert to Local Date/Time - (Default) Value is presumed to be entered in user's local time zone. The value is converted to the System Time Zone for storage in the database. When displayed, it is converted the user's time zone.
Note:
These options are available for new fields in Custom Objects. They are not available for standard Date/Time fields (for example: modified_time) or for Date/Time fields in the System Objects. Those fields are always converted.
Learn more: Dates and Times#Time Format
URL

A web address. For example: http://yourCompany.com

Considerations

  • While saving a record, you may encounter an error Row size too large. If you encounter this error, perform the following actions:
  • Reduce the field length by editing the field properties. Click GearIcon.png > Customization > Objects >> {object} >> Fields >> {field} to update the field property.
  • Remove some of the fields from the object.


Field Audit Log

When the Field Audit Log option is enabled, you list the fields to be audited. Changes to those fields are then added to each record's Activity History.

Lock-tiny.gif

Users that have the Customize Objects permission can set the Field Audit Log. 

Lock-tiny.gif

Users that have the Manage Audit Log permission can view the Audit Log 

When a field is modified, the following information is added to the activity history:

  • Field label
  • Original field value
  • New field value
  • Who changed it
  • When it happened
Considerations
  • Creation dates are not logged.
  • An entry is added to the activity history for each audited field that changes. (If three fields change, three entries are added.)
  • For the Cases object and several other System Objects, all fields are audited, by default.
  • For Custom Objects, field auditing is turned off, by default.

Enable the Field Audit Log

  1. Go to GearIcon.png > Objects > {object} > Field Audit Log Settings
  2. Click Enable Field Audit Log
    The list of object fields appears.
  3. Click Track All Fields, or leave that option unselected and click the checkbox next to each field to be audited.
    (Choose up to 20 fields per object.)
  4. Click [Save]
Learn more: Activity History

Role-Based Field-Level Permission Control

Role Based Permission Control

For Developers

Visit these pages for a list predefined fields in

Guidelines for Add/Update Field Value

The Order of precedence of field properties (#1 takes precedence over #2, etc.):

  1. Always Required
  2. Field Visibility
  3. Display Attribute
Add/Update Field Value
  • For the API/UI calls, the Always Required property applies, even if the field is defined as hidden/read only via Form Layout or Field Visibility settings
  • Fields defined as Hidden/Read-Only via Field Visibility settings can not be added/updated from the UI, and should not be added/updated from the API
  • Fields defined as Hidden/Read-Only via Display Attributes are considered only for UI calls (but not API calls)
  • Hidden Fields can be updated through the scripting
Log Access Violation
  • When fields defined as Hidden/Read-Only via Field Visibility settings are used in an API/UI request, the entry can be logged in the Audit Log, provided that the Enhanced Security Audit is enabled

[[Category:Template:Features]]