Application Parameters

Parameter

Description

Accruals Prior Year Period

(ACCRUAL_PY_APD)

The accounting period placed on the Prior Year (PY) accounting lines created by the Automated Accrual Process. The value should be equal to the latest APD where an encumbrance can be entered to avoid an accrual being recorded prior to the encumbrance it liquidated.

Application System Date

(APPL_SYS_DT)

This date is used most places of the application as the 'current date' when reliance on the system date found on the application server is not appropriate.  It can be set manually or with the Begin Day batch job.

Balance Sheet Account Integrity Check

(BSA_INTEG_CHK)

This parameter has two valid values of Detail and Summary.  It is used by a common routine that evaluates balance sheet account balances to see if an accounting document is going to take the account into a contrary balance.  More can be found about this topic in the ”Balance Sheet Account Balances” section.

Pool Cash Balance Tracking

(CBAL_POOL)

This parameter turns on and off application updates to the Cash Balance Pool table from the Cash Balance Summary table.  More can be found about this topic in the ”Application Parameters” section under Cash Balance Tracking and Control.

Validate Cached Balance Records (VLDT_CACHED_BAL_RCRDS)

This true/false parameter was implemented in association with logic inside of the Common Posting / Balance Table area.  For sites that do not choose to use the lower half of either the Cash or Fund Balance Detail Maintenance tables, then this parameter will not apply.  For those that use either or both, the recommended setting is true.

When the parameter is true, logic inside the Common Posting Routine will ensure a document updating a BSA Balance ITD record linked to either a record on Cash Balance Detail or a Fund Balance Detail Maintenance record, results in the Balance amount matching the Current Balance amount, respectively.  If not, an error with the code A4071 will be raised. 

Amounts between the two can differ for one of two reasons: the records are out of synch in the database, or while one person / batch job was validating/submitting a document, another was in process of changing the same records.  The approach to rectifying the problem is based upon which scenario exists. The user can re-validate or re-submit their document and this may cause the error to disappear because no other person or job is affecting the records at the time.  If it persists after several attempts to validate or submit the document, then the user should verify that the records are in synch with each other.

If they are not in synch then there are several approaches that may be desired. Contacting the CGI Advantage Help Desk to assist in working through the set of approaches is best.  The parameter should only be changed from true to false under very limited circumstances and for a very limited time.  When set temporarily to false, it is critical that no other document processing occur except the document that previously failed, as the cross-table edits will be disabled.  Other document processing at this time could cause more out of synch conditions.  Once the problem document has been submitted, the parameter must be changed back to true so that no further data integrity issues are experienced.

Maximum Document ID Length

(Maximum Document ID Length)

As document ID values can be system generated, this parameter exists to define a maximum length up to 20.  The length also controls a manually created document ID.  The length is a system-wide rule that must not be exceeded when defining lengths at the decentralized location - the Automatic Document Numbering table.

Minimum Document ID Length

(Minimum Document ID Length)

As document ID values can be system generated, this parameter exists to define a minimum length.  The length will also control a manually created document ID.  The length is a system-wide rule that must not be exceeded when defining lengths at the decentralized location - the Automatic Document Numbering table.

Real Time Journal Posting

(RLTM_JRNL_PSTG)

A true/false parameter that controls whether or not accounting documents post to various journals upon being submitted to final.  When set to false, journal posting occurs only when the Journal Posting Engine batch job is run.

OABR Running

(OABR_RUNNING)

A true/false parameter that must be set to True before running and False after running the Open Activity & Budget Roll chain job.  All VLS must be restarted after this value is changed (whether from false to true or true to false).  Please refer to the Open Activity and Budget Roll run sheet in the CGI Advantage Financial - General Accounting Run Sheets guide for more information about the use of the parameter.

OABR Source BFY

(OABR_SRC_BFY)

This parameter is used by the application during the Open Activity and Budget Roll chain job when access to the Parameters for Roll Process (RLPA) table cannot be accessed.  For proper execution of the Open Activity & Budget Roll chain job, the same BFY value entered as the Source BFY on the RLPA ID being used by the chain should be entered as the OABR Source BFY as well.  The value is used by the application when generating allotment lines.  Whether allotments are used or not, this parameter has to be completed.

Back Out Accounting Period

(BACKOUT_APD)

When the Open Activity Roll or Open Activity & Budget Roll chain jobs roll open accounting activity into a new budget year, this parameter supplies the accounting period used on the posting line that backs out activity in the old budget year.

Back Out Fiscal Year

(BACKOUT_FY)

When the Open Activity Roll or Open Activity & Budget Roll chain jobs roll open accounting activity into a new budget year, this parameter supplies the fiscal year used on the posting line that backs out activity in the old budget year. The value in this field must be entered in the CCYY format.

Earliest Year

