PVI Documentation > Reference Manual Menu

PVI Reference Manual – Internal System Design

The CT Center Dialer interface software is proprietary intellectual property of Cubs Consulting, Inc. Source code is encrypted. Users have a limited license to use the software which is renewable for an annual fee. Notwithstanding the proprietary nature of the application, system administrators have a legitimate need to understand the nature of programs which are executing on their system. With that consideration in mind, the following information is made available.

· Programs

· Database Schema

· Control File Items

Programs:

PL-CCI Programs and Included Source Code Items:

Most of the interface programs reside in the PL-CCI file which was created in your “main” Cubs logon at installation time. Other Cubs logons point to the common program file. The program names and brief descriptions follow:

PV.BATCH.POST: Imports payment transaction batches from PV and enables the user to report or autopost them.

PV.CF.ENTRY: Contains the entire user interface for the XPV window.

PV.CIF.FILE.AUTO: Runs PV.CIF.FILE.SUB in automatic mode, with no user interface.

PV.CIF.FILE.MANUAL: Runs PV.CIF.FILE.SUB in manual mode, with a user interface.

PV.CIF.FILE.SUB: Builds the Customer Information File (CIF) for export to PaymentVision.

PV.DAYEND: Run nightly, sends notification letters and launches scheduled payments.

PV.ELAPSED.MINUTES: Sub-program used in managing session-ids to see how old they are.

PV.EQUATES: An included source code item which gives names to numerical database attributes.

PV.FUTURE.PYMT.QUERY: Program to prompt for parameters and generate future payment query data.

PV.GET.PKT.DNUMS.SUB: For PVI users who have chosen to show packet account numbers when future plans are set up, chooses which account numbers to show.

PV.IMPORT.FILES.AUTO: Runs PV.IMPORT.FILES.SUB in automatic mode, with no user interface.

PV.IMPORT.FILES.MANUAL: Runs PV.IMPORT.FILES.SUB in manual mode, with a user interface.

PV.IMPORT.FILES.SUB: Reads daily files from PaymentVision and produces reports.

PV.PAYAPI.SUB: Processes communications with cURL to PaymentVision and Lyons.

PV.PURGE: Run nightly to keep database clean.

PV.RENEW.LICENSE: Allows entry of new 15 digit code to extend software license.

PV.RESTORE.PLAN: Sub-program used to restore future payment plans which were incorrectly cancelled. Not part of generic application, but used in troubleshooting.

PV.SEND.EMAIL.SUB: Uses local host’s email service to send an email.

PV.SESSION.KEEPER: Loops every 10 seconds to keep Lyons session ID current.

PV.SESSION.KEEPER.STOP: Writes out instruction to PV.SESSION.KEEPER to tell it to break its loop and stop.

Software Installed, Not In PL-CCI:

CUBS-MENUS – PV: PaymentVision Menu data for the TCS menu processor.

PRIVLIB – CF.CMDX: New link to XPV window (PV.CF.ENTRY)

PRIVLIB – CFDAYEND-USER-BEGIN: PV.PURGE and PV.DAYEND programs are typically added to this proc.

VOC or MD – PV.POST: Called by PV.BATCH.POST to autopost transactions.

Special Treatment For jBASE / Windows:

In order for the arrow keys to be correctly interpreted after a programmatic call to cURL, the environment variable JBCNOTTYRESET must be unset. For some historical reason, lost to current memory, the standard TCS installation on a jBASE/Windows platform sets that variable to true. When we install the PVI on that platform, we add the following line to the x:\cubsadm\scripts folder, the cubs_global_custom.bat file:

set JBCNOTTYRESET=

Database Schema:

PV-BANK-NAME

To store results from requests to Lyons bank name service, making them available (while they are still “fresh”) from the Cubs database without needing to ask Lyons again.

Attribute	Name	Notes
Item-ID	ABA	9 digit bank routing number
1	BankName
2	LookupDate	The date that this information was last retrieved from Lyons bank name service.

PV-BATCH

There is one record for each PaymentVision validation batch.

