Skip to end of metadata
Go to start of metadata

For KSA, there are two broad categories of configuration options/settings:

  • System Wide. These settings are contained in the ksa.properties file and include parameters for the following:
    • Accounts
    • Cash Limits
    • Localization
    • Memos
    • Payment Billing
    • Refunds
    • Security
    • System
    • Transactions
  • System Based. These settings are contained in the SystemPreference objects and can be changed after runtime. They include the following:
    • 1098T
    • Fee Management
    • Payment Billing
    • Reporting and Reconciliation
    • Security
    • UI preferences
  • User Based. These setting are contained in the AccountPreferences class.

The following sections provide a list and description of the configuration parameters that control these settings, including the defaults.

System Wide Settings

<add a sentence or two that describes what system wide settings are>

These settings are located in the ksa.properties file under the following path:

<add path>/ksa.properties

Account Parameters

<add a sentence or two that describes what Account parameters are>

Configuration ParameterDescriptionDefault Value(s)

ksa.account.default.status.type

Default type for new accounts when they are created, unless altered by the creator.

This is the identifier as stored in  the AccountStatusType class, which is configurable. (Account in Good Standing, or similar).

ksa.account.default.credit.limit

When a new account is created, if no credit limit is specified during account creation, then the limit here will be used.

Amount, in the default system currency. (0, no credit limit.)

ksa.account.default.country

When a postal address is created, and no country is specified, then this value will be inserted. It will most often be the same value as the locale.country

Country code as stored in the PostalAddress class. (US)

ksa.account.default.telephone.country

When a telephone number is created with no country code listed, this is the default country code.

Country code as stored in the ElectronicContact class, for the international telephone code. (1)

ksa.account.default.account.type

Default type for accounts if they are created without an account type.

Undergraduate

Cash Limit Parameters

<add a sentence or two that describes what Cash Limit parameters are>

Configuration ParameterDescriptionDefault Value(s)

ksa.cash.tracking.system

If this is on, combined cash limit tracking is in force.

On or Off

ksa.cash.tracking.amount

If used, when the cash limit tracking is switched on, this will be the amount that is tracked.

Value in the system currency that will be tracked by the cash-limit tracking.

ksa.cash.tracking.days

If cash.tracking.system  is on, this is the number of days over which a cash limit is tracked.

Number of days over which cash-limits are tracked (365=year)

ksa.cash.tracking.tag

Cash transactions must have a tag to be considered as transactions to be tracked. This is the tag that is associated with those transactions.

The tag used for cash transactions to be tracked. “8300”

ksa.cash.tracking.notify

This is the email address to whom an email will be sent when the cash limit is hit by any person.Default email address.                                 

Cash Tracking Tag (8300) Parameters

These settings are specific to the Cash Tracking tag set as part of Cash Limits (above), which defaults to 8300.

Configuration ParameterDescriptionDefault Value(s)

ksa.8300.filer.name

Filer name on the 8300 Form.

Sigma University

ksa.8300.filer.address

Address line for the 8300 Form.

2305 S Colorado Blvd

ksa.8300.filer.city

City line for the 8300 form.

Denver

ksa.8300.filer.state

State code for the 8300 form.

CO

ksa.8300.filer.zip

Zip code for the 8300 form.

80222

ksa.8300.filer.fein

Federal identifier for the 8300 form.

55-5555555

ksa.8300.business.nature

Answer to the “nature of business” question on the 8300 form.

Higher Education

ksa.8300.default.type.of.transaction

Default answer to section 33 of the IRS8300 form. This will map to the ENUM in the XML for the 8300. If there is no match, it will be listed as “other” and this value will be inserted as the answer to question 34 of the form.

personalservice

ksa.8300.us.ssn.tax.type

The code for the tax type that represents a United States Social Security Number.

SSN

Localization Parameters

<add a sentence or two that describes what Localization parameters are>

Configuration ParameterDescriptionDefault Value(s)

ksa.locale

