End of Period [U04]: Overview

In This Document

• Introduction
• Module List
• Batch Jobs
• Dependencies
• Multiple Processes
• EOP Queue Priority
• Module Status Definitions
• End of Period Start [U0410]
• End of Period End [U0499]
  

In Related Documents

• Interactive Updates

  • Submit [U0401]
  • Status Review [U0402]
  • Status Listing [U0403]
  • Halt/Restart/Skip [U0404]
  • Restart [U0405]
  • Print/View Reports [U0406]
    
    
    

• Sequential Updates
  

  • Sequential Updates [U0411] - Introduction
    
    

  • Modules in Sequential Updates [U0411]
    
    (Pre-Defined Cycle)

    • Cycle Accruals [U0301]
    • Cycle Invoices [U0302]
      
      

    (Daily)

    • Assumed Payments [U0414]
    • Auto Apply Suspense for IBL [U0420]
    • Automatic Suspended Earnings [U0439]
    • Batch Payments [U0415]
      • Batch Payment Input File
      • Exception Messages
      • Batch Payment Exceptions Report
      • Batch Payment Audit Report
    • Collateral Tracking Initialization [U0432]
    • Credit Bureau Extract Metro 2 Format [U0462]
    • Insurance Risk Fee [U0428]
    • Insurance Tracking Initialization [U0421]
    • Maturing Lease Tracking Initialization [U0431]
    • Missing Auxiliary File Elements [U0445]
    • Preauthorized Payments [U0304]
    • Vendor Totals [U0441]
      
      

    (Monthly)

    • Automatic Charge Off [U0440]
      • General Ledger Transactions
      • Automated Charge Off Report
      • Automated Charge Off Deferral Report
      • Automated Charge Off Forecasting Report
      • Auto Charge Off Exceptions Report
    • Automatic Desecuritization [U0435]
    • Credit Bureau Extract Metro 2 Format [U0463]
    • Depreciation [U0443]
    • ITC Accrual [U0444]
    • Late Charges Calculation and Assessment [U0433]
    • Portfolio Status [U0442]
      
      

  • Sequential Updates Error Messages
    

  • Sequential Updates Post-Processor [U0412]

    • Sequential Updates Exceptions Report
    • Depreciation Accrual Report
    • ITC Accrual Report
    • Late Charges Audit Report
    
    

  • Sequential Updates Post-Merge [U0413]
    
    

• End of Day Updates

  • Automatic Lease Extension [U0430]
  • Batch Assessments [U0418]
  • Batch Escrow Disbursement [U0409]
  • Batch Payment Reversal [U0470]
  • Batch Payoff [U0427]
    
  • Cashier's Check Disbursal [U0117]
  • Closed Lease Clean-Up [U0419]
  • General Ledger Interface [U1003]
  • Insurance Status Update [U0421]
  • Investor Settlement [U0124]
    
  • Master General Ledger Reconciliation Report [U0460]
  • Notes Payable Accrual [U0905]
  • Suspense Review [R0203]
  • Vendor ACH [U0424]
  • Zero Daily General Ledger Accounts [U0422]
    
    
    

• End of Month Updates

  • Application/RAP Clean-Up [U0453]
  • Dealer Statement [U0426]
  • General Ledger Lessor Income [U0446]
  • Historical Payment/RTX Clean-Up [U0451]
    
  • Insurance Tracking [U1002]
  • Investor Income Participation [R0701]
  • Loan Accrual [U0455]
  • Suspended Earnings [R0609]
  • Use Tax Disbursal [U0449]
  • Vendor File Clean-Up [U0423]
    
  • Vendor Income Participation [R0801]
  • Vendor Payment Participation [R0805]
  • Vertex Interface [U0437]
  • Zero Monthly General Ledger Accounts [U0450]
    
    
    

• End of Year Updates

  • Clear Year-To-Date Fields [U0482]
  • Year-End File Build [U0481]
  • Zero Monthly General Ledger Accounts (EOY) [U0450]
    
    
    

