Difference between revisions of "Field Settings"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
 
(16 intermediate revisions by the same user not shown)
Line 3: Line 3:
:;Label:Enter a field label; This label is displayed on the Form
:;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 Types|Field Display Type]] selected
:;Display Type:The fields in this page will change, depending on the [[Field Display Types|Field Display Type]] selected
<span id="alwaysRequired">
:;Always Required:
:;Always Required:Checkbox</span>
::*By default, Always Required check box is not selected.
::*Default is unchecked
::*If Always Required check box for a field is selected, then the field is required in all the [[Forms]] and [[API]] calls.
::*If checked, this field is required in All [[Forms]] and all [[API]] calls
 
:;Field Name:The name that will be used to reference this object. Must conform to the [[Field Naming Rules]]
::;Considerations:
::*If any object has only one form layout, then the AgileApps Cloud application allows you to save a field with Always Required check box selected.
::*If there are more than one form, then do not select the Always required check box as the AgileApps Cloud application displays the error "This field cannot be made as Always Required. Please use the form layout designer and layout rules to make this field required for the specific form layout".


====Display Attributes====
====Display Attributes====
Line 36: Line 38:
:*When a new role is added, that role receives ''Visibility'' rights to all the fields across all the objects
:*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 means that the user's [[Role]] determines whether a record is visible in the [[Audit Log]]
:*When this control is specified for a field, it means that the user's [[Role]] determines whether a record is visible in the [[Audit Log]]
:*You cannot set any default value at field level for any role with read-only permission.


====Description Information====
====Description Information====
Optionally, add a description of the field
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 [[Form Properties#Show_Field_Hint|Show Field Hint]]s has been enabled for the form the user is in.
<blockquote>
=====Field Hint/Description=====
Text entered here will be displayed when the user hovers their mouse over the field, when [[Form Properties#Show_Field_Hint|Show Field Hint]]s has been enabled for the form the user is in. (It is enabled by default for forms in new objects, but was disabled by default in forms created prior to the Nov 2014 release.)
</blockquote>
 
===For Developers: Displaying Properties for All Fields===
When programming data for an object, it's helpful to know which fields are required, and which are standard system fields that can't be modified. The list of Fields shown for an object has an optional '''Properties''' column for that purpose.
 
For each field, that column shows one of:
:* '''Required''' - the field is required
:* '''Read-Only''' - the field is a standard system field that cannot be modified either programmatically or by users
:::'''Note:'''
:::A field could also be Read-Only by virtue of a user's Role. The view does not reflect that condition.<br>(It would be difficult to display, and does not generally apply to programmed operations.)
 
'''To add that column to the view:'''
# Click the Wrench Icon ([[File:WrenchIcon.png]]) next to the view title ('''All Fields''', by default)
# Choose '''New View''' or '''Edit this View'''
# In the '''Fields''' tab, move '''Property''' to the list of selected fields
# In the '''Order''' tab, position it where you want it to be displayed
# In the '''Filter''' field, specify criteria to determine which fields are displayed.
#* Specify <tt>property equals 1</tt> for required fields, <tt>property equals 2</tt> for read-only fields.
# Click '''[Save]'''

Latest revision as of 03:11, 22 January 2018

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
  • By default, Always Required check box is not selected.
  • If Always Required check box for a field is selected, then the field is required in all the Forms and API calls.
Considerations
  • If any object has only one form layout, then the AgileApps Cloud application allows you to save a field with Always Required check box selected.
  • If there are more than one form, then do not select the Always required check box as the AgileApps Cloud application displays the error "This field cannot be made as Always Required. Please use the form layout designer and layout rules to make this field required for the specific form layout".

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"')

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 means that the user's Role determines whether a record is visible in the Audit Log
  • You cannot set any default value at field level for any role with read-only permission.

Description Information

Optionally, add a description of the field

Field Hint/Description

Text entered here will be displayed when the user hovers their mouse over the field, when Show Field Hints has been enabled for the form the user is in. (It is enabled by default for forms in new objects, but was disabled by default in forms created prior to the Nov 2014 release.)

For Developers: Displaying Properties for All Fields

When programming data for an object, it's helpful to know which fields are required, and which are standard system fields that can't be modified. The list of Fields shown for an object has an optional Properties column for that purpose.

For each field, that column shows one of:

  • Required - the field is required
  • Read-Only - the field is a standard system field that cannot be modified either programmatically or by users
Note:
A field could also be Read-Only by virtue of a user's Role. The view does not reflect that condition.
(It would be difficult to display, and does not generally apply to programmed operations.)

To add that column to the view:

  1. Click the Wrench Icon (WrenchIcon.png) next to the view title (All Fields, by default)
  2. Choose New View or Edit this View
  3. In the Fields tab, move Property to the list of selected fields
  4. In the Order tab, position it where you want it to be displayed
  5. In the Filter field, specify criteria to determine which fields are displayed.
    • Specify property equals 1 for required fields, property equals 2 for read-only fields.
  6. Click [Save]