Installation Options - Algorithms

The following table lists and describes the system events which are available in the Installation Options - Framework screen:
System Event Optional / Required Description
Account Information Optional

We use the term "Account information" to describe the basic information that appears throughout the system to describe an account. The data that appears in "account information" is constructed using this algorithm.

Plug an algorithm into this spot to override the system default "Account information".

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

Adjustment Information Optional

We use the term "Adjustment information" to describe the basic information that appears throughout the system to describe an adjustment. The data that appears in "Adjustment information" is constructed using this algorithm.

Plug an algorithm into this spot to override the system default "Adjustment information".

Note: This algorithm may be further overridden by an "Adjustment information" plug-in on the Adjustment Type. Refer to Adjustment Type for how algorithms of this type are used.

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

Automatic Payment Creation Required if you allow customers to pay automatically

This algorithm is executed to create automatic payments whenever the system creates automatic payments. Refer to How And When Are Automatic Payments Created for the details.

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

Bill Information Required

We use the term "Bill information" to describe the basic information that appears throughout the system to describe a bill. The data that appears in "bill information" is constructed using this algorithm.

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

Case Information Optional

We use the term "Case information" to describe the basic information that appears throughout the system to describe a case. The data that appears in "case information" is constructed using this algorithm.

Plug an algorithm into this spot to override the system default "Case information".

Note: This algorithm may be further overridden by a "Case information" plug-in on the Case Type. Refer to Case Type for how algorithms of this type are used.

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

Collection Agency Referral Information Optional

We use the term "Collection Agency Referral information" to describe the basic information that appears throughout the system to describe a collection agency referral.

Plug an algorithm into this spot to override the system default "collection agency referral information".

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

Collection Process Additional Information Optional

This algorithm displays additional information related to a collection process in a special field on the collection process main page.

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

Control Central Alert Optional

There are two types of alerts that appear on Payment Event - Main: 1) hard-coded system alerts and 2) alerts constructed by plug-in algorithms. You cannot change the hard-coded alerts. However, by plugging in this type of algorithm you can introduce additional alerts.

An error displays if more than 60 alerts are generated for an account by plug-in algorithms.

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

Credit Rating "Created By" Information Required

The data that appears in the credit rating "created by" information is constructed using this algorithm.

Refer to Account - C&C for more information about the credit rating.

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

Credit Rating History Information Optional

We use the term Credit Rating History information to describe the basic information that appears throughout the system to describe a credit rating history entry.

Plug an algorithm into this spot to override the system default "credit rating history information".

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

Determine Open Item Bill Amounts Required if you use overdue functionality to collect on bills

This algorithm is responsible for determining the unpaid amount of an open-item bill. It can also be used to return the unpaid amount for a specific contract on a bill.

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

Document Number Optional

If document numbers have been enabled on the installation record, this algorithm type assigns a document number to a bill or payment event.

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

Document Number Details Optional

If document numbers have been enabled on the installation record, this algorithm type is responsible for returning the details used to construct the document number.

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

Online Bill Display Optional

This algorithm constructs a PDF that contains the image of a bill. This algorithm is executed when the Display Bill button is clicked on the Bill page. Refer to Technical Implementation of Online Bill Image for more information.

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

Online Letter Image Optional

This algorithm constructs a PDF that contains the image of a letter. This algorithm is executed when the Display Letter button is pressed on Customer Contact - Main. Refer to Technical Implementation of Online Letter Image for more information.

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

Online Quote Image Optional

This algorithm constructs a PDF that contains the image of a quote. This algorithm is executed when the Display Quote button is pressed on Quote - Main. Refer to Technical Implementation of Online Quote Image for more information.

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

Online Statement Image Optional

This algorithm constructs a PDF that contains the image of a statement. This algorithm is executed when the Display Statement button is pressed on Statement - Main. Refer to Technical Implementation of Online Statement Image for more information.

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

Payment Amount Calculation Required

This algorithm is executed to calculate the amount of an automatic payment for a bill for an account with an active auto pay option. Refer to How And When Are Automatic Payments Created for more information on automatic payments. This algorithm is also executed to default the amount of a manually added payment. Refer to How To Add A New Payment Event for more information on adding a payment manually.

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

Payment Information Required

We use the term "payment information" to describe the basic information that appears throughout the system to describe a payment. The data that appears in "payment information" is constructed using this algorithm.

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

Person Information Required

In most parts of the system, a person's Main name is displayed to describe a person. However, several transactions do not use this method. Rather, these transactions call the algorithm that's plugged into this spot to construct the person's name. Refer to the description of the Alternate Representation flag on the Main tab for a list of these transactions and for the rationale behind this algorithm.

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

Person Name Validation Required

The format of names entered on Person - Main and Order - Main is validated using this algorithm.

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

Reporting Tool Optional

If your installation has integrated with a third party reporting tool, you may wish to allow your users to submit reports on-line using report submission or to review report history on-line. This algorithm is used by the two on-line reporting pages to properly invoke the reporting tool from within the system.

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

Contract Information Optional

We use the term "Contract information" to describe the basic information that appears throughout the system to describe a contract. The data that appears in "Contract information" is constructed using this algorithm.

Plug an algorithm into this spot to override the system default "Contract information".

Note: This algorithm may be further overridden by an "Contract information" plug-in on the Contract Type. Refer to Contract Type - Algorithms for how algorithms of this type are used.

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