• Non-Updating Reports
  

  • Introduction
    
    
  • End of Day Reports
    • Application Activity [R0501]
    • Daily Transaction Journal [R0405]
    • General Ledger Entries Listing [R0406]
    • Notes Transaction Journal [R1205]
    • Turnaround Timing [R0503]
      
      
  • End of Month Reports
    • Account Balances [R0103]
    • Accounts Payable Balancing [R0408]
    • Accounts Receivable Balancing [R0404]
    • Assessments Receivable Aging [R0607]
    • Book Gain/Loss [R0108]
    • Cash Receipts Journal [R0411]
    • Certificate of Ownership [R0903]
    • Delinquency [R0601]
    • Energy Tax Credit Listing [R0307]
    • Energy Tax Credit Review [R0308]
    • General Ledger Reconciliation [R0403]
    • Historical General Ledger [R0410]
    • Income Receivable Balancing [R0407]
    • Insurance Follow-up [R0904]
    • Investment Tax Credit Listing [R0302]
    • Investment Tax Credit Review [R0303]
    • Lease Inventory [R0902]
    • Monthly Application Summary [R0507]
    • Monthly Notes Transaction Journal [R1205]
    • Monthly Transaction Journal [U0456]
    • New Lease Earnings [R0101]
    • Off-Lease Inventory [R1001]
    • Operator's Status Review [R0202]
    • Paid Off Leases [R0912]
    • Portfolio Status [R0104]
    • Rental Income [R0409]
    • Salesperson Commission [R0204]
    • Tax Depreciation [R0304]
    • Taxable Income [R0301]
    • Trial Balance [R0901]
    • Vendor Delinquency [R0603]
      
      
  • End of Year Reports
    • Book Gain/Loss (EOY)
    • Energy Tax Credit Listing (EOY)
    • Energy Tax Credit Review (EOY)
    • Investment Tax Credit Listing (EOY)
    • Investment Tax Credit Review (EOY)
    • Tax Depreciation (EOY)
    • Taxable Income (EOY)

Introduction

EOP is a group of updates and reports, executed automatically in a batch (non-interactive) environment. EOP is executed separately for each portfolio. All interactive updating (i.e., data entry) for the portfolio is prohibited while EOP is processing.

A normal EOP process is composed of several steps:

1. EOP is submitted to a batch queue for later execution by a designated LeasePak operator at the close of the day, month and/or year, using the Submit update [U0401].
   
   
2. Data files and other applicable files are backed up by a system operator.
   
   
3. The administrator will usually have set EOP to begin processing after backups are completed. EOP automatically submits a batch job for each of the modules (updating/reporting) scheduled to perform. These batch jobs may be executed in parallel to better use the system’s resources.

   Note: Data file backups must be synchronized to be performed only when daily updating for all portfolios is complete.

Reports are created separately for each portfolio. Completion of the entire EOP process is not dependent on other portfolios (e.g., if one EOP terminates abnormally, others may complete successfully, assuming the same problem does not exist in other portfolios).

The elapsed execution time of all EOP processes for the entire database may decrease if each portfolio is assigned a separate EOP batch queue, thus allowing each portfolios to execute its EOP processes simultaneously.

Module List

This section summarizes the EOP modules. It may be used as a reference list of all EOP modules, or to determine the effects of skipping/restarting a specific module.

EOP modules in the following list are shown in order of execution. That is, the modules are executed in this order if EOP is executed sequentially. With sequential execution, only one module executes at a time. The previous module must complete before the next module may begin. If modules are executed in parallel, execution and completion of modules may change because certain modules may execute earlier if they are not dependent on any as yet uncompleted modules.

To summarize, when executing EOP sequentially, the priority is used to determine which module to execute next. When executing EOP in parallel, both the priority and module dependencies are used to determine which module(s) to execute next.

For each module, the following items are listed:

• NAME
  The name of the module (e.g., Use Tax Disbursal) is listed.

• NUMBER
  The number associated with the module (e.g., U0449 for Use Tax Disbursal) is displayed.

• GROUP
  The group to which the module belongs is displayed. The 5groups of EOP are Accrual (ACC), Invoicing (INV), End of Day (Day), End of Month (Month), and End of Year (Year). A value of "Any" is listed if the module is always executed if any group is executed (e.g., EOP Start and EOP End).

• UPD?
  An asterisk (*) is displayed if the module does file updating.