(EARLIEST_YEAR)

A year specified that will be used to evaluate fiscal year values entered within the application.  Any year entered that is before this parameter will not be allowed.  The value in this field must be entered in the CCYY format.

Latest Year

(LATEST_YEAR)

A year specified that will be used to evaluate fiscal year values entered within the application.  Any year entered that is after this parameter will not be allowed.  Must be entered as CCYY.

Require TIN for Miscellaneous Vendors on 1099 Journal Updates

(REQ_TIN_1099_JRNL_UPD)

If the parameter value is blank, then applicable posting lines for miscellaneous vendors without a Taxpayer Identification Number (TIN) will be posted to the 1099 Journal.  If the value is True, then applicable posting lines for miscellaneous vendors without a TIN will not be posted to the 1099 Journal.

Require Vendor on 1099 Journal Updates

(REQ_VEND_1099_JRNL_UPD)

If the parameter value is blank, then applicable posting lines without a vendor/customer code will be posted to the 1099 Journal.  If the value is True, applicable posting lines without a vendor/code will not be posted to the 1099 Journal.

Default 1099 Report Flag

(DFLT_1099_RPT_FLAG)

If it is set to True the 1099 Reportable flag will default to checked while if it is set to False it will default to unchecked when new vendor records are created or modified in the following tables and documents:

• Vendor/Customer (VCUST) table

• 1099 Reporting Information (1099I) table

• Vendor Customer Creation (VCC) document types

• Vendor Customer Modification (VCM) document types

Extended or Standard Budget

(EXT_STD_BUD)

Controls whether or not budget structures should work as standard (STD) - establish appropriations to infer and limit COA combinations - or as extended (EXT) - no inference and no limits on combinations.  The parameter name for this control is EXT_STD_BUD.

Maximum Lines to Summarize

(Record Limit for Calculate Total Action)

When the Calculate Total link is selected on the Accounting Journal (or other page), the system compares the number of detail query result records being summarized to the value defined for this parameter.  If the number of lines being summarized exceeds the limit specified for this parameter then an error is issued.

Active Alert Interval

(ACTIVE_ALERT_INTERVAL)

This parameter defines the interval in minutes that is used to determine how often to trigger the Active Alert check.  The Active Alert Interval parameter represents the number of minutes that should elapse before an Active Alert check should look for new messages.  The value for this entry must be a positive integer.  More can be found on this topic in the ”Alerts” and ”Broadcasts” sections of the CGI Advantage Getting Started Guide.

Bypass Document Attachment Counts (BYPASS_DOC_ATT_CNTS)

This parameter can have a value of true or false.  When set to true the Object Attachment Count Functionality is not active for any documents application wide.  For additional information on the Attachment Count functionality, refer to the ”Using Attachments” section in the CGI Advantage Financial - Documents User Guide.

Bypass Document Attachment Counts List

(BYPASS_DOC_ATT_CNTS_LST)

This parameter can contain a comma separated list of document codes.  This parameter is only referenced when the Bypass Document Attachment Counts parameter is set to false.  When this parameter is referenced the Document Object Attachment Count Functionality is not active for the documents listed in the parameter value for the application in question.  For additional information on the Attachment Count functionality, refer to the ”Using Attachments” section in the CGI Advantage Financial - Documents User Guide.

Accounts Payable Period Fiscal Year

(ACCT_PAY_PD_FY)

If the PR/ABS liquidation posting lines associated with the accounting line has an AFY greater than BFY, then the AFY on the posting line will be derived from this parameter record.

Accounts Payable Period Accounting Period

(ACCT_PAY_PD_APD)

If a document code belonging to either the PR or ABS document type creates a liquidation posting line as part of  an accounting line requesting payment where the Fiscal Year (FY) greater than Budget Fiscal Year, then the Period (accounting period or APD) on the liquidation posting line will be set to the year of this parameter.

The parameter will likely get set once to 12 or 13 and be left as that value for all Fiscal Years.  It can be changed however.  Using this parameter is critical for the liquidation posting to the prior FY.

Automatic Payment Hold

(AUTOMATED_PAYMENT_HOLD)

Automatic Payment Hold Option: This parameter determines whether the Automated Payment Hold functionality or the user will update the User Hold flag on Disbursement Request (DISRQ) page when the disbursement document is cancelled with the Cancellation Type of Hold. Valid Values are True or False. If the flag is set to True, the Automated Payment Hold system wide edits will be used.  IF the flag is set to False, the Automated Payment Hold system wide edits will be bypassed.

Retain Discount From Cancelled Disbursement (RET_DISC_FROM_CANCELLED_DISB)

Retain Discount Terms on cancelled disbursement with Cancellation Type of Reschedule, Hold, or PR Cancellation. Valid values are True or False. If True, the Discount Terms will be retained and used on a re-issuance of disbursement. If False, the Discount Terms will not be retained on a re-issuance of a disbursement.