Defines the locale for the system. A number of other files are referenced through this setting, to permit more fine-grained internationalization of the system. If ksa_(locale).properties exists, it will be loaded, and all options contained in that file will override properties in this file. Also all UI strings are derived from ksa_langpack_(locale).xml. The format uses the ISO-639 language code in lowercase, followed by an underscore, followed by the ISO-3166 country code in capitals (en_US, fr_CA, es_SP, etc.).

en_US (US English)

ksa.default.locale.lang (*)

Defines the language of the system. Derivation of the language pack and other localized settings are taken with this field, coupled with locale.country. Locale language as defined in ISO-639, in lower case

en

ksa.locale.country

ISO-3166 code for the country of the locale, in uppercase.

US

ksa.locale.maxbytes

If the XLIFF file does not contain a maximum number of bytes for each string, this will be set as the default.        

50

Memo Parameters

<add a sentence or two that describes what Memo parameters are>

Configuration ParameterDescriptionDefault Value(s)
ksa.memo.default.levelexplicitly defining a level.2

Refund Parameters

<add a sentence or two that describes what Refund parameters are>

Configuration ParameterDescriptionDefault Value(s)

ksa.refund.account.system.name

When the system automatically performs an account refund (a refund that pays into another KSA account) this is the name that will be passed to the refund object to allow a CSR to see how a refund was executed.

“Automated KSA-to-KSA Refund System”

ksa.refund.account.type

When the system is doing an account refund, this is the type that is associated with it, stored in the RefundType class.

Pointer to RefundType for account refunds.

ksa.refund.check.system.name

When the system automatically a check refund, this is the name that will be passed to the refund object to allow a CSR to see how a refund was executed.

KSA Check Processor

ksa.refund.check.type

When the system is doing an check refund, this is the type that is associated with it, stored in the RefundType class.

Pointer to RefundType for check refunds.

ksa.refund.check.group

If more than one check refund is due on an account, all of the refunds will be rolled up into one single check.

True

ksa.refund.check.group.rollup

If check transactions are rolled up into a single refund, the individual refunds will still post to the account as single transactions. In this case, all will be give the rollup as identified here, which will make them show on initial inspection as a single entry.

Pointer to Rollup type.

ksa.default.refund.method (*)

The default method by which a refund is sent to the user.

cash

ksa.refund.payoff.type

This is the refund type for refunds that are going back to the student’s account as a credit.

Pointer to RefundType for payoff refunds.

ksa.refund.payoff.system.name

When the system automatically produces a payoff refund, this is the name of the system that will tell the CSR how the refund was executed.

KSA Direct Account Refund System

ksa.refund.ach.type

This is the refund type for refunds being returned to the user as an ACH refund.

Pointer to the RefundType for ACH refunds.

ksa.refund.ach.bank.type

This is the BankType pointer that contains the details needed for an ACH refund.

Pointer to BankType that contains ACH information.

ksa.refund.ach.system.name

When the system automatically produces an ACH refund, this is the name of the system that will tell the CSR how the refund was executed.

KSA ACH Processor

ksa.refund.ach.group

If more than one ACH refund is due on an account, all of the refunds will be rolled up into one single ACH transmission.

True

ksa.refund.ach.group.rollup

If ACH transactions are rolled up into a single refund, the individual refunds will still post to the account as single transactions. In this case, all will be give the rollup as identified here, which will make them show on initial inspection as a single entry.

Pointer to Rollup type.

ksa.refund.source.type

This is the refund type for refunds that are redirect to their source (PayPal, Credit Cards, etc.)

Pointer to RefundType for source refunds.

ksa.refund.source.system.name

When the system automatically produces a payoff refund, this is the name of the system that will tell the CSR how the refund was executed. 

KSA Source Refund.

System Parameters

<add a sentence or two that describes what System parameters are>

Configuration ParameterDescriptionDefault Value(s)

ksa.system.currency (Depricated)

All transactions are denominated in this currency. Even when the transaction is a foreign currency transaction, it must be converted to the default currency to be entered into KSA.

DEPRICATED. This is now derived through Locale.getDefault().gerCurrencyCode()

ksa.system.age.debt.method