• EOP ONLY?
  A YES appears in this column if the module may only be executed through EOP.

• SKIP INSTRUCTIONS
  Special instructions on skipping the module are displayed. Refer to the individual EOP modules’ documentation for additional information on skipping a module.

EOP Module List (In order of Execution)

Batch Jobs

Each module of EOP (e.g., Accruals, Maintenance Report, Trial Balance, etc.) is its own batch job. Therefore, a large number of batch jobs is produced and queued to the specified EOP batch queue. For this reason, a batch queue separate from the system batch queue (SYS$BATCH) should be set up for each portfolio’s EOP process. This avoids clogging the system batch queue with EOP jobs.

Dependencies

There is a precise order in which each EOP module is executed. All General Ledger updating, for example, must be performed before the Daily Transaction Journal is created, so that the transaction journal for the day will be complete. This would seem to indicate that modules must be executed in sequence, each module waiting for the previous one to complete before starting. This may not be the case, however.

Several modules may be executed in parallel if they are not dependent on any other modules which are currently executing or are waiting to be executed. Executing in parallel means that several modules may execute at the same time, thereby more effectively using computer resources. Dependencies refer to relationships between modules. For example, a module is dependent on another module if it must use data that the other is generating or, conversely, if it must clear or delete data that the other is using. In the example in the previous paragraph, the Daily Transaction Journal is dependent on programs which update the General Ledger (e.g., Accrual update).

Dependencies define "parent-child" relationships between modules. Module 1 is a parent to module 2 if it must complete before module 2 may begin. Module 1 is not a parent to module 2 if it has no relationship or bearing on processing module 2. For example, the Accrual update [U0301] is a parent

to the Daily Transaction Journal [R0405], because the Accrual update may produce General Ledger transactions that must be reported on the Daily Transaction Journal. Module 2 is a "child" of module 1 if module 2 must wait for module 1 to complete before it may begin. Using the same example, the Daily Transaction Journal is a child of the Accrual update.

Parent-child relationships determine the modules which may be executed in parallel. Again using the above example, the Accrual update and the Maintenance report, which do not depend on each other, may execute at the same time, while the Daily Transaction Journal must wait for the Accrual update to complete before it may begin.

EOP determines the parent-child relationships between all modules and automatically determines which modules may execute and which modules must wait. For the modules which must wait, EOP automatically monitors them and starts them when their parents are complete.

Multiple Processes

In certain cases, it may be beneficial to split the processing of updates into multiple processes. That is, instead of executing an update once for the portfolio, it may be slated to execute several times, each time processing a different set of leases in the portfolio. These separate jobs may then execute in parallel, thereby more fully using the computer’s capabilities.The Sequential Updates Post Processor [U0412] and Sequential Updates Post Merge [U0413] then consolidate results of parallel processing.

Multiple process is available only for the Sequential update [U0411] of EOP. This update performs many varied tasks, and uses the bulk of the processing time required by EOP.

There are performance trade-offs when executing multiple processes rather than a single process. Analysis of the portfolio should be performed by an MSI representative before using this multiple processing capability of LeasePak.

EOP Queue Priority

LeasePak automatically adjusts the priority at which certain EOP modules are executed. The following modules are not adjusted; they run at whatever priority assigned them for the EOP queue:

• Accruals
• Invoices
• Batch payments
• Assumed payments
• Sequential updates
• Sequential updates post processing

Refer to the module list above for standard priorities. All other modules execute at the EOP queue priority for the first 3 to 6 CPU seconds and then have their priority lowered by 1 (if the EOP queue has a priority greater than 1). This allows the more critical EOP jobs to run faster.

If other low priority jobs are to be executed simultaneously with the EOP process, it may therefore be advisable to increase the EOP queue priority by 1.

Module Status Definitions

This section describes EOP module statuses in more detail. It may be used as a reference for any update or report which shows module statuses (e.g., the EOP Status Review report [U0402] or the Halt/Restart/Skip update [U0404]).

Each module of EOP has a current status associated with it. The status indicates that the module has completed successfully, is currently executing or waiting to execute, or has started executing and stopped without completing. The status assists in determining if the EOP process has completed successfully or if some intervention is required in order to allow it to complete.

