library_functions
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
library_functions [2016/06/02 08:00] geelling |
library_functions [2023/04/27 11:44] (current) andrewbreese |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| ====Workflow automation tasks==== | ====Workflow automation tasks==== | ||
| - | There are a number of standard automation tasks you can use in your workflows. Set the CALL=automation_task attribute in the [[special_treatment|special treatment]] box 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). | + | There are a number of workflow automation tasks you can use in your workflows. Set the CALL=workflow_automation_task attribute in the [[special_treatment|special treatment]] box 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 [[lib_fields|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. | Required [[lib_fields|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. | ||
| Line 19: | Line 19: | ||
| * Return values: Calculated | * Return values: Calculated | ||
| * Required input library fields: loan_amount,loan_term,loan_monthly_interest | * 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=calculate_repayments_reverse | ||
| + | * Summary: Calculates repayment values for the credit agreement to allow repayment amount to be set. CALL=calculate_repayments required before use | ||
| + | * Trigger value: Reverese Calculate | ||
| + | * Return values: Calculated | ||
| + | * Required input library fields: loan_amount,loan_term,loan_monthly_interest,repayment_amount | ||
| * Required output library fields: repayment_amount,total_repayable,interest_amount,loan_apr,repayment_amount,loan_interest_amount | * 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 | * Optional library fields: api_focus_system_interest (required if using FOCUS API),loan_new_amount,loan_current_balance | ||
| Line 63: | Line 72: | ||
| * Return values: Pass, Decline, Refer | * Return values: Pass, Decline, Refer | ||
| * Required library fields: person_last_name,person_title, person_first_names, person_dob, address_postcode, person_email | * 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, | + | * Optional library fields: update_id_check (set to Ready on Pass), abodeno, address_house_number, address_line1, address_line2, address_line3, locality, address_town, person_passport_line1, person_passport_line2, person_passport_expiry, person_driving_licence |
| * Other behaviour: sets cv_raw_result[PDS],cv_html_result[PDS] | * Other behaviour: sets cv_raw_result[PDS],cv_html_result[PDS] | ||
| Line 69: | Line 78: | ||
| * Summary: As for id_check, but saves Pass, Refer or Decline in hidden field cv_action, while returning Refer to workflow | * 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 | + | CALL=bank_check |
| * Summary: As for id_check, but also validates sort code and bank account number (requires CallValidate API) | * Summary: As for id_check, but also validates sort code and bank account number (requires CallValidate API) | ||
| * Trigger value: Ready | * Trigger value: Ready | ||
| * Return values: Pass, Decline, Refer | * Return values: Pass, Decline, Refer | ||
| - | * Required library fields: person_sort_code,person_account_number | + | * Required library fields: person_last_name,person_title, person_first_names, person_dob, address_postcode, person_bank_account_no, person_bank_sort_code |
| - | * Other behaviour: sets cv_raw_result[PDS],cv_html_result[PDS] | + | * Other behaviour: sets cb_raw_result[PDS],cb_html_result[PDS] |
| + | |||
| + | CALL=id_bank_check | ||
| + | * Summary: As for bank_check, but returns both cv_action and cb_action (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_bank_account_no, person_bank_sort_code | ||
| + | * Other behaviour: sets cb_raw_result[PDS],cb_html_result[PDS],sets cv_raw_result[PDS],cv_html_result[PDS] | ||
| - | CALL=id_check_bank_refer | + | CALL=bank_check_refer |
| - | * Summary: As for id_check_bank, but saves Pass, Refer or Decline in hidden field cv_action, while returning Refer to workflow | + | * Summary: As for id_check_bank, but saves Pass, Refer or Decline in hidden field cb_action, while returning Refer to workflow |
| CALL=set_rate | CALL=set_rate | ||
| Line 92: | Line 108: | ||
| * Required library fields: none | * Required library fields: none | ||
| * Optional library fields: update_straight_thru_NI (set to Ready on Pass) | * Optional library fields: update_straight_thru_NI (set to Ready on Pass) | ||
| + | |||
| + | CALL=lookup_match | ||
| + | * Summary: match values in the form against a lookup table (stored in a custom form) - optionally read values into the current form | ||
| + | * Format: CALL=lookup_match:article_id:LIB1,LIB2[:LIBA,LIBB] (eg CALL=lookup_match:123:person_nino,person_last_name (lookup only) or CALL=lookup_match:123:person_nino,person_last_name:person_member_id,person_member_type (lookup and read) | ||
| + | * Trigger value: Ready | ||
| + | * Return values: Pass, Fail | ||
| + | * Required library fields: as defined in function call | ||
| + | * Optional library fields: update_lookup_match (set to Ready on Pass) | ||
| + | |||
| + | CALL=lookup_nomatch (from v5.1) | ||
| + | * Identical to lookup_match, but returns Pass when NO match is found and Fail is a match is found | ||
| + | * Optional library fields: update_lookup_nomatch (set to Ready on Pass) | ||
| + | |||
| + | CALL=check_pdf | ||
| + | * Summary: check that a PDF file has been correctly created for credit agreements, etc | ||
| + | * Format: CALL=check_pdf:article_id (eg CALL=check_pdf:123 where 123 is the credit agreement PDF form template ID) | ||
| + | * Trigger value: Agreed | ||
| + | * Return values: PDF OK, PDF Failed | ||
| + | * Required library fields: none | ||
| + | * Optional library fields: none | ||
library_functions.1464847211.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