Retainage Forfeiture Option

(RET_FORF_OPT)

Retainage Forfeiture Option: This parameter provides the option to calculate the retainage forfeiture amount. Valid values are 1 or 2. Value 1 indicates that the FIFO baseline rules will be used to determine how retainage will be forfeited. Value 2 indicates that the rules on the Fund table will be used to determine how the retainage will be forfeited.

Suppress Rolled ALs from performing Liquidation Updates

(SPPRS_RLLD_LQDTN_UPD)

This parameter is read when a referencing accounting line has the event category of PR (Procurement) and that accounting line has been rolled by either the Open Activity Roll or Open Activity & Budget Roll process. The purpose is to suppress liquidation posting lines that will re-open a referenced accounting/posting line.  For example the rolling of a purchase order where a user is modifying an accounting line down that has a partial reference to requisition.  Although such liquidation postings often fail because of BFY Staging, use of this parameter will avoid that error by setting the posting amount of the liquidation posting line to $0 and not making any updates to the referenced commodity, accounting, or posting line.

If this parameter is set to true then liquidation updates are suppressed.  If this parameter is set to false then normal liquidation logic is performed. The delivered and default value for this parameter is false.  

Prevent Rolled Encumbrance Increase Edit

(PRVNT_RLD_ENC_INC_EDT)

This parameter is read when an accounting line has the event category of PR (Procurement) and that accounting line has been rolled by either the Open Activity Roll or Open Activity & Budget Roll process. The purpose is to control increases to lines rolled from one BFY to the next.

Valid values for this parameter are: 0 - increase edits are off, 1 – edits on for non-reference and memo reference, 2 – edits on for partial and final reference, and 3 - edits on for all increases whether referencing or not.  The default value for this parameter is 2.

Separate error messages are issued for non-referencing and memo referencing vs. a partial or final reference to allow for different severity settings.

Control

Description

A/R Reference Option

(AR_REF_OPT)

This parameter has three valid values: 1, 2, or 3. (if value is blank or not 1, 2, or 3, system will presume a value of 1).  Only document types of Cash Receipt (CR), Write Off (WO), Referral to Collection Agency (CL), Receivable (RE), Internal Transaction Initiator (ITI), Internal Transaction Agreement (ITA), and Internal Transaction Exchange (IET) read the option.  Additionally, these document types only read the option when there is a reference to a Accrued Receivable (ARE), RE, or CL document that is not a memo reference type.

With all options, the Fiscal Year (FY) for all posting lines will always be that of the referencing accounting line.  The Budget Fiscal Year (BFY) for the posting line from event type of the referencing accounting line will always be the one from the referencing line.  The BFY of the liquidation posting line can vary as described with each option below.

• If the Parameter Value is 1, the system will infer the BFY value from the referenced accounting line upon validate/submit actions.

That accounting line BFY will then be used on the liquidation posting line.

• If the Parameter Value is 2, the system will not infer the BFY value from the referenced accounting line upon validate/submit actions.  The BFY on the referencing accounting line will either be the BFY from the header of the referencing document or set to equal the FY of the referencing accounting line.  Users may, however, choose to enter a BFY if the defaulting value is not desired.  This allows the manual entry of an old BFY, for example in the first couple of days into a new BFY, or within any other scenario where the old BFY is desired.  However, in such cases, it is more likely that users will enter the old FY with accounting period 12 or an adjustment period, so that the BFY will then be set to that old FY.  

The BFY of the liquidation posting line will be the same as recorded initially on the referenced accounting line.

• If the Parameter Value is 3, the system will not infer the BFY value from the referenced accounting line upon validate/submit actions.  The BFY on the referencing accounting line will either be the BFY from the header of the referencing document or set to equal the FY of the referencing accounting line.  Users may, however, choose to enter a BFY if the defaulting value is not desired.  The Accounts Receivable Event Type Processor will then set the BFY on the liquidation posting line to equal the BFY (CURR_BFY)* from the referencing accounting line.  The standard posting line remains unchanged and is derived from the BFY (CURR_BFY) from the referencing accounting.  Note:  If the Parameter Value is 3, then it is assumed that the site using this option will not run the Open Activity Roll job for receivables as part of their annual processes because it will no longer be necessary to keep FY and BFY in sync.  

The BFY of the liquidation posting line will be the one from the referencing accounting line.

*CURR_BFY is an unseen field that will initially default to be the Default Fiscal Year field on the Calendar Date table for the Document Record Date.  If no Document Record Date is entered on the header, the Application Date is used.  If at any point a Fiscal Year is entered on a document header or accounting line, the CURR_BFY will become that value instead, unless a BFY is entered on the header or accounting line in which case the CURR_BFY will become that value.