EOP statuses are:

• HOLDING ON QUEUE - WAITING BACKUPS
  All modules are holding, generally waiting for backups to complete before beginning execution. Assigned when the Submit update [U0401] is used to submit the EOP process as a single batch job in a hold state. After backups are completed, the batch job is released from the queue by the system operator. This batch job then branches into multiple batch jobs, each executing an individual function of EOP (e.g., Cycle Accruals, Maintenance report, etc.). At this time, the module status changes to another status (e.g., PENDING INITIALIZATION, CURRENTLY IN PROGRESS, or PENDING COMPLETION OF PARENT MODULE).
  
  
• TIMED FOR LATER EXECUTION
  All modules are waiting until a specific time before beginning execution. Assigned when the Submit update [U0401] is used to submit the EOP process as a single batch job with an "after time." At the specified time, the batch job begins executing automatically. The batch job branches into multiple batch jobs, each executing an individual function of EOP (e.g., Cycle Accruals, Maintenance report, etc.). At this time, the module status changes.

• PENDING INITIALIZATION
  The module:
  
  
  • is just beginning to execute (that is, it is performing some initializations before starting), or
  • may be waiting for a slot in the batch queue.
    
    

  A module with this status has no parent for which it is waiting. It may begin executing as soon as it is finished with its initializations or as soon as there is room on the queue (e.g., if the batch queue has a job limit of 5 and 5 other EOP modules are currently executing, this module must wait for one to complete before it may begin).

• PENDING STARTUP OF QUEUE
  EOP batch queue is stopped. This may be done by a system operator or someone who has access to the operating system. All uncompleted EOP modules automatically begin executing when the queue is re-started.

• PENDING COMPLETION OF PARENT MODULE
  Module is waiting for another module to complete successfully. A parent module is defined as another module which updates the same files required by this module, and which must successfully finish before this module may start. Generally, reports do not have to wait for each other before starting. However, most reports must wait until certain updates are finished before beginning execution.

• CURRENTLY IN PROGRESS
  Module is currently executing.

• COMPLETED
  Module has successfully completed. Other dependent modules, which were waiting for the completion of this module, may now start.

• FAILED DUE TO ERROR
  The error file for this portfolio may be examined to determine the error. Also, a MAIL message is sent to the EOP supervisor indicating that an error has occurred and also detailing the error traceback.
  
  However, there may not be an error file entry for this error if the failure was due to a system or power failure.
  
  All dependent modules waiting for release of data files by this module which failed are postponed until specific action is taken on this failed module. The user may either restart the module or skip the module altogether for this EOP process.
  
  A restart recovers the data files for this module and then begins executing the module again. A skip does not recover the data files.
  
  A module should be skipped only after careful analysis of the impact of not completing a module. Refer to the Halt/Restart/Skip update [U0404] and individual EOP module documentation for more information about skipping a module.
  
  All modules must successfully complete or be skipped before updates are unlocked and data entry may resume for this portfolio.

• POSTPONED - PARENT MODULE FAILED
  Module is postponed until action is taken on its failed parent. Postponed modules no longer appear on the batch queue. A postponed module does not start execution because an update or report for which it was waiting failed. A postponed module may be skipped without requiring data recovery, since it did not start execution.
  
  Successful completion or skipping of a failed parent module does not automatically restart postponed modules. Once the parent module is restarted or skipped, postponed modules must also be restarted so that they may be returned to the queue in:
  
  
  • a pending state if any parent has yet to complete, or
  • a current state if all parent batch jobs are completed or skipped.
    
    
• HALTED BY SUPERVISOR
  A halted module no longer appears on the batch queue. Halting a module should be done only in an emergency (e.g., End of Month was submitted by mistake). The files are left unrecovered until restart is specified for the module. All dependent modules are also postponed and no longer appear on the batch queue. This action is similar to a FAILED DUE TO ERROR state, except the module is halted by the supervisor rather than due to power or program failure.

• POSTPONED - PARENT MODULE HALTED
  This state is similar to POSTPONED - PARENT MODULE FAILED, except that the parent module is halted by the supervisor. Refer to the POSTPONED - PARENT MODULE FAILED description for required action.

