Fields Element

Required, Repeatable:

This element is a structure that defines a single field.  The element structure is repeated to define multiple fields.

Required:

This element provides the exact name of an entity database column or a dynamic field associated to an OIPA entity or activity.  It can also present data returned from an associated SQL query or an associated Math section.

Required:

This element provides the field's label. All labels can be translated to languages or renamed for a custom label.

Required:

This element classifies the field to one of the system's supported types of data. A specific data type gives a field a general definition of the potential appropriate values and the operations that can be performed on those values.

Optional:

This attribute provides the name of a mask. The system chooses a specific definition by the mask name and the user's security group. This attribute is applicable only for "Text" data types. Field data that is masked is not persisted with formatting characters.

Optional:

This attribute provides the name of an industry standard calendar type.  This influences the format of the entered or presented data value.  The attribute is applicable only for "Date" data types.

Optional:

This attribute provides the name of a date format defined in the AsTranslation table. The attribute is applicable only for "Date" data types.

Optional:

This element provides a simplified name of the table that is the source of the data presented in the field.  This is used where the source data may come from one of multiple tables (i.e., criteria for search screen).

Optional:

This attribute identifies the Role whose field will be presented by the containing <Field>.

Optional:

This element provides a comma delimited list of currency codes.  This list is presented in OIPA as a combo box.  Selection associates the decimal value to the selected currency code.

The element is applicable to fields with a data type of Money, otherwise it is ignored.

Optional:

This element defines the initial currency selection from the combo box presented by the <Currency> element or provides the single currency code to associate to the field's value when the <Currency> element is not configured.

This element is ignored in the Inquiry Screen's output field section.

Optional:

This element provides the field's initial value.

Optional:

This element provides a means to "calculate" the initial value of the field.  The element's value provides different ways to calculate the field's default value.  The element's value differs between the types provided by the TYPE attribute.

Required:

The attribute describes the value that is configured in the parent element.

Optional:

The element adds additional conditions to process the parent <Calculated> element.

Optional:

The element controls the ability to access the field for data entry.

Optional:

The element controls visibility of the field on the screen.

Optional:

The element controls the width of the field.  Normally the field's width is limited to the width of a single field column on the page.  When a field is expanded, the field's width is expanded across all field columns on the page.  If the field's natural presentation is in the left column, the field is expanded to all field columns.  If the field's natural presentation is not in the left column, the field moves down a row and expands across all field columns.  The only data types that can be expanded are Combo, Radio and Text.

Optional:

The element indicates where a value is required to be entered.  A required field cannot be left blank when the screen is submitted for persistence. 

There is exceptional information to note:

• A "Yes" value for this element is not valid when the data type is Identifier.
• A field with data type is Check must be checked before the screen is submitted else an error is generated. 
• A field with data type is Radio must have a selection before the screen is submitted else an error is generated.
• SecurityGroup configuration may conflict with a required field.
  • SecurityGroup configuration can prevent the user from entering data while at the same time this element may required data entry.  This situation must be avoided.
• This element applies to dynamic fields on the Policy, Client, Segment, Activity, Suspense, Inquiry and ClientGroup Screens.

Optional:

This element will indicate when the field cannot be overridden during inheritance and is only applicable to screen rules that can be inherited.  Those rules are PlanScreen and SegmentName. 

Optional:

This element provides the options that populate a combo box either through a SQL query or static list of <Option> elements.

The element applies to Combo and Radio data type fields only.  If configuration does not provide this element, a screen <Event> and associated <Action> must ASSIGN option values with value\text pairs.

Required:

This attribute defines the method to obtain the options that populate the combo box.

Optional:

This element provides a structure defining the options available to a Combo and Radio data type.  This element is required when the <Query> element's type is FIXED.

Required, Repeatable:

This element defines a single option. An option is always a key and value pair. Repeating the element allows definition of multiple key/value pairs.

Required:

This element provides the value for the key part of the key/value pair. Often this is a code value from the AsCode table. When this option is selected, this is also the field's actual value.

Required:

This element provides a descriptive label for the associated key. A user actually sees this on the UI.

Optional:

This element identifies that the field's text value will be encrypted as it is persisted to the database.  If the field applies a MASK, the MASK is applied first followed by encrypting the data.  MASK formatting characters are not persisted in the database and not part of the encrypted data.  This element may co-exist on the same field with the <Decrypt> element and is recommended.  <Decrypt> instructs the system about data retrieval while <Encrypt> impacts data persistence.

This element applies only to Activities defined by Transaction configuration.

Optional:

This attribute identifies the actions the system takes on this field's data when the Activity processes successfully ("Active" status) or when the activity is deleted while it is pending ("Pending Shadow" status).  This attribute applies to Activities regardless of how they are created ( UI, Data Intake, Spawn, AsFile), regardless of the process that made it active and regardless of the process that shadowed the activity (UI, Data Intake, ShadowPendingActivities attached business rule).

Optional:

This attribute indicates that the field's encrypted text value will be decrypted as the value is retrieved from the database with or without a SQL query.  The data is presented in its raw decrypted value.  A MASK on the field applies formatting characters after decryption.  This element may co-exist on the same field with the <Encrypt> element and is recommended.  <Encrypt> instructs the system on persisting data while <Decrypt> instructs data retrieval.

This element applies only to Activities defined by Transaction configuration.

Optional:

This attribute identifies the actions the system takes on this field's data when the Activity processes successfully ("Active" status) or when the activity is deleted while it is pending ("Pending Shadow" status).  This attribute applies to Activities regardless of how they are created ( UI, Data Intake, Spawn, AsFile), regardless of the process that made it active and regardless of the process that shadowed the activity (UI, Data Intake, ShadowPendingActivities attached business rule).

Optional:

This element provides a structure to define concatenation of field values, math variable values, literals and sequence numbers. This is applicable for fields where <DataType> is "Identifier".

See Parts page under Common Elements topic.

Optional:

The element instructs the system to clear the field's value during the activity's presentation when it is manually recycled by a user. This element can only be applied to a transaction's fields.