Attribute	Name	Notes
Item-ID	Batch Id	PrimaryMCode * SequenceNumber * CreatedDate
1	UserDefinedName
2	Type	ACH or CC
3	CreatedTime
4	ImportedDate
5	ImportedTime
6	ImportedInitials
7	DebitCount	sum of all logons
8	DebitAmount	sum of all logons
9	Re-PresentCount	sum of all logons
10	Re-PresentAmount	sum of all logons
20	LogonName	MultiValued
21	Statuses	Printed, Posted, or File Written (Correlated to LogonName and subvalued)
22	StatusDates	Correlated to Statuses
23	StatusTimes	Correlated to Statuses
24	StatusInitials	Correlated to Statuses
25	DebitCount	Correlated to LogonName (multivalued)
26	DebitAmount	Correlated to LogonName (multivalued)
27	Re-PresentCount	Correlated to LogonName (multivalued)
28	Re-PresentAmount	Correlated to LogonName (multivalued)
40	Dnums	Correlated to LogonName and subvalued (sorted)
41	PayerName	Correlated to Dnums
42	PayDate	Correlated to Dnums
43	PayTotalAmount	Correlated to Dnums (includes fee amount)
44	PayFeeAmount	Correlated to Dnums
45	Capture Tracking Number	Correlated to Dnums

PV-CONTROL

See section on Control File Items, below.

PV-FUTURE-PYMT and PV-FUTURE-PYMT-CANCELLED

The PV-FUTURE-PYMT file is the logical equivalent of the Cubs PD-CHECKS file. It contains information about future payments to be processed through PaymentVision. The PV-FUTURE-PYMT-CANCELLED file has the exact same structure, but contains records which were automatically cancelled

Attribute	Name	Notes
Item-ID	Logon * Dnum
Attributes 1-19 are single valued, header type data for this future payment plan
1	Type of Payment	A = ACH or C = Credit Card
2	Payer Initial	A=Primary debtor 1; B=Primary Debtor 2; C=Alternate payer; D...=Extra payers... Z=FreeForm payer
3	Reference ID	From PaymentVision
4	Collector Review Date
5	Date Updated
6	Updated By	Cubs initials of the last person to update this item
7	Masked Account Info	Either the ABA # + the masked bank account number or the masked credit card number
8	Free Form Payer Name
9	Credit Card Expiration Date	Internal date of first day of the expiration month/year
10	Packet Dnums to Exclude	Multivalued
Attributes 20+ are multivalued, one value for each planned payment
20	Payment Dates	Multivalued
21	Amount of Payment	correlated
22	Amount of Fee	correlated
23	Letter Sent Date	correlated
24	Date Payment Posted	correlated
25	Capture Tracking Number	correlated
26	ExternalRequestID	correlated – only populated for communications failures, to allow transmission of the same transaction the next day.

PV-POST

A posting file for autoposting PaymentVision transactions.

PV-PYMT

There is one record for each immediate payment and for each future payment which was processed.

Attribute	Name	Notes
Item-ID	Capture Tracking Number	As transmitted by PayAPI, including 3 character prefix.
1	Logon
2	Dnum
3	Payment Date
4	Payment Time
5	Payment Amount	Total amount, including fee
6	Reference Id
7	PayType	ACH or CC
8	PayerName
9	Status	P=Pending; C=Confirmed; R=Returned
10	Return Code	Only populated if Attr 9 = R
11	Agent	Cubs collector initials
12	ImmediateOrPlanned
13	Fee Amount	Also included in the PaymentAmount

Control File Items:

The name of the control file is PV-CONTROL. Here is the schema of the items in this file.

LYONS-SESSION-HISTORY and PAYAPI-SESSION-HISTORY

Attribute	Name	Notes
Item-ID	LYONS-SESSION-HISTORY or PAYAPI-SESSION-HISTORY
1	Current Session-ID
2	Date Last Used
3	Time Last Used
4-9	Reserved for later use
10 - 200	Audit trail of history	Most recent history in attr 10.

NEXT-PAYAPI-REQUEST-SEQUENCE

Attribute	Name	Notes
Item-ID	NEXT-PAYAPI-REQUEST-SEQUENCE	Programatically, will range from 10,000 to 99,999. Once upper limit is reached, goes back down to lower limit and starts again.
1	Sequence Number

NEXT-PV-POST-SEQUENCE

Attribute	Name	Notes
Item-ID	NEXT-PV-POST-SEQUENCE	Programatically, will range from 100 to 999. Once upper limit is reached, goes back down to lower limit and starts again.
1	Sequence Number