• SKIPPED - NOT TO RUN THIS EOP
  The scheduled module was skipped through the Halt/Restart/Skip update [U0404]. In case of a severe problem, a module may be skipped altogether for this EOP, but only after carefully analyzing the impact of skipping the module. Skipping one module does not automatically skip all modules dependent on the skipped module. If dependent modules should not be executed, then specifically skip those as well through the Halt/Restart/Skip update [U0404].

• SKIPPED - EOP SPLIT/UPDATES ONLY
  The High Volme module was selected to Split EOP and will only run updates at this time. All other modules will be skipped.

• SKIPPED -EOP SPLIT/REPORTS ONLY
  The High Volume module was selected to Split EOP and run Reports only at this time. All other modules will be skipped.

End of Period Start [U0410]

This module performs the following:

• Initializes information for multiple processes, if applicable.
• Stops all processes still found to be in updates prior to beginning End of Period Processing.
• Recovers all processes with outstanding updates for the portfolio(s) selected.

  Note: Only applicable when LOCK UPDATES ON EOP SUBMIT switch is set to N for the portfolio(s) selected.

• Submits a batch job to the End of Period batch queue for each module to be performed.

When End of Period is submitted by the LeasePak operator using the Submit update [U0401], a single job is placed on the End of Period batch queue. This batch job, when released, executes the End of Period Start module. The End of Period Start module queues all the other End of Period modules to the batch queue.

Skip Comments: This module should not be skipped unless all of the End of Period is also skipped.

End of Period End [U0499]

This module completes the End of Period process by:

• Setting the next execution dates for all EOP groups which executed during this End of Period.
  
  
• Unlocking updates to allow interactive data entry.
  
  
• Executing the Collection module initialization program if all of the following are true:
  
  
  • The Collection module is licensed.
    
  • The Collection module is not being skipped. Refer to the Module Customizations option of the Collection Custom General update [U1121] for more information.
    
    

  While the Collection initialization program is executing, additional portfolios may not be submitted for End of Period. The Collection initialization program adds newly delinquent lessees to the Collection module, removes lessees which are no longer delinquent from the Collection module, and reassigns delinquent lessees to new collectors, if applicable.

  Note: The Collection initialization program [U0498], is part of the End of Period End module [U0499]. This module does not create any reports or visible information regarding the updates made.

  Error messages are written to an exception file in the ERR directory. The file name has the following general format: EXEOP_Pnn_U0499.XPN. ‘Pnn’ refers to the portfolio number of the last portfolio to complete End of Period processing.

  If the Collection module is to be run during an End of Period, then the End of Day Sequential Updates module [U0411] should be executed for all portfolios. The Sequential Updates module [U0411] determines if individual leases are delinquent. This information is subsequently used by the Collection initialization program in determining which lessees are delinquent.

• Executing the capital cost allowance calculations for a tax entity if all of the following are true:
  
  
  • The Capital Cost Allowance module is licensed.
  • The Year-end File Build module [U0481] is not to be skipped for the default portfolio defined for the tax entity.

Refer to the CCA Accrual update [U1501] for more information.

Skip Comments: The End of Period End module [U0499] may be skipped only if End of Period Start [U0410] is skipped (that is, it may not be skipped by itself). If this module is skipped, updates are unlocked but the next execution dates are unchanged.

To skip execution of the Collection module after the Collection initialization program has already begun execution:

• Set the SKIP COLLECTION MODULE DURING END OF PERIOD (Y/ N) parameter to Y in the Module Customizations option of the Collection Custom General update [U1121].
• Use the Halt/Restart/Skip update [U0404] to halt and restart the End of Period End module for the portfolio which is executing the Collection initialization program.

© 2001 by McCue Systems Incorporated.
All rights reserved.

The information contained in this document is the property of McCue Systems, Inc. Use of the information contained herein is restricted. Conditions of use are subject to change without notice. McCue Systems, Inc. assumes no liability for any inaccuracy that may appear in this document; the contents of this document do not constitute a promise or warranty. The software described in this document is furnished under license and may be used or copied only in accordance with the terms of said license. Unauthorized use, alteration, or reproduction of this document without the written consent of McCue Systems, Inc. is prohibited.