This affects the way KSA calculates the aged debts. This is interpreted in the ageDebt() method.

balanceforward or openitem

Transaction Parameters

<add a sentence or two that describes what Transaction parameters are>

Configuration ParameterDescriptionDefault Value(s)

ksa.writeoff.rollup

The code for the rollup for a write-off transaction

WRITEOFF

ksa.contested.payment.type

The code for a transaction type that is a payment type, that is used when a contested deferment is issued.

CONTESTED

ksa.charge.cancellation.rule

If a transaction has a blank cancellation rule, this rule will be used in place of it. This way a school can decide what they will do to cancelled transactions that do not have a rule.

Any cancellation rule.

System-Based Settings

<add a sentence or two that describes what user based settings are>. These user-based configuration options are stored in the SystemPreferences objects and can be changed after runtime.

1098T

<add a sentence or two that describes what 1098T parameters are>

Configuration ParameterDescriptionDefault Value(s)

ksa.1098.filer.name

Filer name on the 1098T Form.

Sigma University

ksa.1098.filer.address1

Address line 1 for the 1098T Form.

2305 S Colorado Blvd

ksa.1098.filer.address2

Address line 2 for the 1098T Form.

<null>

ksa.1098.filer.address3

Address line 3 for the 1098T Form.

<null>

ksa.1098.filer.city

City line for the 1098T form.

Denver

ksa.1098.filer.state

State code for the 1098T form.

CO

ksa.1098.filer.zip

Zip code for the 1098T form.

80222

ksa.1098.filer.country

Country of the filer of the 1098T

USA

ksa.1098.filer.fein

Federal identifier for the 1098T form.

55-5555555

ksa.1098.reporting.method.change

Filing method for 1098 has changed since previous year.

False

ksa.1098.tag.amount.billed

The transaction tag for charges that will be reported in box 2 of the 1098T.

Billed1098

ksa.1098.tag.insurance.refund

The transaction tag for payments that will be reported on box 10 of the 1098T.

InsRef1098

ksa.1098.tag.grants

The transaction tag for payments that are reported in box 5 of the 1098T.

Scholarship1098

ksa.1098.us.ssn.tax.type

The code for the tax type that represents a United States Social Security Number.

SSN

ksa.1098.us.ssn.display.digits

Number of final digits of the SSN that are displayed on screen.

4

Fee Management Parameters

<add a sentence or two that describes what Fee Management parameters are>

Configuration ParameterDescriptionDefault Value(s)

ksa.fm.preclear.manifest

If this is true, then during the reconciliation process, KSA will remove any transactions that have a net- zero effect on the account.

 TRUE

Payment Billing

<add a sentence or two that describes what Payment Billing  parameters are>

Configuration ParameterDescriptionDefault Value(s)

ksa.payment.billing.memo

This is the memo string that will be created when a transaction is reversed in order to place it back on the account as part of payment billing.

Transaction netted off as part of payment billing.

ksa.payment.billing.statement.prefix

This is the statement prefix for the reversal transactions created through payment billing.

<blank>

ksa.payment.billing.rounding.problem.memo

This memo string is added to the student account if the rounding factor makes the payment billing plan impossible.

The payment billing plan could not be created using the default rounding factor. The rounding factor had to be ignored for this student.

ksa.payment.billing.reversal.statement.prefix

Prefix to statement text for all reversals on a payment billing transaction.  

<blank>

Reporting and Reconciliation Parameters

<add a sentence or two that describes what Reporting and Reconciliation parameters are>

Configuration ParameterDescriptionDefault Value(s)

ksa.default.general.ledger.type

If no general ledger type is passed with a transaction, then this is the default type that is used. Usually the default type will be the standard Student Accounts Receivable type. This will be established in the GeneralLedgerType setup.

Code for the default general ledger type, for example “SAR”

ksa.general.ledger.mode

Defines how the system will transmit its general ledger transactions. Individual is near real-time communication of individual transactions to the GL. Batch is a list of all transactions going to the GL in batch mode. BatchRollUp is rolled up values by account number, transmitted in batch mode.

Individual, Batch, BathRollUp

