special_treatment
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
special_treatment [2015/11/30 13:09] geelling |
special_treatment [2017/02/28 10:09] (current) geelling |
||
|---|---|---|---|
| Line 22: | Line 22: | ||
| 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 | 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 | TYPE=DATE expanded to allow all of the following | ||
| * TYPE=DATE:FUTURE - allow only future dates | * TYPE=DATE:FUTURE - allow only future dates | ||
| Line 41: | Line 40: | ||
| 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 | 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=form_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 is used to access functions such as lookups, and is normally attached to a button. |
| - | == JS=Javascript:SPLGetAddressData(document.getElementById('article_form_user_xx').value) == | + | [[form_functions|View the list of form functions]] |
| - | + | ||
| - | 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. | + | |
| - | + | ||
| - | * article_form_user_xx must identify the column containing the postcode | + | |
| - | * READONLY;LIB=address_line1 - address line 1 to be populated | + | |
| - | * READONLY;LIB=address_line2 - address line 2 to be populated | + | |
| - | * READONLY;LIB=address_line3 - address line 3 to be populated | + | |
| - | * READONLY;LIB=address_town - address town to be populated | + | |
| - | * READONLY;LIB=address_county - address county to be populated | + | |
| - | * READONLY;LIB=address_country - address country to be populated | + | |
| - | * READONLY;LIB=address_client - (optional) if using a multi-client setup, this can be used to lookup the client identified with the postcode | + | |
| **UPDATESOURCE** | **UPDATESOURCE** | ||
| Line 76: | Line 64: | ||
| This will allow you to use library functions, such as CALL=calculate_repayments, and cuForms will know where to find the information it needs. | This will allow you to use library functions, such as CALL=calculate_repayments, and cuForms will know where to find the information it needs. | ||
| - | Here is the current list of library field names: | + | 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). |
| - | + | ||
| - | Person fields | + | |
| - | * org_name – organisation name (text) | + | |
| - | * person_title – Mr, Mrs, etc (text) | + | |
| - | * person_first_names – the first name or names of a person (text) | + | |
| - | * person_last_name – the full name of a person (text) | + | |
| - | * person_email – the email address of a person (text in email format) | + | |
| - | * person_phone – the phone number of a person (text) | + | |
| - | * person_dob – the date of birth of a person (dd/mm/yyyy or yyyy-mm-dd) | + | |
| - | * person_nino - the national insurance number of a person (text) | + | |
| - | * person_member_id - the backoffice membership number of a person (text) | + | |
| - | + | ||
| - | Address fields | + | |
| - | * address_house_number - the number or name of a house (text) | + | |
| - | * address_line1 (text) | + | |
| - | * address_line2 (text) | + | |
| - | * address_line3 (text) | + | |
| - | * address_town (text) | + | |
| - | * address_county (text) | + | |
| - | * address_country (text) | + | |
| - | * address_postcode (text) | + | |
| - | * address_client - the credit union or other client matched to this address (text) | + | |
| - | + | ||
| - | Loan fields | + | |
| - | * loan_amount – amount of loan (whole number with or without leading £) | + | |
| - | * loan_term – loan term in months (whole number with or without training “month” or “months”) | + | |
| - | * loan_monthly_interest – monthly interest rate (decimal number with or without trailing %) | + | |
| - | * loan_apr - annual APR rounded to 1 decimal place with or without %) | + | |
| - | * loan_repayment_amount – repayment amount (decimal number with or without leading £) | + | |
| - | * loan_total_repayable – total repayable (decimal number with or without leading £) | + | |
| - | * loan_interest_amount - interest amount (decimal number with or without leading £) | + | |
| - | * loan_first_repayment_date - first repayment date (yyyy-mm-dd) | + | |
| - | * loan_purpose - (text) | + | |
| - | + | ||
| - | API fields | + | |
| - | * api_focus_system_interest – interest rate required for FOCUS API (decimal number) | + | |
| - | + | ||
| - | Affordability fields | + | |
| - | * afford_housing - housing type ('Rented', 'Mortgaged' or 'Owned outright') | + | |
| - | * afford_income_monthly - monthly income amount (decimal number with or without leading £) | + | |
| - | * afford_current_debt - total current debt (decimal number with or without leading £) | + | |
| - | * afford_debt_costs_monthly - current monthly repayments (decimal number with or without leading £) | + | |
| - | * afford_deps_older - number of people in household over 14 - including applicant (whole number - 1 or above) | + | |
| - | * afford_deps_younger - number of people in household under 14 (whole number or zero) | + | |
| - | * afford_monthly_expenses - calculated monthly expenses based on NSO data and including debt repayments (decimal number) | + | |
| - | * afford_monthly_income_net - calculated monthly disposable income (decimal number) | + | |
| - | * afford_new_debt_spend_pc_income_net - repayments on proposed loan as a % of disposable income (decimal number) | + | |
| - | * afford_debt_spend_pc_income - total debt repayments (including proposed loan) as a % of total monthly income (decimal number) | + | |
| - | * afford_debt_pc_income - total debt amount (including proposed loan) as a % of total annual income (decimal number) | + | |
| - | * | + | |
| - | + | ||
| - | 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=straight_thru_NI | + | |
| - | * Summary: **//currently only available as a dummy function returning Pass or Decline at random//**. Checks the application National Insurance Number against your backoffice system and returns key information if a match is found (requires backoffice API) | + | |
| - | * Trigger value: Ready | + | |
| - | * Return values: Pass, Decline, Refer | + | |
| - | * Required library fields: none | + | |
| - | * Optional library fields: update_straight_thru_NI (set to Ready on Pass) | + | |
| - | + | ||
| - | CALL=credit_check | + | |
| - | * Summary: Retrieves a credit score for the application and returns key information (requires CallCredit API) | + | |
| - | * Trigger value: Ready | + | |
| - | * Return values: Pass, Decline, Refer | + | |
| - | * Required library fields: person_last_name | + | |
| - | * Optional library fields: update_credit_check (set to Ready on Pass), person_title, person_first_names, person_dob, abodeno, address_house_number, address_line1, address_line2, address_line3, locality, address_town, address_postcode, person_email | + | |
| - | * Other behaviour: sets cc_raw_result,cc_html_result | + | |
| - | + | ||
| - | CALL=credit_check_dummy | + | |
| - | * Summary: As for credit_check, but returns Pass, Refer or Decline at random for testing purposes | + | |
| - | CALL=credit_check_refer | + | [[lib_fields|View the list of library field names]] |
| - | * Summary: As for credit_check, but saves Pass, Refer or Decline in hidden field cc_action, while returning Refer to workflow | + | |
| - | CALL=set_rate | + | **CALL=workflow_automation_task** |
| - | * Summary: **//currently only available as a dummy function returning a random rate value//**. Selects a monthly interest rate at random from those allowed in the form | + | |
| - | * Trigger value: Ready | + | |
| - | * Return values: x% (where rate existing as an option for the form) | + | |
| - | * Required input library fields: none | + | |
| - | * Optional library fields: update_set_rate (update to Ready if set) | + | |
| - | CALL=calculate_repayments | + | There are a number of workflow 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"). |
| - | * Summary: Calculates repayment values for the credit agreement | + | |
| - | * Trigger value: Ready | + | |
| - | * Return values: Calculated | + | |
| - | * Required input library fields: loan_amount,loan_term,loan_monthly_interest | + | |
| - | * Required output library fields: repayment_amount,total_repayable,interest_amount,loan_apr,repayment_amount,loan_interest_amount | + | |
| - | * Optional library fields: api_focus_system_interest (required if using FOCUS API) | + | |
| - | * Other behaviour: sets loan_repayment_amount,loan_total_repayable,loan_interest_amount,loan_months,loan_apr,loan_monthly_interest,short_loan_apr,loan_repayment_amount | + | |
| - | CALL=focus_api_newmemberloan | + | [[library_functions|View the list of workflow automation tasks]] |
| - | * Summary: Calls FOCUS to create new member and loan account | + | |
| - | * Trigger value: Ready | + | |
| - | * Return values: Completed, Error | + | |
| - | * Required input library fields: person_title,person_forenames, person_surname,person_email,person_phone,person_dob,person_nino,address_house_number,address_line1,address_postcode,address_country,loan_amount,repayment_amount,api_focus_system_interest,loan_first_repayment_date,loan_purpose | + | |
| - | * Required output library fields: none | + | |
| - | CALL=affordability_assessment | ||
| - | * Summary: Uses national data and income to rate affordability | ||
| - | * Trigger value: Ready | ||
| - | * Return values: Pass, Decline, Refer, Error | ||
| - | * Required input library fields: afford_housing, afford_income_monthly, afford_current_debt, afford_debt_costs_monthly, afford_deps_older, afford_deps_younger | ||
| - | * Required output library fields: afford_monthly_expenses, afford_monthly_income_net, afford_new_debt_spend_pc_income_net, afford_debt_spend_pc_income, afford_debt_pc_income | ||
special_treatment.1448885365.txt.gz · Last modified: 2017/02/20 16:49 (external edit)
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
