Fields Element
The following elements allow for the configuration of fields. Fields dictate the entry information required for screens and activity processing.
| Element/Tag | Attribute | Definition | 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). |
Organization, Person, or Client Also may include fields from |
|
| ROLECODE |
RoleCode from ASRole table.
|
||
|
<Display> |
BOLD ITALICS |
Optional: Renders bold or italicized representation of a dynamic field’s contents. If added to an inquiry’s Input section <Name> element and set to Yes, then BOLD and ITALICS attributes will be ignored. |
Yes: field contents will be bold and/or in italicized. No: contents will not have bold or italicized content. |
|
<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. |
Blank: Used for Filler fields. Check: Displays check box on the screen. Client:Provides the user with a list of all available clients from the AsClient table. Allows the user to invoke the ClientSearchScreen from within ClientScreen, PolicyScreen, SegmentScreen, and ActivityDetailScreen. Combo: Combination/drop down field. Note: Bold and Italics tags are not applicable to "Combo" type fields. Date: Date field with calendar icon. Decimal: Displays decimal point and calculator icon. 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 left-justified within the column of fields in which it is placed. Line: Displays line across frame for aesthetics. Message: Generates a static or dynamic message (using values from fields). Money: Displays a monetary value along with its currency code and Calculator icon. Percent: Displays percent sign. Radio: Mutually exclusive options. Selecting one automatically unselects the others. Role: Text: Free form entry. TextArea: Variable-length dynamic text field. Note: TextArea is not supported within the <Table> element. Title:Displays a bolded text label centered across both columns of fields. ExternalLink: Displays third party URLs as as clickable links. |
| MASK |
Optional: Used to specify the mask used to format or conceal the field data for display purposes. |
Text: Any mask name that has been defined. |
|
| CALENDAR |
Optional: Used when DataType is set to “Date” to designate appropriate calendar format. |
Gregorian, JP, JP_IMP | |
| FORMAT |
Optional: Used when DataType is set to “Date”, and designates the appropriate date format. |
Translation Key values in AsTranslation table. Cannot be Date Format. | |
| <Encrypt> | Optional: Used when the field data is to be stored in the appropriate encrypted format. |
Yes: Field data is stored in the encrypted format. No: Field data is stored in the decrypted/ normal format. |
|
| ERASE |
Optional: Can be used in Activity Field Configuration to erase field data
Note: This is applicable for all the 'Pending Shadow' activities that are created through OIPA UI/Data Intake/Spawn activities (Pending Shadow for spawned activities that may occur in case of reversal), or activities created from AsFile. Also, when an activity is deleted during Data Intake, or manually deleted by a user, or deleted by an APE like ShadowPendingActivities. |
Yes: Acitivity field data is erased on successful completion of the activity or when an activity is moved to 'Pending Shadow (34)' status. No: Field data is stored in the encrypted /decrypted format as defined. This is the default value. |
|
| <Decrypt> | Optional: Used when the encrypted field data is to be retrieved during a SQL/Query. |
Yes: Encrypted field data should be decrypted for SQL/Query. No: No change |
|
|
<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> |
TYPE |
Used with the Combo datatype to retrieve options for the combo box. |
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. |
|
<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 calculated element to populate the current field’s value. |
If the TYPE attribute is set to SQL, this element should contain a SQL query that is used to populate the field. Entity screens (e.g. AddressScreen, PolicyScreen) can access GUIDs belonging to their corresponding entity (e.g. AddressGUID, PolicyGUID) using this query. Additionally, the Client screen can access PolicyGUID if the screen is accessed via a policy, and the Role screen can access the ClientGUID for the currently selected client. Transactions can access the fixed fields associated with the AsActivity database table, such as ClientNumber, ProcessingOrder, TransactionGUID and ActivityGUID. The values of these fields are available once the activity is saved. |
| TYPE | Defines the type of calculation to be performed. | 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. MESSAGE: Sets the element to contain a static message (containing only text) or dynamic message (with substitution of values from embedded fields). FUNCTION: Specifies a function to be called if the Calculated element is executed. |
|
|
METHOD |
IFEMPTY: Execute the Calculated element if the field is empty. |
||
|
<ClearOnRecycle> |
|
OptionalAllows recycled activities to remove the value of a field that was previously populated. |
Yes: The value of this field is cleared when the activity is manually recycled. No: The value of this field is not changed when the activity is manually recycled. |
|
<Disabled> |
|
Allows field entry. |
Yes: 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 with datatype of Combo, Radio, or Text. |
Yes: Field is expanded. Is a field is expanded, it is the only field in the line. No: Field is not expended. |
|
|
<Required> |
|
Optional: Indicates if the field is a required field for entry. A required field must not be blank or null when the screen is submitted. Note: This element applies only to the following screens: Client, Policy, Segments, Activities, Suspense, Inquiry and ClientGroup. It is not valid if the DataType is Identifier. |
Yes or No Yes – Field is required. Note: If a user is prevented by the security configuration from entering data in a required field, the screen will not pass validation when submitted. No – Field is not required (this is the default value). |
|
<Currency> |
|
Optional: Used when the DataType is set to "Money". When added to Inquiry’s Output section’s Fields <Currency> element it will be ignored. |
A list of one or multiple currency codes from the AsCurrency table (e.g. USD, JPY, THB, etc…) |
|
<DefaultCurrency> |
|
Optional:
Used when DataType is set to "Money". When added to Inquiry’s Output section’s Field, <DefaultCurrency> element it will be ignored. |
One currency code from AsCurrency table (e.g. USD, JPY, THB, etc…) |
|
<Final> |
|
Optional: Valid in <PlanScreen> and <SegmentName> rules only. |
Yes or No Yes – When the value is set to “Yes”, the field cannot be overridden. If not added, the default is No. |
| <ToolTip > | Provides an informational message to the user when they hover over field name. | Value: String |
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>
XML Examples
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>
Currency Example
<Field>
<Name>AnnualPremium</Name>
<Display>Annual Premium</Display>
<DataType>Money</DataType>
<Disabled>Yes</Disabled>
<DefaultValue>0</DefaultValue>
<Currency>KRW,THB,INR,USD</Currency>
<DefaultCurrency>USD</DefaultCurrency>
</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>
Tooltip Example
<Field>
<Name>QualNonQual</Name>
<Display>Qual or Non-Qual</Display>
<DataType>Combo</DataType>
<DefaultValue>00</DefaultValue>
<Query TYPE="SQL">SELECT '00' AS CodeValue, '' AS ShortDescription FROM
DUAL UNION SELECT </Query>
<ToolTip>Your message here</ToolTip>
</Field>
ERASE Example (<Encrypt> with ERASE = Yes|No )
<Transaction>
<Fields>
<Field>
<Name>TestErase</Name>
<Display>TestErase</Display>
<DataType>Text</DataType>
<Encrypt ERASE="Yes">Yes</Encrypt>
<!--<Encrypt ERASE="No">Yes</Encrypt> (to configure with ERASE="No")-->
</Field>
<Field>
<Name>Test2</Name>
<Display>Test2</Display>
<DataType>Text</DataType>
</Field>
</Fields>
</Transaction>
ERASE Example (<Decrypt> with ERASE = Yes|No )
<Transaction>
<Fields>
<Field>
<Name>TestErase</Name>
<Display>TestErase</Display>
<DataType>Text</DataType>
<Decrypt ERASE="Yes">Yes</Decrypt>
<!--<Decrypt ERASE="No">Yes</Decrypt> (to configure with ERASE="No")-->
</Field>
<Field>
<Name>Test2</Name>
<Display>Test2</Display>
<DataType>Text</DataType>
</Field>
</Fields>
</Transaction>
