AgileApps Support Wiki Pre Release

Difference between revisions of "Subforms"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 1: Line 1:
In a [[Web Form]], a subform can be used display ''related records'' (records that have a [[Lookup]] to the current record). It can also allow related records to be created by filling in the subform fields.
In a [[Web Form]], a subform can be used display ''related records'' (records that have a [[Lookup]] to the current record). It can also allow related records to be created by filling in the subform fields.


For example, a Subform might present this kind of information in a record:
For example, a subform might present this kind of information in a record:
:*Line items in an order
:*Line items in an order
:*Expense line items in an Expense Report object
:*Expense line items in an Expense Report object
Line 12: Line 12:
#Choose one of the following options:
#Choose one of the following options:
#*Click the ''New Subform'' link (located in the [[Elements Sidebar]])
#*Click the ''New Subform'' link (located in the [[Elements Sidebar]])
#*Or click the ''Edit'' link in a Subform section heading.
#*Or click the ''Edit'' link in a subform section heading.
#:
#:
#Fill in the subform settings:
#Fill in the subform settings:
Line 32: Line 32:
====Sorting Rows, Totaling Columns ====
====Sorting Rows, Totaling Columns ====


The second page of the Subform definition lets you specify sorting and totaling options:
The second page of the subform definition lets you specify sorting and totaling options:
#;Sort Settings: Choose the column to sort on, and specify ascending or descending sort.
#;Sort Settings: Choose the column to sort on, and specify ascending or descending sort.
#;Column Totals: Select the numeric and currency fields that will be automatically totaled.<br>(Only numeric and currency fields are listed.)
#;Column Totals: Select the numeric and currency fields that will be automatically totaled.<br>(Only numeric and currency fields are listed.)
Line 50: Line 50:
:[[File:GridInForm.png|border]]
:[[File:GridInForm.png|border]]


{{DeveloperNote|<br>Fields for Column Totals, Column-Total Adjustments, and the Net Total are added to the original object (the object the Subform is defined on). The field names have the form <tt>grid_{name}_123456...</tt>, where the name might be "discount", "net_total", or "comptn" (for a column total), and where the number at the end is the ID of the object [[Field]].}}
{{DeveloperNote|<br>Fields for Column Totals, Column-Total Adjustments, and the Net Total are added to the original object (the object the subform is defined on). The field names have the form <tt>grid_{name}_123456...</tt>, where the name might be "discount", "net_total", or "comptn" (for a column total), and where the number at the end is the ID of the object [[Field]].}}

Revision as of 19:58, 26 June 2013

In a Web Form, a subform can be used display related records (records that have a Lookup to the current record). It can also allow related records to be created by filling in the subform fields.

For example, a subform might present this kind of information in a record:

  • Line items in an order
  • Expense line items in an Expense Report object
  • List of available inventory items
Considerations
  • The owner of the main record becomes the owner of the related records created by the subform.

To Add or Edit a Subform

  1. Choose one of the following options:
    • Click the New Subform link (located in the Elements Sidebar)
    • Or click the Edit link in a subform section heading.
  2. Fill in the subform settings:
    Title
    The text to display in the GUI.
    Section Type
    Pre-populated (do not change)
    Object Name
    The Object records to display in the Subform
    Linking Field
    Select the field that does a Lookup to the current object. (A list is presented, in case there is more than one.)
    Number of Rows
    Specify the number of rows to display in the Subform
    • This is the minimum number of number of rows to display.
    • It defaults to 5 rows. You can specify any value up to 100 rows.
    • If data exists, then all available data is shown, plus an additional 3 empty rows.
    Header Image
    Optionally, select an image to display at the top of the section
    Footer Image
    Optionally, select an image to display at the bottom of the section
    Left Side Image
    Optionally, select an image to display to the left of the section
    Right Side Image
    Optionally, select an image to display to the right of the section
  3. Use the Arrow Buttons to move fields to the list of Selected Fields list, to specify their order.
    The selected fields are displayed in the Subform when the form is displayed.
  4. Click [Next]

Sorting Rows, Totaling Columns

The second page of the subform definition lets you specify sorting and totaling options:

  1. Sort Settings
    Choose the column to sort on, and specify ascending or descending sort.
    Column Totals
    Select the numeric and currency fields that will be automatically totaled.
    (Only numeric and currency fields are listed.)
    Column-Total Adjustments
    This section appears when you are totaling currency fields. (Only currency fields are listed.)
    • Select the currency field that will have additional adjustments applied to it, and specify the adjustments to allow for. (See below)
  2. Click [Save]

Column-Total Adjustments

If you total one more currency fields, you can elect to apply adjustments to one of them:

  • Surcharge - Adds a surcharge percentage field to the form.
  • Discount - Adds a discount percentage field to the form, as well as a discount amount.
    (Either can entered. If an amount is entered, it is saved as a percentage.)
  • Tax - Adds a tax percentage field to the form.
  • Shipping - Adds a field for a shipping charge.

Each selection adds the appropriate fields to the form, and does the appropriate calculations to produce a net total:

File:GridInForm.png

Notepad.png

Note for Developers:
Fields for Column Totals, Column-Total Adjustments, and the Net Total are added to the original object (the object the subform is defined on). The field names have the form grid_{name}_123456..., where the name might be "discount", "net_total", or "comptn" (for a column total), and where the number at the end is the ID of the object Field.