ksa.general.ledger.make.effective.information

String of text that is passed to the general ledger queue that is read by the user. This text indicates that a gl transaction occurred within the makeEffective() method.

Standard General Ledger Transaction.

ksa.general.ledger.account.validation

If this setting is set to off, then isGeneralLedgerAccountValid() will always return true. If it is on, then the system will attempt to validate the general ledger account. Note that as KFS does not permit real-time account number validation, KSA relies on a local copy of the account numbers in order to validate the account number. If a different general ledger system is used, this method could be overridden to permit the use of real-time account number validation.

Off

ksa.general.ledger.payment.application.information

String of text that is passed to the general ledger queue that is read by the user. This text indicates that a gl transaction occurred within the paymentApplication() method. (In reality, within the allocation methods.)

Standard Payment Application Transaction

kfs.send.detail

Are we going to send details of transactions with GL upload.On

kfs.balance.type.code

By default, we sent (TR)ansfer balance types to KFS.

TR
kfs.document.type.code

String used to indicate the type of document that KSA is sending to KFS. By default this is JV (journal voucher).

JV

kfs.document.number.prefix

Prefix for the document number that KSA sends to KFS. We send by default the transmission identifier for the document, prefixed with this string.

KSAJV

kfs.document.number.prefix.detail

Prefix for the document number that KSA sends to KFS in detail mode – this will be the prefix to the glTransaction identifier.KSAJV-D-
kfs.transaction.ledger.entry.descriptionString that is sent to the general ledger system to recognize the transaction.KSA General Ledger Transaction

kfs.default.coa

Default chart of accounts code to be sent to KFS. KSA will send the chart of account code with each transaction, if that information is available. If the numbering system does not make this number available, this will be the default number. This will also be transmitted in the KFS header.

01

kfs.organization.code

Organization code that will be transmitted to KFS in the batch headerKS

kfs.batch.sequence.prefix

The generated batch number from KSA will be prefixed with this before it is sent to KFS.KSA-

kfs.campus.code

Campus code for the KFS header.01

kfs.contact.email

The email address that is sent to KFS if there are queries.bursar@sigmauniversity.edu

kfs.phone.number

The telephone number that is sent with the KFS transaction file.888-BUR-SARS

kfs.mailing.address

Address that is passed to KFS in the header of a batch transmission.

1109 Lee Bldg.

kfs.department.name

Name of the department that is transmitted to KFS.

Bursar

kfs.origination.code

Defaults this to BR for Bursar.

BR

Security Parameters

<add a sentence or two that describes what Security parameters are>

Configuration ParameterDescriptionDefault Value(s)
ksa.security.masking.characterThe character that will be used to mask unwanted characters. See maskNumber()X

UI Parameters (Global)

<add a sentence or two that describes what UI parameters are>

Configuration ParameterDescriptionDefault Value(s)

ksa.ui.transaction.view.start.date

Default start date for the transaction view.

Null= start of account.

Null

ksa.ui.transaction.view.end.date

Default start date for the transaction view.

Null= start of account.

Null

ksa.ui.transaction.view.zero.balance

If this is yes, the transaction view will start at the first zero balance.

NO (/YES)

User-Based Settings

<add a sentence or two that describes what user based settings are>. These user-based configuration options are stored in the AccountPreferences class as simple key-value pairs. In some cases, users should be able to alter these values directly. For example, the could change their language preference or set a refund preference. In other cases, these values need to be set by the system or by another user such as a <define this acronym> (CSR).

Configuration ParameterDescriptionDefault Value(s)

ksa.refund.method

Stores the method by which a user prefers to receive their refund. In the absence of this setting, default.refund.method is used.

CHECK

 

ksa.override.refund.method

In certain cases, the preference of the account holder’s refund method (refund.method) will be overridden by a CSR. A common scenario for this is when the office decides that a certain student cannot have their refund mailed to them, they must come to the office to pick up the check.

NULL

 

ksa.locale.lang

The language that is used by the user interface. If this value is not set, then default.locale.lang will be used in its place.

en_US

 

 


  • No labels