PROCESS-PARAMETERS

Attribute	Name	Notes
Item-ID	PROCESS-PARAMETERS
Attributes 1-39 contain parameters for use across logons
1	Request folder path
2	Response folder path
3	Import folder path
4	Import archive folder path
5	Report folder path
6	Curl program command
7	Paths to add to execution path	Optional
8	PayAPI Logon
9	PayAPI Password
10	PayAPI API Key
11	PayAPI Token
12	Merchant Payee Code
13	PayAPI request and response – number of sequence numbers to retain.	Used by purge program to keep request and response folders pruned. Whatever number is here is subtracted from the next number to define the threshold value.
14	PV-FUTURE-PYMT purge days	How many days after the final payment to keep future payment plans in the database.
15	PV-PYMT purge days	How many days after each payment to keep the record in the PV-PYMT file.
16	Import purge days	How many days after file date to keep the files in the import archive folder
17	PayAPI URL	Either https://pvdemo.autoscribe.com/api/api.asmx or https://portal.paymentvision.com/api/api.asmx
18	Payment Types	“ACH”, “CC”, or “BOTH”
19	AVS Query Service	“Y” or “N”
20	Bank Lookup Service	“Y-999” or “N”. If Y, then 999 is the number of days for a bank name lookup to be considered “fresh”. If 999 is blank, there are not any fresh stored lookups.
21	TRANS file description location	x.y.z where x is the AMC, y is the VMC, and z is the SVMC
22	LyonsCompanyID	For Lyons Logon request
23	LyonsUsername	For Lyons Logon request
24	LyonsPassword	For Lyons Logon request
25	LyonsAVSUrl
26	LyonsBankLookupURL
27	PV-BATCH purge days
28	ValidateFinancialAccount Service	“Y” or “N”
29	Export folder path
Attributes 40-79 contain parameters for each logon, at the multivalue level
40	Cubs Logons	Multivalued
41	Cubs Logon Initial	correlated – used in building Customer Reference ID
42	CC Letter Name	LETTER-TEXT item-id to use for future credit card payment notification
43	ACH Letter Name	LETTER-TEXT item-id to use for future ACH payment notification
44	Advance Letter Days	How many days before future payment to launch notification letter
45	CC Payment Trans Code	Cubs trans code for credit card payment; default = 1
46	ACH Payment Trans Code	Cubs trans code for ACH payment; default = 1
47	CC New Status Code	To change D23 for new future CC payment plan. If empty, no new status code.
48	Fee Adj Trans Code	Cubs trans code for adding fee to balance due
49	Advance Letter Minimum Days	How many days before payment NOT to launch notification letter, because it won’t get there on time
50	ACH New Status Code	To change D23 for new future ACH payment plan. If empty, no new status code.
51	CC Auto-Cancelled Status Code	To change D23 for auto-cancelled future CC payment plan. If empty, no new status code. If “<PREVIOUS>”, use D69.1.
52	ACH Auto-Cancelled Status Code	To change D23 for auto-cancelled future ACH payment plan. If empty, no new status code. If “<PREVIOUS>”, use D69.1.
53	Unavailable Packet Dnums Status Codes	Sub-valued. Status codes for which to make packet members unavailable from being considered part of an open future payment plan.
54	Show Packet Members Screen	“Y” or “N”
55	Packet Dnums Sort Order	“J” – using order of PACKET file attr 19 (Default) “D” – using Dnum, to get oldest first “A” – using assigned date (D14) to get oldest first
Attributes 80-89 contain parameters for each extra payer setup, within each logon, at the subvalue level
80	Extra Payer (EP) Descriptions	correlated to logon (attribute 20 above) and subvalued allowing multiple extra payers per logon.
81	EP Initial	correlated – used in building Customer Reference ID. Values A, B, and C are already taken for primary debtors and alternate payer. EP initials start with D.
82	EP Name FAttr	correlated – FISCAL file attribute number Note: If the name is in 2 separate attributes (i.e. First and Last), use a pipe “|” delimiter with last name attribute first and first name attribute second.
83	EP Address FAttr	correlated
84	EP Address2 Fattr	correlated
85	EP City FAttr	correlated
86	EP State FAttr	correlated
87	EP Zip FAttr	correlated

Back Next

Copyright 2012, Cubs Consulting, Inc.