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>	Optional; This is the name of the group (table) that should be used to obtain the value. This is used only where source data may come from multiple tables (i.e., search screens).
<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, the operations that can be performed on the type and how the value is stored.		Address: Holds address information. Check: Displays check box on the screen. Client:Provides the user with a list of all available clients from the AsClient table. Combo: Combination/drop down field . Comment:Allows the user to enter a comment. CopyBook: Used to attach a CopyBook. Date: Date field with calendar icon. Decimal: Displays decimal point and calculator icon. Filler: Adds an empty space between fields. Identifier: Generates a unique value by combining various values from other fields and a sequence number. Integer: Formats to a whole number. Displays calculator icon. Label: Displays a text label. Line: Displays line across frame for aesthetics. Money: Displays a monetary value along with its currency code and Calculator icon. Multifields: Used to turn on multifield functionality and specify a particular multifield rule. Percent: Displays percent sign. Radio: Mutually exclusive options. Selecting one automatically unselects the others. Text: Free form entry. XML Comment: Add a comment from the Fields pane instead of scrolling through the XML in the XML Source pane.
	Optional; Used to specify the mask used to format or obfuscate the field data for display purposes.	MASK	Text: Any mask name that has been defined.
	Optional: Used when DataType is set to “Date” to designate appropriate calendar format.	CALENDAR	Gregorian, Japanese TranslationKey
	Optional: Used when DataType is set to “Date”, and designates the appropriate date format.	FORMAT	Translation Key values in AsTranslation table. Cannot be Date.Format
<Parts>	Optional: Used when DataType is set to "Identifier".
<Part>	See Parts element for details.		Specifies the parts to generate the identifier field.
<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.
<Options>	Individual option value. Used with the Combo and Radio datatypes.
<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.		Date, Decimal, Integer, or String Value
<OptionText>	Text that will display in drop down box or radio buttons.		String Value
<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 data 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	IFEMPTY: Execute the Calculated element if the field is empty. 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>	Controls the visibility of the field on the screen.		Yes: Field is hidden from user. No: Field is visible.
<Expanded>	Optional: Used on Client screen configuration.		Yes: Field is expanded. If a field is expanded, it is the only field in the line. No: Field is not expanded.
<Length>	Limits character entry.		Integer: Applicable for integer and text type fields.

XML Example

General Example

<Field>

<Name>TaxID</Name>

<Display>Tax ID</Display>

<DataType MASK="SSN">Text</DataType>

<Disabled>No</Disabled>

<Hidden>No</Hidden>

</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="FIXED">

<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 AsCode

 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>