Changes

Payment Scheduler

288 bytes added, 15:03, 20 December 2016
no edit summary
|This article will explain '''how''' you can implement this feature for use on your SmartSimple system.
|}
 
==Overview==
The Payment Scheduler enables the generation of multiple payments in batch simplifying the payment scheduling process. It allows the scheduling of '''[[Level 2 Entity|Level 2]] ''' payments from a '''[[Level 1 Entity|Level 1]] ''' based on a set of specified criteria (total amount, start date, end date, duration). Users can map specific criteria to Level 1 fields and enable the scheduler on certain Level 1 field types. The Payment Scheduler also allows mappings for specified Level 2 fields (L2 type, L2 status, payment amount, payment date, payment number, etc.). Based on the provided criteria an initial payment schedule is generated. '''Note:''' At this stage, the scheduler pre-populates the payment fields, however no records are created yet. New records are created on until the '''Save''' actionschedule is saved.
==How to Implement the Payment Scheduler=====Enable Payment Scheduler=on the Level 1==
# Select the desired '''[[UTA]]'''
# Click on the '''[[UTA Settings]]''' icon
# Under the '''[[Level 1 Entity|Level 1]]''', select '''Templates'''
# Click on the edit icon for the Level 1 template
# Add a check mark in the '''Enable Payment Scheduler (Beta)''' option box
[[Image:Enable_payment_scheduler_checkbox.png|200px|link:]]# Click the '''Save''' button
===Field Mapping===
# Select the desired UTA
# Click on the UTA '''Settings''' icon
# Under the [[Level 2 Entity|Level 2]] tab, click on the ''' "Payment Scheduler Mapping (Beta)"''' hyperlink
# Complete the form fields including Total Amount, Start Date, End Date, Activity Type, Activity Status, Payment Amount, Payment Date, and Other Fields.
# Click '''Save'''
[[Image:Payment_schedule_mappingEnable_payment_scheduler_checkbox.png|200px|link:]]<!--# Select the desired UTA# Click on the UTA '''Settings''' iconbr /># Under the L2 tab, Click on '''Payment Schedule Scheduler Mapping''' - Here you will map the criteria from the L1 fields (total amount, start date, end dateBeta), and the pre-populated L2 fields (L2 Provider Type, L2 Provider Status, Payment Amount, and Payment Date). These fields are required. -->'''Please note'''* Additional optional fields can be added through the '''Other Fields'option illustrated above'' field to the scheduler. These can include general L2 fields or fields under a mapped L2 type. * The following field types are allowed: single line text field, multi line text field, select one combo box, and auto number.
==Field Mapping==
=[[Image:Payment_schedule_mappings.png|link:]]<br /><br/>* Select the desired '''[[UTA]]'''* Click on the '''[[UTA Settings]]''' icon* Under the '''[[Level 2 Entity|Level 2]]''' tab, click on the ''' "Payment Scheduler Mapping (Beta)"''' hyperlink* Complete the form fields. For each of the following Level 1 Criteria fields below select the Level one field that will be mapped to the Payment Scheduler field.:* '''Total Amount''' - The total dollar amount that the scheduler will use to create the payments:* '''Start Date''' - The date of the first scheduled payment:* '''End Date''' - The last scheduled payment date:* '''Activity Type''' - The specified Level 2 type:* '''Activity Status''' - The status of the Level 2 type:* '''Payment Amount''' - The amount of the each scheduled payment:* '''Payment Date''' - The dates for each scheduled payment:* '''Other Fields''' - Optional Level 2 fields can be mapped using this lookup field. These can include general Level 2 fields or fields under a mapped Level 2 type. The following field types are allowed: single line text field, multi line text field, select one combo box, and auto number. Examples of Level 2 fields include: Level 2 type, Level 2 status, payment amount, payment date, payment number, etc.:* '''Enabled Request Templates''' - choose L1 templates against which Payments can be scheduled * Click '''Save''' ==Payment Scheduler page=Page==* Once the Payment Scheduler is enabled and a valid mapping is created, the Payment Scheduler link will appear in edit/view L1 Level 1 Provider page.* If the L1 Level 1 doesn't have any payment L2 Level 2 payments underneathit, the L1 Level 1 criteria fields with pre-populated values from mapping will appear. All criteria can be modified except for the total amount.* Once criteria is set, click on the '''Preview ''' button and the system will generate a list of payments. Please note this is created through javascript and just for preview purposepurposes, no actual records have been created in the system.
* For each record: the date is generated according to the criteria date period and frequency; the amount is divided evenly according to total amount and number of payments (except for last record which might contain a remainder); the type and status will be populated according to mapping; all additional fields will be displayed and can be modified, but will not be pre-populated.
* The displayed records can be deleted or you can add new ones updated before submission.* You can re-generate Update records by modify modifying the criteria and click clicking on '''Preview ''' button again.* Once everything looks good you can click on the '''Create Payment ''' button. This will generate actual L2 Level 2 records in the system and trigger workflow, template formula/status trigger etc.* If the L1 Level 1 has existing payment L2 Level 2 payments underneath, the L1 Level 1 criteria div will not be displayed. Only the ''total amount is '' will be visible.* You can edit the fields for existing L2 Level 2 payments, delete existing L2 Level 2 payments or add new ones on this page. * Click on the '''Create Payment ''' button to update/add payments. 
==Notes==
* If an existing L2 Level 2 payment is in a locked status, the row will be read only.* There is a validation that the sum of amounts on page should not exceeds the ''total amount''.* Allowed field typesinclude: ''single line text field, multi line text field, select one combo box, and auto number''.
* The scheduler will load the existing payments and add new payments or delete existing ones if the payments are not in locked status.
* Template formulas, workflows, status triggers will run for L2 Level 2 payments when they are edited through the scheduler.
 
==Also See==
 [[Category:Under ConstructionPayments]][[Category:Consumer/Provider]]
Smartstaff, administrator
4,478
edits