Obligation Type - Algorithms

Open Admin > Obligation Type and navigate to the Algorithm tab to define the algorithms that should be executed for obligations of a given type.

Description of Page

The grid contains Algorithms that control important functions in the system. You must define the following for each algorithm:

CAUTION:
Warning! These algorithms are typically significant processes. The absence of an algorithm may prevent the system from operating correctly.

The following table describes each System Event for which you can define algorithms.

System Event

Optional / Required

Description

Bill Completion

Optional

These algorithms are executed whenever a bill is completed for an account that contains a non-canceled obligation of this type.

Note. Algorithms of this type are called for all non-Canceled obligations, regardless of whether or not they are billed. If your algorithms should only be processed under certain conditions (for example, only process this algorithm for Active obligations), then it is the responsibility of the algorithm to check the conditions before continuing.

Click here to see the algorithm types available for this system event.

Break Pay Plan Obligation

Optional

These algorithms are executed when a pay plan is manually stopped via the pay plan maintenance page.

Click here to see the algorithm types available for this system event.

Cash Accounting True Up

Optional

This algorithm is responsible for making all necessary adjustments to the general ledger to transfer amounts from "holding" general ledger accounts to true payable accounts. It is executed when the Calculate P&I service has been called in Update mode, regardless of whether or not P&I is applicable for the obligation type. Refer to P&I and Cash Accounting for more information.

Click here to see the algorithm types available for this system event and for more information about the behavior of this plug-in spot.

Close / Reactivate Criteria

Optional

This algorithm is invoked from the common routine that performs closing / reactivation logic for an obligation. The common routine is invoked from the close action on the obligation maintenance page, when an account's obligations are monitored for overdue debt and whenever an FT is added, canceled or frozen for the obligation. It checks any additional conditions that are necessary to determine if an obligation of this type can be closed or reactivated. Only the first algorithm plugged in on this spot will be executed.

Click here to see the algorithm types available for this system event.

Determine Detailed Balance

Optional

This plug-in spot is responsible for breaking down an obligation's balance into balances by separate assessments and debt categories (for example: tax, penalty, interest, fees, etc). It is used in the base P&I Calculation plug-in and several other services that require the balance of an obligation to be broken down by assessment and debt category.

Click here to see the algorithm types available for this system event and for more information about the behavior of this plug-in spot.

FT Freeze

Optional

These algorithms are executed whenever a financial transaction is frozen that is linked to an obligation of this type.

Click here to see the algorithm types available for this system event.

Generate Obligations

Optional

This plug-in spot is responsible for generating Obligations of the associated Obligation Type for a Tax Role. It is invoked by the common service that generates obligations for a tax role. In addition to creating obligations for periods up to and including the current business date, algorithms plugged into this spot must indicate the date on which the next obligation of this type is due to be created for the tax role. Refer toTax Roles Can Maintain Obligations for more information.

Click here to see the algorithm types available for this system event and for more information about the behavior of this plug-in spot.

Obligation Activation

Optional

These algorithms are executed when an obligation status changes from Pending Start to Active. It performs any additional activities that are necessary to activate an obligation.

Click here to see the algorithm types available for this system event.

Obligation Cancel

Optional

These algorithms are executed when an obligation status changes to Canceled. It performs any additional activities that are necessary when an obligation is canceled.

Click here to see the algorithm types available for this system event.

Obligation Creation

Optional

These algorithms are executed when an obligation is created.

Click here to see the algorithm types available for this system event.

Obligation Information

Optional

We use the term "obligation information" to describe the basic information that appears throughout the system to describe an obligation. The data that appears in "obligation information" may be constructed using an algorithm plugged in here.

Refer to Defining Obligation Information for more information on when this algorithm is used.

Click here to see the algorithm types available for this system event.

Obligation Renewal

Optional

These algorithms are executed by the Obligation Renewal background process whenever an obligation is due for renewal or when the user clicks the Renew button. It performs any activities that are necessary to renew an obligation and returns the new renewal and expiration dates for the obligation.

Click here to see the algorithm types available for this system event.

Obligation Stop

Optional

These algorithms are executed whenever an obligation's status changes from pending stop to stopped.

Click here to see the algorithm types available for this system event.

Obligation Stop Initiation

Optional

These algorithms are executed whenever an obligation's status becomes pending stop.

Click here to see the algorithm types available for this system event.

P&I Calculation

Optional

This plug-in spot is responsible for calculating penalty and interest for the input obligation.

Click here to see the algorithm types available for this system event and for more information about the behavior of this plug-in spot.

P&I Eligibility

Optional

This plug-in spot is invoked by the base Calculate Penalty and Interest plug-in. It receives an obligation id as input and returns an indication of whether the obligation is eligible or ineligible for P&I. Refer to P&I Eligibility for more information.

Click here to see the algorithm types available for this system event and for more information about the behavior of this plug-in spot.

P&I Post Processing

Optional

This plug-in spot is invoked by the base P&I Calculation plug-in after all the penalty and interest calculations are finished. Algorithms plugged into this plug-in spot are responsible for additional logic performed at the end of the P&I process. Refer to P&I Post Processing for more information.

Click here to see the algorithm types available for this system event and for more information about the behavior of this plug-in spot.

P&I Pre-processing

Optional

This plug-in spot is invoked by the base P&I Calculation plug-in and is used to populate information needed during P&I calculations. Refer to P&I Pre-Processing for more information.

Click here to see the algorithm types available for this system event and for more information about the behavior of this plug-in spot.

P&I Prepare Periodic Balance

Optional

This plug-in spot is called from the Calculate Penalty and Interest plug-in spot for each date range being calculated. It is responsible for passing the appropriate FTs to the Determine Detailed Balance plug-in for the current date range.

Click here to see the algorithm types available for this system event and for more information about the behavior of this plug-in spot.

Payment Freeze

Optional

These algorithms are executed whenever a payment is frozen.

Click here to see the algorithm types available for this system event.

Process Pay Plan Scheduled Payment

Optional

These algorithms are executed by the Pay Plan Scheduled Payment Processing background process whenever a scheduled payment is due. If the pay plan obligation is unmonitored, this algorithm is not called. This algorithm should be specified on pay plan obligation types to create the necessary adjustments for the pay plan obligation.

Click here to see the algorithm types available for this system event.

Retrieve FT List

Optional

This plug-in spot is responsible for retrieving the existing FTs for an obligation. It obtains all the data for each FT that is needed for P&I Calculation logic and the Determine Detailed Balance logic. Refer to the Big Picture of Penalty and Interest for more information.

Click here to see the algorithm types available for this system event and for more information about the behavior of this plug-in spot.