Fields

From LongJump Support Wiki

Designer > Objects > {object} > Fields

Fields are attributes of an Object, and are used to contain many types of data.

Contents 1. About Fields 2. Working with Fields 2.1 Add a Field 2.1.1 Basic Information 2.1.2 Display Attributes 2.1.3 Default Value 2.1.4 Role-Based Field Visibility 2.1.5 Description Information 2.2 Delete a Field 2.3 Field Audit Log 2.4 Role-Based Field Visibility 2.5 For Developers 2.5.1 Guidelines for Add/Update Field Value

About Fields

• 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 for that field
• Fields can have a Default Value defined, which pre-populates the field in the data entry form (Form)
• Default values can be created with Formula Fields
• Fields created by Users are listed as Custom in the Type column

Users that have the Customize Objects permission can edit Fields

Working with Fields

Add a Field

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.

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 in the floating toolbar

   

   

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

1. REDIRECT Field Audit Log Settings

Role-Based Field Visibility

Set Field Visibility based on Role. This option defines the Roles that are permitted to view and use the designated Field. Available field settings include:

• Visible
• Read-Only
• Hidden

This control is created when a Field is Added to an object.

Learn more: Visibility Controls

Considerations

• When a field is added to a Form, the field visibility control is set to Visible by default
• When a new role is added, that role receives Visibility rights to all the fields across all the objects
• When this control is specified for a field, it will be enforced in the Field Audit Log; This means that the user Role determines whether a record is visible in an Audit Log

For Developers

Visit these pages for a list of predefined fields in

• CRM Objects
• Built-in Objects

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

• Fields defined as part of Custom Objects can be set to Read-Only or Hidden via Field Visibility settings

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