LeasePak Utilities
The LeasePak utilities are options of the
program $uexe/lpautil.exe. You must have direct access to the LeasePak server, either as the LeasePak administrative
user (lpadmin) or as the MSI release administrator (msiadmin), in order to run this program. Many of
the utilities can severely corrupt LeasePak and its databases; consult your NetSol representative before running any of
them.
Terminal emulation: you must use one of the supported terminal types. Refer to System Requirements for more information.
Menu
To run the program and access the utilities, log on the LeasePak server, type $uexe/lpautil.exe, and press
Enter. The terminal will display the following:
0 Exit 108 Add user security record 109 Dump contents of linked-in maps 111 Copy the batch payment and PAP files into LeasePak 112 Unix and SQL Server password translation 200 Lock/unlock updates 207 DAS update 212 Change key utility (change port/comp/regn/offc) 213 Initialize multi-process lease ranges 214 Print EOP file dependencies 215 Set up EOP module 217 Auditing Extract update 218 Batch applications 219 Transfer data from scratch files into RBS table for BA 220 Historical RTX clean-up 221 DAVOX download 222 PTMS export 226 DAVOX upload 227 Create 'catch up' version of invoice scratch file 228 Cycle invoices 229 Batch payments 230 Batch payment reversal 231 Transfer data from GL_HIST scratch files to ASCII files 232 Master G/L Reconciliation report 233 Booked Applications Post-Processor 234 Custom Payoff Quotes update
235 AFM - Create asset level payment schedules 236 Batch IDC Adjustment Utility Your selection?
Type the number of your selection and press Enter.
Options
- 0 Exit
- Exits the
$uexe/lpautil.exeprogram. - 108 Add user security record
- Use this utility to set up the security record for the LeasePak administrative user only. You must acquire a special password from MSI in order to use this utility; refer to the LeasePak Administrative User section of the document LeasePak Server Configuration and Maintenance for more information or consult your NetSol representative.
- 109 Dump contents of linked-in maps
- This is an MSI product support tool used to examine the information contained in storage areas linked directly into the executable image of LeasePak. Use this utility only on the advice of your NetSol representative; improper use will corrupt LeasePak and its databases.
- 111 Copy the batch payment and PAP files into LeasePak
- Copies the Batch Payment and Pre-Authorized Payment (PAP) files into the LeasePak database. Use this utility only on the advice of your NetSol representative; improper use will corrupt LeasePak and its databases.
- 112 Unix and SQL Server password translation
- Translates a LeasePak client user's Client String into the corresponding encrypted server (OS) and DBMS passwords. For more information, refer to the Passwords section of the LeasePak Users document.
- 200 Lock/unlock updates
- Locks or unlocks updates on a specific portfolio. Consult your NetSol representative before using this update; unlocking a portfolio while End of Period is running will corrupt LeasePak and its databases.
- 207 DAS updates
- Initializes the internal LeasePak calendar. Use this only as part of the initial set up of a LeasePak database; improper use will corrupt LeasePak and its databases.
- 212 Change Key Utility (change port/comp/regn/offc)
- Normally you change the key (portfolio/company/region/office) for a single lease through the
Change Lease Key [U0114] update. Use utility 212 with an input
file to change the keys for a group of leases. Contact your NetSol representative for information and assistance;
improper use will corrupt LeasePak and its databases.
Batch Change Key (Lease Utility 212)
In addition to the interactive Change Lease Key (U0114), NetSol Technologies Inc. also offers a stand-alone batch change key program accessed through the lease utility 212. (Note: the Batch Change Key module that can be run as part of End of Period is part of Leasepak’s automatic de-securitization function and is not available for general change key use.) Effective use of the Batch Change Key utility requires purchase of Batch Payment Processing, an optional Leasepak module. The utility can be used without Batch Payments, but all payments made on or after the change key transfer date will need to be manually reversed and reapplied.
Change Key Input File Batch Change Key performs the Change Lease Key update based on input from a sequential text file (normal ASCII) created by the user. Each lease to be change keyed requires two lines of the file - in other words, the text file will always contain exactly twice as many lines as leases to be changed. The first line of each pair specifies the original lease key and lease number; the second specifies the new key:
1 1 1 1 12345
2 1 1 1
1 1 1 1 12346
2 1 1 1
In the above example, lease number 12345 is transferred from portfolio 1, company 1, region 1, office 1 to portfolio 2, company 1, region 1, office 1. Then the same action is performed on lease 12346. The breakdown of a line pair, including positions and spacing, is as follows:
(line one)
1 110 1 67890
aabbccdddeeeeeeeeee
a. portfolio - occupies 2 positions total, number right-aligned within space
b. company - 2 positions, right-aligned
c. region - 2 positions, right-aligned
d. office - 3 positions, right-aligned
e. lease - 10 positions, right-aligned
(line two)
2 110 1
aabbccddd
a. portfolio
b. company
c. region
d. office
Preparation for Running the Batch Change Key Utility
- Set up any needed destination keys using the U0212 Portfolio, U0208 Company, U0207 Region, and U0206 Office updates.
- If you are change keying between portfolios, use the U0212AS Portfolio/Assessments update to verify that the origination and destination portfolios have assessment setups identical for the following parameters (this can be a temporary change for just the duration of the change key process):
FIRST SCREEN (STATIC ASSESSMENTS) PARAMETERS
assessment is used Y/N
basis for accounting A/C
used for delinquency Y/N
SECOND SCREEN (RECURRING CHARGES) PARAMETERS
total number of recurring charges set up
recurring charge type (I/P/T/E etc.)
(The names of assessments do not need to match.) - Also if you are change keying between portfolios, use the U0212NL Portfolio/New Lease update to verify that the origination and destination portfolios have the same settings for the switches BOOK ITC ACCRUE (Y/N) and VENDR PARTICIPATES IN INCOME (Y/N) (again, these may be changed temporarily for the duration of the change key process).
- Build the change key input file and place it in the home directory of the user who will be running the batch change key utility.
- Use the U0301AC Cycle Accruals update to accrue all portfolios containing leases that are to be change keyed.
- List of suggested reports to run prior to the change key: U0403 General Ledger Reconciliation, U0404 Accounts Receivable Balancing, U0406, U0407, U0408, and U0901. Run reports for all portfolios involved in the change key.
- Have all users (except the one running the batch change key utility) log off Leasepak. Verify that no other processes are running.
- Perform a full backup of the database prior to the change key.
- After performing the batch change key, rerun the same set of accounting reports run prior to the change and verify that all leases have transferred properly.
The user running the utility should be at the DCL (shell) prompt and in their home directory.
Type lease /utilities (or lease /u) at the prompt to bring up the utilities menu, from which utility 212 may be selected:0 Exit
Alternately, type lease /u 212 at the prompt to bypass the menu and begin the utility:
108 Add user security record
(etc.)
This Utility option uses an input file to perform batch change key updates. This utility is used with electronic data conversions.
For more information contact MSI.
Do you wish to continue (Y/N)?
Enter Y to continue, N to exit from the utility.
EFF DATE OF CHANGE KEY: ACCRUED TO / COMMENCEMENT OR OTHER DATE
(A/C/O) ?
Select A to use each lease’s accrued to date as the transfer date for that lease. Select C to use each lease’s commencement date. If O is selected, the utility will prompt for a date:
ENTER THE EFFECTIVE DATE OF TRANSFER (YYMMDD)?
Enter the desired transfer date in YYMMDD format, without any punctuation.
WHAT IS THE NAME OF YOUR INPUT FILE?
Enter the name of the input file. The input file should be located in the home directory of the user running the utility.
ENTER THE BANK CODE USED TO REAPPLY THE REVERSED PAYMENTS?
If the Multiple Banks module is purchased, the utility will prompt for the bank code for the reapplication of payments. Enter the three-digit G/L cash account number to be used when payments are reapplied. If no number is entered, the utility will use the same bank code as when the payment was originally applied. The utility also uses the original number for any payment reversals. The batch change key process automatically creates a Batch Payments input file, 99_sctzpmt.dat (where 99 is replaced by the actual portfolio number), for the reapplication of any reversed payments.
Once processing is complete, the system will return the user to the DCL (shell) prompt. The utility writes an audit report for the change keyed leases (LPCHNG.RPT), and both an audit and exceptions report for batch payments performed during the process (LPCHNG_1.RPT and LPCHNG_2.RPT).
Error Messages
Lease is paid off
Paid off and terminated leases may not be change keyed. If appropriate, payoffs or terminations may be reversed and change keyed manually using the U0114 Change Lease Key update.
Lease payment due day is different from lease commencement date
Payment due day changes must be reversed prior to the change key using the U0118DR Payment Due Day Change Reversal update.
All payments made on/after transfer date must be reversed
Without purchase of the Batch Payment Processing module, all payment reversals and reapplications must be performed manually.
Assessment types on portfolios do not match
When a lease is to be changed to a different portfolio, the number of recurring charges used, as well as the switch settings on all assessments must match between the origination and destination portfolios. If appropriate, portfolio settings may be temporarily matched prior to the change key and then reset.
Cannot change portfolio for group+lease
Leases must be removed from billing groups prior to being changed to a different portfolio.
Change key does not exist
The destination key has not been set up. Use the U0212 Portfolio, U0208 Company, U0207 Region, and U0206 Office updates to add the needed key(s).
Change key either too long or too short
The line in the change key input file specifying the destination key does not contain the correct number of characters and/or spaces.
Dealer participation flags on portfolios do not match
When a lease is to be changed to a different portfolio, the “VENDR PARTICIPATES IN INCOME (Y/N)” switch setting on the origination and destination portfolios must match. If appropriate, this switch may be changed using the U0212NL Portfolio/New Lease update.
Effective date must not be after lease accrued to date
The effective date selected for the change key is beyond the lease’s accrued to date. The lease may be at maturity or in a non-accrual status.
Effective date must not be before lease commencement date
The lease has not yet commenced. If appropriate, the lease can be removed using the U0101RM Remove Lease update and then booked back into the destination key.
Error in accessing changed lease number
The program has encountered a problem accessing the lease record after the change key was performed. The lease should be examined for inconsistencies.
Error in accessing existing lease number
The program has encountered a problem accessing the lease record prior to the change key. It may be possible to change key the lease manually using the U0114 Change Lease Key update.
Error in reapplying the reversed payment (lau0415)
The program has encountered a problem reapplying reversed payments using the Batch Payment Processing module. It may be possible to reapply the payments manually using the U0102 Payments update.
Existing lease number not found
The program could not locate the lease number as read from the change key input file.
Input file not found
The change key input file should be placed in the home directory of the user running the batch change key utility, and the file name should be verified prior to initiating the program.
Invoice to be reversed has already been paid
Without purchase of the Batch Payment Processing module, all payment reversals and reapplications must be performed manually.
Invoice to be reversed has been partially paid
Without purchase of the Batch Payment Processing module, all payment reversals and reapplications must be performed manually.
ITC accrual flags on portfolios do not match
When a lease is to be changed to a different portfolio, the “BOOK ITC ACCRUE (Y/N)” switch setting on the origination and destination portfolios must match. If appropriate, this switch may be changed using the U0212NL Portfolio/New Lease update.
Key is either too long or too short
The line in the change key input file specifying the origination key and lease number does not contain the correct number of characters and/or spaces.
New lease number already exists
A record for the destination key + lease number, as read from the change key input file, already exists. Lease numbers are unique across all keys; the information from the change key input file should be verified.
No change to key for this input key
The second text line for the lease is missing from the change key input file.
No input key for this change to key
The first text line for the lease is missing from the change key input file.
Record is presently locked
Some other process, possibly an unrecovered process, is preventing access to the record. The change key may be attempted later, or a cleanup of processes and/or user journal files may be required.
Security record for end of period is not found
The security record for the “end of period” user cannot be located. The record may have been inadvertently deleted or improperly set up.
Successful transfer
The change key, including the reversal and reapplication of payments, has completed successfully.
These two keys are the same
The origination and destination keys, as read from the change key input file, are identical.
- 213 Initialize multi-process lease ranges
- If you have an End of Period multi-process count greater than 1, you can use this utility to determine the range of lease numbers to run with each process. Contact your NetSol representative for information and assistance with multi-process End of Period.
- 214 Print EOP file dependencies
- As a tool for MSI product support and development, this utility creates a report listing file I/O conflicts between End of Period modules.
- 215 Set up EOP module
- Updates the End of Period (rep) table for a specific portfolio to prepare it for running individually in debug mode. Improper use of this utility will corrupt LeasePak and its databases.
- 216 Auditing Extract update
- The Auditing Extract takes a subset of the Auditing information that pertains to non-financial changes made to leases and
their associated Clients and assets, reformats it for reporting, and records it to the
rzuMaintenance database table. You can then either run the Non-Monetary Archive Report [R0413] to view non-financial changes made to a particular lease, or you can create custom reports using therzutable as needed to view change information. Refer to Non-Monetary Archive Report [R0413] for more information on the report, Auditing, and the Auditing Extract update. - 218 Batch Applications
- Begins processing applications through the Batch Application update. For more information, refer to the document New Lease [U0101]: Batch Applications.
- 219 Transfer data from scratch files into RBS table for BA
- Transfers data from a scratch file into the RBS table for the specified portfolio for Batch Assessment
processing. For more information, refer to the
Batch Assessment [U0418] section of the
document End of Period [U04]: Daily Updates.
The user must select the portfolio, then the type of input file to generate:
- R - Regular import file
- A - ALI import file
- P - PTMS import file
- 220 Historical RTX Clean-up
- Cleans up the Historical Payment table (rtx). This utility deletes data from the table; contact your NetSol representative for more information.
- 221 DAVOX Download
- Creates a DAVOX download file; contact your NetSol representative for more information.
- 222 PTMS Export
- Prepares an export file for the Property Tax Management System (PTMS) software. The user must specify the
portfolio/company/region/office combination, file name, and start date. The file name format is PPCCRROOO.dat,
where PPCCRROOO is the P/C/R/O combination. Fields exported to the file are:
required fields table field(s) format length comments portfolio, company, region, office, lease ID rls por_s+com_s+reg_s+off_s+lse_s char 19 billing ID rls les_s char 9 asset ID req id_s char 25 original asset ID (if transferred, rewritten, inventoried) req asset_s char 10 original asset customer name ral nam_long_s char 25 truncate field from 125 chars customer city ral cty_s char 25 customer state ral st_s char 2 customer zip ral zip_s char 9 customer billing name ral short_cont_nam_s char 25 customer billing address ral rls rcu bill_add_s or add_s char 36 based on billing level flag (b_lvl_s) customer address bill_add2_s or add2_s char 36 same as above customer billing city bill_cty_s or cty_s char 25 same as above customer billing state bill_st_s or st_s char 2 same as above customer billing zip bill_zip_s or zip_s char 9 same as above lease start date rls d_com_s date 8 contract commencement date lease level equipment cost rls lsd_unit_d real asset purchase date req d_acq_s date asset tax basis req bk_basis_d real asset description req desc_s char 36 asset serial number req part_num_s char 25 asset residual req res_d real asset last used date req used_s date last used date asset tax sale date req d_disp_s date asset disposition date asset class req cls_s char 4 asset ppt switch (y/n) req rpt_ptax_s char 1 asset ppt exemption status req ptax_exampt_s char 4 asset address req eq_add_s char 36 asset city req eq_cty_s char 25 asset state req eq_st_s char 2 county req ct_s char 25 asset zip req eq_zip_s char 9 - 224 Cost Per Use Import File
- Cost Per Use: For users with the Cost Per Use module, use this utility to load meter charge assessment and reversal information into the RBM table for processing by the End of Period (Sequential Updates, Daily) module Batch Meter [U0448]. For more information, refer to the overview document Cost Per Use.
- 226 DAVOX Upload
- Processes a DAVOX upload file.
The program prompts for the following:
- Client string password
- DAVOX upload filename; the file must reside in the
datadirectory (/opt/msi/vNNa/env/environment/data)
For each record in the file, the program creates a new lease-level record in the
mjl(Lease Notebook) table. The following items are used in creating the notebook record:- The lease on the Davox upload record will be stored in the lease notebook record(mjl.app_lse_s).
- The date/time of the most recent call on the upload record, index 0 of the V21_RECORD's, result_table, fields: date/time, will be stored in the date/time entered of the lease notebook record(mjl.dt_ent_s).
- The status of the most recent call on the upload record, index 0 of the V21_RECORD's, result_table, field:
status, will be used to lookup the LeasePak collection status code(RCO table).
The collection status table will be used to determine other lease notebook field defaults.
Using the Davox code/LPUX collection status table mapping below, the process will read the RCO table.
If the Davox status does not have a corresponding LPUX collection status then the 'E' collection status will be used.
The following items will be used to populate the lease level notebook table:
- The lease level notebook record, follow-up date field, (mjl.dt_fol_s), will be calculated by taking today's date and adding the value stored in the rco.def_fol_mins_l.
- The lease level notebook record, note type field, (mjl.note_type_s), will be populated using the value stored in the rco.def_note_type_s.
- The lease level notebook record, collection status field, (mjl.col_stat_s), will be populated using the mapped collection status.
- The lease level notebook record, note title field, (mjl.note_title_s), will be populated using the description value in the RCC table of the collection status code.
- The date/status/time of the of the upload record, index 1-4 of the V21_RECORD's, result_table, fields: date, status/time, will be stored in the info1_s field of the lease notebook record (mjl.info1_s). Each of these fields will be tagged with appropriate labels for readability purposes.
- All of the Davox upload record phone numbers will also be stored in the info1_s field of the lease notebook record (mjl.info1_s). Each of these fields will be tagged with appropriate labels for readability purposes.
- The following fields on the lease notebook record will have the following defaults:
- mjl.prcs_s = 'N'
- mjl.prio_c = '4'
- mjl.to_s = 'DVX'
- mjl.from_s = 'DVX'
- mjl.info_s = NULL
- mjl.private_c = 'Y'
- mjl.lse_acc_s = 'D'
- ntbk_rsn_s = ''
- mjl.info2_s = NULL
- mjl.info3_s = NULL
- mjl.info4_s = NULL
Davox Code/LeasePak Collection Status Mapping DAVOX Code Description LeasePak Collection Status b Busy B f No Answer A g High and Dry A h No Dialtone B I AMD D2 j Rescheduled B k Called party hung up on hold B l Called party hung up on message D2 m Called party hung up on BK message D2 n Invalid Phone # 14 o All numbers invalid 14 p Dropped from hold message B q Modem/Fax A r AMD Detected-End D2 s AMD Detected-left message D2 t Dial faulted A Undefined Undefined status E This is the current layout of the Davox file upload record:
/*------------------------------------------------------! ! V271 UPLOAD RECORD ! !------------------------------------------------------*/ typedef struct _result_record { char date_s [6]; /* In MMDDYY format */ char username_s [8]; char code_s [2]; char time_s [4]; /* In HHMM format */ } RESULT_REC; typedef struct _v271_record { RESULT_REC result_table [5]; char portfolio_s [2]; char company_s [2]; char region_s [2]; char office_s [3]; char acct_num_s [10]; char cust_res_phone_s [14]; /* In AREACODE+PREFIX+SUFFIX+EXTENSION */ char cust_empl_phone_s[14]; /* In AREACODE+PREFIX+SUFFIX+EXTENSION */ char coby_res_phone_s [14]; /* In AREACODE+PREFIX+SUFFIX+EXTENSION */ char coby_empl_phone_s[14]; /* In AREACODE+PREFIX+SUFFIX+EXTENSION */ char comment1_s [75]; char comment2_s [75]; char important_note1_s[75]; char important_note2_s[75]; } V271_RECORD; - 227 Create 'catch up' version of invoice scratch file
- This utility enables users to generate an invoice scratch file for all deals booked with a commencement date prior to the
current date or booked since the last End of Day (End of Period) was run. For example, if today is the 5th and the user books a deal
with a commencement date of the 1st (and invoice deferral days are set at 0), the deal has missed the invoicing cycle for the 1st of
the month and, under normal circumstances, would not be picked up for invoicing until the next 1st of the month. With this utility
(run either interactively or as a
cronjob), users can generate invoice scratch files for these types of back-dated or interim deals. The utility uses the invoice deferral days settings to determine whether or not a lease or loan needs to be included in the 'catch up'. The scratch filelpu0302a.scris written to the current working directory of the process and not to the End of Period (EOP) directory. This is a separate but standardlpu0302a.scrscratch file; whatever invoice-generating process used for the EOP invoice scratch file should be used on this file as well.
The utility will prompt the user for the LeasePak client string password and whether or not to enter a specific date (in YYMMDD format). If the user does not enter a specific date, the utility will use the date of the last End of Day (EOP). - 228 Cycle invoices
- Similar to Cycle Invoices [U0302] (interactive/EOP). Documentation coming soon.
- 229 Batch payments
- Similar to Batch Payments [U0305] (interactive) and Batch Payments [U0415] (EOP). Documentation coming soon.
- 230 Batch payment reversal
- Similar to Batch Payment Reversal [U0306] (interactive) and Batch Payment Reversal [U0470] (EOP). Documentation coming soon.
- 231 Transfer data from GL_HIST scratch files to ASCII files
- With this utility, users can convert all
gl_hist.scrin a specified directory into correspondinggl_hist.rptASCII files, either using a fixed-width format or delimited by the pipe (|) symbol. The utility overwrites existinggl_hist.rptfiles. Each line of the file contains:
- Portfolio (2 characters)
- Company (2 characters)
- Region (2 characters)
- Office (2 characters)
- Lease (10 characters)
- G/L amounts--an array of 128 amounts, each formatted xxxxxxxxxxxx.xx (15 characters--for fixed-width or pipe-delimited, 0.00 becomes |0|)
The user can specify the location of the originalgl_hist.scrfiles, as well as whether to convert them to fixed-width or delimited ASCII files. The resultinggl_hist.rptfiles write to the user's home directory on the LeasePak server. - 232 Master G/L Reconciliation report
- Provides a way for users to run the Master General Ledger Reconciliation Report [U0460] outside of End of Period.
Below is an example of using this utility:
This utility option will run the U0460 - G/L Master Reconciliation report. NOTE: To ensure that the output of this report is created accurately, it is recommended that this report should be run within it's normal setting of EOP. However, if this report is designated to run in this mode, as an utility, certain tables must not be updated from post EOP processes. For example, the lease table (RLS) and/or asset table (REQ) must not be modified. Please consult with MSI for a more detailed list of tables that should not be modified. Do you wish to continue (Y/N)? Y Client Password? Enter in the portfolio, <RETURN> to exit> 2 The last EOP completion date/time is <Dec 12, 2006> <10:06am>. Do you want to enter in a new date/time (Y/N), <RETURN> to exit> N Generating the Master G/L Reconciliation report for: Portfolio : < 2> Using RTX's records starting from : <Dec 12, 2006> <10:06am>
The utility also accepts inputs from external file. In order to do so, users need to create an input file containing the list of applications and leases to process in the data directory. Save the file with the name p[n]_afmcnrvt.dat, where n is the portfolio number. After prompting the user for a portfolio number, the utility searches the data directory in the user's environment for the presence of a data file. If found, it prompts the user whether they would like use the data in it for processing.
The input file must contain the data to process in the following format:
<lease>Lease number
<lease>Lease number
<app>Application number
<app>Application number
Example:
<app>64
<app>65
<lease>67
<lease>68
It is important that the data must follow the recommended format to avoid errors. Keep the following points in mind when creating the input file.
- Although new line characters are supported, they are not necessary. The 235 utility skips any blank lines when reading the file.
- The
<app> and <lease> markers in the file are case sensitive and should be provided as demonstrated in the above example given. - Do not insert any extra spaces after or before the <app> and <lease> markers as they will result in an error.
- Enter valid application and lease numbers only. LeasePak verifies all entries in the input file to ensure the applications and leases listed are valid and belong to the portfolio specified by the user. The utility will skip any invalid entries and will report them in the exception report for the job.
- The order of <app> and <lease> entries may occur in any order in the file.
- The utility will skip any duplicate entries in the file.
Audit Report
LeasePak generates an audit report, lp_util_235.LOG for the job. The report provides information on the selected processing method and any exceptions encountered. The generated report is available in the home directory of the LeasePak user executing the job. LeasePak creates a report for every job and hence will overwrite any existing report in the directory.
LeasePak Documentation Suite
©
by NetSol Technologies Inc. All rights reserved.
The information contained in this document is the property of NetSol Technologies Inc. Use of the information contained herein is restricted. Conditions of use are subject to change without notice. NetSol Technologies 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 NetSol Technologies Inc. is prohibited.