Most form lines fall into this category. It provides the definition
of a field on the form, including the label to display.
The base product provides the C1-StandardLine business object, which has the common
structure of a form line.
A standard line can be configured to either create a new field
or point to an existing field in the system. To create a new field,
specify Create New in
the Definition Field Usage and specify the data type, the applicable
settings for the data type and the label definition. To point to an
existing field, specify Use Existing in the Definition Field Usage and specify an existing field in Definition
Field Usage.
The base business object supports most basic field data types that
the Framework supports - i.e. character, number, money, date, boolean,
etc.
Character field types can be validated using a Validation Pattern that uses an
Extended Lookup, C1-RegularExpressionLookup. The Extended Lookup uses a regular expression to define the pattern.
The validation is only performed if the Form Line Configuration Validation
form rule, C1-ChkReqSectionsLines is included on the Form Type.
In addition, special data types are also supported: simple lookup,
extendable lookup and foreign key reference.
Simple lookups are used when the line's possible values is a simple
list of descriptions. To configure a form line to point to an existing
lookup, specify
Use Existing in the Definition Field Usage and specify an existing lookup field
in the Definition Field Name. To configure a form line to create a
new lookup field, specify
Create
New in the Definition Field Usage and define the lookup
field and values.
Note: The initial list of values can be specified
on the line configuration. However, once the lookup field exists,
any changes to the lookup values must be done via Lookup maintenance.
Extendable lookups are used when the lookup values require additional
information. For example, a list of counties may be set up using an
extendable lookup. Each county can specify not only the description
of the county, but also a distribution code. To configure a form line
as an extendable lookup, the extendable lookups have to be defined
first, via Extendable Lookup maintenance. When defining the form line,
specify Use Extendable Lookup in the Definition Field Usage and specify the Extendable Lookup
BO.
Foreign key references are used when the form line needs to contain
a value that exists in one of the tables in the product. For example,
a registration form may specify an industry code, which must be defined
in the Industry Code table. To configure a form line as a foreign
key reference, specify
Use Foreign
Key Reference in the Definition Field Usage and specify
the Foreign Key Reference. In addition, specify the UI Map Usage,
to indicate whether the values will be displayed as a dropdown list
or as an input field with search.
Note:
Input Field should be specified only if the foreign key
reference has a custom search.
Form lines can be configured to map to a Related Form Field. The
Related Form Field list consists of columns in the tax form or registration
form. When a form line is mapped to a related form field, the line's
value is copied to the corresponding table column. When mapping a
form line to a related form field, specify the Form Line Mapping setting,
to indicate whether the copy happens every time the form is updated
or only when a form rule executes.
For each form line, the following elements may be configured:
- As Current - This is required. This element captures the line's
current value.
- As Reported - This setting is optional. This element is used to
display the original value that was reported for the line. It is
populated when the form exits the Pending state.
CAUTION:
This setting should be carefully considered. This should not be enabled
for forms with a large volume of lines because it can adversely impact
performance. Users can refer to the Form Versions tab of the tax form,
to view any of the form's versions, including the original version.
- Override Switch - This switch is used to bypass validation. For
example, a form rule may be defined such that "If line 110 is populated,
line 120 must have a value greater than 500." Suppose line 110 is
populated and line 120 has a value of 499 and the business rule is
that when this form suspends, a user can review it and make a decision
that the value on the form is valid and that the rule should be bypassed.
The user clicks on the Override switch and try to re-validate the
form.
CAUTION:
This setting should only be enabled for
form lines where a corresponding validation rule is designed to check
this switch.
- Change Reason - This is optional. It allows a change reason to
be supplied at the form line level (in addition to change reasons
at the form level, if applicable). When a user changes the current
value of a line, this change reason can also be supplied.
CAUTION:
Capturing a change reason at the line level requires
an additional element and thus, adds to the size of the form. This
should be carefully considered.
All of the above mentioned elements have a Display Label setting.
To ensure the proper display of line details, this setting should
always be the same for all applicable elements.
CAUTION:
HTML rendering considers labels as elements or widgets too. Therefore,
labels add to the form's size. Carefully consider when the labels
for these extra elements should display. For instance, when the line
only has As Current is applicable, it's probably not useful to display
the 'As Current' label. More importantly, when enabling As Reported,
Override and/or Change Reason on a repeating group of lines, the 'As
Current', 'As Reported', 'Override' and 'Change Reason' labels should
be enabled for the first line only.
Copyright © 2007, 2016, Oracle and/or its affiliates. All rights reserved. Documentation build: 2.5.2016 10:21:45 [T1_1454696505000]