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 [2016/06/26 10:57] 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 80: | Line 68: | ||
| [[lib_fields|View the list of library field names]] | [[lib_fields|View the list of library field names]] | ||
| - | There are a number of library fields associated with the processing of automated tasks, and these are listed in the section on [[library_functions|library functions]]. | + | **CALL=workflow_automation_task** |
| - | + | ||
| - | **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"). | + | |
| - | + | ||
| - | [[library_functions|View the list of library functions]] | + | |
| - | + | ||
| - | There are a number of library fields associated with the processing of automated tasks, and these are listed in the section on [[library_functions|library functions]]. | + | |
| - | 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 | + | |
| - | * 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 | + | |
| - | + | ||
| - | CALL=calculate_repayments | + | |
| - | * 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),loan_new_amount,loan_current_balance | + | |
| - | * 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=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 | + | |
| - | * Summary: As for credit_check, but saves Pass, Refer or Decline in hidden field cc_action, while returning Refer to workflow | + | |
| - | + | ||
| - | CALL=focus_api_newmemberloan | + | |
| - | * 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=focus_api_newmember | + | |
| - | * Summary: Calls FOCUS to create new member 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 | + | |
| - | * Required output library fields: none | + | |
| - | + | ||
| - | CALL=focus_api_newloan | + | |
| - | * Summary: Calls FOCUS to create new loan account for existing member | + | |
| - | * Trigger value: Ready | + | |
| - | * Return values: Completed, Error | + | |
| - | * Required input library fields: person_forenames, person_surname,person_member_id,loan_amount,repayment_amount,api_focus_system_interest,loan_first_repayment_date,loan_purpose | + | |
| - | * Required output library fields: none | + | |
| - | + | ||
| - | CALL=id_check | + | |
| - | * Summary: Retrieves an ID&V report for the application and returns key information (requires CallValidate API) | + | |
| - | * Trigger value: Ready | + | |
| - | * Return values: Pass, Decline, Refer | + | |
| - | * Required library fields: person_last_name,person_title, person_first_names, person_dob, address_postcode, person_email | + | |
| - | * Optional library fields: update_id_check (set to Ready on Pass), abodeno, address_house_number, address_line1, address_line2, address_line3, locality, address_town, | + | |
| - | * Other behaviour: sets cv_raw_result,cv_html_result | + | |
| - | + | ||
| - | CALL=id_check_refer | + | |
| - | * Summary: As for id_check, but saves Pass, Refer or Decline in hidden field cv_action, while returning Refer to workflow | + | |
| - | + | ||
| - | CALL=id_check_bank | + | |
| - | * Summary: As for id_check, but also validates sort code and bank account number (requires CallValidate API) | + | |
| - | * Trigger value: Ready | + | |
| - | * Return values: Pass, Decline, Refer | + | |
| - | * Required library fields: person_sort_code,person_account_number | + | |
| - | * Other behaviour: sets cv_raw_result,cv_html_result | + | |
| - | + | ||
| - | CALL=id_check_bank_refer | + | |
| - | * Summary: As for id_check_bank, but saves Pass, Refer or Decline in hidden field cv_action, while returning Refer to workflow | + | |
| + | 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"). | ||
| - | CALL=set_rate | + | [[library_functions|View the list of workflow automation tasks]] |
| - | * 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=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) | ||
special_treatment.1466931441.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
