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 MSI representative before running any of
them.
Terminal emulation: you must use one of the supported terminal types. Refer to the Terminal Emulation section of the document 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 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 MSI 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 MSI 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 MSI 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 document LeasePak Users.
- 200 Lock/unlock updates
- Locks or unlocks updates on a specific portfolio. Consult your MSI 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 MSI representative for information and assistance; improper use will corrupt LeasePak and its databases.
- 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 MSI 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 MSI representative for more information.
- 221 DAVOX Download
- Creates a DAVOX download file; contact your MSI 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]. To use the utility, create a batch input file
named
p*_btchcpu.dat(where * is the portfolio number) and place it in thedatadirectory of your LeasePak environment. Each line of the batch input file must contain the following three elements separated by commas:- Transaction type, either A for assessment or R for reversal
- Asset number or asset serial number, preceded by U if the asset number or S is the serial number (with no space between the U or S and the following number)
- Meter ID, preceded by M (with no space between the M and the following ID).
- Meter reading, preceded by V (for Value), with no space between the V and the following value (also, do not use commas or other punctuation in the meter value)
- Service credits, preceded by C, with no space between the C and the number of credits (also, do not use commas or other punctuation in the credit number)
- Meter period end date, format YYMMDD, preceded by E (for End date), with no space between the E and the number of credits
Example 1
A,U12245,M0001,V12500,E040115
This line assesses Asset 12245, Meter 0001 with a meter reading of 12,500 and a meter period end date of 01/15/04.
Example 2
A,SSER#124912-23133,M0002,V550000,C2300
This line assesses an asset with serial number SER#124912-23133, Meter 0002 with a meter reading of 550,000 and 2,300 service credits.
Example 3
R,SSER#124912-23133,M0002
This line reverses the most recent meter charge made to the asset with serial number SER#124912-23133.
Once the batch input file is successfully loaded, the Batch Meter module (if set to run) will process it during the next End of Period. - 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.
LeasePak Documentation Suite
©
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.