You are here: Common Elements > Fields Elements

Fields Element

Description

The following elements allow for the configuration of fields. Fields dictate the entry information required for screens and activity processing.

Fields Element/Attribute Table
Element/Tag	Definition	Attribute	Element/Attribute Value and Description
<Fields>	The opening and closing tag of the fields section.
<Field>	The opening and closing tag for each field being configured
<Name>	Required; Exact name of the field. This is the name that is found in the configuration whenever a reference is being made to this field.
<Group>	This is the name of the group (table) that should be used to obtain the value.	ROLECODE	Code: Only applicable when Group is Role.
<Display>	Required; Provides the label text that will display on the screen. Spaces are allowed.
<DataType>	Required; A classification identifying one of various types of data which provide general definition to the appropriate values for the type, the operations that can be performed on the type and how the value is stored.		Address: Check: Check box field Client: Allows the user to invoke the ClientSearchScreen from within another screen Combo: Combination/drop down field Comment: CopyBook: Date: Date field with calendar icon Decimal: Displays decimal point and calculator icon Filler: Identifier: generates a sequence number in Client, Address, Suspense, BatchSuspense, and ActivityDetail screens. Integer: Formats to whole number. Displays calculator icon Label: Line Separator: Displays line across frame for aesthetics Money: Displays dollar sign, commas, decimals and Calculator icon MultiField: Percent: Displays percent sign Radio: Mutually exclusive options. Selecting one automatically unselects the others Text: Free form entry Title: Blank: Inserts a space on screen
<DefaultValue>	Default value of field. If set to SYSTEMDATE, the default value will be set to the system date.		String, Code or Integer (depending on DataType).
<Query>	Used with the Combo datatype to retrieve options for the combo box.	TYPE	SQL: SELECT Statement that returns the values to be displayed in the combo box. The Query must return a Key and a Value. The Key is a unique pointer to the Value. Value is a user-friendly description and is visible in the combo box. FIXED: Uses Options tag to fill the options. RADIO: Uses Options tag to fill the options.
<Options>	Individual option value. Used with the Combo datatype.
<Option>	Each option set needs to be contained in this opening and closing tag.
<OptionValue>	Code Value for the option. This is the key value that is stored in the database.
<OptionText>	Text that will display in drop down box or radio buttons
<Calculated>	Allows execution of a SQL statement or a previous field to populate the current field’s value.	TYPE	SQL: Allows for a SQL query to be executed with the result being the date displayed in the field. It must be a single column, single row return.
			REPLACE: Forces the field to accept the value of the field referenced by the Calculated element's value.
		METHOD	FORCE: Used to force execution of the Calculated element every time the screen is loaded.
<Disabled>	Allows field entry.		Yes: Field is locked down and grayed out. No: Field is enterable ReadOnly: Field is locked down and grayed out.
<Hidden>			Yes: Field is hidden from user. No: Field is visible.
<Length>	Limits character entry.		Integer: Applicable for integer and text type fields.
<Parts>	Provides information to create a next identifier. Used with datatype Identifier.		String

XML Example

General Example

<Field>

<Name>Adjustment</Name>

<Display>Adjustment</Display>

<DataType>Money</DataType>

<DefaultValue>0</DefaultValue>

<Disabled>No</Disabled>

<Hidden>No</Hidden>

<Length>15</Length>

</Field>

Line DataType Example

<Field>

<Name>Line1</Name

<Display>Line</Display>

<DataType>Line</DataType>

</Field>

Radio DataType/OptionText population Example

<Field>

<Name>AccountType</Name>

<Display>Account Type</Display>

<DataType>Radio</DataType>

<Query TYPE="RADIO">

<Options>

<Option>

<OptionValue>C</OptionValue>

<OptionText>Checking</OptionText>

</Option>

<Option>

<OptionValue>S</OptionValue>

<OptionText>Savings</OptionText>

</Option>

</Options>

</Query>

</Field>

Calculated Example

<Field>

<Name>Prefix</Name>

<Display>Prefix</Display>

<DataType>Text</DataType>

<Calculated TYPE="SQL">SELECT CASE WHEN '[PolicyStatus]' = '08' THEN 'B' ELSE 'R' END</Calculated>

</Field>

Combo DataType/SQL population Example

<Field>

<Name>BankStateLocation</Name>

<Display>Bank State</Display>

<DataType>Combo</DataType>

<Query TYPE="SQL">SELECT CodeValue, ShortDescription FROM AsCodeState

 UNION SELECT '$$$Blank$$$', ' ' ORDER BY ShortDescription</Query>

</Field>

Parts Example #1

<Field>

<Name>ClientID</Name>

<Display>Client Name ID</Display>

<DataType>Identifier</DataType>

<Parts>

<Part TYPE="SEQUENCE" FORMAT="0000000000">ClientID</Part>

</Parts>

</Field>

Parts Example #2

<Field>

<Name>ActivityWarrantNumber</Name>

<Display>Activity Warrant Number</Display>

<DataType>Identifier</DataType>

<Parts>

<Part TYPE="FIELD" LEFT="1">Prefix</Part>

<Part TYPE="SEQUENCE" FORMAT="0000000">AsActivity_RBWarrantNumber</Part>

</Parts>

</Field>

XML Schema

<Field>

<Name>. . .</Name>

<Display>. . .</Display>

<DataType>Identifier</DataType>

<Parts>

<Part TYPE="VALUE">[literal]</Part>

<Part TYPE="SYSTEMDATE" FORMAT="YY|MM|DD|YYYY|YYMM|YYYYMM|YYMMDD|YYYYMMDD"></Part>

<Part TYPE="FIELD" LEFT="[integer]" FORMAT="[padding characters]">[field name]</Part>

<Part TYPE="FIELD" RIGHT="[integer]" FORMAT="[padding characters]">[field name]</Part>

<Part TYPE="FIELD" MID="[integer, integer]" FORMAT="[padding characters]">[field name]</Part>

<Part TYPE="SEQUENCE" FORMAT="[padding characters]" SEQUENCEDATE="[field name]|SYSTEMDATE|EffectiveDate">[sequence  name]</Part>

</Parts>

</Field>