FieldSettings structure
This structure holds details associated with a given field as read from the Field Settings.
The structure is used as a parameter in TextFieldFormatting user exit.
The elements that are part of this structure are as follows.
Structure Element |
Type |
Description |
---|---|---|
FIELDNAME |
String |
The field name. |
VerifierLabel |
String |
The field label in the Validation Activity. |
ACTIVE |
Boolean |
The field active flag. |
RequiredInRTS |
Boolean |
The denotes whether the field is required in Transformation Server. |
RequiredInVerifier |
Boolean |
The denotes whether field entry is mandatory in the Validation Activity. |
COUNTRYFILTER |
String |
The comma-separated list of countries that control whether the field is mandatory or not. |
FIELDTYPE |
String |
The field type. |
FORCEVERIFY |
Boolean |
The force verify indicator. |
DEFAULTVALUE |
String |
The field default value. |
DEFAULTIFNOTHINGEXTR |
SubstitutionRule |
The field default if no value is extracted automatically. |
SubstitutionRule |
String |
The field substitution rule. |
MINLENGTH |
Integer |
The field minimum length. |
MAXLENGTH |
Integer |
The field maximum length. |
RIGHTJUSTIFY |
Boolean |
The indicator as to whether the field must be right-justified if a pad character is used. |
PADCHAR |
String |
The padding character. |
REMOVEALLSPECIALS |
Boolean |
The flag to indicate whether special characters must be removed. |
REMOVEBLANKS |
Boolean |
The flag to indicate whether blank spaces must be removed. |
KEEPCERTAINSPECIALS |
String |
The list of special characters that must be retained. |
REMOVESTARTEND |
Boolean |
The flag to indicate whether special characters must be removed from the start and end of the string. |
SUBSTRINGSTARTPOS |
Integer |
The substring start position. |
SUBSTRINGLENGTH |
Integer |
The substring length. |
REMOVELEADINGZEROS |
Boolean |
The flag to indicate whether leading zeros must be removed from a string. |
DECIMALPLACES |
Integer |
The number of decimal places for an exported amount. |
NEGATIVETYPE |
Integer |
The negative type code. |
OUTPUTFORZERO |
String |
The export value if an amount field is zero. |
SUBSTITUTEVALUEIFOVER0 |
String |
The export value if an amount is greater than zero. |
FUTUREDAYS |
Integer |
The number of days that an extracted date is permitted to be in the future. |
NODAYSINPAST |
Integer |
The number of days that an extracted date is permitted to be in the past. |
DateOnlinInCurrentMonth |
Boolean |
The flag to indicate whether the date should only be in the current month. |
FIELDMASK |
String |
The list of valid field masks for text fields. |
ExtractionProfile |
ExtractionProfile |
The extraction profile ID (for custom fields 1-5). |