Fields

From LongJump Support Wiki
Revision as of 23:00, 22 June 2012 by imported>Aeric (→‎Delete a Field)

Designer > Data > Objects > {object} > Fields

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

  • Fields are defined by giving them a label and specifying a Field Display Type
  • New fields can be added to the Form canvas
  • Fields can have Role-Based Visibility, meaning that the field data is visible only to users who have permission rights for that field
  • Fields can have a Default Value defined, which pre-populates the field in the data entry form (Form)
  • 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. The fields that are displayed to users in different roles, and the positioning of those fields, is defined in Forms.

Add a Field from the Fields Tab

Designer > Objects > {object} > Fields

Fields can be added to an object, customized, and displayed in a variety of ways.

Basic Information

Specify the basic characteristics of the field

Label
Enter a field label; This label is displayed on the Form
Display Type
The fields in this page will change, depending on the Field Display Type selected

Always Required
Checkbox
  • Default is unchecked
  • If checked, this field is required in All Forms and all API calls
(Optional) Include in Quick Edit
This choice will appear for fields in these objects only: Prospects, Accounts or Contacts; See Quick Edit for more information
Field Name
The name that will be used to reference this object. Must conform to the Field Naming Rules
(Optional) Mapped to Account Column
This choice will appear for fields in Prospects only; Select a field in the Accounts object that will be mapped to this new field (When a Prospect is converted to an Account, this field value is copied to the specified Account field; The Account field is overwritten with the value in this field)

Display Attributes

This section is displayed when adding a new field. It specifies the default attributes for the field, when it appears in a Form.

Section
Select the section in the default form where the field will appear. (The Basic Information section is the default.)
Required
Checkbox
  • Default is unchecked
  • If checked, this field is required in the current Form

Default Value

Specify the content to be displayed as the Default Value when adding a new record to this object, or use the interactive Formula Builder to define a default-value expression.
Considerations
  • For Lookup fields, the value must resolve to a record_id. (A user_id, for Lookups to the USER object.)
    For example, this formula can be used to specify a default value for the record Owner, by using an email address to do the Lookup:
LOOKUP('USER','id','email="newOwner@OurCompany.com"')

Role-Based Field Visibility

When a new field is created, it's visibility can be determined by the user's Role.

Learn more: Role-Based Field Visibility

Description Information

Optionally, add a description of the field

Description
Text entered here will be displayed when the user hovers their mouse over the field--but only if Show_Field_Hints has been enabled for the form the user is in.

Delete a Field

To remove a field from a Form:

  1. Click Designer > Objects > {object} > Forms > {form}
  2. Hover the mouse over the field to remove
  3. Click the Remove Field icon 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.

To delete a field entirely:

  1. Visit Designer > Objects > {object} > Fields
  2. Click the field name.
  3. Click [Delete].
    A confirmation dialog opens.
  4. Click [OK] to delete the field.

This is a permanent deletion, and cannot be restored.

Field Audit Log

Designer > Objects > {object} > [Field Audit Log Settings]

When the Field Audit Log option is enabled, any changes to the selected fields are logged in the Related Information section of the object.

When a field is modified, a new row containing the following information is added to the log:

  • Original field value
  • New field value
  • User name
  • Date and Time Modified
Note: Date Created is not logged

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 

Enable the Field Audit Log

  1. Click Designer > Objects > {object}
  2. Click the [Field Audit Log Settings] button
  3. Click Enable Field Audit Log
    The list of object fields appears.
    Fieldauditlog.gif
  4. Click the checkbox next to the field(s) that should be audited; Choose up to 20 fields per object
    Fieldauditlog2.gif
  5. Click [Save]

Set Field Audit Log to be Visible in Related Information

By default, the Field Audit Log is Hidden in the Form. To make it appear:

  1. Navigate to the object of interest in Forms
  2. Click the Display Settings link
    Formlayouts-DisplaySettings.gif
  3. Move the Field Audit Log object to the Visible column and Save your changes
    Displaysettings.gif
  • To select multiple elements from a list that are not adjacent, press and hold the CTRL key and click each element individually (CTRL-click)
  • To select a series of adjacent elements, click an element at the beginning of a series, press and hold the SHIFT key, then click the last element in the series (SHIFT-click)

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 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