This is an old revision of the document!
Output fields
The special treatment field in article segments for text segments allows you to select different display formats.
HIGHLIGHT highlights the text block so special messages stand out. Text marked as [b]bold[/b] will be displayed as a header (HTML5 only)
SECTIONHEAD uses a large font to show the start of a new section of the form (bold text in HTML4 option)
Input fields
The special treatment field in article segments for user input allows you to access features such as address lookups. The main features are listed below:
You can use a semicolon to apply multiple special treatments to the same column - eg READONLY;ADDRESS_LOOKUP_LINE2 will mark the column readonly, and identify it as Address Line 2 for a lookup
TYPE validation
TYPE=field_type - this carries out additional validation on text field input. Field types include EMAIL, NUMBER, POSTINT, POSTINTORZERO, POSNUMBER, POSTNUMBERORZERO, PHONE, DATE, NINO (National Insurance Number)
TYPE=EMAIL:DOMAIN=somedomain.com,otherdomain.org.uk - a specific case of the email type, which will only allow emails matching the given domains to be used
[due 1-August-2015]: TYPE=DATE expanded to allow all of the following
Examples
READONLY
READONLY - this makes a field readonly, this is particularly useful for address lookup fields where the lookup will populate the field, and you do not want the user to be allowed to overwrite the information
JS function
JS=javascript_function - this is used to access functions such as lookups, and is normally attached to a button. The main lookups available are as follows:
This uses an external postcode lookup to find the address details matching a given postcode. This does not lookup the house name or number which must be entered by the user.
UPDATESOURCE
Attach special treatment to column (eg Enter AGREE here):
- UPDATESOURCE:[col_name] - will update the source column with the data from this column
- UPDATESOURCE:[col_name] = value?use_value,value?use_value,default?use_value - will update the source column with use_value where this column contains value (case-INsensitive!)
Examples
- UPDATESOURCE:[First payment date] - will update the source column with the description “First payment date” with the contents of this field
- UPDATESOURCE:[Credit Agreement]=AGREE?agreed,DECLINE?declined,default?declined - will update the source column “Credit Agreement” with “agreed” if this field contains AGREE, “declined” if it contains DECLINE or contains any other value
LIB=library_field
You can give the fields in your forms whatever names you like, but in order to carry out standard calculations and other tasks, we need to be more precise.
Whenever you plan to use the contents of a field in a calculation, use the LIB attribute. For example, for monthly interest use LIB=monthly_interest
This will allow you to use library functions, such as CALL=calculate_repayments, and cuForms will know where to find the information it needs.
Fields marked [PD] will be treated as personal data when applying data retention rules (ie these fields will be deleted, while the rest of the form data is retained). Information relating to credit reference searches and ID and verification searches [marked PDS] are treated as sensitive personal data and redacted after 3 months (or as set in account admin).
Here is the current list of library field names:
Person fields
Address fields
Loan fields
Note: the optional fields loan_new_amount and loan_current_balance should be used where new borrowing is being added to existing borrowing, and combined to commence a new loan for the total amount. In this case all three fields must be present, and loan_amount (usually setup as a hidden field and therefore empty) will be set to loan_new_amount + loan_current_balance during execution of the calculate_repayments function.
API fields
Affordability fields
There are a number of library fields associated with the processing of automated tasks, and these are listed in the next section
CALL=automation_task
There are a number of standard automation tasks you can use in your workflows. Use the CALL attribute to trigger the automation task for a specific field (usually when the field changes to “Ready”). All the return values listed below must be set up as options in the workflow designer (though they can be set to VISIBLE=NEVER where you only want the automation task to be able to select them).
Required library fields must be identified in your form using LIB=field_name. Input library fields will be used by the automation task for its work, and output library fields will be used to store the results of the task.
The available automation tasks are described below:
CALL=affordability_assessment
CALL=calculate_repayments
CALL=credit_check
CALL=credit_check_dummy
CALL=credit_check_refer
CALL=focus_api_newmemberloan
CALL=focus_api_newmember
CALL=focus_api_newloan
CALL=id_check
CALL=id_check_refer
CALL=id_check_bank
CALL=id_check_bank_refer
CALL=set_rate
CALL=straight_thru_NI