Layout Rules

From AgileApps Support Wiki
Revision as of 23:33, 4 March 2011 by imported>Aeric (Text replace - 'Setup > Customize > ' to 'Designer > Data & Presentation > ')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Layout Rules provide the ability to create dynamic Form Layouts - data entry forms that adapt and offer additional options when specific data is entered: to hide/show fields based on conditions, rules and data criteria. Layout Rules guide users through a form layout so they only edit or view the information they need.

Some examples might be: Show a discount button when an amount reaches some value, or Hide a section and prevent access to data until after a specific date and time.

Lock-tiny.gif

Users that have the Customize Objects permission can edit Layout Rules 

How it Works

Layout Rules use an IF...THEN...ELSE model to customize a form layout:

IF some <condition> is TRUE
THEN do a <thing>
ELSE do another <thing>
Available <things> are any of the following actions:
  • Show/Hide Sections or Fields
  • Disable/Enable Fields
  • Assign Value to Fields
  • Setup Value in Picklist
  • Display Message
  • Show/Hide Buttons
The <condition> is written as a Formula Expression, which can make use of most of the fields in the record, as well as some related fields.

Notepad.png

Note:
A field can be referenced in either:

a. A section for which Show Empty Fields in View has been disabled
    (using Advanced Options in a Section), or
b. A Layout Rule condition.

But it cannot be referenced in both places.

The Reason: If the field is empty, the server removes it from the page. The Layout Rule, meanwhile, is a JavaScript function in the page. When the Layout Rule tries to test that field, an error occurs.


Examples

  • In this example, the application tracks orders for Shoes and displays a VIP discount section if a premium material selected:
Form when the criteria is TRUE:
File:Layoutruletrue.gif
Condition is met: the fields in the VIP discount section can be viewed or edited
Form when the criteria is FALSE:
File:Layoutrulefalse.gif
Condition is not met: the section heading is displayed however the fields in the VIP discount section can not be viewed or changed
  • Special offer for VIP Customers:
IF Total Amount is greater than $100 USD
THEN
  • Display a VIP section with special offers for VIP clients (free shipping, discounts on next purchase, etc.)
  • Set the "VIP" flag to TRUE (which will add this customer to a customer service call list for follow up)
ELSE Set Shipping amount to "Standard"
  • Why was an Opportunity Lost?
IF Stage in an Opportunity record is changed to Closed/Lost
THEN Display a "Reason" field
ELSE Do nothing


Considerations

  • Layout rules follow an IF...THEN...ELSE model
  • Each Layout Rule can include multiple actions
  • Actions are executed in the order in which they are displayed
  • Actions can be added, edited, deleted or reordered
  • Sections can be opened based on a condition
  • A condition can be applied on Add, View or Update a Record
  • Multi Object Lookup fields cannot be used to specify criteria for a Layout Rule.
    Learn more: Multi Object Lookup#Considerations

Manage Layout Rules

  1. Click Designer > Data & Presentation > Objects > {object}
  1. Click the Form Layouts tab
  2. Click the Layout Rule File:Layoutruleicon.gif icon
  3. Optionally, click the Delete link to delete a Layout Rule
  4. Optionally, click the [Reorder Rule] button to change the order that the rules are executed
  5. Click the [Add New Rule] button to add a new Layout Rule, or click the name of an existing rule to edit the Layout Rule
    Name
    Name of the Layout Rule
    Enabled
    Check the box to enable the Layout Rule, or uncheck it to disable the Layout Rule
    Description
    Description of the rule
    Apply rule during
    Executes the Layout Rule when any the selected actions are taken on a record in the Object
    • Add Record
    • View Record
    • Update Record
    On Success do not continue to next Rule
    Checkbox, unchecked by default
    • If checked, and this rule is Triggered, then any rules that follow are not processed
    • The order of processing rules in controlled with the [Reorder Rule] button
    Use the Layout Rule Builder to create an IF, THEN, ELSE statement. This statement defines the behaviors and actions of the Layout Rule.
  6. Click [Save]

Layout Rule Builder

The Layout Rule Builder has three sections:

IF Section
Specify the condition that will trigger this rule
  • Create a Formula Expression (using <FIELD_NAME> <OPERATOR> <FUNCTION>) that evaluates to a TRUE/FALSE state
  • The contents of the Field list may differ based on the object
  • If the condition resolves to TRUE, take the action associated with the THEN condition
  • If the condition resolves to FALSE, take the action associated with the ELSE condition
THEN Section
Optionally, create action(s) to take when the expression is TRUE; Actions are displayed in rows which can be added, edited, deleted or reordered
ELSE Section
Optionally, create action(s) to take when the expression is FALSE; Actions are displayed in rows which can be added, edited, deleted or reordered

Available Actions

Layout Rules Actions

Using Enumerated Picklists in Layout Rules

Layout Rule criteria can be specified using Enumerated Picklist Values. The Display Label is not considered valid for criteria in Layout Rules.