ProtoBase User`s Guide

Transcription


ProtoBase
Administrator
Version 4.3.002
User Guide
Southern DataComm, Inc.
ProtoBase Administrator User Guide - Version 4.3.002
ProtoBase Administrator User Guide
COPYRIGHT
Copyright  2000 Southern DataComm, Incorporated. All rights reserved. No part
of this publication may be reproduced or distributed without the prior consent of
Southern DataComm, Incorporated, 10700 76th Court, Largo, Florida 33777.
DISCLAIMER
Southern DataComm, Incorporated provides this publication "as is" without warranty
of any kind, either express or implied. This publication could include technical
inaccuracies or typographical errors. Changes are periodically made to the
information herein; these changes will be incorporated in new editions of the
publication. Southern DataComm, Incorporated may make improvements and/or
changes in the products(s) and/or program(s) described in this publication at any
time.
TRADEMARKS
ProtoBase and SofTrans are registered trademarks of Southern DataComm,
Incorporated. All other brand and product names are trademarks or registered
trademarks of their respective companies.
RELATED DOCUMENTS
The following documents are related to this document:
ProtoBase User Guides
SofTrans Transaction Processor Guide
ProtoBase Technical Reference Guide
ProtoBase Integration Guide
PbAdmin Error Messages Addendum
Edition
Date
Version
First Release
08/2000
4.3.002
Proprietary & Confidential
08/2000
Table of Contents
I. Introduction...................................................................................................................... 1
Purpose.......................................................................................................................... 3
How to Use this Guide .................................................................................................. 4
Conventions ................................................................................................................... 6
Product Overview.............................................................................................................. 9
Administrator Setup and ProtoBase Configuration.................................................11
Settlement ....................................................................................................................12
Field Data Validation..................................................................................................13
Transaction Maintenance ...........................................................................................13
Database Maintenance ..............................................................................................14
Reporting......................................................................................................................14
Transaction History .....................................................................................................15
Troubleshooting and Help ..........................................................................................15
ProtoBase Administrator Front End (PBFE) ...........................................................16
II. PbAdmin Integration....................................................................................................18
ProtoBase Administrator Front End (PBFE) ...........................................................18
ProtoBase American Express Utility.....................................................................18
PBFE Functions ......................................................................................................19
Incremental Authorization .......................................................................................19
Authorization Reversal............................................................................................20
Validation of Data by PbAdmin.................................................................................21
Transaction Types (Valid for PbAdmin)....................................................................21
Table of Transaction Types....................................................................................21
Required Input Fields by Transaction Type ..........................................................25
Suggested Input Fields by Industry Type ..............................................................26
Output Fields................................................................................................................27
Input Fields...................................................................................................................29
Integrating PbAdmin for Specific Processing Situations........................................36
Incremental Authorization and Authorization Reversal........................................36
AVS ..........................................................................................................................38
Prior-Authorized Sale .............................................................................................38
Voids and Returns...................................................................................................38
Settlement ................................................................................................................39
Gateways .................................................................................................................40
Auto Close ...............................................................................................................40
Multiple Locations ...................................................................................................40
Real Time Transactions..........................................................................................40
Transaction Qualifier Field (115)...........................................................................40
Force Field (12) for Forced Authorizations ..........................................................41
User Defined Field (11)..........................................................................................41
Time Out Reversal...................................................................................................41
Printer Setup ............................................................................................................41
08/2000
Card Number Validations.......................................................................................42
Transaction Inquiry (Tran Type 22) ........................................................................42
How to Generate Reports Outside of PbAdmin.......................................................43
PBADREP, the PbAdmin Report Generator .......................................................43
How to Call the Report Generator (PBADREP) ..................................................44
How to Set up the Input File....................................................................................45
Table of Input File Fields ........................................................................................46
Output File that is Generated .................................................................................49
How to Use the Optional File Server Gateway.........................................................51
III. Installing PbAdmin ......................................................................................................55
Installation of PbAdmin for DOS/LAN, OS/2 ............................................................56
System Requirements (DOS/LAN, OS/2) ............................................................57
First Time Installation of PbAdmin (DOS/LAN, OS/2).........................................58
Upgrade of PbAdmin (DOS/LAN, OS/2)..............................................................60
Installation of PbAdmin for UNIX ................................................................................63
System Requirements ............................................................................................64
First-Time Installation of PbAdmin for UNIX .........................................................65
First-Time Installation of PbAdmin for UNIX (cont.) .............................................66
Upgrade of PbAdmin for UNIX ..............................................................................68
Setting Up PbAdmin.......................................................................................................72
Setup Screens/ Instructions........................................................................................73
Global INI File Screen.............................................................................................73
ProtoBase Administrator User Login Screen......................................................74
ProtoBase Administrator Locations Screen........................................................75
Location Information Screen..................................................................................76
User Security Screen..............................................................................................78
Reports Security Screen ........................................................................................80
Configuring ProtoBase...................................................................................................82
Automatic Configuration - Overview..........................................................................82
Manual Configuration - Overview...............................................................................82
Backing up the DB Directory .....................................................................................83
Automatic Configuration of ProtoBase.....................................................................83
How to Know if You Are Ready to Configure Automatically................................83
Steps to Automatically Configure ..........................................................................84
Activating the New Values (Run Configuration) ...................................................85
Manual Configuration of ProtoBase..........................................................................87
Processors...............................................................................................................90
Terminals..................................................................................................................93
Credit Card Tables .................................................................................................96
Devices ..................................................................................................................100
Run Configuration..................................................................................................102
Print Configuration ................................................................................................106
Running Test Transactions Using PBFE ....................................................................107
How to Run Test Transactions Using PBFE ..........................................................107
08/2000
IV. PbAdmin Technical Reference Guide...................................................................111
Global and Local INI File Screens ...........................................................................112
Location Information Screen....................................................................................116
User Security Screen................................................................................................124
Reports Security Screen ..........................................................................................127
Processor Edit Screen.............................................................................................130
Terminal Edit Screen................................................................................................134
Edit Credit Card Table Screen................................................................................136
Add/Edit Credit Cards Screen ............................................................................137
Device Edit Screen...................................................................................................142
Environment Settings Screen ..................................................................................148
Select/View/Edit Transactions Screen (Main Screen)..........................................149
Add Transaction [F3] – .........................................................................................152
Search for Transaction [F4]..................................................................................156
Transaction Detail [F6] .........................................................................................157
Select/Deselect Transactions [F8/F9] ................................................................159
Industry Detail Screens .........................................................................................161
PbAdmin Reports......................................................................................................177
Cashier (Server) Summary Report......................................................................178
Cashier (Server) Detail Report............................................................................180
Cashier Extended Detail Report - Retail............................................................182
Server Extended Detail Report - Restaurant......................................................184
Cashier Extended Detail Report -Lodging .........................................................186
Cashier Extended Detail Report - Rental Car....................................................188
Cashier Extended Detail Report - Direct Marketing .........................................190
Terminal Summary Report ...................................................................................192
Terminal Detail Report..........................................................................................194
Terminal Extended Detail Reports ......................................................................196
Deposit Status Report ..........................................................................................197
Authorization Date & Time Report ......................................................................198
Incremental Authorization Report.........................................................................199
Card Type Summary Report ................................................................................200
Card Type Detail Report ......................................................................................202
Merchant Key Summary Report...........................................................................204
Merchant Key Detail Report.................................................................................206
Server Tip Report (Restaurant Only) ...................................................................208
Administrator Configuration Report ....................................................................211
Transaction History Search......................................................................................213
Transaction Log.........................................................................................................215
Administrator Log......................................................................................................219
PbAdmin File and Program Descriptions ..............................................................220
V. How to Use PbAdmin...............................................................................................230
How to Start PbAdmin..............................................................................................231
User Log In Screen ...................................................................................................231
How to Exit PbAdmin................................................................................................233
Select/Edit Transactions ..........................................................................................234
08/2000
Select/View/Edit Transactions Screen (Main Screen)......................................235
Select Display Mode [Shift]+[F4].........................................................................236
Select/Deselect Transactions [F8] and [F9].......................................................238
View/Modify Transaction Detail [F6]...................................................................242
Toggle Status [Shift]+[F6].....................................................................................246
Add Transaction [F3] - Add New Detail Transaction Screen...........................247
Add Transaction [F3] - Add New Detail Transaction Screen (cont.) ...............248
Reports.......................................................................................................................249
How to Generate a Report ...................................................................................250
Report Descriptions ..............................................................................................252
Deposit Transactions (Settlement)..........................................................................257
When You Perform the Settlement ......................................................................258
Multi-Merchant Settlement....................................................................................259
When Settlement is Complete .............................................................................260
View Deposit Log (Settlement Log)........................................................................262
American Express Status Check ........................................................................263
Viewing the Deposit (Settlement) Log................................................................264
Transaction History Menu.........................................................................................265
Transaction History Search..................................................................................266
View History Transactions Screen......................................................................267
View Transaction Detail [F6]................................................................................271
Select/Deselect Transactions [F8] and [F9].......................................................273
Reverse and Copy to Main Database [F5].........................................................275
Copy to Main Database [Shift]+[F6]....................................................................276
Deposit Date and Time Report ...........................................................................277
Various History Reports .......................................................................................277
Database Management Menu .................................................................................278
Modify Transaction Status ....................................................................................279
Purge Old Authorizations......................................................................................281
Check Settlement Information..............................................................................282
Fix Settlement Information....................................................................................283
Rebuild Transaction Database............................................................................284
Purge Transaction Database...............................................................................286
Rebuild History File ...............................................................................................287
Purge History Files................................................................................................288
View Log ................................................................................................................289
Purge Log ..............................................................................................................292
VI. PbAdmin Troubleshooting ......................................................................................294
Issues to Consider Prior to Calling SDC Client Services.....................................294
Error Messages/Solutions........................................................................................304
Other PbAdmin Errors/Solutions .............................................................................309
08/2000
GLOSSARY
INDEX
08/2000
ProtoBase Administrator User Guide - Version 4.3.002 - Introduction

ProtoBase
Administrator
Version 4.3.002
User Guide
I. Introduction
08/2000
Introduction
The ProtoBase Administrator (also called “PbAdmin” or
“the Administrator”) is a screen-based, data base
application that stores approved transactions and, when
appropriate, automatically tracks compliance data during
electronic payment processing. It is an add-on product
and intermediate interface to ProtoBase, the SDC
communications utility that integrates into a point-of-sale
(POS) system. ProtoBase provides the link between the
third-party transaction processor and the merchant at the
point-of-sale (see Figure I-1).
NOTE:
For detailed information on how to use
ProtoBase, please refer to the ProtoBase
User Guide for your operating system.
Screen
Interface
Data
Base
Data
Base
SofTrans
Third-Party
Transaction
Processor
POS System
PbAdmin and
ProtoBase
SofTrans
SofTrans
Check
Processor
SofTrans
AMEX
Auth/
Settlement
Figure I - 1
08/2000
1
Introduction
(cont.)
PbAdmin provides detailed data validation before
transactions reach the third-party transaction processor. It
stores data for several transaction and payment types,
including credit cards, debit cards, and checks. It
supports Address Verification with each transaction, if
Address Verification is applicable to the particular
processor.
Transaction maintenance is easy using PbAdmin. This
system enables the merchant to edit or delete transactions
prior to settlement. The merchant can also choose which
transactions to settle by category. The categories include
terminal, date, cashier (server), and card type.
PbAdmin provides comprehensive reporting capabilities,
including detailed and summary industry reports with
various sorts. The Administrator also provides system
setup, configuration reports, and audit logs that can be
used for troubleshooting problems.
2
08/2000
Purpose
This document provides the necessary information to
successfully use the ProtoBase Administrator. It
describes field definitions and functions for each screen.
To set up the Administrator, we provide integration,
installation, and configuration information. Additionally,
this user guide shows industry-specific screens and report
examples.
We also provide troubleshooting techniques, including a
complete set of error messages for reference purposes.
POS System
PbAdmin w/
ProtoBase
Tape or diskette
drive
Installation
SofTrans
SofTrans
SofTrans
Laser printer
SofTrans
Modems
Integration
Configuration
PbAdmin
Reports
Screens
Troubleshooting
Solution!
PbAdmin
Reports
Figure I -2
08/2000
3
How to Use this
Guide
This section documents the various tabbed sections of
this user guide, giving a brief overview. It also details the
conventions of this user guide, describing how it was
designed to help you use the ProtoBase Administrator
effectively.
Introduction
•
Gives a brief overview of the ProtoBase Administrator
•
Explains the reason for this user guide
•
Summarizes the various sections and document
conventions
•
Describes the main attributes of the ProtoBase
Administrator system, including a general discussion
of the capabilities of PbAdmin
•
Describes PBFE, the PbAdmin front end program
•
Lists the transaction types and input/output fields
•
Explains how PbAdmin handles specific transaction
types and processing situations
•
How to determine minimum system requirements
•
How to install for the first time or as an upgrade
•
How to set the various environment variables
•
How to start and set up the basic information on
PbAdmin, including location and user security data
•
How to configure ProtoBase using the ProtoBase
Configuration group of screens
Integration
Installation and
Setup
Installation and
Setup Quick
Reference
4
Provides a summary of the steps to install and setup the
ProtoBase Administrator
08/2000
PbAdmin
Technical
Reference
How to Use
PbAdmin
Describes the technical information of PbAdmin,
including:
•
•
•
•
Description of every screen field
Report descriptions and samples
Transaction (PBFE) log
PbAdmin file and program descriptions
Describes how to perform the various day-to-day functions
of PbAdmin from the end-user point-of-view, including:
•
How to Select and Edit Transactions
•
How to Add Transactions
•
How to Search for a Transaction
•
How to Generate and View Reports
•
How to Deposit Transactions (How to Perform
Settlement)
•
How to View the Deposit Log
•
How to Search and View Transaction History
•
How to Perform Database Clean-up
Troubleshooting
Provides troubleshooting techniques, including a list of all
error messages and recommended solutions.
Glossary
Contains ProtoBase and payment service industry terms.
NOTE: At the end of this user guide, we provide
an index to give you an easy way to find
PbAdmin topics quickly.
08/2000
5
Conventions
This user guide employs many conventions to help you
use this product.
Important Points
Notes are identified by the word NOTE in bold type.
Important information follows this break in the flow of text.
A different font style is used for readability.
NOTE:
Operating
Systems and
Platforms
Please read all important points in this
guide. The information given will help
you avoid integration problems.
Operating system naming conventions vary. UNIX
filenames are case sensitive, but do not require the .EXE
extension for executables. DOS, OS/2 and Windows
NT/95 require the .EXE extension for executables, but are
not case sensitive. The requirements, conventions, and
instructions may vary for each operating system.
Executable programs for DOS, OS/2 and Windows NT/95
have one of the following extensions: EXE, COM, BAT,
CMD. For this guide, program names may or may not
include an extension. For example, PBFE.EXE or PBFE
refer to the same program.
NOTE:
File Names
Please be aware of your specific operating
system requirements. This guide does
not attempt to cover every possibility for
every operating system.
To enable readability:
For DOS, OS/2, and Windows, file names are capitalized
when referenced.
For UNIX, file names are displayed in their correct case.
If the operating system is not referenced, file names are
capitalized when referenced.
6
08/2000
Parameters
When the parameter is specified, the word indicating the
parameter is italicized and, if optional, placed in brackets.
Example:
PBFE -iInputFile [-oOutputFile]
Keystrokes
Keystrokes are in bold font and usually capitalized. The
keys are enclosed in brackets and combination key
strokes are divided by a plus sign (+).
Example:
press [ENTER]; press [CTRL]+[BREAK]
press [F2] to view a list of valid values
For UNIX systems, the [ESC] key has to be pressed
twice, due to the way the operating system interprets the
escape key.
Field Names
Data is passed between the POS software and
ProtoBase, PbAdmin, or it’s other utilities (or add-on
products) via files. The data information is in the format:
field number, data. The comma separates the field
number from the data.
When the fields are referenced by name, they are followed
by the word “field” and their associated field number, if
applicable.
Example:
Reference Number (field 007)
08/2000
7
ProtoBase
Transaction
Types
One of the fields passed to ProtoBase is the type of
transaction being performed. Transaction types include
the transaction name and a uniquely associated number
as shown in the following examples:
Authorization Only (01)
Prior-Authorized Sale (07)
Return (09)
Examples
Examples usually follow a line of text just like the example
below.
Terminal=TERM1
Steps of a
Process
Steps are numbered if there is more than one instruction
as shown below.
1. Select the Select/Edit Transactions option from
the Main Menu.
2. Use the arrow keys to move to the transaction you
want to select.
3. Press the space bar to mark the transaction as
selected.
Other
Documentation
Other User Guide references and tabbed section
references are bolded and italicized as shown in the
following example:
For detailed information on how to use
ProtoBase, please refer to the ProtoBase
User Guide for your operating system.
8
08/2000
Product
Overview
The ProtoBase Administrator is a text-based, electronic
payments database software interface. It is an add-on to
ProtoBase, the data communications utility created by
Southern DataComm, Inc. It contains settlement,
reporting, field data validation, transaction history, and
maintenance functions beyond what is provided in a
ProtoBase-only distribution.
You navigate various menus and screens using the arrow,
tab, enter, and function keys. You choose menu options
by selecting the highlighted letter of the option or using the
arrow and enter keys. Choice lists are available for fields
that have a specific set of values for entry.
NOTE:
Online help is available throughout
PbAdmin by pressing the [F1] key.
When you log in to PbAdmin, the Main Menu appears as
shown below:
Main Menu
The above menu shows the primary groups of screens
and functions contained in the ProtoBase Administrator.
08/2000
9
Product
Overview
(cont.)
This section summarizes the various features of PbAdmin,
separated into several categories. For each category, we
list the submenus (or any separate utility programs) you
would generally use from the Main Menu to access the
features listed.
The following categories are included in this overview:
•
•
•
•
•
•
•
•
•
10
Administrator setup and ProtoBase configuration
Settlement
Field data validation
Transaction maintenance
Database maintenance
Reporting
Transaction history
Troubleshooting and help
ProtoBase Administrator front end (PBFE)
08/2000
Administrator
Setup and
ProtoBase
Configuration
You can maintain merchant locations, users, ProtoBase
configuration, and general system attributes through
PbAdmin. The Administrator Setup Menu from the Main
Menu allows users to maintain this information.
Some of the PbAdmin features related to setup and
configuration are as follows:
•
Enables configuration of Global and Local INI File
Setup, Location, User Security, Printer Setup, and
ProtoBase (transaction processors, terminals,
payment types, and communication devices).
•
Supports multiple merchant locations in one
application (e.g., one location for hotel/front desk,
and one for hotel/restaurant).
•
For terminal capture processing, allows
authorization through one processor and settlement
through another.
•
Includes security with multiple user access levels.
Each user/login can be configured with different
access permissions. It supports master login
capabilities, allowing one or more users to monitor
activity at all locations.
•
Provides full access to ProtoBase configuration
using a screen interface. You configure ProtoBase
through easy-to-use screen prompts instead of
editing a text file.
•
Provides a modem pick list. Just pick your modem
brand from the list and PbAdmin automatically
supplies the initialization data. The user can
modify the default initialization data.
•
Enables viewing of environment settings to help
diagnose problems.
08/2000
11
Settlement
PbAdmin provides various functions related to the
settlement of transactions. The three primary settlementrelated options from the Main Menu are as follows:
•
•
•
Select/Edit Transactions
Deposit Transactions
View Deposit Log
Some of the PbAdmin features related to settlement are
as follows:
12
•
Enables inquiry and selection of transactions to be
settled.
•
Allows deletion of transactions prior to settlement.
•
Supports settlement for both terminal and host
capture processors; also supports real time
transactions.
•
For terminal capture processing, allows user to
choose which transactions to settle by terminal,
date, cashier (server), and card type.
•
Settles all transactions selected for deposit for all
processors.
•
Performs Incremental Authorizations (type 75) or
Authorization Reversals (type 76) as required
automatically.
•
Provides multi-merchant settlement capability, in
which multiple Terminal IDs can be identified and
settled in a single batch using a Settlement Group.
This feature is applicable to those transaction
processors that accept multi-merchant settlement.
08/2000
Field Data
Validation
PbAdmin provides validation of field data in the input file
that is passed to the POS system for processing
transactions. This validation occurs prior to sending the
data to the third-party transaction processor. This reduces
the amount of invalid data being passed to the processor
and stored in the database.
When a transaction is built and processed through
PbAdmin, it verifies the validity of each field and its
contents as found in the input file. If a discrepancy exists,
PbAdmin indicates the error and allows you to edit the
transaction prior to communicating with the processor.
The merchant benefits in that it does not get charged for
authorization transactions that contain errors; PbAdmin
catches these errors before they are sent.
Transaction
Maintenance
Through PbAdmin, you can view and maintain
transactions. To accomplish this, access the Select/Edit
Transactions option from the Main Menu.
Some of the PbAdmin features related to transaction
maintenance are as follows:
•
Add, modify, or delete individual or groups of
transactions.
•
Allow manual entry or modification of transactions.
08/2000
13
Database
Maintenance
Reporting
14
You can also view and purge history files and various logs.
To accomplish this, access the Database Management
option from the Main Menu. Some of the PbAdmin
features related to database maintenance are as follows:
•
Ability to select a group of transactions and move
them from history back to the main database
(working status) or from the main database to
history. This can be used to correct problems with
settlement.
•
Delete old authorizations that have expired.
•
Rebuild the entire transaction database. This
function is useful when the database may have
been corrupted.
•
Rebuild or delete history files as of a specific date.
These functions are useful when particular history
files may have been corrupted or memory
constraints require a purge.
•
View or delete PbAdmin logs. Deleting the logs
should be done periodically to free up space on
your hard disk.
PbAdmin provides various reporting capabilities. You can
produce and view the various reports through both the
Reports Menu option and the Transaction History option
from the Main Menu. Some of the PbAdmin reporting
features are as follows:
•
Generate, view, and print all available reports.
•
Choose from summary, detailed and extended
industry data on most reports.
•
Sort by cashier, terminal, card type, and merchant
key within each location.
•
Generate Deposit Status report for overview of
settled batches.
•
Report on authorization statistics.
08/2000
Transaction
History
You can inquire into transaction history for a specific
month through PbAdmin. To accomplish this, you can
access the Transaction History Menu option from the Main
Menu.
Some of the PbAdmin features related to transaction
history are as follows:
Troubleshooting
and Help
•
View and search for particular transactions in
history for chargeback research.
•
Generate history reports for a particular month,
including either all batches or a specific batch.
PbAdmin provides various troubleshooting and help
functions. These can be accessed using several menu
options and function keys.
Some of the troubleshooting and help features of
PbAdmin are as follows:
•
The function key [F1] for help. The [F1] key
provides brief descriptions and hints concerning
the field, menu option, error messages, or whatever
portion of a screen the cursor resides.
•
Detailed informational and error messages that
display at the bottom of the screen.
•
Setup information available under the Administrator
Setup option from the Main Menu.
•
System log information available from the View
Log screen under the Database Management
option from the Main Menu. Three log options are
available which record major activities: the
PbAdmin front end (Transaction), PbAdmin
(Administrator), and settlement (Settlement).
These logs can be used to troubleshoot certain
problems.
08/2000
15
ProtoBase
Administrator
Front End (PBFE)
The ProtoBase Administrator uses a front end module,
PBFE, which verifies that the fields being passed in the
input file to the POS system meet specific requirements in
field length and content. This depends on the particular
transaction type and industry being processed. This
greatly reduces the amount of invalid data being passed
to the transaction processor.
Your POS system must call PBFE, the ProtoBase
Administrator front end module. When your POS system
calls PBFE, it in turn calls ProtoBase. ProtoBase then
invokes PB, the transaction builder. PB parses and builds
the third-party transaction processor messages based on
the input file used to communicate between ProtoBase
and the transaction processor.
16
08/2000
ProtoBase Administrator User Guide - Version 4.3.002 – Integration
ProtoBase 
Administrator
Version 4.3.002
User Guide
II. Integration
08/2000
17
PbAdmin
Integration
This section provides the information you need to
successfully integrate the ProtoBase Administrator
(PbAdmin) into your POS system.
NOTE:
You must first integrate ProtoBase into
your POS system prior to integrating
PbAdmin. Please refer to the ProtoBase
Integration Guide for more information.
PbAdmin is a screen-based, data base application that
stores approved transactions and tracks compliance data.
It is an add-on product and intermediate interface to
ProtoBase, the SDC communications utility that integrates
into a point-of-sale (POS) system. ProtoBase provides
the link between the third-party transaction processor and
the merchant at the point-of-sale.
PbAdmin provides a simpler means of integration that
eases the burden of the POS system having to verify and
store much of the transaction data processed by their
merchants.
PbAdmin integration includes in-depth validation and error
checking of the following:
•
•
•
•
ProtoBase
Administrator
Front End (PBFE)
ProtoBase
American
Express Utility
18
Field lengths
Data types
Transaction types
Required fields
Your POS system must call PBFE, the ProtoBase
Administrator front end module. When your POS system
calls PBFE, it in turn calls ProtoBase. ProtoBase then
invokes PB, the transaction builder. PB parses and builds
the third-party transaction processor messages based on
the input file used to communicate between ProtoBase
and the transaction processor.
If you have also integrated the ProtoBase American
Express Utility, your POS system should route American
Express transactions through PBFE also.
08/2000
PBFE Functions
PBFE parses the transaction data to be stored in the
PbAdmin main database (see Figure II-1 on the next
page).
This program also verifies that the fields being passed in
the input file meet specific requirements in field length and
content. This depends on the particular transaction type
and industry being processed. This greatly reduces the
amount of invalid data being passed to the transaction
processor.
PBFE stores data for Authorizations, Voids, Sales, PriorAuthorized Sales, Returns, and real-time transactions. It
stores Address Verification Service (AVS) data for each
transaction and provides support for this if the third-party
transaction processor supports AVS. PBFE automatically
tracks and computes required CPS/PS2000 data.
Incremental
Authorization
The Incremental Authorization transaction enables
merchants to add to the total authorized amount. This may
be needed for compliance when the total authorized
amount is less than the Prior-Authorized Sale amount by
more than the industry-specific tolerance.
To handle this situation, PBFE can be integrated one of
two ways:
1. When a Prior-Authorized Sale is processed, PBFE
will check the total amount authorized. If the total
amount authorized is less than the Prior-Authorized
Sale amount by more than the industry-specific
tolerance, PBFE will return an error.
2. When a Prior-Authorized Sale is processed, PBFE
will check the total amount authorized. If the total
amount authorized is less than the Prior-Authorized
Sale amount by more than the industry-specific
tolerance, the system will automatically process an
Incremental Authorization for the difference.
08/2000
19
Authorization
Reversal
The Authorization Reversal transaction enables merchants
to reverse from the total authorized amount. This may be
needed to be in compliance when the total authorized
amount is greater than the Prior-Authorized Sale amount
by more than the industry-specific tolerance.
If the transaction processor supports an Authorization
Reversal, PbAdmin issues an Authorization Reversal
transaction at settlement time when the total amount
authorized is greater than the Prior-Authorized Sale by
more than the tolerance. It does the same for any
transactions that have been voided.
Integration Diagram - PbAdmin
Screen
Interface
Data
Base
Point-of-Sale System
Integrated with
PbAdmin and ProtoBase
ProtoBase with
SofTrans
PbAdmin
PB
PBFE
Third-Party
Transaction
Processor
Figure II -1
20
08/2000
Validation of Data
by PbAdmin
PbAdmin provides validation of field data in the input file
that is passed to the POS system for processing
transactions. This validation occurs prior to sending the
data to the third-party transaction processor. This reduces
the amount of invalid data being passed to the processor
and stored in the database.
PbAdmin uses the file VALID.DAT to verify the validity of
each field and its contents as found in the input file.
VALID.DAT contains a list of fields and their attributes that
are required for each transaction type.
When a transaction is built and processed through
PbAdmin, a data validation check is made against the
data for those fields and the transaction type as defined in
VALID.DAT. If a discrepancy exists, PbAdmin indicates
the fields in error and rejects the transaction. This enables
you to correct the error.
Transaction
Types (Valid for
PbAdmin)
The following table lists the transaction types and relevant
information for the transactions that are valid for PbAdmin.
Table of Transaction Types
Transaction
Type
Account
Authorization
Status
Stored in PbAdmin
database?
Can/Cannot be
Settled
(Deposited with
transaction
processor)?
Authorization
Only (1)
Authorizes card
account for the
amount specified
Transaction stored in
PbAdmin database or
added to existing
Authorization for the same
transaction
Cannot be settled
Sale (2)
Authorizes
account for the
amount specified
PbAdmin database as:
-Prior-Auth Sale (07) for
terminal capture
-Sale (02) for host capture
Can be settled
08/2000
21
Transaction
Type
Account
Authorization
Status
Stored in PbAdmin
database?
Can/Cannot be
Settled
(Deposited with
transaction
processor)?
PriorAuthorized
Sale (7)
Card must have
been previously
authorized however, if not
previously
authorized, may
authorize if
configured to do
so
Adds a sale that has
already been authorized
to the PbAdmin
database
Can be settled
Return (9)
No authorization
needed
Adds a return to the
PbAdmin database
Can be settled
Void Sale (11)
Voids a sale
transaction that
has not been
previously
settled
Changes the status of a
sale or prior-authorized
sale transaction in the
PbAdmin database to
VOIDED
Usually not
settled, but may
be included in
batch upload
depending on
processor
Void Return
(17)
No authorization
needed
Changes the status of a
credit card return
transaction in the
PbAdmin database to
VOIDED
Cannot be
settled
22
08/2000
Transaction
Type
Account
Authorization
Status
Stored in PbAdmin
database?
Can/Cannot be
Settled
(Deposited with
transaction
processor)?
Check
Authorization
(20); or Sale
(02) with
Transaction
Qualifier (field
115) equal to
020
Check verification
or guarantee
performed to
determine risk of
customer
PbAdmin database for
reporting purposes
Cannot be
settled; moved to
history
automatically
Transaction
Inquiry (22)
No authorization
needed
Not stored in database;
appears in Transaction
Log only
Cannot be
settled
Incremental
Authorization1
(75)
Performs
authorization on
a previously
authorized card
account for an
additional
amount
PbAdmin database;
reflected in the total
authorized amount
Cannot be
settled
Authorization
Reversal 2 (76)
Performs
reversal on
previous card
account
authorization for
a specific
amount
Transaction is not stored
in PbAdmin database;
reflected in the total
authorized amount
Cannot be
settled
1
Transaction types (1) and (75) are very similar. They are treated as such by PbAdmin product. A
transaction type (75) is handled internally by PbAdmin. If a transaction type (1) is used and the system
discovers a previous authorization for that credit card account, PbAdmin automatically changes the transaction
type to 75. If the transaction type (75) is not supported by the processor, PbAdmin automatically changes it back
to a 1 and resubmits the transaction.
2
The PbAdmin system does Authorization Reversals automatically instead of having to enter the
transaction type (76).
08/2000
23
Transaction
Type
Account
Authorization
Status
Stored in PbAdmin
database?
Can/Cannot be
Settled
(Deposited with
transaction
processor)?
Working Key
Update (77)
Not applicable
Not stored - Result of
transaction is returned to
calling program
Cannot be
settled
Close of
Open
Transaction
(89)
Closes an open
transaction and
allows update of
the amount, tips,
and extra
amount
PbAdmin database for
reporting purposes only
Can be settled
Remove
Open
Transaction
(90)
Deletes all
outstanding
authorizations
associated with
a specific card
Deletes a specific
authorization record from
the database
Cannot be
settled
NOTE: Settlement is performed through the
Deposit Transactions option from the
Main Menu. The settlement transaction
itself is done through PbAdmin. The
PbAdmin front-end (PBFE) does not
perform the settlement transaction.
Each transaction requires a specific set of input fields and
returns a defined set of output fields regardless of thirdparty transaction processor.
24
08/2000
Required Input
Fields by
Transaction Type
The following table lists the minimum fields required by
PbAdmin in the input file for each valid transaction type.
We provide a more detailed list of fields later in this
section. For a detailed description of each field, please
refer to the ProtoBase Technical Reference Guide.
Transaction Type
Authorization Only (1)
Input Fields
2, 3, 105, 109
Sale (2)
2, 3, 105, 106, 109
Prior-Authorized Sale (7)
2, 3, 105, 106, 109
Return (9)
2, 3, 105, 106, 109
Void Sale (11)
2, 3, 7, 105, 106, 109
Void Return (17)
2, 3, 7, 105, 106, 109
Check Authorization (20)
2, 105, 106, 109
Transaction Inquiry (22)
3, 7, 105, 106, 109
Incremental Authorization (75)
2, 3, 105, 109
Authorization Reversal (76)
2, 3, 105, 109
Working Key Update (77)
None required
Close of Open Transaction (89)
2, 3, 7, 105, 106, 109
Remove Open Transaction (90)
2, 3, 7, 105, 106, 109
08/2000
25
Suggested Input
Fields by Industry
Type
The following table lists the industry-specific fields that
should be included in the input file to comply with current
regulations for electronic card processing.
Industry Type
Input Fields
Restaurant (002)
200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 212,
213
Lodging/Front Desk
(003)
300, 301, 302, 303, 304, 305, 306, 307, 309, 310, 311, 312,
313
Retail (004)
71, 400, 401, 406, 407, 408, 409, 410, 411, 412, 413, 414,
415, 416
Rental Car (005)
500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511,
512, 513, 514, 515, 516, 517, 519, 520, 521
Direct Marketing
(007)
711, 712, 713, 714, 715, 716, 717, 718, 719, 720, 721, 722
Lodging/Restaurant
(003/002)
300, 301, 305, 308, 200, 201, 202, 203, 204, 205, 206, 207,
208, 209, 210, 212, 213
Lodging/Retail
(003/004)
300, 301, 305, 308, 400, 401, 406, 407, 408, 409, 410, 411,
412, 413, 414, 415, 416
Generic (999)
None available
NOTE:
26
Lodging/Retail may be set up as either
Lodging/Retail or Retail. Similarly,
Lodging/Restaurant may be set up as
either Lodging/Restaurant or
Restaurant. How this is set up depends
on the industry classification assigned by
American Express or the hotel’s thirdparty transaction processor.
08/2000
Output Fields
The output fields returned for each transaction include:
•
•
•
All fields passed as input fields
Field 1003 (ProtoBase response code)
Field 1010 (ProtoBase response message)
Output Field Names and Attributes
1003
ProtoBase Response Code
Numeric
4
1004
Host Response Message
Alpha numeric
80
1009
Host Response Code
Alpha numeric
10
1010
ProtoBase Response Message
Alpha numeric
30
1011
Host Reference Number
(Used by Host Processor)
Alpha numeric
8
1015
AVS Result Code
Alpha numeric
8
08/2000
27
Output Fields
(cont.)
Transaction
Type
In addition to the output fields on the previous page, other
conditions determine which output fields will be passed
depending on the response code returned.
If PbAdmin response
code (Field 1003) = 0,
these additional fields
are returned:
1
6
1004
2
6, 7, 1011
1004
7
7, 1011
1004
9
7, 1011
1004
11
1004
17
1004
20
6
1004
22
75
N/A
6
1004
76
1004
77
1004
89
1004
90
1004
NOTE:
28
If PbAdmin response
code = 60, this
additional field is
returned:
If the ProtoBase response code (Field
1003) is not a 0 or 60, you should display
the Host response text returned in Field
1004.
08/2000
Input Fields
The following are the fields available for use with
PbAdmin. Shaded fields are stored and maintained
within PbAdmin, but are not required; however, they will be
accepted and processed by PbAdmin if supplied.
Input Field Names and Attributes
Field
Number
Field Name
Data Type
1
Transaction Type
Numeric
2
Transaction Amount
Decimal Amount
3
Account Number/Track
Alpha Numeric
4
Expiration Date
Numeric
6
Authorization Number
Alpha Numeric
6
7
Reference Number
Alpha Numeric
12
9
Batch Number
Numeric
8
11
User Defined Field
Alpha Numeric
80
12
Force Flag
Numeric
1
13
Override System Transaction Date
Numeric
MMDDYY
14
Override System Transaction Time
Numeric
HHMMSS
15
PS2000 Data
Alpha Numeric
16
PS2000 Amount
Decimal Amount
18
Debit PIN Number
Alpha Numeric
25
Business Date
Date
MMDDYY
32
Transaction Date
Date
MMDDYY
33
Transaction Time
Time
HHMMSS
34
CPS PSI Indicator
Alpha Numeric
1
35
CPS Transaction Code
Alpha Numeric
4
36
CPS Transaction ID
Alpha Numeric
15
37
CPS Authorizer
Alpha Numeric
1
38
Reason Code
Alpha Numeric
2
39
POS Entry Mode
Alpha Numeric
4
40
CVC Error Indicator
Alpha Numeric
1
08/2000
Size/Format
2
99999.99
120
MMYY
23
9999.99
16
29
Field
Number
30
Field Name
Data Type
41
Magnetic Stripe Quality Indicator
Alpha Numeric
1
42
Authentication Code
Alpha Numeric
6
70
Customer Code
Alpha Numeric
17
71
Tax 1 Included
Numeric
1
72
Tax 1 Amount
Decimal Amount
73
Tax 2 Included
Numeric
74
Tax 2 Amount
Decimal Amount
75
Tax 3 Included
Numeric
76
Tax 3 Amount
Decimal Amount
100
X Display Coordinate
Numeric
2
101
Y Display Coordinate
Numeric
2
105
ProtoBase Files Path
Alpha Numeric
80
106
Settlement Path
Alpha Numeric
80
107
Settlement Report Path
Alpha Numeric
80
108
Settlement History Path
Alpha Numeric
80
109
Terminal ID
Alpha Numeric
8
110
Cashier ID
Alpha Numeric
7
112
Processor ID
Numeric
3
115
Transaction Qualifier
Numeric
3
118
Reversal ID
Numeric
1
125
Retrieval Reference Number
Numeric
8
126
Acquiring ICA
Alpha Numeric
2
127
Authorization Characteristic Indicator
Alpha Numeric
1
128
Original Authorization Amount
Numeric
9
129
Preferred Customer Indicator
Alpha Numeric
1
130
Total Authorized Amount
Numeric
9
131
Total Number of Incrementals
Numeric
2
132
Authorization Reversal Sent
Numeric
1
08/2000
Size/Format
999.99
1
999.99
1
999.99
Restaurant
Field
Number
3
Field Name
Data Type
200
Charge Description
Numeric
201
Tip 1 Amount
Decimal Amount
9999.99
202
Tip 2 Amount
Decimal Amount
9999.99
203
Server 1 Number
Numeric
8
204
Server 2 Number
Numeric
8
205
Ticket Number
Numeric
6
206
Tax Amount
Decimal Amount
999.99
207
Food Amount 3
Decimal Amount
99999.99
208
Beverage Amount
Decimal Amount
9999.99
209
Table Number
Numeric
210
Tip 1 Description
Alpha Numeric
“TIP”
211
Adjusted Tip Amount
Decimal Amount
99.99
212
ROC Number
Alpha Numeric
10
213
Food Description
Alpha Numeric
“FOOD”,
“FOOD/BEV”,
“BEVERAGE”
214
Beverage Description
Alpha Numeric
“BEVERAGE”
“DRINKS”
215
Tip 2 Description
216
Number of Guests
Alpha Numeric
Numeric
Size/Format
2
3
“TIP”
2
Food Amount - Any amount 10,000 or greater will be changed to 9999.99 due to processor limitations
08/2000
31
Lodging
Field
Number
Field Name
Data Type
Size/Format
300
Charge Description4
Numeric
2
301
Folio Number
Numeric
8
302
Room Rate5
Decimal Amount
303
Checkin Date
Date
MMDDYY
304
Checkout Date
Date
MMDDYY
305
Program Code
Numeric
306
Tax Amount
Decimal Amount
307
Length of Stay 6
Numeric
4
308
Ticket Number/ROC Number
Numeric
10
309
Operator/Server ID
Numeric
6
310
Room Number
Alpha Numeric
4
311
Extra Charges
Decimal Amount
312
Extra Charges Reason7
Numeric
6
313
Guest Name
Alpha Numeric
26
9999.99
2
999.99
999.99
4
Charge Description values - 00=Health Spa, 01=Lodging, 02=Food/Beverage, 03=Gift Shop, 04=Beauty
Salon, 05=Convention Fees, 06=Tennis/Pro Shop, 07=Golf/Pro-Shop, 08=Unassigned, 09=Unassigned
5
Room Rate - Any amount 1,000 or greater will be changed to 999.99 due to processor limitations
6
Length of Stay - Any amount 100 or greater will be changed to 99 due to processor limitations
7
Extra Reason Codes: 0-None, 2-Restaurant, 3-Gift Shop, 4-MiniBar, 5-Telephone, 6-Other, 7-Laundry
(Up to six individual reason codes can be entered in the same field)
32
08/2000
Retail
Field
Number
Field Name
Data Type
Size/Format
400
Item Code
Numeric
2
401
Invoice Number
Numeric
6
406
Item 1 Text
Alpha Numeric
40
407
Item 2 Text
Alpha Numeric
40
408
Item 3 Text
Alpha Numeric
40
409
Item 4 Text
Alpha Numeric
40
410
Item 5 Text
Alpha Numeric
40
411
Retail Terms
Numeric
4
412
Item Code 1
Numeric
4
413
Item Code 2
Numeric
4
414
Item Code 3
Numeric
4
415
Item Code 4
Numeric
4
416
Item Code 5
Numeric
4
8
Rental Car
500
Vehicle ID Number
Numeric
501
Adjustment Amount
Decimal Amount
502
Rental Date
Date
MMDDYY
503
Rental Time
Time
HHMMSS
504
Rental City
Alpha Numeric
18
505
Rental State
Alpha Numeric
2
506
Return Date
Date
MMDDYY
507
Return Time
Time
HHMMSS
508
Return City
Alpha Numeric
18`
509
Return State
Alpha Numeric
2
510
Renter Name
Alpha Numeric
26
511
Rental Agreement Number
Alpha Numeric
9
512
Days Rented
Numeric
2
08/2000
999.99
33
Field
Number
Field Name
Data Type
Size/Format
513
Promotion Code
Numeric
4
514
Certificate Number
Alpha Numeric
14
515
Reserve City
Alpha Numeric
18
516
Reserve State
Alpha Numeric
2
517
Tax Amount
Numeric
999.99
518
Charge Description
Numeric
1
519
Program Indicator
Alpha Numeric
2
520
Return Location ID
Alpha Numeric
10
521
Extra Charges 8
Numeric
6
Address Verification
700
Zip Code
Numeric
9
701
Street Address
Alpha Numeric
20
702
First Name
Alpha Numeric
15
703
Last Name
Alpha Numeric
20
704
House Number
Alpha Numeric
6
705
Street Name
Alpha Numeric
20
706
Apartment Number
Alpha Numeric
6
707
City
Alpha Numeric
20
708
State
Alpha Numeric
2
Direct Marketing
711
Shipping Date
Date
MMDDYY
712
Charge Description
Numeric
2
713
Clearing Sequence Count
Numeric
2
714
Clearing Sequence Number
Numeric
2
715
Order Number
Numeric
10
716
Ship to Zip Code
Numeric
5-9
8
Extra Charges reason code: 0-None, 1-Gas, 2-Extra Mileage, 3-Late Return, 4-One way service, 5Parking Violation
34
08/2000
717
Item 1 Text
Alpha Numeric
Field Name
Data Type
718
Item 2 Text
Alpha Numeric
40
719
Item 3 Text
Alpha Numeric
40
720
Item 1 Code
Numeric
4
721
Item 2 Code
Numeric
4
722
Item 3 Code
Numeric
4
Field
Number
40
Size/Format
Checks
900
MICR Number
Alpha Numeric
40
901
Driver’s License Number
Alpha Numeric
50
902
Check Number
Numeric
6
903
Alpha Numeric State Code
Alpha Numeric
2
904
Numeric State Code
Numeric
2
905
Date of Birth
Date
906
Check Type
Numeric
3
907
MICR Entry Mode
Numeric
1
908
Driver’s License Entry Mode
Numeric
1
909
Manager Override
Alpha Numeric
1
910
Zip Code
Numeric
5-9
911
Phone Number
Numeric
10
912
ABA Number
Numeric
9
913
Alternate Identification Indicator
Numeric
2
914
Alternate Identification
Alpha Numeric
80
Alpha Numeric
40
MMDDYY
Gateways
8000
Remote Program to Run (PBFE.EXE)
NOTE: Detailed descriptions of all of these fields are available in the
ProtoBase Technical Reference Guide. Many of these
fields correspond to PbAdmin screen fields. We describe the
screen fields in detail in the PbAdmin Technical Reference
section.
08/2000
35
Integrating
PbAdmin for
Specific
Processing
Situations
Before integrating PbAdmin into your POS system, you
need to know how PbAdmin handles various transaction
types (such as Authorization maintenance, PriorAuthorization, and Settlement) and other processing
situations.
In this section, we describe the integration considerations
for specific transactions and other processing options.
Incremental
Authorization and
Authorization
Reversal
PbAdmin can be set up to run Incremental Authorizations
and Authorization Reversals as required.
If the difference between the original and final
authorization amount is greater than the Authorization
Tolerance percentage, PbAdmin can automatically
process the appropriate Incremental Authorization or
Authorization Reversal. The Authorization Tolerance
percentage is set in the Authorization Tolerance Value
field (on the Location Information screen).
NOTE: If Auth Tolerance Value is set to 100%, it
disables checking for both Incremental
Authorization and Authorization
Reversals. PbAdmin does not create one
of these transactions automatically in
this case. Therefore, incrementals and
reversals must be handled by the
integrator to maintain CPS compliance.
If a transaction is manually edited making the difference in
the original and final amount more than the tolerance, an
Incremental Authorization or Authorization Reversal is
automatically run prior to settlement as required.
Incremental Auths and Auth Reversals are both reflected in
the total amount authorized field (130) of the transaction.
CPS field data is automatically maintained by PbAdmin
and does not need to be passed by the POS system for
these transactions.
36
08/2000
Incremental
Authorization
Processing for Incremental Authorizations depends on
how the Auto Authorize Difference field is set in the
Location Information screen for that location:
•
If set to Yes, when a Prior Auth is run and the
amount is greater than the total authorized amount
by more than the Auth Tolerance percentage,
PbAdmin will automatically create an Incremental
Auth.
•
If set to No, the user will get an error message
“-116 Final Amt Too Large” if the amount is
greater than the total authorized amount by more
than the Auth Tolerance percentage.
If two Authorization Only (type 01) transactions are run with
the same Reference Number, PbAdmin converts the
second Auth Only into an Incremental Authorization
automatically, if required.
If an Incremental Authorization (type 75) is run without an
Authorization Only to reference, it changes the Incremental
Authorization to an Authorization Only.
Authorization
Reversal
If the total amount authorized exceeds the amount to be
settled by an amount larger than the Tolerance
percentage, PbAdmin automatically does an Authorization
Reversal (type 76) at settlement.
If a void is done, at settlement an Auth Reversal
transaction is generated automatically to reverse the
existing authorization.
If the user wants to run an Auth Reversal manually, this can
be done by running an Authorization Reversal (type 76)
manually through ProtoBase.
08/2000
37
AVS
Prior-Authorized
Sale
AVS data is supported and the AVS result code in the
output is stored for the particular transaction. The AVS
information may be viewed from the Select/View/Edit
Transactions screen by pressing [F6] (to view a particular
transaction) and then [Shift]+[F3]. For the Direct
Marketing industry, AVS information also appears on the
transaction detail screen.
PbAdmin matches a Prior-Authorized Sale (type 07)
transaction to an existing Authorization Only transaction by
Reference Number, Account Number, and Location.
If a Prior-Auth Sale is entered manually without an Auth
Only to reference, an Auth Only is automatically generated
at settlement time.
If a Prior-Auth Sale is processed with an authorization
number but does not have a matching authorization, the
transaction will be treated as a forced authorization and
accepted.
For the lodging industry, if one card is used for check in
and another card is used for check out and the hotel
customer wants to cancel the first card’s purchase, this
can be done. However, the new card must be authorized
with an Auth Only transaction. The original Auth Only will
remain unless it is removed by running a Remove Open
Transaction (type 90), or purged using the Database
Management menu option.
NOTE:
Voids and
Returns
PbAdmin will not reverse authorizations
for any authorizations that are purged.
The Void Sale or Void Return transactions replace the
existing Sale, Prior-Auth Sale, or Return.
A Return transaction creates a new record in the main
database.
38
08/2000
Settlement
The Settlement or Deposit transaction must be run within
PbAdmin using the Deposit Transaction option from the
Main Menu. This transaction cannot be run through
PBFE using a Settlement transaction (type 13).
A ProtoBase “batch file” is created by PbAdmin only at
settlement time. Transactions are not stored in a batch
file, but in the PbAdmin database.
Settlement information is locked in and cannot be
modified at the time the Prior-Auth Sale is run. Errors in
settlement information may be corrected to match the
current configuration using the Fix Settlement
Information option on the Database Management menu.
08/2000
39
Gateways
If using a ProtoBase Gateway product, you must include
an entry of PBFE.EXE in Field 8000 (Remote Program to
Run). This lets the Gateway know to run PBFE, the
PbAdmin Front End program.
Auto Close
SDC does NOT recommend our clients integrate with an
auto-close feature. The “Auto-Close” is offered by some
host capture transaction processors to automatically settle
the batch file at a specified time each day, without sending
a Batch Settlement/Close request. Using PbAdmin with
auto-close will cause transactions to be moved to history
without ever dialing out.
Multiple
Locations
Integrators have to consider whether the user will have
multiple locations or one location. Each terminal is tied to
a specific location. A particular merchant key may be
used by one or more locations.
If the end user will be authorizing with one transaction
processor and settling with a different transaction
processor, separate terminals must be set up.
Real Time
Transactions
PbAdmin moves real-time transactions (i.e., PIN-pad
debit card or check authorization) to the PbAdmin history
database directly; no dialing out occurs for these
transactions. Offline transactions without the use of a PIN
pad are treated like credit transactions.
Transaction
Qualifier Field
(115)
PbAdmin accepts three values for theTransaction Qualifier
field (115). These values are as follows:
010 = Credit
020 = Check
030 = Debit
To run a transaction using one of these qualifiers, the input
file would be run as a Sale transaction (type 02) with the
appropriate value in Field 115.
40
08/2000
Force Field (12)
for Forced
Authorizations
If a manual authorization is done and the user wants this
transaction in the database, they can run an authorization
with the Force Field (12) set to 1. This will not dial out, but
will put the transaction in the database.
User Defined
Field (11)
The User Defined field (11) can be used to pass any
special data needed with the transaction. If this field is
passed in the input file, it is returned in the output file as
presented for all transactions.
Time Out
Reversal
A communication error may occur when an Authorization,
Sale, or Prior-Auth Sale is attempted. It may be uncertain
if the transaction was received by the transaction
processor. In this case, PbAdmin automatically runs a
time-out reversal transaction, or retries the transaction.
PbAdmin will retry the transaction as many times as
allowed by the transaction processor. If, after exhausting
the number of attempts PbAdmin still cannot process the
transaction, it will be returned to the POS with the original
error message.
Printer Setup
Printer setup records are provided in PbAdmin for
different report formats, as follows:
Portrait
Landscape
17 cps/20 cps line printer
These settings determine the number of characters per
line when printing reports.
08/2000
41
Card Number
Validations
A common practice in the lodging industry is for users to
run an initial authorization for $1.00 to validate the account
number. If, at some point, they expect to actually swipe the
card, it is recommended that the $1.00 authorization be
done at a terminal different than the one used to process
the transaction with the cardholder present. The terminal
used should be set to go to a different location to avoid
conflict with inactive transactions.
Transaction
Inquiry (Tran
Type 22)
The Transaction Inquiry transaction is unique to users of
PbAdmin. This transaction can be used to inquire about
the status of a transaction in the PbAdmin database. This
would be used when an error occurs that prevents an
output response file from being received. In this case, the
transaction status is uncertain. The Transaction Inquiry
can be run on this transaction to determine the current
status of the transaction.
This transaction does not dial out. It returns CPS data in
its response and a report on the current status.
ProtoBase does not need to be running for this transaction
to function.
42
08/2000
How to Generate
Reports Outside
of PbAdmin
This section describes the information you need to run
reports outside of PbAdmin. This integration option
enables your POS system to call the report generator
program, PBADREP, directly, rather than having PbAdmin
call it.
PBADREP, the
PbAdmin Report
Generator
PBADREP, the PbAdmin report generator, uses an input
file that specifies the type of report (in Field 1) and the
criteria to generate it. Within the PbAdmin menus, this
input file is generated automatically when you select any
report option (e.g., from the Reports Menu or from the
Transaction History Menu).
However, you may want to generate reports outside
PbAdmin and have your POS system call PBADREP
directly. This will offer your POS system more flexibility for
PbAdmin report generation.
The input file for PBADREP may be created as you need
it. If the same report will be run multiple times, you may
want to set up a batch file to use the same input field
values every time.
To have your POS system call PBADREP, you must set
up an input file first. We describe how to do this on the
next page.
PBADREP generates the report and places its text in the
directory path and filename specified in Field 107 of the
input file. We describe the reports themselves in more
detail in the PbAdmin Technical Reference section.
Reports are page numbered and printed according to the
length and width specified. However, the user must set
the printer mode prior to printing. No printer codes are
inserted into the report. Reports are blank line padded to
the proper page length.
08/2000
43
PBADREP, the
PbAdmin Report
Generator
(cont.)
In addition to the actual report, an output file is also
generated when PBADREP is run. It contains response
codes, dollar amounts, and item counts. If you want, you
may parse this output file to verify the report has been
generated successfully.
NOTE: PBADREP will exit with a non-zero value if
any errors are present. The program error
code may then be reviewed.
How to Call the
Report Generator
(PBADREP)
To call the report generator, use the following format:
pbadrep -iinput.in [-ooutput.out]
input.in is the input filename and output.out is the
optional output filename. If the output filename is not
specified, the default output filename is the input filename
with a .out extension.
You must set up an input file for PBADREP to use. We
describe the entries you can make in this file below.
44
08/2000
How to Set up the
Input File
The input file to be used by PBADREP must contain a
vertical series of field numbers and corresponding values,
separated by a comma. The number to the left of each
comma indicates the field number. The value to the right
of each comma indicates the value for this field.
Comments are entered to the right of asterisks.
The following is a sample input file transaction:
1,1
105,.\
106,.\
107,.\report.rpt
110,3
111,X
112,steve’s front desk
115,D
* Terminal report
* Report text file
* Pre-settlement
* Selected records
* Location name
*Standard detail/totals
Using the above input file, PBADREP will generate a presettlement Terminal report called report.rpt containing
selected records from the location named “steve’s front
desk”.
08/2000
45
Table of Input File
Fields
The table below describes the fields that may be included
in the input file used by PBADREP. The table shows the
field number, name, description, values and whether the
field is required.
NOTE:
Not all combinations of values will work
for PBADREP. You must be aware of the
limitations of certain reports. For
example, Card Type and Merchant Key
reports (values 8 and 9 in Field 1) do not
offer the industry detail option (value F in
Field 115). For more information on the
reports, please refer to the PbAdmin
Technical Reference section.
Input File Format Used for PBADREP
Field
Number
Field Name
Required?
Description
1
Report Type
Yes
The type of report to be generated.
1 = Terminal Report
2 = Cashier Report
3 = Auth Date-Time Report
4 = Tip Report (Restaurant Only)
5 = Deposit Date and Time Report
6 = Deposit Error Report
7 = Incremental Auth Report
8 = Card Report
9 = Merchant Key Report
100
Width of Page
No
The width of the report page.
80 = Portrait (Default)
137 = Epson 17 cpi
160 = Epson 20 cpi
177 = Landscape
101
Length of Page
No
The length of the report page.
60 = All print modes
46
08/2000
Input File Format Used for PBADREP (cont.)
Field
Number
Field Name
Required?
Description
105
ProtoBase Files
Directory Path
Yes
The directory path for the ProtoBase
files. The minimum entry is .\ (nonUNIX) or ./ (UNIX). These are the files
in PBPATH.
106
PbAdmin Database
Directory Path
Yes
The directory path for the PbAdmin
databases. The minimum entry is .\
(non-UNIX) or ./ (UNIX). These are the
files in PBDBPATH.
107
Report Directory
Path and Filename
Yes
The directory path and filename for the
report generated from the PBADREP
program. The minimum entry is
.\report.rpt or ./report.rpt (where
report.rpt is the report filename).
110
Report Selection
Criteria
Yes
Defines the type of records to be
selected for the report.
1 = All records
2 = Selected Records
3 = Pre-settlement
If this value is 2 or 3, Field 111 is also
required.
111
Report Selection
Criteria (Additional)
No if Field 110
=1
Yes if Field
110 = 2 or 3
The transaction status flags to be
included on the report. Transactions
with any of these flags on the
Select/View/Edit Transactions screen
(or History Transaction screen) will be
included on the report. Enter this value
as a string with no separators.
! = Transaction in error
A = Authorizing
H = Host capture
I = In progress (currently being settled)
M = Move to History pending
P = Pending with American Express
R = Real time transaction
S = Settled
U = Host capture pending
V = Void or Void Return
X = Selected records
XUR is the recommended setting.
08/2000
47
Input File Format Used for PBADREP (cont.)
Field
Number
Field Name
Required?
Description
112
Location Name
Yes
The location name from which these
records are to be selected for the
report. This value must match exactly
to the actual name of the location. Use
“ALL” for all locations.
113
Exclude Characters
No
The transaction status flags to be
excluded from the report. Transactions
with any of these flags on the
(or History Transaction screen) will be
excluded from the report. Enter this
value as a string with no separators.
The values are the same as for Field
111.
IA is the recommended setting.
114
Batch Number for
History Reports
No
The batch number to report. Applicable
only for history reports.
115
Detail Type
Yes
Defines the type of records to be selected
for the report. Each of these values may
not be applicable to all report types found
in Field 1.
T = Totals only (Applicable to all report
types)
D = Standard detail and totals (Applicable
to all report types except 5 and 7)
F = Full industry detail and totals
(Applicable to report types 1 and 2
only)
116
Sort Order
No
Describes the numeric or alphabetic
order that records will be grouped on
the report.
A = Ascending order (low to high)
D = Descending order (high to low)
117
48
History Month and
Year
Applicable
and required
for history
reports only
08/2000
The month and year of the history to
include on the report. Required for
history reports.
Input File Format for PBADREP (cont.)
Field
Number
Field Name
Required?
Description
9998
Deposit Status Text
No
Text to be displayed on report regarding
transaction deposit status. Userdefined.
9999
Report Header Text
No
Text to be displayed on the report as
the report header. User-defined.
Output File that is
Generated
The following table describes the fields that may be
generated in the output file from PBADREP. This file may
be parsed and used to determine that reports have
generated successfully. The table shows the field number,
field name, and description.
NOTE: This output file is not the report text
output; the actual report text is placed
under the directory and filename defined
in Field 107.
Output File Generated from PBADREP
Field
Number
Field Name
Description
1003
Error Code
The error code from PBADREP other than databaserelated errors. If the report is generated correctly, this
field equals 0.
1009
Database Error
Code
The error code from PBADREP related to a database
problem. If the report is generated correctly, this field
equals 0.
1010
Error Text
The verbose error from PBADREP. If the report is
generated correctly, this field equals
“ACKNOWLEDGED”.
1020
Net Credit Dollar
Amount
Total dollar amount for all credit transactions on this
report.
1021
Net Debit Dollar
Amount
Total dollar amount for all debit transactions on this
report.
08/2000
49
Output File Generated from PBADREP (cont.)
Field
Number
Field Name
Description
1022
Net Check Dollar
Amount
Total dollar amount for all check transactions on this
report.
1030
Net Credit Count
Total count of all credit transactions on this report.
1031
Net Debit Count
Total count of all debit transactions on this report.
1032
Net Check Count
Total count of all check transactions on this report.
50
08/2000
How to Use the
Optional File
Server Gateway
This section describes how to setup PbAdmin to use the
ProtoBase File Server Gateway. This integration option
enables the merchant to perform settlement or other
transactions from systems that cannot work together
directly, such as using ProtoBase Windows NT (i.e., 32bit) from a 16-bit DOS machine, an OS/2 machine, and a
remote 32-bit Windows machine. See Figure II-2 for an
example.
System
Requirements
To use the ProtoBase File Server Gateway in the
merchant’s system, the following requirements must be
met:
•
The local computers that will be running
settlement must have the ProtoBase directory
mapped to it. This allows the local program to
have access to the databases on the network
server.
•
The operating system of the POS must support
shared file systems (for example, Novell,
LANtastic, Microsoft Networks, and UNIX NFS).
POS System
Workstations
Network
Server
Transaction
Processor
ProtoBase Windows NT,
File Server Gateway, and
Global PbAdmin with
Global INI File
16-Bit DOS,
Local
PbAdmin with
Local INI
OS/2,
Local
PbAdmin with
Local INI
Remote 32-Bit
Windows, Local
PbAdmin with
Local INI
Figure II-2
08/2000
51
How to Setup
PbAdmin to Use
the Gateway
52
To setup PbAdmin to use the File Server Gateway, the
Global INI file must already be set up on the network
machine running ProtoBase. Refer to the
Installation/Setup section for more information. After
this is setup, you must perform the following steps:
•
Install PbAdmin on at least one local computer.
We describe installation procedures in the
Installation/Setup section.
•
Setup a Local INI file on the local computer. You
do this using the Local INI File screen. We
describe this screen in detail in the PbAdmin
•
Install the ProtoBase File Server Gateway
software on the network machine, if not already
installed. For information on Gateways, refer to
the ProtoBase Gateway documentation.
•
Enter the file dropoff path for the Gateway
software in the Optional Gateway File Path field
on the Local INI File Screen on the local
computer. This is not the path where the
Gateway software resides; it is the path where
files are to be picked up by the Gateway for
processing. We describe this screen field in
detail in the PbAdmin Technical Reference
section.
08/2000
When PbAdmin is
Setup with the
Gateway
When you set up the ProtoBase File Server Gateway, all
PbAdmin reports and settlement will run through the
Gateway.
To have PBFE process transactions through the Gateway,
you must have a specific entry for Field 8000 in all
transaction input files. This entry must consist of 8000,
followed by the fully-qualified path where PBFE resides
(e.g., 8000,c:/pb/pbamin/PBFE.EXE).
For reports using PBADREP, you must include a similar
entry (e.g., 8000,c:/pb/pbadmin/PBADREP.EXE)in the
input file used by PBADREP.
08/2000
53
ProtoBase Administrator User Guide - Version 4.3.002 – Installation/Setup
ProtoBase 
Administrator
Version 4.3.002
User Guide
III. Installation/Setup
54
08/2000
Installing
PbAdmin
To install the ProtoBase Administrator system, you must
install all of the following components:
•
•
•
•
ProtoBase and applicable SofTrans modules
Any ancillary Southern DataComm products you
are using, including the American Express Direct
Settlement Utility and ProtoBase Gateways
The ProtoBase Front End program (PBFE)
The ProtoBase Administrator (PbAdmin)
All of these parts must be installed and working correctly in
order for the entire system to work properly.
NOTE:
If you are installing PbAdmin on a
machine that already has ProtoBase, you
should already have the necessary
ProtoBase software and SofTrans module
on your system (Minimum ProtoBase
version 4.76).
If you are installing ProtoBase and
PbAdmin for the first time, you should
install ProtoBase and the SofTrans
modules and perform testing prior to
installing PbAdmin. Refer to the
ProtoBase User Guide for instructions
on how to install ProtoBase and the
SofTrans modules.
PbAdmin installation differs depending on the particular
operating system and whether it is an upgrade or a firsttime installation. We separate the installation instructions
into the following:
•
•
•
•
DOS/LAN, OS/2 (First-time)
DOS/LAN, OS/2 (Upgrade)
UNIX-based (First time)
UNIX-based (Upgrade)
We discuss how to install PbAdmin for DOS/LAN and
OS/2 beginning on the next page. To install PbAdmin for
UNIX, proceed to this topic on page 55 of this section.
08/2000
55
Installation of
PbAdmin for
DOS/LAN, OS/2
This section details the procedure for installing the
ProtoBase Administrator for the first-time or as an
upgrade on non-UNIX based operating systems
(DOS/LAN, OS/2). For installation of PbAdmin for UNIXbased operating systems, please refer to the appropriate
instructions on page 55 of this section.
NOTE: If a Technical Bulletin accompanied your
software, please consult it for any special
installation or upgrade requirements.
The installation CD contains four files: PKUNZIP.EXE,
PBADMIN.ZIP, PBFE.ZIP, and INSTALL.BAT.
56
08/2000
System
Requirements
(DOS/LAN, OS/2)
Prior to installing PbAdmin for non-UNIX-based systems,
verify that your customer’s operating system meets the
following minimum requirements:
•
Minimum 10 MB of free hard disk space for
installation and basic operation.
•
Minimum 386 mother board (Pentium highly
recommended).
•
Minimum 8 MB RAM; however, 16 MB or more
RAM is highly recommended.
•
Additional hard disk space is needed to store
history files and databases which can become
large in size.
•
Set FILES=50 (at a minimum) in your configuration.
•
Must load the SHARE executable (DOS and OS/2
only).
•
Minimum 550K for largest executable program size
(Type mem at the command line to check this).
08/2000
57
First Time
Installation of
PbAdmin
(DOS/LAN, OS/2)
Below, we detail the steps for installing PbAdmin for the
first time on a non-UNIX system. If you are upgrading
PbAdmin for non-UNIX, please refer to these procedures
beginning on page 60.
NOTE:
PbAdmin should be installed in
the ProtoBase directory, either
directly or within a PbAdmin
directory within the ProtoBase
directory. You can also install it
as a separate directory on the
same level as ProtoBase; however,
SDC recommends that you install
it in the ProtoBase directory.
Complete the following steps:
1. Change to the directory where PbAdmin will be
installed.
2. Insert the PbAdmin medium into the appropriate drive
and change to that drive.
3. Run the installation script, INSTALL.BAT, by typing the
following at the command prompt:
install [full path to ProtoBase directory] [full path
to PbAdmin directory] /d [ENTER]
E.g., install c:\pb c:\pb\ /d [ENTER]
INSTALL.BAT performs the following for you:
•
•
•
•
•
Uncompresses the distribution files
Creates subdirectories DB, DBHIST, and API
Creates Global and Local INI files
Installs the new PbAdmin files
Copies the default user location database files
to the proper directory
The /d argument causes the test location and user
files, PBADLOCA.DAT, PBADLOCA.IDX,
PBFLOOR.DAT, PBFLXREF.DAT,
58
08/2000
First Time
Installation of
PbAdmin
(DOS/LAN,, OS/2)
(cont.)
PBADUSER.DAT, and PBADUSER.IDX, to be
copied to the DB directory from the DB/DEFAULT
directory. DB is one of the subdirectories under
PBADMIN automatically created when you ran the
install program.
4. Change back to the main PbAdmin directory.
5. For OS/2 systems only, a session of PBSHELL.EXE
should be started on the machine which is running
ProtoBase. You should include the command start /n
pbshell in your startup script.
PbAdmin is delivered with one default location (TEST
LOCATION) and one default login ID and password.
Both the login ID and password are pbadmin (all lower
case letters since it is case-sensitive).
You are ready to begin setting up and configuring
PbAdmin. Please refer to the topic Setting Up PbAdmin
on page 72 of this section.
08/2000
59
Upgrade of
PbAdmin
(DOS/LAN, OS/2)
Below, we detail the steps for upgrading PbAdmin on a
non-UNIX system. If you are installing PbAdmin for the
first time, please refer to these procedures beginning on
page 58.
NOTE 1: Do not upgrade from a version of
PbAdmin earlier than 4.3.001. Please
contact SDC Client Services for help.
NOTE 2:
Follow these instructions if you have
installed PbAdmin in a separate PbAdmin
directory under the main ProtoBase
directory. If you have installed PbAdmin
directly into the root ProtoBase directory,
contact our Client Services Department
toll free at 1-877-SDC-1799 for assistance.
Please have your customer account
number available.
1. Backup all existing PbAdmin files on the current
PbAdmin directory for precautionary purposes.
2. Change to the PbAdmin directory.
3. If your existing version is 4.1, type DBEXPORT from
the command prompt to export your databases from
the existing version. You will run a script later that will
import them back into the new version of PbAdmin.
Be sure to save all *.EXP files.
4. If your existing version is 4.2 or higher, type
DBEXPORT -a –h from the command prompt to
export your databases (including history) from the
existing version. You will run a script later that will
60
08/2000
Upgrade of
PbAdmin
(DOS/LAN, OS/2)
(cont.)
The following command line arguments are available
for DBEXPORT for version 4.2 or higher:
-a = Export all databases except history
-h = Export all of history database
-h (MMYY) = Export history database for two-digit month
and year specified
-m = Export main database
-p = Export packet database
-l = Export location database
-u = Export user database
-d [char] = Export character delimiter (“|”, the pipe
symbol, is the default character)
-? = Displays this menu of options
5. Insert the PbAdmin installation medium into the
appropriate drive and change to that drive.
6. Verify you have backed up the existing database files
and check for the *.EXP files. Then, delete the existing
database files (the .DAT and .IDX files for
PBADLOCA, PBADUSER, PBADMAIN, and
PBPACKET; and, from version 4.1, GENSETUP.DAT
in the DB directory; and, from version 4.3.002,
PBFLOOR.DAT and PBFLXREF.DAT; and all .DAT
and .IDX files in the DBHIST directory).
7. Run the install script, INSTALL.BAT, by typing the
install [full path to ProtoBase directory] [full path
to PbAdmin directory] [ENTER]
E.g., install c:\pb c:\pb\pbadmin [ENTER]
INSTALL.BAT performs the following for you:
•
•
•
•
Uncompresses the distribution files
Updates the Global and Local INI files
Deletes the old version of PbAdmin
NOTE: Do not use the /d option in the above
command line as it will overwrite your
existing databases.
08/2000
61
Upgrade of
PbAdmin
(DOS/LAN, OS/2)
(cont.)
8. Change back to the main PbAdmin directory. Then
type DBIMPORT -a -h from the command prompt to
import the exported databases into the new version.
9. Copy PBCONFIG.LST from the DB directory to the
ProtoBase directory. Rename this file to
PBCONFIG.CFG.
10. Run the upgrade configuration utility, READCFG, to
read in your existing PBCONFIG.CFG information.
Please refer to page 82 for details.
11. For OS/2 systems only, a session of PBSHELL.EXE
should be started on the machine which is running
ProtoBase. You should include the command start /n
pbshell in your startup script.
PbAdmin should be setup with the same location
information as before the upgrade. To make edits to your
setup, refer to the Setting Up PbAdmin topic on page 72.
You must run configuration to initialize the upgrade.
Please refer to the topic Configuring ProtoBase on page
82 of this section.
62
08/2000
Installation of
PbAdmin for
UNIX
This section details the procedure for installing the
ProtoBase Administrator for the first time or as an
upgrade on UNIX-based operating systems For
installation of PbAdmin for non-UNIX operating systems
(DOS/LAN or OS/2), please refer to the appropriate
instructions on page 56 of this section.
NOTE: If a Technical Bulletin accompanied your
software, please consult it for any special
installation or upgrade requirements.
A CD is provided with your distribution and may contain
software for several SDC products. It includes one of two
PbAdmin files: 43001.tar or 43002.tar.
These files are contained in a CD directory structure
illustrated below. The file name that you will specify for
installation represents the version of PbAdmin that you are
running.
ROOT
/
<Operating System>
PBADMIN
43001.TAR
43002.TAR
Abbreviations for the Operating Systems
Operating System Abbreviation
AIX
AIX322, AIX41, AIX43
DG/UX
DGUX411, DGUX43
HP UX
Motorola
QNX
VMS
Red Hat Linux
SCO OpenServer
SCO UnixWare
Sequent
Solaris
HP1020, HP1010, HP11
M68K, M88K
QNX424
VMS71
REDHAT52
SCO322, SCO325
UWARE21, UWARE71
SEQUENT
SOL26, SPARC26, SOL8, SPARC8
08/2000
63
System
Requirements
(UNIX)
Prior to installing PbAdmin for UNIX-based systems, verify
that your customer’s operating system meets the following
minimum requirements:
•
Minimum 10 MB of free hard disk space for
installation and basic operation.
•
90% or less used disk space on the installation
files system.
•
Additional hard disk space as needed to store
history files and databases which can become
large in size.
•
Computer terminal or emulator that is compatible
with one of the following types:
•
•
•
•
•
Wyse 50
VT 100/220/320
IBM 3151
VT 100
ANSI
Other compatible terminals may be available. Please
contact SDC Client Services for more information.
64
08/2000
First-Time
Installation of
PbAdmin for
UNIX
Below, we detail the steps for installing PbAdmin for the
first time on a UNIX system. If you are upgrading
PbAdmin, please refer to these procedures beginning on
page 68.
NOTE:
PbAdmin should be installed in the
ProtoBase directory, either directly or
within a PbAdmin directory within the
ProtoBase directory. You can also install
it as a separate directory on the same
level as ProtoBase; however, SDC
recommends that you install it in the
ProtoBase directory.
To properly install PbAdmin, complete the following :
1. Create two directories. One is a temporary installation
directory; call it temp or a similar name. The other will
be the main PbAdmin directory; call it pbadmin or
similar. You will use the temporary directory to untar
the files from the CD. You will use the other as your
permanent main PbAdmin directory.
2. Change to the temporary directory you have created.
If this is a SCO operating system, type: /bin/ksh
For LINUX or QNX, set the environmental path variable
to the current directory:
export PATH=$PATH:.
3. Insert the distribution CD and untar the files from the
CD to the temporary directory by typing the following:
For Motorola 68/88:
Example: Type
tar xovf /<mount point>/M68K/pbadmin/43002.tar
[ENTER]
where <mount point> is the name you designated
when mounting the CD-drive.
For all others:
Example: Type
tar xvf /<mount point>/<current operating system
abbreviation>/pbadmin/43002.tar [ENTER]
where <mount point> is the name you designated
when mounting the CD-drive.
08/2000
65
First-Time
Installation of
PbAdmin for
UNIX (cont.)
4. The following files are uncompressed:
disk1.taz, disk2.taz, install.scr
5. Install PbAdmin by typing the following at the command
prompt:
chmod 777 install.scr [ENTER]
chmod 777 compress [ENTER]
install.scr [full path to ProtoBase directory] [full
path to PbAdmin directory] /d [ENTER]
e.g., install.scr /pb/pbadmin /d [ENTER]
install.scr performs the following for you:
•
•
•
•
•
•
Untars the file on the temporary directory
Creates the pb and pbadmin subdirectories
Copies test location files to the appropriate
directories
Creates Global and Local INI files
Changes all file permissions for user, group, and
access
The /d argument causes the test location and user
files, PBADLOCA.DAT, PBADLOCA.IDX,
PBADUSER.DAT, and PBADUSER.IDX, to be
copied to the DB directory from the DB/DEFAULT
directory. DB is one of the subdirectories under
PBADMIN automatically created when you ran the
install program.
6. Set VVTERMCAP=path to PbAdmin
directory/DB/vvtermcap.
For example:
VVTERMCAP=/pbadmin/DB/vvtermcap; export
VVTERMCAP
66
08/2000
First-Time
Installation of
PbAdmin for
UNIX (cont.)
7. Set VVTERM=terminal emulation (this is optional and
should only be set if the TERM is not compatible with
the terminals described earlier).
For example:
VVTERM=wyse50; export VVTERM
8. If this is a SCO operating system, type: exit
PbAdmin is delivered with one default location (TEST
LOCATION) and one default login ID and password. Both
the login ID and password are pbadmin (all lower case
letters since it is case-sensitive).
You are ready to begin setting up and configuring
PbAdmin. Please refer to the topic Setting Up PbAdmin
on page 72.
08/2000
67
Upgrade of
PbAdmin for
UNIX
Below, we detail the steps for installing PbAdmin as an
upgrade on a UNIX system. If you are installing PbAdmin
for the first time, please refer to these procedures
NOTE 1: Do not upgrade from a version of
PbAdmin earlier than 4.3.001. Please
contact SDC Client Services for
assistance.
NOTE 2:Follow these instructions if you have
installed PbAdmin in a separate PbAdmin
directory under the main ProtoBase
directory. If you have installed PbAdmin
directly into the root ProtoBase directory,
contact our Client Services Department
toll free at 1-877-SDC-1799 for
assistance. Please have your customer
account number available.
1. Backup all existing PbAdmin files on this directory for
security purposes. Create a temporary installation
directory; call it temp or a similar name. You should
already have a main PbAdmin directory called
pbadmin or similar. You will use the temporary
directory to untar the files from the CD.
If this is a SCO operating system, type: /bin/ksh
2. If your existing PbAdmin version is 4.1, change to the
main PbAdmin directory. Type dbexport from the
command prompt to export your databases from the
existing version. You will run a script later that will
68
08/2000
Upgrade of
PbAdmin for
UNIX
(cont.)
3. If your existing PbAdmin version is 4.2 or higher,
change to the main PbAdmin directory. Type
dbexport -a -h from the command prompt to export
your databases from the existing version. You will run
a script later that will import them back into the new
version of PbAdmin. Be sure to save all *.EXP files.
The following command line arguments are available
for dbexport for version 4.2 or higher:
-a = Export all databases except history
-h = Export all of history database
-h (MMYY) = Export history database for two-digit month
and year specified
-m = Export main database
-p = Export packet database
-l = Export location database
-u = Export user database
-d [char] = Export character delimiter (“|”, the pipe
symbol, is the default character)
-? = Displays this menu of options
4. Change to the temporary directory you have created.
Insert the PbAdmin CD and untar the files from the CD
to the temporary directory. (Refer to page 63 for the
CD directory structure.) Type the following:
For Motorola 68/88:
Example: Type
tar xovf /<mount point>/M68K/pbadmin/43002.tar
[ENTER]
where <mount point> is the name you designated when
mounting the CD-drive.
For all others:
Example: Type
tar xvf /<mount point>/<current operating system
abbreviation>/pbadmin/43002.tar [ENTER]
where <mount point> is the name you designated when
mounting the CD-drive.
08/2000
69
Upgrade of
PbAdmin for
UNIX
(cont.)
5. Run the upgrade script, upgrade.scr, by typing the
upgrade.scr [full path to ProtoBase directory] [full
path to PbAdmin directory] [ENTER]
e.g., upgrade.scr /pb/pbadmin [ENTER]
upgrade.scr performs the following for you:
•
•
•
•
•
•
Untars the file on the temporary directory
Updates the Global and Local INI files
Deletes the old version of PbAdmin
Changes all file permissions for user, group, and
access
Imports the exported data files (except history)
6. Change back to the main PbAdmin directory. Then
type dbimport -h from the command prompt to import
the exported history databases into the new version.
7. Copy pbconfig.lst from the DB directory to the
ProtoBase directory. Rename this file to
pbconfig.cfg.
8. Run the upgrade configuration utility, readcfg, to read
in your existing pbconfig.cfg information. Please
refer to page 82 for details.
9. Set VVTERMCAP=path to PbAdmin
directory/DB/vvtermcap.
For example:
VVTERMCAP=/pbadmin/DB/vvtermcap; export
VVTERMCAP
70
08/2000
Upgrade of
PbAdmin for
UNIX
(cont.)
10. Set VVTERM=terminal emulation (this is optional and
should only be set if the TERM is not compatible with
the terminals described earlier).
For example:
VVTERM=wyse50; export VVTERM
11. If this is a SCO operating system, type: exit
PbAdmin should be setup with the same location
information as before the upgrade. To make edits to your
setup, refer to the next topic, Setting Up PbAdmin, on
page 72.
You must run configuration to initialize the upgrade.
Please refer to the topic Configuring ProtoBase on page
82 of this section.
08/2000
71
After you have completed the installation of the ProtoBase
Administrator, you can begin setting up PbAdmin for use.
This step involves configuring various aspects of PbAdmin
and ProtoBase to work with your operating system
properly.
Setting Up
PbAdmin
NOTE:
If you are upgrading PbAdmin and have
imported existing databases, you may
want to use this section to edit your
setup information.
This section explains how to set up the following:
•
•
•
•
Global and Local INI files
Merchant locations
User security
Reports security
Figure III-1 outlines the general areas to set up.
Directory Paths
Merchant
Locations
INI
Files
PbAdmin Set-up
Reports
Security
User
Security
PbAdmin
Reports
Figure III-1
72
08/2000
Setup Screens/
Instructions
After PbAdmin installation, use the PBADDLOC utility to
access the Global INI File screen. This screen reads in
the global directory paths you set and allows you to make
any corrections. It also creates a default Local INI File
which contains paths to the Global INI File. For a
description of the Local INI File screen, please refer to the
PbAdmin Technical Reference section.
Global INI File
Screen
To access the Global INI File screen, change to the
PbAdmin directory. From the command prompt, type
pbaddloc [ENTER]. The Global INI File screen appears
as shown below. It indicates “New” if being accessed for
the first time.
You should verify the accuracy of the information on this
screen. Make any changes where appropriate. Press
[F1] for a description of each field. For a detailed
description of every field on this screen, refer to the
Global INI File Screen
Press the [F10] key to save changes; then press [ESC] to
continue setup. This exits you out of the Global INI File
screen and takes you into the ProtoBase Administrator
User Log In screen.
08/2000
73
ProtoBase
Administrator
User Login
Screen
The ProtoBase Administrator User Login screen enables
you to log into the ProtoBase Administrator system.
Log in using pbadmin as the Login ID and pbadmin as
the Password. Both of these must be entered with all
lower case letters.
When you log in, the next screen, the Locations screen,
lists all of the locations currently setup in the system.
User Login Screen
74
08/2000
ProtoBase
Administrator
Locations Screen
The ProtoBase Administrator Locations screen enables
you to view a list of all established locations. These can
be different individual merchant locations, or separate
POS stations within one merchant location. When you first
install PbAdmin, one default location, “Test Location”, is
automatically established. The default location is set up
as a master location.
Locations Screen
To choose an existing location to modify, highlight the
location and press [ENTER]. If you are installing for the
first time, the only location established is called TEST
LOCATION.
To enter a new location, press [F3].
08/2000
75
Location
Information
Screen
You access the Location Information screen automatically
when you select one of the locations listed on the previous
Locations list screen, or when you press [F3] to enter a
new location. This screen also can be accessed from
PbAdmin through the Administrator Setup option from the
Main Menu.
Use this screen to set up details about a particular
location that is using PbAdmin. You may modify existing
locations or add new ones using this screen.
For a detailed description of every field on this screen,
refer to the PbAdmin Technical Reference section.
The Location Information screen appears as shown below.
Location Information Screen
76
08/2000
Location
Information
Screen (cont.)
If this was a new location you have just entered, press
[F10] to save the new location. PbAdmin will
automatically access the User Security screen. We
describe this screen on the next page.
If you have made changes to an existing location, press
[F10] to save the changes. The message “Changes
have been saved” appears. You can then press [ESC]
to return to PbAdmin.
08/2000
77
User Security
Screen
The User Security screen is accessed automatically when
you enter a new location from the Location Information
screen and exit for the first time. This screen also can be
accessed through the Administrator Setup option from the
Main Menu.
You should use this screen to make changes to user
access for this particular location. You can limit a
particular user’s access to various parts of PbAdmin for
this location by indicating No for any of these screen
fields. However, the primary user for this location should
have all fields set to Yes.
The User Security screen appears as shown below.
User Security Screen
78
08/2000
User Security
Screen (cont.)
If you adding the initial user to a new location, the “Yes/No”
fields automatically default to Yes. You can specifically
select those fields you want to change to No.
If you access the User Security screen from the
Administrator Setup option from the Main Menu, the
“Yes/No” fields automatically default to No. You can
toggle all of these fields to Yes by pressing [Shift]+[F3].
NOTE: Enter information in the Login screen field
carefully. This becomes the base login for
the location you just added.
Make sure you press [F10] to save any changes you have
made. The message “Changes have been saved”
appears.
You can now press [F6] to enter the Reports Security
screen to set up security for the PbAdmin reports.
NOTE:
The Reports Security screen can only be
accessed from the User Security screen.
08/2000
79
Reports Security
Screen
The Reports Security screen is accessed by pressing [F6]
from the User Security screen. This screen contains fields
representing each of the reports available in PbAdmin.
You should use this screen to make any changes to user
access for particular reports. You can limit a particular
user’s access to a report by pressing the space bar to
toggle the appropriate screen field to No.
The Reports Security screen appears as shown below.
Reports Security Screen
80
08/2000
Reports Security
Screen (cont.)
If you adding the initial user to a new location, the “Yes/No”
fields automatically default to Yes. You can then
specifically select those report fields you want to change
to No.
If you access the Reports Security screen via the User
Security screen from the Administrator Setup option from
the Main Menu, the “Yes/No” fields automatically default to
No. You can toggle all of these fields to Yes by pressing
[Shift]+[F3].
Make the appropriate edits on this screen. Use the space
bar to toggle between Yes and No responses.
appears.
Press [ESC] to exit the Reports Security screen. This
brings you back to the User Security screen. If you are
satisfied with all changes on the User Security screen,
press [ESC] again. This brings you back to the
Administrator Setup menu. Press [ESC] and [F10] to exit
back to the command prompt.
You are now ready to configure ProtoBase. We explain
how to do this with the next topic, Configuring ProtoBase.
08/2000
81
Configuring
ProtoBase
You have two options for configuring ProtoBase to work
with PbAdmin: automatic configuration and manual
configuration. We discuss both methods in this section.
NOTE:
Automatic
Configuration Overview
For OS/2 systems only, start PBSHELL
from an OS/2 window prior to
configuring ProtoBase. You should
include the command start /n pbshell in
your startup script.
Automatic configuration may be used if you have an
existing ProtoBase configuration file, PBCONFIG.CFG,
that you want to convert to the PbAdmin screen interface.
You convert this file to PbAdmin using the executable file,
READCFG. We recommend you use this method if you
want to configure several merchant sites using PbAdmin
the same way (or very similar) from one file. You can use
one version of PBCONFIG.CFG to create multiple
configurations of ProtoBase in PbAdmin format.
On the next page, we describe this method in detail.
Manual
Configuration Overview
Manual configuration may be used to configure the
transaction processors, terminals, credit card tables, and
communication devices right into the ProtoBase
Administrator using the PbAdmin configuration screen
interface. Although this is a manual process, it is still fairly
quick and efficient. The ProtoBase Configuration option
in PbAdmin, like other menu options, has easy-to-use
pop-up lists. You can move the cursor to particular items
and press [ENTER] to select them.
We describe this configuration method in detail beginning
on page 87.
82
08/2000
Backing up the
DB Directory
We strongly suggest that after you have installed and
configured PbAdmin, but before actually using PbAdmin,
you back up the databases in the DB directory. You can
do this by creating a separate directory and saving the
files on the DB directory to the back-up directory.
The files you need to backup are the .IDX and .DAT files
for PBADUSER, PBADLOCA, PBADMAIN, and
PBPACKET.
Do this as a safety measure against any possibilities of
corrupted databases.
When you are sure that PbAdmin is running successfully,
you can delete the back-up directory.
Automatic
Configuration of
ProtoBase
This section explains how to configure the ProtoBase
Administrator with a pre-existing ProtoBase configuration
file (PBCONFIG.CFG).
The PBCONFIG.CFG file is a text file that can be edited
using any standard text editor. For information on how to
edit this file, please refer to the ProtoBase Technical
Reference Guide.
How to Know if
You Are Ready to
Configure
Automatically
If your PBCONFIG.CFG file contains entries in the
Terminal section starting with *** <PbAdmin>***, then the
file is ready to be automatically configured and “read into”
PbAdmin.
If these entries are missing, you will have to manually
configure settlement and backup terminals and terminal
locations.
NOTE: Recent versions of PbAdmin 4.1 produce a
PBCONFIG.LST file with the above entries
included to facilitate the upgrade to
PbAdmin 4.2 or higher.
08/2000
83
Steps to
Automatically
Configure
Complete the following steps to automatically configure
ProtoBase to work with PbAdmin:
1. Follow the steps outlined in this section to configure
your location information.
2. Change to the PbAdmin subdirectory (according to
the path set in the PBDBPATH environment
variable).
NOTE:
If backup terminals were used in the
setup under the old version of
PbAdmin, delete all backup terminals
(ending with “B”) from the
PBCONFIG.CFG file prior to reading it
in the new version.
3. Type the following from the PbAdmin subdirectory:
readcfg [ENTER]
NOTE:
If the location information is not
included with the terminals in the
Terminal section of PBCONFIG.CFG,
you must type the location name
surrounded by quotation marks (“ ”)
after the readcfg command (for example
readcfg “hotel location1” [ENTER]).
The READCFG program checks the PBPATH directory
for an existing PBCONFIG.CFG file. If one is found, it
converts the values in PBCONFIG.CFG into PbAdmin
format. It moves that file to PBCONFIG.LST in the DB
directory (a subdirectory of the PBADMIN directory).
PbAdmin is then set up with the information from the preexisting ProtoBase configuration.
84
08/2000
Activating the
New Values (Run
Configuration)
For PbAdmin to use the new configuration values that
came from running READCFG, you must run ProtoBase
configuration.
NOTE:
Shut down ProtoBase before running
configuration. For DOS/LAN, type pbarb
/u [ENTER]. For all other operating
systems, type pbkill [ENTER].
Use the following instructions to activate the values:
1. Log in to PbAdmin and any location using one of
the login IDs and passwords you have set up.
2. Select Administrator Setup Menu from the Main
Menu.
3. Select ProtoBase Configuration from the
Administrator Setup menu. The following message
appears:
One moment. Loading…
4. Verify the ProtoBase values are correct by viewing
them through the menu options.
•
•
•
•
Select Processors and view the
processors set up. Press [ESC] to exit.
Select Terminals and view the terminals set
up. Press [ESC] to exit.
Select Credit Card Tables and view the
credit cards set up for specific terminals.
Press [ESC] to exit.
Select Devices to view the communication
devices set up. Press [ESC] to exit.
08/2000
85
Activating the
New Values (Run
Configuration)
(cont.)
5. Activate the settings by selecting the Run
Configuration option.
NOTE:
After running the configuration, this
message appears in the report file:
“WARNING: Pbconfig has been forced to
not test version compatibility.”
Disregard this message. These files have
been checked for version compatibility
already by PbAdmin by running the
PBCHKVER program that is included in a
ProtoBase distribution.
After you complete the automatic configuration of
ProtoBase, you are ready to test the Select/Edit
Transactions option from the Main Menu. We describe
how to do this in the How to Use PbAdmin section.
86
08/2000
Manual
Configuration of
ProtoBase
If you have not performed an automatic configuration of
ProtoBase from a pre-existing configuration, you must set
up a ProtoBase configuration before you can run
ProtoBase with PbAdmin. PbAdmin provides an easy-touse screen interface to set up your configuration.
To manually configure, complete the following steps:
1. Start PbAdmin. To do this, change to the PbAdmin
directory if you are not already in it. Then, type
pbadmin and press [ENTER].
2. Log into the system. Use one of the login IDs and
passwords you have set up. For testing purposes,
the built-in login ID is pbadmin and the password
is pbadmin. Type the appropriate login ID and
password and press [ENTER]. The Main Menu
appears as shown below.
Main Menu
08/2000
87
Manual
Configuration of
ProtoBase (cont.)
3. From the main menu, select the Administrator
Setup option. The Administrator Setup submenu
appears as shown below.
Administrator Setup Menu
NOTE: Earlier in this section, we describe the
other options shown on this submenu for
setting up the ProtoBase Administrator.
4. To access the ProtoBase Configuration screen
interface, select the ProtoBase Configuration
option from this submenu.
When selected, the message “One Moment.
Loading…” displays while the configuration program
loads.
88
08/2000
Manual
Configuration of
ProtoBase (cont.)
The ProtoBase Configuration submenu appears as shown
below.
ProtoBase Configuration Menu
The ProtoBase Configuration submenu contains options
to build and configure the ProtoBase file PBCONFIG.LST.
The primary areas to configure are as follows:
•
•
•
•
Processors
Terminals
Credit Card Tables
Devices
We describe each of these areas in detail beginning on
the next page.
NOTE:
Any changes made during this manual
configuration process will not take effect
until you select the Run Configuration
option and the configuration runs
successfully.
08/2000
89
Processors
The Processors portion enables you to configure various
transaction processor information. This includes primary
and secondary phone numbers, baud rates, data bits, and
parity for transaction processors to be used for
authorization and settlement.
To begin this process, select Processors from the
ProtoBase Configuration submenu.
If One or More
Processors
Already
Configured and
You Want to Edit
If you have configured one or more processors already, a
list appears showing those processors. We show a
sample below.
Processor List Screen
You can select the one you want to edit by highlighting it
and pressing [ENTER]. The Processor Edit Screen
appears with the transaction processor information filled
in. We show a sample on page 92.
90
08/2000
Processors (cont.)
If No Processors
Configured Yet
If you want to add a new processor, press [F3]. A generic,
partially completed Processor Edit Screen appears with
default values filled in for some fields. A pop-up list of
available processors and corresponding SofTrans module
numbers also appears. We show a sample below.
If you have not configured any processors, a generic,
partially completed Processor Edit Screen automatically
appears with a pop-up list of available processors and
SofTrans module numbers (e.g., VisaNet CPS (088) ).
We show a sample below.
Processor Edit/Processors Screen
Select a Processor by highlighting it and pressing
[ENTER]. The pop-up list disappears. The Processor
Edit Screen now appears with the Processor you selected
showing in the Processor Name screen field at the top.
08/2000
91
If No Processors
Configured Yet
(cont.)
We show a sample of the Processor Edit Screen below
for VisaNet CPS (088) with the default values already
filled in.
Make the appropriate edits on this screen.
appears.
Press [ESC] to exit the Processor Edit Screen. This
brings you back to the Processor List screen that lists all
of your current processors.
If you are satisfied with all changes, press [ESC] again.
This brings you back to the ProtoBase Configuration
submenu.
To edit a different processor, press [ENTER] on the
appropriate processor and complete the edits needed.
When finished, press [F10] to save and [ESC] to exit.
You are now ready to configure the Terminals portion of
the ProtoBase configuration. We explain how to do this
on the next page.
Processor Edit Screen
92
08/2000
Terminals
The Terminals portion of the ProtoBase configuration
enables you to configure various terminal names.
Terminals may represent individual or associated groups
of POS work stations, electronic cash registers, locations,
or PCs. Each terminal entry consists of the valid credit
card (and other payment) types and the third-party
transaction processor(s) through which each type will be
authorized and settled.
One physical terminal may have several terminal ID’s. For
example, Terminal 1 is configured to accept Visa and
MasterCard, Terminal 2 is configured to accept Debit
cards, and Terminal 3 is configured to accept checks.
Terminals 1, 2, and 3 are one physical terminal, but are
configured as three separate terminals for reporting and
authorizing purposes.
You link the terminals named here with specific payment
types (e.g., credit cards) and processors using the Credit
Card Tables option from the ProtoBase Configuration
submenu. We describe Credit Card Tables on page 96.
To set up or edit your terminals, select Terminals from the
If One or More
Terminals Already
Configured and
You Want to Edit
If you have configured one or more terminals already, a
Terminal List screen appears listing the terminals you
have configured. We show a sample below.
Terminal List Screen
08/2000
93
Terminals (cont.)
You can select the terminal you want to edit by highlighting
it and pressing [ENTER]. The Terminal Edit Screen
appears showing the location applicable to this terminal
name. We show a sample below.
Terminal Edit Screen
Press [F2] to view all of the locations available to be set
up with this terminal. If you want to change the terminal’s
location, you may do so here. This screen enables you to
tie terminals to specific locations that have been set up in
the Location Information screen.
If One or More
Terminals Already
Configured and
You Want to Add a
Terminal
If you want to add a new terminal, press [F3] from the
Terminal List screen. A blank Terminal Edit Screen
appears showing the location you are logged into. You
can complete the screen and press [F10] to save.
If No Terminals
Configured Yet
If you have not configured any terminals, a blank Terminal
Edit Screen automatically appears showing the location
you are logged into.
94
08/2000
If You Want to
Create a
Settlement Group
A settlement group enables you to settle multiple Terminal
IDs in the same batch file. If you want to tie this Terminal
ID with other Terminal IDs in the same group, type the
name of the settlement group here. This should not be
used unless the transaction processor supports multimerchant settlement. Otherwise, leave this field blank.
Making Edits on
this Screen
Make the appropriate edits on this screen, including the
Terminal ID field and the Settlement Group field, as
applicable.
appears.
Press [ESC] to exit the Terminal Edit Screen. This brings
you back to the Terminal List screen that lists all of your
current terminals.
submenu.
If you want to edit a different terminal, press [ENTER] on
the appropriate terminal and complete the edits needed.
When you are done, press [F10] to save and [ESC] to
exit.
You are now ready to configure the Credit Cards (and
other Payment types) portion of the ProtoBase
configuration. We explain how to do this beginning on the
next page.
08/2000
95
Credit Card
Tables
The Credit Card Tables portion of the ProtoBase
configuration enables you to assign the various credit
cards and other payment types for a specific terminal.
Using the Add/Edit functions, you tie the Terminal IDs you
have set up in the Terminal portion to specific payment
types with the transaction processors for authorization and
settlement, by card type.
To set up or edit your credit cards and other payment
types, select Credit Card Tables from the ProtoBase
Configuration submenu.
If One or More
Credit Cards
Already
Configured and
You Want to Add
or Edit
If you have configured one or more credit cards or other
payment types already, a Terminal List screen appears
listing the terminals tied to those credit cards. We show a
sample below.
96
08/2000
If One or More
Credit Cards
Already
Configured and
You Want to Add
or Edit (cont.)
You can select the terminal you want to edit by highlighting
it and pressing [ENTER]. The Edit Credit Card Table
screen appears showing the credit cards and other
payment types configured. A check mark indicates which
payment types are selected for that terminal.
Edit Credit Card Table Screen
To select a credit card or other payment type (e.g., check,
debit), press the space bar to place a check mark next to
each payment type you want to accept for this terminal. A
total of 24 card ranges are configurable per terminal.
NOTE:
To function properly, checks and debit
cards must be setup by themselves on
separate terminals, and not on the same
Terminal ID with credit card types.
To edit the processor and card information tied to a
payment type, use the arrow keys to move the cursor next
to that payment type and press [F3]. The Add/Edit Credit
Cards screen appears. We show a sample and describe
the screen on page 137 of this section.
08/2000
97
If One or More
Credit Cards
Already
Configured and
You Want to Add
or Edit (cont.)
To add a new payment type, move the cursor next to a
blank card type and press [F3]. Enter the appropriate
processor and card information in the Add/Edit Credit
Cards screen.
If No Credit Cards
Configured Yet
If you have not configured any credit cards or other
payment types yet, a Terminal List screen appears listing
the available terminals (same as if you have credit cards
configured already). We show a sample below.
Other function key options on the Edit Credit Card Table
screen are [F1] (help), [F8] (delete this terminal), [F10]
(save changes), and [ESC] (exit).
When you select a terminal, the Edit Credit Card Table
screen appears as described earlier.
Follow the above instructions for adding new payment
types.
98
08/2000
Add/Edit Credit
Cards Screen
You access this screen by pressing [F3] from the Edit
Credit Card Table screen.
made. This exits you back to the Edit Credit Card Table
screen. Press [F10] again to save all changes in the
Credit Card portion of the ProtoBase Configuration. The
message “Changes have been saved” appears.
Press [ESC] to exit the Edit Credit Card Table screen.
This brings you back to the Terminal List screen that lists
all of your current terminals.
submenu.
If you want to edit a different terminal, press [ENTER] on
the appropriate terminal and complete the edits needed.
exit.
You are now ready to configure the Devices portion of the
ProtoBase configuration. We explain how to do this
beginning on the next page.
Add/Edit Credit Cards Screen
08/2000
99
Devices
The Devices portion of the ProtoBase configuration
enables you to configure various communication devices
to work with ProtoBase.
To set up or edit your devices, select Devices from the
If One or More
Devices Already
Configured and
You Want to Add
or Edit
If you have configured one or more devices already, a
Device List screen appears listing the devices already
configured. We show a sample below.
Device List Screen
You can select the device you want to edit by highlighting it
and pressing [ENTER]. To add a device, press [F3]. The
Device Edit Screen appears. We show a sample on the
next page.
If No Devices
Configured Yet
100
If you have not configured any devices, a Device Edit
Screen automatically appears showing particular default
information.
08/2000
Device Edit Screen
appears.
Press [ESC] to exit the Device Edit Screen. This brings
you back to the Device List screen that lists all of your
current devices.
submenu.
If you want to edit a different device, press [ENTER] on
the appropriate device and complete the edits needed.
exit.
Device Edit Screen
You are now ready to run configuration to include all
changes you have made to all portions of the ProtoBase
Configuration. We explain how to do this beginning on the
next page.
08/2000
101
Run
Configuration
The Run Configuration option on the ProtoBase
Configuration menu initiates actual reconfiguration of
ProtoBase. It includes all edits made to all portions of the
ProtoBase Configuration (Processors, Terminals, Credit
Card Tables, and Devices).
NOTE 1: Shut down ProtoBase before running
configuration.
NOTE 2:You must perform the Run Configuration
option whenever you make edits to your
ProtoBase configuration.
To run the configuration, select Run Configuration from
the ProtoBase Configuration submenu as shown below.
Upon selection, PbAdmin first checks to see if a
PBCONFIG.CFG file already exists.
If the file PBCONFIG.CFG already exists in the ProtoBase
directory, an overwrite warning displays. If you are unsure
whether you want to delete the existing PBCONFIG.CFG
file, you may exit here and not run the configuration.
102
08/2000
Run Configuration
(cont.)
If there is no PBCONFIG.CFG found or you continue
through the overwrite warning, PbAdmin runs the
configuration. The existing PBCONFIG.CFG file is
deleted, replaced by PBCONFIG.LST. The .LST file is a
text version of the information that appears in the
ProtoBase Configuration screens in PbAdmin.
As the configuration is running, a Status Window screen
appears showing the configuration progress. When
completed, the Status Window displays the following:
Status Window Screen
Press any key. PbAdmin returns you to the ProtoBase
Configuration submenu. The message “Restart
ProtoBase to activate new settings” displays to
remind you that you must restart ProtoBase for the new
configuration settings to take effect.
08/2000
103
Run Configuration
(cont.)
Press any key again to display the configuration settings.
We show a sample below.
Configuration Settings Report
Run Configuration
(cont.)
This display shows the basic data elements configured for
each configuration section (Card Types, Terminals,
Devices, Processors). For a more detailed configuration
listing, use the Print Configuration option from the
ProtoBase Configuration submenu. We describe this
option on page 89.
NOTE:
After running the configuration, this
message appears in the report file:
“WARNING: Pbconfig has been forced to
not test version compatibility.”
Disregard this message. These files have
been checked automatically by PbAdmin
by running the PBCHKVER program that
comes with ProtoBase. Please refer to the
ProtoBase User Guide for more
information.
104
08/2000
Run Configuration
(cont.)
Use the [Page Up] and [Page Down] keys to scroll
quickly through this display.
You may print this display by pressing the [F7] (Print) key.
To save this display as a text file, press the [F10] (Save
as) key. PbAdmin prompts you to save as a specific
filename. The default directory path is the DB
subdirectory under your PbAdmin main directory. The
default filename is PBADMIN.rpt.
To exit this display, press the [ESC] key.
NOTE: Once PbAdmin has been installed and is
running, you can no longer run the
ProtoBase executable PBCONFIG.
Instead, all changes to configuration
must be done using the PbAdmin screen
interface.
08/2000
105
Print
Configuration
To print a detailed ProtoBase configuration, select Print
Configuration from the ProtoBase Configuration
submenu. We show a sample below.
This is the PBCONFIG.LST file found in the DB directory
under PBADMIN, in PBCONFIG.CFG format.
Print Configuration Report
This display shows the detailed data elements configured
for each configuration section (Card Types, Terminals,
Devices, Processors).
Use the [Page Up] and [Page Down] keys to scroll
quickly through this display.
You may print this display by pressing the [F7] (Print) key.
To save this display as a text file, press the [F10] (Save
as) key. PbAdmin prompts you to save as a specific
filename. The default directory path is the DB
subdirectory under your PbAdmin main directory. The
default filename is PBADMIN.rpt.
To exit this display, press the [ESC] key.
You are now ready to run test transactions.
106
08/2000
Running Test
Transactions
Using PBFE
When you have completed setting up and configuring the
ProtoBase Administrator, run several test transactions
through PBFE, the ProtoBase front end program for
PbAdmin. We describe how to do this below.
How to Run Test
Transactions
Using PBFE
To run test transactions using PBFE, complete the
following procedures:
1. Exit out of the ProtoBase Administrator. Use the
[ESC] key to exit out of most screens and menus.
From the Main Menu, press [F10] or “E” to exit to
your command prompt.
2. Change to the directory that contains PBFE.EXE,
the PbAdmin front end executable program. This
must be located under your main ProtoBase
directory.
3. Prepare various test transactions. Use a text editor
to edit the sample transaction file, PBSALE.IN,
included with your ProtoBase distribution.
A transaction is generally transmitted via a text file
that provides the PBFE program the necessary
information to run a transaction. It contains a
vertical series of field numbers and corresponding
values, separated by a comma. The number to the
left of each comma indicates the field number. The
value to the right of each comma indicates the
value for this field.
08/2000
107
How to Run Test
Transactions
Using PBFE
(cont.)
The following is a sample Sale transaction:
1,2
2,1.00
3,%B4012888888881881^NUMBER/TEST
^99121010000019301000000498000000?;40128
88888881881=9608101193010498498?
6,000000
7,43215678
105,.\
106,.\
109,TERM42
110,SOMEONE
NOTE:
For fields 105 and 106 above, UNIX
systems require a forward slash (/).
In this sample, the first entry (1,2) indicates Field 1
(Transaction type) has a value of 2 (indicating
Sale). The next entry (2,1.00) indicates Field 2
(Transaction amount) has a value of $1.00. For a
description of all fields available, refer to the
You can also build other sample input files. Make
sure you build several transaction types, applicable
to the appropriate industry.
4. Start ProtoBase in demonstration (i.e., noncommunicating) mode. This varies per operating
system. Type the following from the command
prompt of the main ProtoBase directory:
DOS:
pbarb /mmain /s1 /v /o
Windows NT/95 or OS/2:
start pbdirect . -d
UNIX:
pbdirect . -qd&
For more details on starting ProtoBase, please
refer to the ProtoBase User Guide.
108
08/2000
How to Run Test
Transactions
Using PBFE
(cont.)
5. Run the various test transactions you have built.
You may want to build a batch file (such as
PBSALE.BAT) that contains more than one
transaction. To run the transaction(s) contained in
the file PBSALE.IN, type the following at the
command prompt:
pbfe -ipbsale.in [-opbsale.out] [ENTER]
pbsale.in is the name of the input file and
pbsale.out is the name of the output file. If you do
not enter an output file name,
the default name is PBSALE.OUT.
6. View the output file for each of these transactions to
verify that the transactions completed successfully.
To do this, type TYPE (for DOS, Windows, or
OS/2) or CAT (for UNIX) and the output filename at
the command prompt and press [ENTER]. If the
transaction was successful, Field 1010 should
contain the message COMPLETE.
7. View the transactions that were successful in the
ProtoBase Administrator data base. You can do
this by logging into PbAdmin and selecting
Select/Edit Transactions from the Main Menu.
The transactions that were successful appear on
the Select/View/Edit Transactions screen. We
describe how to use this screen in the section How
to Use PbAdmin.
8. Run some test transactions through the POS
system to make sure that transactions are being
accepted and stored in the database.
When you are satisfied that you have set up PbAdmin
correctly, you can begin using PbAdmin to perform its
daily functions. The How to Use PbAdmin section
describes the functions for the operation and use of the
ProtoBase Administrator.
08/2000
109
ProtoBase Administrator User Guide - Version 4.3.002 - Technical Reference

ProtoBase
Administrator
Version 4.3.002
User Guide
IV. Technical Reference
110
08/2000
PbAdmin
Technical
Reference
Guide
The PbAdmin Technical Reference Guide documents
detailed technical information, including screen fields and
files/programs, that may be needed by integrators,
installers, and end-users of PbAdmin. It does not provide
step-by-step instructions on how to install or use this
program; however, this information is covered in detail in
the Installation and Setup and How to Use PbAdmin
sections, respectively.
You may need to use this section to look up technical
information related to integration, installation/set-up,
troubleshooting, and specific use of PbAdmin.
The following are the technical aspects of PbAdmin
covered in this section:
•
Description of every screen field
•
Report descriptions and samples
•
Transaction and Administrator logs
•
PbAdmin file and program descriptions
08/2000
111
Global and Local
INI File Screens
- Field Names
and Descriptions
The following describes the information on the Global INI
File screen and the Local INI File screen. In addition to
describing the screen fields, the Description column
indicates the default values for screen fields, when
applicable.
To access either screen, choose the Administrator Setup
Menu from the Main Menu. Then choose the Global INI
File option (for the global file) or the Local INI File option
(for the local file).
Global INI File Screen (PBFE.INI)
Local INI File Screen (PBADMIN.INI)
112
08/2000
When You Would
Use the Local INI
File Screen
(PBADMIN.INI)
The Local INI File screen corresponds to the file
PBADMIN.INI. Use this file to set up a local version of
PbAdmin with different INI settings on a particular
computer. This screen overrides the values in the Global
INI File screen. The PBADMIN.INI file also contains the
path to the PBFE.INI file, which is important when the
PBFE and PBADMIN directories are different. Programs
use the INI files to locate the PBFE directory.
Description Table
The following describes the fields on the Global and Local
INI File screens. For non-UNIX systems, the paths listed in
the following table must include the drive designator (e.g.,
C:\).
Global INI and Local INI
Screens
Field Name
ProtoBase Path
Description
Full path to ProtoBase executable directory. Defaults to the value set
in PBPATH during initial setup.
Required for the Global INI screen.
ProtoBase Data Path
Full path to ProtoBase data directory. Defaults to the value set in
PBPATH during initial setup. This path can be set to allow loading of
files from a faster local drive.
ProtoBase Executables Path
Full path to ProtoBase executable directory. Defaults to the value set
PBFE Executables Path
Full path to the PBFE executable directory. Defaults to the value set
ProtoBase Administrator Path
Full path to the base ProtoBase Administrator directory. Defaults to
the value set in PBDBPATH during initial setup.
This field is required for the Global INI screen.
08/2000
113
PBADMIN Executables Path
Full path to the base ProtoBase Administrator directory. Defaults to
the value set in PBDBPATH during initial setup. This path can be set
to allow loading of files from a faster local drive.
Optional Gateway File Path
Full path to the directory where the File Gateway is located. The path
is where the File Server Gateway picks up files if PbAdmin will be
required to use the Gateway during settlement or to run reports. Files
not transferred through the gateway within 30 seconds would indicate
an error in gateway operation. This is only used for special
implementations of PbAdmin and requires additional software. Set
“None” on the Local INI screen to override the Global INI. Refer to the
Integration section for more details about the File Gateway.
Optional Internal File Viewer
Defines the viewer program to replace the default viewer. Optional.
Leave blank to use the default viewer.
Set “NONE” on the Local INI screen to override the Global INI.
Optional System Command
Path to point to operating system shell command or other command
to be executed from the setup menu. Optional.
Set “NONE” on the Local INI File screen to override the Global INI.
On the Local INI File screen, the next four fields contain the option
“Override Global?”. “Yes” indicates that the value should override the
Global INI file. Defaults to “No”.
Backup Database before Deposit
This field determines if a backup of the database files is to be made
prior to settlement. If a backup is made, the copies are stored in the
DBHST directory.
Corresponds to the environment variable PBBACKUP.
Post Reversal Delay (seconds)
This determines the number of seconds to wait before starting
settlement after the last reversal transaction is run. This allows the
multitran timer to hang up the modem before initiating settlement.
Default value is 10.
Corresponds to the environment variable PBSETDEL.
114
08/2000
Global INI and Local INI
Screens
Field Name
Use DOS ProtoBase
Description
For OS/2 and Windows NT/95 systems. If set to “Yes”, PbAdmin will
call DOS ProtoBase instead of the native version when using a 32 bit
system to run transactions or settlement on a DOS installation.
Corresponds to the environment variable PBOS.
Debug Level (0=Off, 4=Max)
This field should be set to 0. It should only be set to 4 temporarily for
troubleshooting purposes.
Corresponds to the environment variable DBLEVEL.
Function Keys:
Help=[F1]
Press the [F1] key to display help information for the current field.
Save=[F10]
Press the [F10] key to save the changes you have made to the screen
fields.
Exit=[Esc]
Press the [ESC] key to exit the screen. (UNIX users have to press
[ESC] twice to exit.)
NOTE:
No changes will be saved if you escape out of this
screen without pressing [F10].
08/2000
115
Location
Information
Screen
- Field Names and
Descriptions
The following describes the information on the Location
Information screen.
To access this screen, choose the Administrator Setup
Menu from the Main Menu. Then choose the Location
Information option.
Enter the information you want to add or edit.
Field Name
Location Name
Description
Name of this location. This can be the name of an individual merchant
location or separate POS station within one merchant location.
If you are modifying an existing location, the Location Name field
cannot be edited.
If you are entering a new location, you can enter the new Location
Name here. (You can only add or delete locations when logged in as
a master user. For more information, refer to the Installation and
Setup section.)
116
08/2000
Field Name
Description
Address
City
State/Province
Phone
Zip/Postal
This is the specific address and phone number information for this
particular location.
Printer Destination
Identifies the printer port. For non-UNIX systems, press the [F2] key
for a choice list. For UNIX systems, the printer destination must be
entered manually.
Printer Type
Choice list field of base printer type to use when printing. Press the
[F2] key for a choice list.
If none of the supported printer types work with your printer, contact
SDC Client Services to configure a new printer type.
Printer Locale
(For UNIX Systems only) Choose Local for a local printer or Remote
for a remote print server.
Default Select/Edit Display
This determines what transactions will display on the Select/View/Edit
Transactions screen.
Press [F2] for a choice list. Valid values are:
Settlement = Display only settleable transactions
Auth Only = Display only Authorization Only
Transactions
All
= Display all transactions (default value)
Banner Setting
Indicates whether a banner is to be used for print jobs. Press the [F2]
key for a choice list. Valid values are:
No Banner
Use Banner
This field displays and is only applicable to UNIX-based systems.
08/2000
117
Field Name
Default Report Mode
Description
This determines what transactions to include when generating reports
from the current transaction database.
All
= Report all transactions
Selected = Report all transactions selected on the
Pre-settle = Report all transactions selected on the
Select/View/Edit Transactions screen, excluding the
Authorization Only transactions
Duplicates Allowed
Indicates whether to allow duplicate transactions in the transaction
database. PbAdmin considers transactions duplicates if they have
the same reference number, account number, and dollar amount.
No = Does not allow duplicates; enables duplicate
checking (default)
Yes = Allows duplicates; disables duplicate checking
This field should be set to Yes for testing, and normally No for live
transactions (unless there is a possibility that you will send up valid
duplicate transactions).
Press the space bar to toggle between No and Yes.
Log File Base Name
Filename for the logs created by PbAdmin for this location. Users
may want a different log filename for each location. However, for
multi-merchant settlement, the names must be the same for all
locations. These files are stored in the DB subdirectory. The default
base name is PBADMIN. The default log filenames are as follows:
PBADMIN.STL - Settlement log
PBADMIN.TRN - PBFE Transaction log
PBADMIN.LOG - PbAdmin system log
118
08/2000
Field Name
Description
Settlement Directory Name
Name for the subdirectory where settlement files are located. Each
location must have a unique settlement directory name to
perform settlements at separate locations concurrently.
However, for multi-merchant settlement, the names must be the
same for all locations.
Business End-of-Day
This is the time of day, in military time, that this location officially
ends its business day. This determines the “business date”, which
affects the selection and reporting of transactions. The business date
equals the current system date until the time of day reaches this time;
the business date then switches to the next day.
For example, the Business End-of-Day time is set to 22:00 (10:00
p.m.). The current system date is Tuesday. The “business date”
would be considered “Tuesday” from 10:01 p.m. Monday until 10:00
p.m. Tuesday. At 10:01 Tuesday, the “business date” switches to
Wednesday.
If the Business End-of-Day is set prior to noon, the business date will
default to the actual transaction date.
If you do not want to use the Business End-of-Day option, set the
value to 00:00.
This screen field does not affect the actual transaction date, which
always matches the current system date.
Days to Keep Auths
This is the minimum number of days Authorization Only transactions
must be retained before they can be purged. Valid range is from 10 to
999 days. The default is 100 days.
You can purge authorizations from the Database Management menu.
Days to Keep Logs
Number of days of previous entries to retain in the various logs when a
purge is run. The minimum number is 10 days. Any log entries older
than the number of days shown here will be purged when you select
that option from the Database Management menu.
08/2000
119
Field Name
Enable Auto Dial Backup
Description
Indicates whether to automatically configure ProtoBase to switch to
an alternate terminal in the event of a communications failure. This is
mainly used for a dial backup if the primary line is a leased line, other
direct line, or a network connection.
No = Do not create dial backup terminals (default)
Yes = Create dial backup terminals
Press the space bar to toggle between No and Yes.
Industry
The industry for this location. This entry defines the field required in
the transaction record and specific industry field information.
If this is the base location tied to all locations, choose MASTER
LOCATION for the industry.
NOTE:
Running a transaction for the Master Location will
result in an error.
If this merchant/location is not tied to a particular industry, choose
Generic for the industry.
Press [F2] for a choice list. The list includes these options:
Generic
Restaurant
Retail
Rental Car
Lodging/Front Desk
Lodging/Restaurant
Lodging/Retail
Direct Marketing
MASTER LOCATION
Batch Number for Next Batch
120
This is the sequential number identifying the next batch for this
location. This can be edited from this screen. This always starts at a
value of 1.
08/2000
Field Name
Authorization Tolerance (CPS)
Description
Percentage a Prior-Authorized Sale transaction (type 07) can vary
from the corresponding original Authorization Only (type 01) without
either returning an error or having to run an Incremental Authorization
(type 75) or Authorization Reversal (type 76).
If this value is set to 100, PbAdmin will not validate the
tolerance on a Prior Authorization.
NOTE:
If set to 100, Reversals and Incremental Auths must
be run manually to comply with CPS regulations.
For the Car Rental and Lodging industries, this field should equal 15.
For the Restaurant industry, this field should equal 20.
For all other industries, this field should equal 0.
Settle American Express Direct
Indicates whether this system is using SDC’s American Express
Direct Settlement Utility to settle American Express transactions
directly. This utility enables authorization and settlement directly to
American Express, using SofTrans module #40.
No = No, not using American Express utility (default)
Yes = Yes, using American Express utility
Press the [SPACE] bar to toggle between values.
Auto Authorize Difference
Flag indicating whether PbAdmin automatically initiates an
Incremental Authorization (type 75) for the difference between the
original authorized amount and final dollar amount of a transaction.
Valid values are:
No = Do not initiate Incremental Auth (default)
Yes = Initiate Incremental Auth if the difference is greater
than the Authorization Tolerance percentage
defined in the screen field above
08/2000
121
Field Name
Will Host Auto-Close Batch
Description
Applicable to host capture transaction processors only. Indicates
whether a host capture transaction processor is set up to
automatically settle batches that are open at the host (i.e., set up for
auto close).
When the Deposit Transactions option is run (described in the How to
Use PbAdmin section), this field indicates the following:
No = Settle normally. Transactions will be moved to history after a
successful settlement. This is the default value.
Yes = Transactions will go directly to history without dialing the host.
NOTE:
If this field is set for a non-host processor, or if the
processor is not set up to auto-clear, the transaction
will move to history, but will not be settled.
American Express Pending
Indicates whether an American Express settlement has been
uploaded and is waiting for confirmation. Valid values are:
No = No American Express confirmation is pending
Yes = American Express confirmation is pending
This field is normally for display purposes only. However, you can edit
this field by pressing [SHIFT]+[F3].
NOTE:
Settlement In Progress
To verify the batch has been processed by American
Express, confirmation must be received.
Indicates whether a settlement is in progress. Valid values are:
No = No settlement is in progress
Yes = Settlement is in progress
This field is normally for display purposes only. However, you can edit
this field by pressing [SHIFT]+[F3]. This is needed when a settlement
doesn’t terminate normally, and this field still equals Yes. Set back to
“No” to re-try the settlement.
122
08/2000
Field Name
Description
Function Keys:
Help=[F1]
Toggle=[Space]
Press the space bar to toggle between No and Yes responses
(applicable fields only).
Choices=[F2]
Press the [F2] key to display a list of available choices.
Delete=[F8]
Press the [F8] key on any field to delete the entire location. PbAdmin
prompts you before the location is deleted. A location cannot be
deleted if transactions are present. If you accidentally press this key,
you can press [ESC] to exit the delete function.
NOTE: You must be logged in as a Master User to add or
delete locations.
Save=[F10]
Press the [F10] key when you are ready to save the changes you
have made to the screen fields.
Exit=[ESC]
Press the [ESC] key to exit the screen.
08/2000
123
User Security
Screen
- Field Names and
Descriptions
The following describes the information on the User
Security screen.
Menu from the Main Menu. Then select the User Security
option, and choose the appropriate user from the list.
Make the appropriate edits on this screen. Use the space
bar to toggle between Yes and No responses.
User Security Screen Field
Name
Description
Name
Single user name or group description of users using this login. For
the sample location TEST LOCATION, this defaults to pbadmin when
you first install PbAdmin.
Login
Login ID for this name. Maximum number of characters is ten;
minimum is one character. For the sample Test Location, this is
pbadmin. This field is case sensitive.
Password
Password for this Login ID. It can be any combination of
characters/numbers. It does not display on the screen during entry.
Maximum number of characters is 10, minimum is one character. For
the sample Test Location, this is pbadmin. This field is case
sensitive.
124
08/2000
Name
Verify
Description
Password entered again to verify it was typed correctly.
Select Transactions:
General
Indicates whether user has access to the Select/View/Edit
Transactions function from the Main Menu.
Detail
Indicates whether user has access to the Transaction Detail function
[F6] from the Select/View/Edit Transactions screen.
Modify
Indicates whether user has access to the Add, Modify, or Delete
functions from the Select/View/Edit Transactions screen.
Use the space bar to toggle between Yes and No.
Indicates whether user has access to the Deposit Transactions
function from the Main Menu.
View Deposit Log
Indicates whether user has access to the View Deposit Log function
from the Main Menu.
DataBase File Mgmnt.
Indicates whether user has access to the Database Management
menu from the Main Menu.
History:
Search
Indicates whether user has access to the Transaction History Search
function from the Transaction History Menu (from the Main Menu).
Transfer
Indicates whether user has the ability to copy transactions from
history to the current working database.
Reports
Indicates whether user has access to any of the reports on the
Transaction History Menu (from the Main Menu).
08/2000
125
Name
General Setup
Description
Indicates whether user has access to the INI File Setup screen from
the Administrator Setup Menu (from the Main Menu).
Location Setup
Indicates whether user has access to the Location Information screen
from the Administrator Setup Menu (from the Main Menu).
User Security
Indicates whether user has access to the User Security screen from
the Administrator Setup Menu (from the Main Menu).
Print Configuration
Indicates whether user has access to the Print Configuration function
from the Administrator Setup Menu (from the Main Menu).
ProtoBase Config.
Indicates whether user has access to the ProtoBase Configuration
submenu from the Administrator Setup Menu (from the Main Menu).
Function Keys:
All Yes=[Shift]+[F3]
Press the [Shift] and [F3] keys together. Allows users to toggle
between all of the defaults at once.
Help=[F1]
Rpts=[F6]
Press the [F6] key to enter the Reports Security screen. We
describe this screen on the next page.
Del=[F8]
Press the [F8] key on any field to delete the entire User Login.
PbAdmin prompts you before the User is deleted. If you accidentally
press this key, you can press [ESC] to exit the delete function.
Save=[F10]
Exit=[ESC]
Press the [ESC] key to exit the screen. This returns you to the
Administrator Setup menu.
126
08/2000
Reports Security
Screen
- Field Names and
Descriptions
The following describes the information on the Reports
Security screen. We describe how to run the reports in the
How to Use PbAdmin section.
To access this screen, press [F6] from the User Security
screen.
Report Security Screen Field
Name
Description
Cashier Report Summary
Indicates whether user has access to the Cashier Summary Report.
Detail
Indicates whether user has access to the Cashier Detail Report. This
report includes the customer’s card number.
Extended
Indicates whether user has access to the Cashier Extended Report.
This report includes both industry data and card data.
NOTE:
For the restaurant industry, the term “Cashier” is
replaced by the term “Server”.
08/2000
127
Name
Description
Terminal Report Summary
Indicates whether user has access to the Terminal Summary Report.
Detail
Indicates whether user has access to the Terminal Detail Report. This
Extended
Indicates whether user has access to the Terminal Extended Report.
This report includes industry data and card data.
Card Type Report Summary
Indicates whether user has access to the Card Type Summary
Report.
Detail
Indicates whether user has access to the Card Detail Report. This
Merch Key Report Summary
Indicates whether user has access to the Merchant Key Summary
Report.
Detail
Indicates whether user has access to the Merchant Key Detail Report.
This report includes the customer’s card number.
Deposit Status Report
Indicates whether user has access to the Deposit Status Report.
Auth Date & Time Report
Indicates whether user has access to the Authorization Date & Time
Report.
128
08/2000
Name
Incremental Auth Report
Description
Indicates whether user has access to the Incremental Authorization
Report.
Server Tip Report
For restaurant locations only. Indicates whether user has access to
the Server Tip Report.
Function Keys:
Help=[F1]
Toggle=[SPACE]
Press the space bar to toggle between No and Yes responses.
All Yes=[Shift+F3]
Press [Shift]+[F3] at the same time to change all Yes/No responses
to Yes. This is the easiest way to allow access to all reporting
features of PbAdmin to this user.
If you are adding the initial user for a location, all “Yes/No” fields will
automatically default to Yes.
Back=[ESC]
Press the [ESC] key to exit this screen and return back to the User
Security screen.
Save=[F10]
08/2000
129
Processor Edit
Screen
- Field Names and
Descriptions
The following describes the information on the Processor
Edit Screen. It indicates the default values for screen
fields, when applicable.
Menu from the Main Menu. Then select the ProtoBase
Configuration option. Choose the Processors option
and select the appropriate processor.
130
08/2000
Processor Edit Screen Field
Name
Processor Name
Description
This is the transaction processor and SofTrans module associated
with this set of screen information.
The name of the processor is abbreviated.
If CPS appears with the name, this SofTrans module is CPScompliant.
The three-digit number in parenthesis (e.g., 088) indicates the
SofTrans module number. Some transaction processors may have
more than one SofTrans module associated with it.
Modem Type
The general classification of modem that the merchant is using to
connect to the host computer.
The default value is “Hayes” (for “Hayes Asynchronous”). For DOSbased systems, this is the only valid value. For all other operating
systems, the other valid value is “Synchronous”.
Authorization Primary
The seven fields associated with the Authorization Primary heading
describe the primary connection made for Authorization-type
transactions. These descriptions are the same for Authorization
Primary, Authorization Secondary, Settlement Primary, and
Settlement Secondary. Therefore, we describe them only once.
Attempts
Number of times ProtoBase will try this phone number before
attempting the corresponding secondary number or returning an error.
A high number in this field may cause extremely long transaction
times when the host connection is down.
The default value is 1. This field length is one digit.
08/2000
131
Name
Baud
Description
The rate of speed, in bits-per-second (bps), at which ProtoBase will
communicate with this transaction processor. This value cannot be
set greater than the maximum baud rate of the host computer’s
device.
0, 300, 1200, 2400, 4800, 9600, 19200, 38400
The default value is 1200.
If the Processor name is Amex Direct Stl (American Express
Settlement #40), the Baud must equal 9600.
Data Bits
The number of data bits required for communication with this
transaction processor. The default value is 7, the most common
value. (This is the “7” of “7E1”.)
Press [F2] for a choice list. Valid values are 6, 7, or 8.
American Express requires a value of 8.
Stop Bits
The number of stop bits required for communication with this
transaction processor. The default value is 1, the most common
value. (This is the “1” of “7E1”.)
Press [F2] for a choice list. Valid values are 1 or 2.
Parity
The parity required for communication with this transaction processor.
The default value is Even, the most common value. (This is the “E” of
“7E1”.)
Press [F2] for a choice list. Valid values are Even, Odd, None, Spac
(Space), or Mix (Mixed).
American Express requires a value of None.
Phone No.
The phone number used to dial to connect to this transaction
processor.
NOTE:
132
For UDP/IP or TCP/IP, this is the Internet Protocol
(IP) address used to connect to the transaction
processor.
08/2000
Name
Description
Login File
Filename containing a log-in script for communicating with the
transaction processor. This field is not used by all transaction
processors. Some processors require a special login procedure
based on geographical location and customer setup. It is part of the
SofTrans distribution, if required by the processor. Maximum of 12
characters.
Authorization Secondary
The seven fields associated with the Authorization Secondary heading
describe the secondary connection for Authorization-type
transactions. This is considered the “back-up” line for Authorizationtype transactions if the primary line does not function properly. (This
is not the same as the Dial Backup Terminal.)
(same fields as Authorization
Primary)
Settlement Primary
The seven fields associated with the Settlement Primary heading
describe the primary connection for Settlement-type transactions.
Primary)
Settlement Secondary
Primary)
The seven fields associated with the Settlement Secondary heading
describe the secondary connection for Settlement-type transactions.
This is considered the “back-up” line for Settlement-type transactions
if the primary line does not function properly. This is not the same as
the Dial Backup Terminal.
Function Keys:
Help=[F1]
Select=[ENTER]
Press [ENTER] to select the value displayed in the field the cursor is
on. You may edit the default value displayed and then press
[ENTER].
Choices=[F2]
Delete=[F8]
Press the [F8] key on any field to delete the entire transaction
processor. PbAdmin prompts you before the processor is deleted. If
you accidentally press this key, you can press [ESC] to exit the
delete function.
Save=[F10]
Exit=[ESC]
Processor List screen. Pressing [ESC] again gets you back to the
08/2000
133
Terminal Edit
Screen
- Field Names and
Descriptions
The following describes the information on the Terminal
Edit Screen.
Configuration option. Choose the Terminals option and
select the appropriate terminal.
Field Name
Terminal ID
Description
This is the terminal ID or terminal name associated with this location.
If an entry already exists here, you cannot edit this entry.
If this is a new terminal, press [F3] from the Terminal List screen and
enter the name of the terminal you want to add.
If you want to change the name of the existing Terminal ID, you must
delete it from this screen by pressing [F8] and enter a new terminal
with the name you want.
134
08/2000
Field Name
Location
Description
The name of the location to which this terminal is tied.
Press [F2] for a list of available locations. This field defaults to the
current login location.
Settlement Group
Optional Settlement Group setting for this terminal. At settlement
time, transactions are normally grouped by merchant key. If the
settlement terminal has a settlement group specified, the settlement
group will be used in place of the merchant key to group transactions
being settled. Multiple terminals may specify the same settlement
group.
This setting is useful if you require transactions with different merchant
keys to be settled together. The transaction processor you are
settling through also must support multi-merchant settlement.
All terminals with the same settlement group will settle in one large
group at settlement time, even across locations for master
settlements.
Function Keys:
Help=[F1]
Choices=[F2]
Delete=[F8]
Press the [F8] key to delete the entire terminal. PbAdmin prompts
you before the terminal is deleted. If you accidentally press this key,
you can press [ESC] to exit the delete function.
Save=[F10]
Exit=[ESC]
Terminal List screen. Press [ESC] again to return to the ProtoBase
Configuration menu.
08/2000
135
Edit Credit Card
Table Screen
- Fields Names
and Descriptions
The Edit Credit Card Table screen displays a list of
payment types. A check mark (3
3 or X) indicates which
payment types are to be accepted by the specific terminal.
Configuration option. Choose Credit Card Tables and
select the appropriate Terminal.
Function Keys:
Help=[F1]
Edit/Add=[F3]
Press the [F3] key next to a payment type to edit or add information.
Toggle=[Space]
Press the space bar to toggle to select or deselect a payment type.
Save=[F10]
Exit=[ESC]
Terminal List screen. Press [ESC] again to return to the ProtoBase
Configuration menu.
136
08/2000
Add/Edit Credit
Cards Screen
- Field Names and
Descriptions
The following describes the information on the Add/Edit
Credit Cards Screen.
To access this screen, press [F3] from the Edit Credit
Card Table screen.
Field Name
Description
08/2000
137
Field Name
Card Type
Description
The two-character abbreviation of the card or other payment type.
Press [F2] for a list of choices.
The valid values are:
VI=VISA
MC=MasterCard
DS=Discover
AX=American Express
JC=JCB
DC=Diners Club
NOTE:
138
CB=Carte Blanche
EN=enRoute
DB=Debit
PL=Private Label
CK=Checks
To function properly, checks and debit cards must
be setup by themselves on separate terminals, and
not on the same Terminal ID with credit card
types.
08/2000
Add/Edit Credit CardsScreen
Field Name
Description
Long Name
Longer description of the card or other payment type being used.
(e.g., VISA, MasterCard)
Low Range
The beginning (lowest) Bank Identification Number (BIN) for this card
or payment type. The first six digits of a card number must fall
between this number and the High Range number.
NOTE:
High Range
The ending (highest) Bank Identification Number (BIN) for this card or
payment type. The first six digits of a card number must fall between
this number and the Low Range number.
NOTE:
PRIMARY Auth Merchant
If a particular card type has more than one BIN
range, you must make a separate entry for this card
type for each BIN range.
If a particular card type has more than one BIN
range, you must make a separate entry for this card
type for each BIN range (e.g., 400001-401000,
420001-421000).
The primary merchant key used for authorizations for this card type.
This value is required and must match the merchant key in the
merchant file (PBMERC.DAT).
You must press the [F2] key for a list of valid values. These values
are read from the currently installed PBMERC.DAT file. You can
scroll through this list using the arrow keys. Select by pressing
[ENTER].
Once selected, the transaction processor name corresponding to this
merchant key appears to the right of this field.
(PRIMARY) Settlement Merchant
The primary merchant key used for settlement for this card type. This
value is required and must match the merchant key in the merchant
file (PBMERC.DAT).
Press the [F2] key for a list of valid values. You can scroll through
this list using the arrow keys. Select by pressing [ENTER].
08/2000
139
Field Name
(PRIMARY) Settlement Terminal
Description
The primary Terminal ID used for settlement for this card type. This
value is required and corresponds to the Terminal ID you set up in the
Terminals section of the ProtoBase configuration. This corresponds to
the terminal you have selected to view this screen.
Press the [F2] key for a list of the Terminal IDs you have set up.
ALTERNATE Auth Merchant
The secondary or backup merchant key used for authorizations for
this card type. This can be used for a dial-up backup line when the
primary line is a leased (direct) line or a network connection.
NOTE:
(ALTERNATE) Settlement
Merchant
To use this field, you must set the “Enable Auto Dial
Backup” field to Yes on the Location Information
screen.
The secondary or backup merchant key used for settlement for this
card type. This can be used for a dial-up backup line when the
primary line is a leased (direct) line.
NOTE:
(ALTERNATE) Settlement Terminal
screen.
The secondary or backup Terminal ID used for settlement for this card
type. This value is required and corresponds to the Terminal ID you
set up in the Terminals section of the ProtoBase configuration. This
corresponds to the terminal you have selected to view this screen.
Press the [F2] key for a list of the Terminal IDs you have set up.
NOTE:
140
screen.
08/2000
Field Name
Authorizer Reference
Description
Special code sent to authorizer/depositor to indicate who authorized
this transaction.
NOTE:
Valid Lengths
Only used for Gensar.
This is a set of up to three fields indicating how long account numbers
may be for this card type. ProtoBase uses each of these values in
validating the field length of the account number before passing the
transaction on to the processor. A value of 0 indicates no field length
validation is performed.
The valid values (which are the default values) per card type are as
follows:
VISA = 13, 16, 0
MasterCard = 16, 0
Amex = 15, 0
Diners Club = 0
Carte Blanche = 0
Discover = 16, 0
JCB = 15, 16, 0
Check = 0
Debit = 0
To turn off the account number length validation, enter 0 for all of these
fields.
Function Keys:
Help=[F1]
Choices=[F2]
Delete=[F8]
Press the [F8] key on any field to delete the entire payment type for
this terminal. PbAdmin prompts you before the payment type is
deleted. If you accidentally press this key, you can press [ESC] to
exit the delete function.
Save=[F10]
Exit=[ESC]
Press the [ESC] key to exit the screen. This returns you to the Edit
Credit Card Table screen.
08/2000
141
Device Edit
Screen
- Field Names and
Descriptions
The following describes the information on the Device Edit
Screen. In addition to describing the screen fields, the
Description column indicates whether a screen field is
applicable to a specific operating system. It also
indicates the default values for screen fields, when
applicable.
Configuration option. Choose Devices and select the
appropriate device.
Device Edit Screen
Device Edit Screen
Field Name
Description
Comm Port
The name of the communications port which connects a modem or
direct line to the transaction processor. This is usually a name such
as “com1” (for DOS, OS/2 and Win NT/95) or “/dev/tty/xxx” (for UNIX).
Network Dest
For DOS/LAN users only. The network name of the PC where the
communications port is located. Corresponds to the
<machine name> [/m] for PBARB. This must be the machine name
used to start ProtoBase (for example, “Main”). The default value is
blank.
142
08/2000
Device Edit Screen
Field Name
Modem Brand
Description
The make and model of the modem. The default value is Generic
Hayes Compatible.
Choosing a selection from the list automatically sets the modem
initialization string (Init. String) and dial string (Dial String) to the
correct value. If your modem is not on the list, choose the “Generic
Hayes Compatible”. Then consult your modem guide for the correct
initialization string and other applicable information.
Modem Type
Type of modem attached to the device port.
Press the [F2] key for a list of valid values. ProtoBase only accepts
Hayes in this field. This should not be set to synchronous.
Max Baud
The maximum rate of speed, in bits-per-second (bps), at which
ProtoBase will communicate with this transaction processor using this
device. This rate must be greater than or equal to the baud rate set
for Authorization Primary in the Processor Edit screen.
0, 300, 1200, 2400, 4800, 9600, 19200, 38400
The default value is 2400.
If the Processor name is Amex Direct Stl (American Express
Settlement #40), the Max Baud must equal 9600.
Recovery Interval
Number of minutes to pause between each communication attempt
before trying to reestablish communications with the modem in the
event of an error.
The default value is 0. Leave at 0 unless using a direct or nonswitched line.
Max. Queue
Maximum number of transactions to queue up on this device before
switching to another device. This field is only used if more than one
device is configured. The default value is 0.
If the processor accepts multiple transactions on a single call, this
value should be great enough to prevent unnecessary dialing out.
08/2000
143
Device Edit Screen
Field Name
Line Type
Description
Type of communication line connection being made to the transaction
processor.
Use the space bar to move through each option and select the
appropriate line type. Options are:
Dial-Up
Non-Switched
Direct Dial
ISDN
TCP/IP
UDP/IP
Direct Processor
= Phone dial-up line
= Normal leased line
= Leased line that, at the line level, works like
a dial-up
= Integrated System Digital Network line
= Internet protocol line
= Internet protocol line
The transaction processor reserved for a direct line.
Applicable to the Non-Switched, Direct Dial, ISDN, or UDP/TCP Line
Types only.
The next four fields (Baud, Parity, Data Bits, and Stop Bits) are applicable for Direct Processor lines only:
Baud
The rate of speed, in bits-per-second (bps), at which ProtoBase will
communicate with this direct transaction processor. This value
cannot be set greater than the maximum baud rate of the host
computer’s device.
0, 300, 1200, 2400, 4800, 9600, 19200, 38400
Applicable to the Non-Switched, Direct Dial, or ISDN Line Types only.
144
08/2000
Device Edit Screen
Field Name
Data Bits
Description
The number of data bits required for communication with this direct
transaction processor.
Press [F2] for a choice list. Valid values are 6, 7, or 8.
Parity
The parity required for communication with this direct transaction
processor.
Press [F2] for a choice list. Valid values are Even, Odd, None, Spac
(Space), and Mix (Mixed).
American Express requires a value of None.
Applicable to the Non-Switched, Direct Dial or ISDN Line Types only.
Stop Bits
The number of stop bits required for communication with this direct
Press [F2] for a choice list. Valid values are 1 or 2.
IP Address
The Primary and Secondary Internet Protocol address used for
communication using either TCP/IP or UDP/IP.
This field will be available only if TCP/IP or UDP/IP is selected for Line
Type.
Dep. IP Address
The Primary and Secondary Internet Protocol address used for deposit
or settlement communication using either TCP/IP or UDP/IP.
This field will be available only if TCP/IP or UDP/IP is selected for Line
Type.
08/2000
145
Device Edit Screen
Field Name
Init. String
Description
String sent to the modem prior to every dial-out attempt.
If you selected a modem from the list given in the “Modem Brand”
field, the correct initialization string will automatically be set in this
field.
The default value is ATE0V0X4S0=0Q0&C1&D2.
Applicable to Dial-Up Line Type only.
This field will not display if TCP/IP or UDP/IP is selected for Line Type.
Dial String
String sent to the modem following the initialization string. The default
value is ATDT (Tone dialing). Another common value is ATDP (Pulse
dialing).
field, the correct dial string will automatically be set in this field.
This field will not display if TCP/IP or UDP/IP is selected for Line Type.
Hangup String
String sent to the modem when communication with the transaction
processor is complete and it is time to "hang up" the phone line.
field, the correct hangup string will automatically be set in this field.
The default for this string is blank. If the modem does not hang up
properly, use ATH0.
NOTE:
If the “&D2” option is set in the InitString, and the
modem is attached to a port that supports the drop
DTR method of hangup, leave this field blank. “&C1”
is very important if the modem doesn’t drop DTR in
this mode.
146
08/2000
Device Edit Screen
Field Name
Reset String
Description
String sent to the modem when a modem error occurs. Used to
attempt to resolve a modem error. The default for this string is blank.
A common value is ATZ.
field, the correct reset string will automatically be set in this field.
Device Data
Used by ProtoBase to attach certain data elements to the device
being configured. The most common usage of this field is for the
American Express initialization string data for the particular modem.
Do not use this field unless instructed by SDC personnel.
field, the correct device data will automatically be set in this field.
Function Keys:
Help=[F1]
Select=[ENTER]
Press the [ENTER] key to select the choice displaying for the
particular field (applicable fields only).
Choices=[F2]
Delete=[F8]
Press the [F8] key on any field to delete the entire device data.
PbAdmin prompts you before the device data is deleted. If you
accidentally press this key, you can press [ESC] to exit the delete
function.
Save=[F10]
Exit=[ESC]
Device List screen.
08/2000
147
Environment
Settings Screen
The information displayed on the Environment Settings
screen describes the current settings for common
PbAdmin system variables. The information is useful if
you are executing PbAdmin from an external menu and
are not sure how the environment has been set up.
This screen also indicates the available memory for DOS,
Win NT/95, and OS/2.
Menu from the Main Menu. Then select the Environment
Settings option.
Press the [F1] Help key for a brief description of each
variable and/or pathway.
Press the [ESC] key to exit the screen. This returns you to
the Administrator Setup menu screen.
Environment Settings Screen (DOS version shown)
148
08/2000
Select/View/Edit
Transactions
Screen (Main
Screen)
The Select/View/Edit Transactions screen shows all the
transactions in the database for the currently logged in
location that have not been settled. This is the main
screen you will use to view transactions.
To access this screen, choose the Select/Edit
Transactions option from the Main Menu.
Pressing [SHIFT]+[F3] together from this screen shows a
list of additional functions available. We describe [F3],
[F6], and [F8]/[F9] in this section. For a detailed
description of these functions and others ([F4], [Shift]+[F4],
and [Shift]+[F6]), refer to the How to Use PbAdmin
section.
On the next page, we provide a description of the fields on
this screen.
Select/View/Edit Transactions Screen
08/2000
149
Select/View/Edit Transactions
Screen
Field Name
Select
Description
This column indicates the current status of this transaction.
A check mark (3
3 or X) indicates that the transaction is currently
marked for settlement the next time the Deposit routine is run. It also
indicates that these are selected transactions to include on the
reports (if you run them in “Selected” mode).
Additional indicators display immediately to the right or left of the
brackets ([ ]).
The additional indicators in the Select screen field are:
* = Authorization Only. It cannot be settled in this state.
P = Currently pending with American Express for
settlement status check. Awaiting user’s view of
deposit log to verify this settlement is okay.
I = Currently being settled by another process.
U = Host capture pending. Already been conveyed to
the host processor. (Used only for host
capture systems). Use [Shift]+[F6] to
toggle to a status of “h”.
h = A host pending transaction that has been toggled to allow
editing. Use [Shift]+[F6] to toggle to a status of “U”.
F = “Forced” Authorization Only (for Voice or other than
regular Auth Only).
M = Move to History pending.
V = Void or Void Return.
R = Real Time Transaction (Check, ATM/Debit). It
cannot be edited in this status. Use [Shift]+[F6] to
toggle to a status of “r”
r = Toggled real-time transaction. It can be edited in
this status. Use [Shift]+[F6] to toggle to a status of “R”.
Ref Number
The 12-digit reference number assigned to this transaction by the
POS package. From this screen, you only see the first eight digits of
the reference number. To see the full number, press [F6].
Account Number
The credit card, debit card, or check information represented by this
transaction. If the transaction is a check authorization and the
customer’s driver’s license was used for identification, the field
contains “DL: <driver’s license info>”. If the transaction is a check
authorization and the customer’s MICR number was entered, this field
contains “MCR: <MICR info>”. This field is 24 digits.
Amount
The transaction amount. Field is right justified, space filled.
150
08/2000
Screen
Field Name
Description
Date
Date transaction was authorized/added to database. It is in
MM/DD/YY format.
Auth #
Transaction approval code assigned by the processor.
Terminal
Terminal identifier. Represents the terminal through which this
transaction was authorized.
Function Keys:
Help=[F1]
Available Keys=[Shft][F3]
Press the [Shift]+[F3] keys together to view a menu of additional
functions. We describe how to use these functions in detail in the
The available functions are as follows:
[F3] = Add new transaction
[F4] = Transaction search
[F6] = Transaction detail
[F8] = Select transaction criteria
[F9] = Deselect transaction criteria
[Shift]+[F4] = Select display mode
[Shift]+[F6] = Toggle status
[Arrow Up] = Arrow up one transaction
[Arrow Down] = Arrow down one transaction
[Shift]+[F7] = Moves to top of database
[Shift]+[F8] = Moves to bottom of database
[Space] = Toggles to select or deselect
Exit=[ESC]
Press the [ESC] key to exit the screen. This returns you to the Main
Menu screen.
08/2000
151
Add Transaction
[F3] –
Add New Detail
Transaction
Screen
Below, we describe the fields on the Add New Detail
Transaction screen. This screen is accessed from the
Select/View/Edit Transactions screen by pressing [F3]. In
the description, we also provide the corresponding
ProtoBase field number.
Add New Detail Transaction Screen
Add New Detail Transaction
Screen
Field Name
Description
Reference
12-character alphanumeric reference number assigned to this
transaction by the POS system. (Field 07)
Host Ref
Reference number assigned to this transaction by the third-party
transaction processor or acquirer. This field is only used with host
capture systems. Otherwise, leave blank. (Field 1011)
Terminal
Eight-character terminal identifier of authorizing/settling terminal.
Press the [F2] key for a list of valid values. (Field 109)
152
08/2000
Screen
Field Name
Description
Cashier (Server)
Seven-character employee identifier of cashier or server performing the
transaction. For the restaurant industry, this field is “Server”; for all
other industries, it is “Cashier”. (Field110)
Tran Type
10-character description of type of transaction running. Press the [F2]
key to select from a list of valid values. (Field 1)
Account
24-digit account number for this transaction. Data may be entered
through a magnetic stripe reader if it meets the following criteria:
·
·
·
·
·
Current cursor is in the first position.
Card reader is attached to keyboard and appears as keyboard
input.
Track 1 data is preceded by a percent (%) sign.
Track 2 data is preceded by a semi-colon (;).
The entire track is read, up to and including the end sentinel,
usually a question (?) mark.
If the account number is entered through a magnetic stripe reader, this
field is automatically updated and skipped. (Field 3)
Exp. Date
The date the account number expires. In MM/YY format.
Automatically updated if the card was entered through a magnetic
stripe reader. You have the ability to enter an expired date, if
necessary (e.g., when adding a manual Prior Auth). (Field 4)
Card Type
Two-character short name identifier for payment type.
For example, VI.
(Field 1000)
MKey
The deposit merchant key corresponding to the card type as assigned
in the ProtoBase configuration for this location.
Card Name
Long name identifier for payment type or card association.
For example, VISA.
(Field 1001)
Amount
Maximum eight-digit (99999.99) transaction dollar amount. (Field 2)
08/2000
153
Screen
Field Name
Description
Customer
26-character customer name. Automatically updated if track 1 is
provided in the Account number field. For the lodging industry, this is
the Guest Name (Field 313).
Date
Authorization date of this transaction. Date is in MM/DD/YY format.
Automatically defaults to the current date if left blank. (Field 32)
The Business Date appears in parenthesis to the right of the Date.
Time
Authorization time of this transaction. Time is in HH:MM:SS format.
Automatically defaults to the current time if left blank. (Field 33)
Auth #
Maximum six-character authorization approval number returned by the
processor. This field is required for Prior-Auth Sale transactions.
(Field 6)
PS2000
Compliance data corresponding to four different ProtoBase fields:
1st field - One-character code identifying the authorizing agency (Field
37)
2nd field - Maximum 15-character CPS transaction identifier; unique
tracking number assigned by issuing bank (Field 36)
3rd field - Maximum four-character CPS validation code; assigned by
the card association (Field 35)
4th field - One-character authorization characteristics indicator;
identifies the card association authorizing the transaction (Field 34)
Inc. Info
Compliance data corresponding to two different ProtoBase fields:
1st field - Maximum eight-digit amount representing the total amount
authorized during the life cycle of this transaction (Field 130)
2nd field - Two-digit number representing the total number of
incremental authorizations (Field 131)
CPS Data
Compliance data corresponding to four different ProtoBase fields:
1st field - Maximum 15-character CPS chargeback retrieval reference
number (Field 125)
2nd field - Maximum four-character CPS acquiring ICA; identifies the
acquiring bank or transaction processor (Field 126)
3rd field - One-character CPS miscellaneous data code (Field 127)
4th field - One-character CPS preferred customer indicator (Field 129)
154
08/2000
Screen
Field Name
MERIT
Description
Compliance data corresponding to five different ProtoBase fields:
1st field - Two-character MERIT reason code, assigned by some
transaction processors to track why a transaction was rated as it was
(Field 38)
2nd field - Maximum four-character MERIT POS entry mode, assigned
by some transaction processors identifying how the data was entered
(Field 39)
3rd field - One-character MERIT CVC error indicator, returned by the
issuing bank to indicate the result of the CVC check (Field 40)
4th field - One-character MERIT magnetic stripe quality indicator (Field
41)
5th field - Maximum six-character MERIT authentication code,
assigned by the issuing bank (Field 42)
(Industry-specific fields listed on
right side of screen)
See Industry Detail Screens, page 161 of this section, for descriptions
and examples of transaction screens containing industry specific
information.
Function Keys:
Help=[F1]
Save=[F10]
Exit=[ESC]
Select/View/Edit Transactions screen.
08/2000
155
Search for
Transaction [F4]
This screen is accessed from the Select/View/Edit
Transactions screen by pressing [F4]. The left side of the
screen contains the same fields as the Add New
Transaction function [F3], except for the compliancy fields.
The right side of the screen is blank. Entry of industry
specific information is not allowed for this function.
Search Criteria Screen
Field Name
Description
Function Keys:
Help=[F1]
Search=[F4]
After you enter the search criteria in the appropriate field(s), press the
[F4] key to perform the search. A list of transactions which match the
search criteria will appear. Highlight the appropriate transaction and
press [ENTER] to return to the Select/View/Edit Transactions screen.
The transaction you selected will appear at the top of the screen.
Exit=[ESC]
156
08/2000
Transaction Detail
[F6]
The Detail View of Transaction screen is accessed from
the Select/View/Edit Transactions screen by pressing
[F6]. This enables the user to modify or delete transaction
detail. The left side of the screen contains the same fields
as for the Add New Transaction function [F3].
The right side of the screen contains the industry-specific
fields. The sample below is the data for the Lodging
industry. We describe all of the industry-specific fields,
Detail View of Transaction Screen
In order to insure the integrity of the CPS/PS2000
information, PbAdmin will not allow you to change certain
fields.
08/2000
157
Detail View of Transaction
Screen
Field Name
Description
Function Keys:
Help=[F1]
Choice List=[F2]
AVS Info=[Shft][F3]
Press the [Shift]+[F3] keys together to modify Address Verification
Service information associated with this transaction.
Delete=[F8]
Press the [F8] key on any field to delete the entire transaction data.
PbAdmin prompts you before the transaction is deleted. If you
accidentally press this key, you can press [ESC] to exit the delete
function.
Save=[F10]
Exit=[ESC]
158
08/2000
Select/Deselect
Transactions
[F8/F9]
The Select/Deselect Transaction Criteria screen is
accessed from the Select/View/Edit Transactions screen
by pressing [F8] (for select) or [F9] (for deselect). This
enables the user to select or deselect particular groups of
transactions for settlement based on particular criteria.
Select Transaction Criteria Screen
Select Transaction Criteria
Screen
Field Name
Description
Card Types
Select or deselect by specific card types (VI, MC, AX, DS, etc.).
Press [F2] for a list of valid card types.
Business Date
Select or deselect by the business date the transaction was
processed.
Transaction Date
Select or deselect by the date the transaction was processed.
08/2000
159
Screen
Field Name
Description
Terminal
Select or deselect, based on a specific terminal ID (defined in Field
109). Press [F2] for a list of valid terminals.
Cashier
Select or deselect a specific Cashier/Server ID (defined in Field 110).
Function Keys:
Help=[F1]
Accept=[F10]
Press the [F10] key to have PbAdmin accept the selection criteria you
have entered. To select/deselect all transactions, leave the selection
criteria blank and press the [F10] key. PbAdmin prompts you before
it selects or deselects transactions on the Select/View/Edit
After the records have been selected, a window appears showing the
total number of records that were just selected/deselected.
Exit=[ESC]
160
08/2000
Industry Detail
Screens
This portion of the PbAdmin Technical Reference
section describes the fields for each of the industryspecific detail screens.
To access these screens, press [F6] from the
Select/View/ Edit Transactions screen. The Detail View
of Transaction screen for your industry displays.
We describe the industry-specific fields that appear on the
right side of the Detail View of Transaction screen for the
following industries:
•
•
•
•
•
•
•
Retail
Lodging Retail
Restaurant
Lodging Restaurant
Lodging/Front Desk
Rental Car
Direct Marketing
The fields that appear on the left side of the screen are
described earlier in this section.
Retail - Detail View of Transaction
08/2000
161
Lodging/Retail - Detail View of Transaction
Retail and Lodging/Retail
Transaction Detail
Field Name
Folio
Description
Maximum eight-digit Property Management System folio reference
number assigned to this transaction. (Field 301)
Applies to Lodging/Retail, but not Retail.
Charge Desc.
Description of transaction charges. Press the [F2] key for a list of
valid values. The valid values are:
Lodging
Restaurant
Gift Shop
Spa
Beauty Shp
Conv Fees
Tennis/Pro
Golf/Pro
(Field 300)
162
08/2000
Retail and Lodging/Retail
Transaction Detail
Field Name
Hotel Code
Description
Detailed description of charges. Press the [F2] key for a list of valid
values. The valid values are:
Sale
Assured NS
Adv Depost
Delayed Ch
Expr Svc
Assured Rv
(Sale)
(Assured No-Show)
(Advance Deposit)
(Delayed Charge)
(Express Service)
(Assured reservation)
(Field 305)
Invoice/ROC
Maximum six-digit invoice number or record-of-charge; reference
Item Code
Two-digit code assigned to describe what type goods were purchased.
This is usually matched up with a text description of the code and
forwarded to the card issuer. (Field 400)
Sales Tax
Maximum seven-digit (9999.99) amount of sales tax included in this
charge. (Field 72)
Retail Terms
Maximum four-digit number identifying special terms or payment
options. (Field 411)
Purchase Information (5 lines)
Up to five lines describing the purchases for this transaction. For
each line, a four-digit CODE and maximum 40-character
DESCRIPTION provide the description for each purchased item (Fields
412-416 for CODES, 406-410 for DESCRIPTION, which are included
in the Integration section).
08/2000
163
Restaurant - Detail View of Transaction
Lodging/Restaurant - Detail View of Transaction
164
08/2000
Restaurant and
Lodging/Restaurant
Transaction Detail
Field Name
Folio
Description
number assigned to this transaction.
Applies to Lodging/Restaurant, but not Restaurant.
(Field 301)
Charge Desc.
Lodging
Restaurant
Gift Shop
Spa
Beauty Shp
Conv Fees
Tennis/Pro
Golf/Pro
(Field 300)
Hotel Code
Sale
Assured NS
Adv Depost
Delayed Ch
Expr Svc
Assured Rv
(Sale)
(Assured No-Show)
(Advance Deposit)
(Delayed Charge)
(Express Service)
(Field 305)
Check
Maximum six-digit ticket number or record-of-charge; reference
08/2000
165
Restaurant and
Lodging/Restaurant
Transaction Detail
Field Name
Rest Chg Des
Description
Description of food purchased. Valid values are:
“FOOD”
“FOOD-BEV”
“BEVERAGE”
If food amount reflects food charges
only
If food amount includes drinks or if the
software is unable to split the values
If amount reflects beverage charges
only
(Field 200)
Server 1
Maximum eight-digit employee ID of primary server on this ticket.
(Field 203)
Server 1 Tip
Maximum seven-digit (9999.99) amount of tip included on this
transaction allotted to the primary server. If the amount is greater than
9999.99, enter 9999.99. (Field 201)
Tip 1 Descr
Description of first tip field. This field should contain “TIP” even if no
tip 1 is included. (Field 210)
Server 2
Maximum eight-digit employee ID of secondary server on this ticket.
(Field 204)
Server 2 Tip
Maximum seven-digit (9999.99) amount of tip included on this
transaction allotted to the secondary server. If the amount is greater
than 9999.99, enter 9999.99. (Field 202)
Tip 2 Descr
Description of second tip field. This field should contain “TIP” if tip 2 is
included. Otherwise, leave it blank. (Field 215)
Food Amount
Maximum eight digit (99999.99) dollar amount of transaction used for
food charges. (Field 207)
Food Descr.
Maximum ten-character description of the food on this ticket. If the
Food Amount field is blank, leave this field blank also. (Field 213)
166
08/2000
Restaurant and
Lodging/Restaurant
Transaction Detail
Field Name
Description
Beverage Amt
Maximum eight-digit (99999.99) dollar amount of transaction used for
drink charges. (Field 208)
Bev. Descr.
Maximum ten-character description of beverages on this ticket. Valid
values are “DRINKS” or “BEVERAGE”. If the Beverage Amt field is
blank, leave this field blank also. (Field 214)
Tax Amount
Maximum eight-digit (99999.99) dollar amount of transaction used for
sales tax. (Field 206)
Adj. Tip Amt
Maximum five-digit (99.99) amount of adjustment, if any, of tip charges
applied at a later date/time. (Field 211)
Table Number
Maximum three-digit identification number of customer’s table. (Field
209)
ROC Number
Maximum ten-digit record-of-charge number. (Field 212)
08/2000
167
Lodging/Front Desk - Detail View of Transaction
Lodging/Front Desk
Transaction Detail
Field Name
Description
Folio
Charge Desc.
Lodging
Restaurant
Gift Shop
Spa
Beauty Shp
Conv Fees
Tennis/Pro
Golf/Pro
(Field 300)
168
08/2000
Lodging/Front Desk
Transaction Detail
Field Name
Hotel Code
Description
Sale
Assured NS
Adv Depost
Delayed Ch
Expr Svc
Assured Rv
(Sale)
(Assured No-Show)
(Advance Deposit)
(Delayed Charge)
(Express Service)
(Field 305)
Check-In
Date (in MMDDYY format) when customer begins stay at location.
(Field 303)
Check-Out
Date (in MMDDYY format) when customer ends stay at location.
(Field 304)
Room Number
Maximum four-character identification of room incurring primary
charges. (Field 310)
Room Rate
Maximum six-digit (999.99) per day charge for room. If the rate is
greater than 999.99, enter 999.99. (Field 302)
Tax Amount
Maximum eight-digit (99999.99) amount of tax included in transaction
amount. (Field 306)
Duration
Two-digit length of customer stay, in days. If greater than 99, enter
99. (Field 307)
Operator/Svr
Maximum six-digit number identifying the employee performing the
transaction. (Field 309)
ROC Number
Maximum eight-character record-of-charge number. (Field 308)
08/2000
169
Lodging/Front Desk
Transaction Detail
Field Name
Description
Extra Charge
Maximum seven-digit (9999.99) amount of extra charges included in
the transaction amount field. (Field 311)
X Chg Reason
Maximum six-digit reason code(s) for extra charges; enter multiple
reasons consecutively (for example, 235).
0 - None
2 - Restaurant
3 - Gift Shop
4 - Minibar
5 - Telephone
6 - Other
7 - Laundry
(Field 312)
Guest
170
Maximum 20-character name of guest. (Field 313)
08/2000
Rental Car - Detail View of Transaction
Rental Car
Transaction Detail
Field Name
Description
Renter Name
Maximum 26-character name of person renting the vehicle. (Field
510)
Agreement #
Maximum nine-digit rental agreement number. (Field 511)
Promo Code
Maximum four-digit number or code for any promotional specials
applied to this transaction. (Field 513)
Certificate
Maximum 14-character certificate number applied to this transaction.
(Field 514)
Res. City/ST
Maximum 18-character city and two-character state where rental car
was reserved. (Fields 515 and 516)
08/2000
171
Rental Car
Transaction Detail
Field Name
Description
Duration
Maximum two-digit number of days rental car was rented. (Field 512)
Vehicle #
Maximum eight-digit vehicle identification number. (Field 500)
Adjust Amt
Maximum eight-digit (9999.99) amount this transaction was adjusted
from original agreement amount. (Field 501)
Rent Dte/Tme
Date (MMDDYY) and time (HHMMSS in military format) the rental car
was picked up. (Fields 502 and 503)
Rent City/ST
Maximum 18-character city and two-character state where the rental
car was picked up. (Fields 504 and 505)
Ret. Dte/Tme
Date (MMDDYY) and time (HHMMSS in military format) the rental car
was returned. (Fields 506 and 507)
Ret. City/ST
Maximum 18-character city and two-character state where the rental
car was returned. (Fields 508 and 509)
Tax Amount
Maximum seven-digit (9999.99) amount of tax included in the
Transaction Amount field. (Field 517)
Charge Desc.
Description of the extra charge. Press the [F2] key for a list of valid
values. Valid values are:
No Extra
Gas
Extra Miles
Late Return
OneWay Svc
Parking Tkt
(Field 518)
172
08/2000
Rental Car
Transaction Detail
Field Name
Description
Prog Ind
Two-digit special program code indicator. (Field 519)
Ret. Loc ID
Maximum ten-character identification of return location. (Field 520)
Extra Charge
Maximum five-digit reason code(s) for extra charges; enter multiple
reasons consecutively (for example 235):
0 - None
1 - Gas
2 - Extra mileage
3 - Late return
4 - One way service
5 - Parking violation
(Field 521)
08/2000
173
Direct Marketing - Detail View of Transaction
Direct Marketing
Transaction Detail
Field Name
Description
Zip Code
Five-digit or nine-digit zip code. This information is used for AVS.
(Field 700)
Street Address
Maximum 20-character street address. This information is used for
AVS. (Field 701)
174
08/2000
Direct Marketing
Transaction Detail
Field Name
AVS Response
Description
The response received after performing an Address Verification
Service. Press the [F2] key for a list of choices. Available choices
are:
Exact w/9 Zip Code
Exact w/5 Zip Code
Match Address Only
Match w/9 Zip Only
Match w/5 Zip Only
No Match
AVS Unavailable
Retry
Ineligible for AVS
AVS Not Supported
AVS Not Performed
AVS Not Performed_
Edit Error
(Field 1015)
Shipping Date
Date (MMDDYY) when merchandise was shipped. (Field 711)
Charge Desc.
Description of a mail order purchase. Press the [F2] key for a list of
choices. Choices are:
Non-Mail Order
Single Transaction
Recurring Transaction
Installment Payment
Unknown Mail Order
(Field 712)
Clearing Seq
Two fields, separated by “of”, indicating the current and total number of
installment payments. Used only when the Charge Desc. field equals
“Installment Payment”.
1st field - Maximum two-digits; indicates current installment payment
due (Field 714)
2nd field - Maximum two-digits; indicates total number of installment
payments (Field 713)
Example: 02 of 10 indicates this is the second of ten installment
payments.
08/2000
175
Direct Marketing
Transaction Detail
Field Name
Order Number
Description
Maximum ten-digit order number used to identify the transaction.
(Field 715)
Ship to Zip Cd
Five-digit or nine-digit zip code to which merchandise is to be shipped
or delivered.
(Field 716)
Purchase Information (3 lines)
176
Up to three lines describing the purchases for this transaction. For
each line, a four-digit CODE and maximum 40-character
DESCRIPTION provide the description for each purchased item (Fields
720-722 for CODES, 717-719 for DESCRIPTION which are included in
the Integration section.)
08/2000
PbAdmin Reports
This section describes the various reports available
through PbAdmin.
The reports provide detailed transaction information
according to the sort you choose. The sorts available are
Cashier, Terminal, Card Type, and Merchant Key. Most of
these reports can be generated using the Reports Menu
option from the PbAdmin Main Menu. To generate these
reports outside PbAdmin, please refer to the Integration
section for information.
Each report provides various headings related to specific
transaction detail. Most reports provide totals by card
type at each sort break (e.g., each cashier), then totals by
card type for all of the particular sort (e.g., all cashiers).
Wide format reports provide additional tax and tip totals,
depending on industry.
Each detail report provides a Type heading that displays
an abbreviation for the particular transaction type for each
transaction listed on the report.
The transaction types that may appear under the Type
heading are as follows:
AO
AF
SA
MO
PA
RE
VS
VR
CK
IA
AR
DS
DR
##
*
= Authorization Only
= Forced Authorization
= Sale
= Mail Order
= Prior-Authorized Sale
= Return
= Void Sale
= Void Return
= Check
= Incremental Authorization
= Authorization Reversal
= Debit Sale
= Debit Return
= A transaction type number that does not correspond to
any of the above transaction types
= This transaction was manually entered
An additional character may appear to the right of this twocharacter abbreviation. This additional character
originates from the third-party transaction processor and
usually equals the Authorization Characteristics Indicator
(Input Field 34) if one is present.
08/2000
177
Cashier (Server)
Summary Report
The Cashier Summary Report provides a summary of all
transactions sorted by cashier ID. For the restaurant
industry, this is called the Server Summary Report. This
report provides the following:
•
•
•
Sort by cashier
Totals by card type for each cashier
Totals by card type for all cashiers
It can be generated from the Reports Menu option from
the PbAdmin Main Menu. We show a report sample on
the next page in wide format.
NOTE:
178
For the restaurant industry, this report is
the Server Summary Report. For all
other industries, this is the Cashier
Summary Report.
08/2000
Cashier (Server) Summary Report
ProtoBase Administrator Cashier Report
Transactions by Cashier for All Records
Printed: 07/21/98 11:23
Page
1
Location:
Hotel Location
--------------------------------------------------------------------------------------------------------------------------------------------------------
Credit Totals for Cashier:
CASHIER
Card Type # Auth
Auth $ # Sale Sales $
# Ret Return $ # Net
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
62 15753.38
0
0.00
62 15753.38
0.00
MASTERCARD
0
0.00
100 48266.72
0
0.00
100 48266.72
0.00
VISA
0
0.00
98 35277.26
0
0.00
98 35277.26
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
260 99297.36
0
0.00
260 99297.36
0.00
==========================================================================================
Credit Totals for All Cashiers in Location:
Hotel Location
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
62 15753.38
0
0.00
62 15753.38
0.00
MASTERCARD
0
0.00
100 48266.72
0
0.00
100 48266.72
0.00
VISA
0
0.00
98 35277.26
0
0.00
98 35277.26
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
260 99297.36
0
0.00
260 99297.36
0.00
==========================================================================================
****** End of Report ******
08/2000
179
Cashier (Server)
Detail Report
The Cashier Detail Report provides a standard detail list
of all transactions, sorted by cashier ID. For the restaurant
industry, this is called the Server Detail Report. This
report provides the following:
•
•
•
•
Standard transaction detail only (no extended
industry data)
Sort by cashier
NOTE:
180
For the restaurant industry, this report is
the Server Detail Report. For all other
industries, this is the Cashier Detail
Report.
08/2000
Cashier (Server) Detail Report
Transactions by Cashier for Selected Records
with Standard Detail
Printed: 07/21/98 15:27
Page
1
Location:
Hotel Location
Cashier :
CASHIER
-----------------------------------------------------------------------------------------------------------------------------------------------Ref #
Account
Exp Type
Amount
Date
Bus. Auth# Terminal
-------- ------------------ ----- ---- -------- -------- ----- ------ -------1235 373238500012351
08/98 PA
461.70 11/18/97 11/18 2385
HOTEL
1236 373238500012369
01/99 PA
405.00 11/18/97 11/18 2385
HOTEL
1237 373238500012377
03/98 PA
100.00 11/18/97 11/18 2385
HOTEL
1238 373238500012385
11/98 PA
75.00 11/18/97 11/18 2385
HOTEL
1239 373238500012393
02/98 PA
75.00 11/18/97 11/18 2385
HOTEL
1240 373238500012401
02/99 PA
100.00 11/18/97 11/18 2385
HOTEL
1241 373238500012419
12/99 PA
450.00 11/18/97 11/18 2385
HOTEL
CASHIER
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
==========================================================================================
Hotel Location
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
==========================================================================================
08/2000
181
Cashier Extended
Detail Report Retail
The Cashier Extended Detail report for Retail provides an
extended detail list of all transactions, sorted by cashier
ID, for the retail industry. This report provides the
following:
•
•
•
•
•
Standard transaction detail
Retail-specific detail
Sort by cashier
182
08/2000
Cashier Extended Detail for Retail
with Retail Industry Detail
Printed: 07/21/98 15:40
Page
1
Location:
Retail Location
Cashier :
CASHIER
--------------------------------------------------------------------------------------------------------------------------------------------------------Ref #
-------1235
1236
1237
1238
1239
1240
1241
Account
-----------------373238500012351
373238500012369
373238500012377
373238500012385
373238500012393
373238500012401
373238500012419
Exp
----08/98
01/99
03/98
11/98
02/98
02/99
12/99
Type
Amount
Date
Bus. Auth# Terminal Invoice
---- -------- -------- ----- ------ -------- ------PA 5
461.70 11/18/97 11/18 DEMO-7 RETAIL
001235
PA 5
405.00 11/18/97 11/18 DEMO-7 RETAIL
001236
PA 5
100.00 11/18/97 11/18 DEMO-7 RETAIL
001237
PA 5
75.00 11/18/97 11/18 DEMO-7 RETAIL
001238
PA 5
75.00 11/18/97 11/18 DEMO-7 RETAIL
001239
PA 5
100.00 11/18/97 11/18 DEMO-7 RETAIL
001240
PA 5
450.00 11/18/97 11/18 DEMO-7 RETAIL
001241
Item
---01
01
01
01
01
01
01
Tax
Terms
-------- -----
Item1 Item2 Item3 Item4 Item5
----- ----- ----- ----- ----054 6532
054 6532
054 6532
054 6532
054 6532
054 6532
054 6532
CASHIER
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
==========================================================================================
Retail Location
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
==========================================================================================
08/2000
183
Server Extended
Detail Report Restaurant
The Server Extended Detail report for Restaurant provides
an extended detail list of all transactions, sorted by server
ID, for the restaurant industry. This report provides the
following:
•
•
•
•
•
Restaurant-specific detail
Sort by server
Totals by card type for each server
Totals by card type for all servers
184
08/2000
Server Extended Detail for Restaurant
ProtoBase Administrator Server Report
Transactions by Server for Selected Records
with Restaurant Industry Detail
Printed: 07/21/98 15:58
Page
1
Location:
Restaurant Location
Server :
server2
--------------------------------------------------------------------------------------------------------------------------------------------------------Ref #
Account
Exp Type
Amount
Date
Bus.
Tbl Adj. Tip
-------- ------------------ ----- ---- -------- -------- ------- --------1220 5454545454545454
09/99 PA*
150.00 07/20/98 07/20
1222 5454545454545454
09/99 PA*
100.00 07/20/98 07/20
Credit Totals for Server:
Auth#
Terminal Ch Desc. Tip 1
Tip 2
Emp 1
Emp 2
Ticket # Tax Amt
Food Amt Bev Amt
------ -------- -------- -------- -------- -------- -------- -------- -------- -------- -------122220 rest2
122222 rest2
00
00
server2
Card Type # Auth
Net $
Tip1 $
Tip2 $
Tax $
Food $
Bev $ AdjTip $
---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------MASTERCARD
0
0.00
2
250.00
0
0.00
2
250.00
0.00
0.00
0.00
0.00
0.00
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------0
0.00
2
250.00
0
0.00
2
250.00
0.00
0.00
0.00
0.00
0.00
0.00
=======================================================================================================================================
Credit Totals for All Servers in Location:
Restaurant Location
Card Type # Auth
Net $
Tip1 $
Tip2 $
Tax $
Food $
Bev $ AdjTip $
---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------MASTERCARD
0
0.00
2
250.00
0
0.00
2
250.00
0.00
0.00
0.00
0.00
0.00
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------0
0.00
2
250.00
0
0.00
2
250.00
0.00
0.00
0.00
0.00
0.00
0.00
=======================================================================================================================================
08/2000
185
Cashier Extended
Detail Report Lodging
The Cashier Extended Detail report for Lodging provides
an extended detail list of all transactions, sorted by cashier
ID, for the lodging industry. This report provides the
following:
•
•
•
•
•
Lodging-specific detail
Sort by cashier
186
08/2000
Cashier Extended Detail for Lodging
with Lodging Industry Detail
Printed: 07/21/98 16:10
Page
1
Location:
Hotel Location
Cashier :
CASHIER
--------------------------------------------------------------------------------------------------------------------------------------------------------Ref #
-------1235
1236
1237
1238
1239
1240
1241
Account
-----------------373238500012351
373238500012369
373238500012377
373238500012385
373238500012393
373238500012401
373238500012419
Exp
----08/98
01/99
03/98
11/98
02/98
02/99
12/99
Type
Amount
Date
Bus. Auth#
---- -------- -------- ----- -----PA
461.70 11/18/97 11/18 2385
PA
405.00 11/18/97 11/18 2385
PA
100.00 11/18/97 11/18 2385
PA
75.00 11/18/97 11/18 2385
PA
75.00 11/18/97 11/18 2385
PA
100.00 11/18/97 11/18 2385
PA
450.00 11/18/97 11/18 2385
Terminal
-------HOTEL
HOTEL
HOTEL
HOTEL
HOTEL
HOTEL
HOTEL
Ch. Desc.
--------SPA
SPA
SPA
SPA
SPA
SPA
SPA
Folio #
Rm Rate
---------- -------000000
1.00
000000
1.00
000000
1.00
000000
1.00
000000
1.00
000000
1.00
000000
1.00
Arr Date
-------10/28/97
10/28/97
10/28/97
10/28/97
10/28/97
10/28/97
10/28/97
Dep Date Code Tax Amt. Dur
-------- ---- -------- --10/29/97
06
0.00 1
10/29/97
06
0.00 1
10/29/97
06
0.00 1
10/29/97
06
0.00 1
10/29/97
06
0.00 1
10/29/97
06
0.00 1
10/29/97
06
0.00 1
Cashier Rm #
-------- ---002
002
002
002
002
002
002
CASHIER
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
==========================================================================================
Hotel Location
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
7
1666.70
0
0.00
7
1666.70
0.00
==========================================================================================
08/2000
187
Cashier Extended
Detail Report Rental Car
The Cashier Extended Detail report for Rental Car
provides an extended detail list of all transactions, sorted
by cashier ID, for the rental car industry. This report
provides the following:
•
•
•
•
•
Rental-car-specific detail
Sort by cashier
188
08/2000
Cashier Extended Detail for Rental Car
with Car Rental Industry Detail
Printed: 07/21/98 16:24
Page
1
Location:
Car Rental Location
Cashier :
CASHIER
--------------------------------------------------------------------------------------------------------------------------------------------------------Ref #
Account
Exp Type
Amount
Date
Bus. Auth# Terminal Rent Name
Rent Date Rent Time
St Days
Rental Agree #
Vehicle# Adj.Amt. Tax Amt.
PmCd Certificate # Reserve City
St Retn Date Retn Time
St
-------- ------------------ ----- ---- -------- -------- ----- ------ -------- ---- -------------- ------------------ ---- --------- ------------ ---- ---1235 373238500012351
732475600
08/98 PA
42375600
461.70 11/18/97 11/18 2385
1236 373238500012369
732475600
01/99 PA
42375600
405.00 11/18/97 11/18 2385
RENTAL
RENTAL
Rent City
Return City
--------------
Nikki Moore
CLEARWATER
10/28/97
10/29/97
13:46:24
06:32:27
CLEARWATER
CLEARWATER
FL
FL
1
FL
Joan Moss
CLEARWATER
10/28/97
10/29/97
13:46:24
06:32:27
CLEARWATER
CLEARWATER
FL
FL
1
FL
CASHIER
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
2
866.70
0
0.00
2
866.70
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
2
866.70
0
0.00
2
866.70
0.00
==========================================================================================
Car Rental Location
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
2
866.70
0
0.00
2
866.70
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
2
866.70
0
0.00
2
866.70
0.00
==========================================================================================
08/2000
189
Cashier Extended
Detail Report Direct Marketing
The Cashier Extended Detail report for Direct Marketing
provides an extended detail list of all transactions, sorted
by cashier ID, for the rental car industry. This report
•
•
•
•
•
Direct marketing-specific detail
Sort by cashier
190
08/2000
Cashier Extended Detail for Direct Marketing
with Direct Marketing Industry Detail
Printed: 07/21/98 16:30
Page
1
Location:
Direct Marketing Location
Cashier :
CASHIER
---------------------------------------------------------------------------------------------------------------------------------------------------------Ref #
-------1235
1236
Account
Exp Type
Amount
Date
Bus.
------------------ ----- ---- -------- -------- ----373238500012351
08/98 PA 7
461.70 11/18/97 11/18
373238500012369
01/99 PA 7
405.00 11/18/97 11/18
Auth#
-----123456
123456
Terminal Order Num.
-------- ---------DIRECT
9978665
DIRECT
9978665
AVS
--0
0
Zip Code
--------33764
33764
Billing Address
--------------------
CASHIER
Card Type # Auth
Net $
---------- ------ --------- ------ --------- ------ --------- ------ --------AMER EXPR
0
0.00
2
866.70
0
0.00
2
866.70
---------- ------ --------- ------ --------- ------ --------- ------ --------0
0.00
2
866.70
0
0.00
2
866.70
===============================================================================
Direct Marketing Location
Card Type # Auth
Net $
---------- ------ --------- ------ --------- ------ --------- ------ --------AMER EXPR
0
0.00
2
866.70
0
0.00
2
866.70
---------- ------ --------- ------ --------- ------ --------- ------ --------0
0.00
2
866.70
0
0.00
2
866.70
===============================================================================
08/2000
191
Terminal
Summary Report
The Terminal Summary Report provides a summary of all
transactions sorted by terminal ID. This report provides
the following:
•
•
•
Sort by terminal ID
Totals by card type for each terminal
Totals by card type for all terminals
192
10/99
Terminal Summary Report
ProtoBase Administrator Terminal Report
Transactions by Terminal for All Records
Printed: 07/21/98 16:33
Page
1
Location:
Hotel Location
----------------------------------------------------------------------------------------------------------------------------------------------------------Credit Totals for Terminal:
HOTEL
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
62 15753.38
0
0.00
62 15753.38
0.00
MASTERCARD
0
0.00
100 48266.72
0
0.00
100 48266.72
0.00
VISA
0
0.00
98 35277.26
0
0.00
98 35277.26
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
260 99297.36
0
0.00
260 99297.36
0.00
==========================================================================================
Credit Totals for All Terminals in Location:
Hotel Location
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
62 15753.38
0
0.00
62 15753.38
0.00
MASTERCARD
0
0.00
100 48266.72
0
0.00
100 48266.72
0.00
VISA
0
0.00
98 35277.26
0
0.00
98 35277.26
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
260 99297.36
0
0.00
260 99297.36
0.00
==========================================================================================
10/99
193
Terminal Detail
Report
The Terminal Detail Report provides a standard detail list
of all transactions, sorted by terminal ID. This report
•
•
•
•
industry data)
Sort by terminal
194
10/99
Terminal Detail Report
ProtoBase Administrator Terminal Report
Transactions by Terminal for Selected Records
Printed: 07/21/98 16:40
Page
1
Location:
Hotel Location
Terminal:
HOTEL
--------------------------------------------------------------------------------------------------------------------------------------------------------Ref #
-------1235
1236
41533
556048
Account
-----------------373238500012351
373238500012369
5209012204153327
5209019955604895
Credit Totals for Terminal:
Exp
----08/98
01/99
07/98
08/99
Type
Amount
Date
Bus. Auth#
---- -------- -------- ----- -----PA
461.70 11/18/97 11/18 2385
PA
405.00 11/18/97 11/18 2385
PA
268.66 11/18/97 11/18 9012
PA
18.35 11/18/97 11/18 9019
Cashier
-------CASHIER
CASHIER
CASHIER
CASHIER
HOTEL
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
2
866.70
0
0.00
2
866.70
0.00
MASTERCARD
0
0.00
2
287.01
0
0.00
2
287.01
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
4
1153.71
0
0.00
4
1153.71
0.00
==========================================================================================
Credit Totals for All Terminals in Location:
Hotel Location
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
2
866.70
0
0.00
2
866.70
0.00
MASTERCARD
0
0.00
2
287.01
0
0.00
2
287.01
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
4
1153.71
0
0.00
4
1153.71
0.00
==========================================================================================
08/2000
195
Terminal
Extended Detail
Reports
Retail
Restaurant
Lodging
Rental Car
Direct Marketing
196
These reports follow the same format as the Cashier
Extended Detail reports (described beginning on page
182), except they are sorted by Terminal ID. They can be
generated from the Reports Menu option from the
PbAdmin Main Menu.
08/2000
Deposit Status
Report
The Deposit Status Report shows the settlement (or
deposit) log. It provides all settlement deposit attempts,
both successful and unsuccessful.
This report can be generated from the Reports Menu or
from the View Deposit Log option from the PbAdmin
Main Menu. We show a report sample below.
There are no totals for this report, only detail of each
settlement deposit attempt.
08/2000
197
Authorization
Date & Time
Report
The Authorization Date and Time Report lists transactions
sorted by Authorization Date, and within each date, by
Authorization Time. It can be used to determine if old or
expired authorizations exist in the data base. This report
can be generated from the Reports Menu option from the
PbAdmin Main Menu. We show a report sample below.
Authorization Date and Time Report - Detail
Authorization Date and Time Report - Totals
198
08/2000
Incremental
Authorization
Report
The Incremental Authorization Report lists each
transaction, sorted by Terminal ID. It shows the original
and final authorization amounts. It can be used to review
the amount of incremental authorizations that may be
needed for particular transactions.
This report can be generated from the Reports Menu
option from the PbAdmin Main Menu. We show a report
sample below.
Incremental Authorization - Detail
There are no totals for this report.
08/2000
199
Card Type
Summary Report
The Card Type Summary Report provides a summary of
all transactions sorted by card type. This includes any
“card type” defined in the ProtoBase configuration,
including CHECK and DEBIT. This report provides the
following:
•
•
•
Sort by card type, with separate totals for credits
and returns by card type
Totals by card type
Totals for all card types
sample on the next page in wide format.
200
08/2000
Card Type Summary Report
ProtoBase Administrator Location Report
Transactions by Card Type for Selected Records
Printed: 07/21/98 16:54
Page
1
Location:
Hotel Location
-------------------------------------------------------------------------------------------------------------------------------------------------------Credit Totals for Location: Hotel Location
AMER EXPR Sales
Transaction Type
Count
Total
Tip
------------------------- --------- --------Sales
4
1041.70
0.00
===============================================================================
Net Totals for Location:
Hotel Location
AMER EXPR
Count
Total
Tip
---------- --------- --------Net Totals
4
1041.70
0.00
===============================================================================
Location:
Hotel Location
-------------------------------------------------------------------------------------------------------------------------------------------------------Credit Totals for Location: Hotel Location
MASTERCARD Sales
Transaction Type
Count
Total
Tip
------------------------- --------- --------Sales
4
574.02
0.00
===============================================================================
Net Totals for Location: Hotel Location
MASTERCARD
Count
Total
Tip
---------- --------- --------Net Totals
4
574.02
0.00
===============================================================================
Credit Totals for All Card Types in Location:
Hotel Location
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
4
1041.70
0
0.00
4
1041.70
0.00
MASTERCARD
0
0.00
4
574.02
0
0.00
4
574.02
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
8
1615.72
0
0.00
8
1615.72
0.00
==========================================================================================
08/2000
201
Card Type Detail
Report
The Card Type Detail Report provides a standard detail
list of all transactions, sorted by card type. This includes
any “card type” defined in the ProtoBase configuration,
including CHECK and DEBIT. This report provides the
following:
•
•
•
•
industry data)
Totals by card type
202
08/2000
Card Type Detail Report
Transactions by Card Type for Selected Records
Printed: 07/21/98 17:04
Page
1
Location:
Hotel Location
Card Type: AMER EXPR Sales
--------------------------------------------------------------------------------------------------------------------------------------------------------Card Number
Exp
Auth
Date
Bus.
------------------------ ----- ------ -------- ----373238500012351
08/98
2385 11/18/97 11/18
373238500012369
01/99
2385 11/18/97 11/18
Credit Totals for Location:
Hotel Location
Time
Total
Reference
Cashier
Tip
MKey
----- --------- --------- ---------- -------- ----14:10
461.70
1235
CASHIER
N/A L88
14:10
405.00
1236
CASHIER
N/A L88
Processor
--------------VisaNet CPS
VisaNet CPS
Type
---PA
PA
AMER EXPR Sales
Transaction Type
Count
Total
Tip
------------------------- --------- --------Sales
2
866.70
0.00
===============================================================================
Net Totals for Location:
Hotel Location
AMER EXPR
Count
Total
Tip
---------- --------- --------Net Totals
2
866.70
0.00
===============================================================================
Credit Totals for All Card Types in Location:
Hotel Location
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
2
866.70
0
0.00
2
866.70
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
2
866.70
0
0.00
2
866.70
0.00
==========================================================================================
08/2000
203
Merchant Key
Summary Report
The Merchant Key Summary Report provides a summary
of all transactions sorted by merchant key (ID). This report
•
•
•
Sort by merchant key
Totals by card type for each merchant key
Totals by card type for all merchant keys
204
10/99
Merchant Key Summary Report
Transactions by Merchant Key for All Records
Printed: 07/21/98 17:07
Page
1
Location:
Hotel Location
-------------------------------------------------------------------------------------------------------------------------------------------------------Credit Totals for Merchant Key: L88
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
62 15753.38
0
0.00
62 15753.38
0.00
MASTERCARD
0
0.00
100 48266.72
0
0.00
100 48266.72
0.00
VISA
0
0.00
98 35277.26
0
0.00
98 35277.26
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
260 99297.36
0
0.00
260 99297.36
0.00
==========================================================================================
Credit Totals for All Merchant Keys in Location: Hotel Location
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
62 15753.38
0
0.00
62 15753.38
0.00
MASTERCARD
0
0.00
100 48266.72
0
0.00
100 48266.72
0.00
VISA
0
0.00
98 35277.26
0
0.00
98 35277.26
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
260 99297.36
0
0.00
260 99297.36
0.00
==========================================================================================
08/2000
205
Merchant Key
Detail Report
The Merchant Key Detail Report provides a standard
detail list of all transactions, sorted by merchant key (ID).
This report provides the following:
•
•
•
•
industry data)
206
08/2000
Merchant Key Detail Report
Transactions by Merchant Key for Selected Records
Printed: 07/21/98 17:12
Page
1
Location:
Hotel Location
Merchant Key: L88
-----------------------------------------------------------------------------------------------------------------------------------------------------------Card Number
-----------------------373238500012351
373238500012369
5209012204153327
5209019955604895
Exp
Auth
Date
Bus. Time
Total
Reference
Cashier
Tip
MKey
----- ------ -------- ----- ----- --------- ---------- -------- --------- ----08/98
2385 11/18/97 11/18 14:10
461.70
1235 CASHIER
N/A L88
01/99
2385 11/18/97 11/18 14:10
405.00
1236 CASHIER
N/A L88
07/98
9012 11/18/97 11/18 13:49
268.66
41533 CASHIER
N/A L88
10/99
9019 11/18/97 11/18 13:48
18.35
556048 CASHIER
N/A L88
Processor
--------------VisaNet CPS
VisaNet CPS
VisaNet CPS
VisaNet CPS
Type
---PA
PA
PA
PA
Credit Totals for Merchant Key: L88
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
2
866.70
0
0.00
2
866.70
0.00
MASTERCARD
0
0.00
2
287.01
0
0.00
2
287.01
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
4
1153.71
0
0.00
4
1153.71
0.00
==========================================================================================
Credit Totals for All Merchant Keys in Location: Hotel Location
Card Type # Auth
Net $
Tax $
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------AMER EXPR
0
0.00
2
866.70
0
0.00
2
866.70
0.00
MASTERCARD
0
0.00
2
287.01
0
0.00
2
287.01
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- --------0
0.00
4
1153.71
0
0.00
4
1153.71
0.00
==========================================================================================
08/2000
207
Server Tip Report
(Restaurant Only)
The Server Tip Report provides tip and credit totals per
restaurant server, and grand totals for all servers.
This is applicable to the restaurant industry only.
208
10/99
Server Tip Report
ProtoBase Administrator Server Report
Transaction Summary for Selected Records With Tips
Printed: 08/17/98 11:05
Page
1
Location:
Restaurant Location
--------------------------------------------------------------------------------------------------------------------------------------------------------Tip Totals for Server:
server3
Tip 1
Tip 2
Net
-------- -------- -------42.50
22.50
65.00
Credit Totals for Server:
server3
Card Type # Auth
Net $
Tip1 $
Tip2 $
Tax $
Food $
Bev $ AdjTip $
---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------VISA
0
0.00
2
250.00
0
0.00
2
250.00
42.50
22.50
0.00
0.00
0.00
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------0
0.00
2
250.00
0
0.00
2
250.00
42.50
22.50
0.00
0.00
0.00
0.00
=======================================================================================================================================
Tip Totals for All Servers in Location:
Restaurant Location
Tip 1
Tip 2
Net
-------- -------- -------42.50
22.50
65.00
Credit Totals for All Servers in Location:
Restaurant Location
Card Type # Auth
Net $
Tip1 $
Tip2 $
Tax $
Food $
Bev $ AdjTip $
---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------VISA
0
0.00
2
250.00
0
0.00
2
250.00
42.50
22.50
0.00
0.00
0.00
0.00
---------- ------ --------- ------ --------- ------ --------- ------ --------- -------- -------- -------- --------- --------- -------0
0.00
2
250.00
0
0.00
2
250.00
42.50
22.50
0.00
0.00
0.00
0.00
=======================================================================================================================================
08/2000
209
ProtoBase Administrator User Guide Version 4.3.002 – Technical Reference
Administrator
Configuration
Report
The Administrator Configuration Report shows all
PbAdmin system settings you have set up for this location.
This report provides a summary of many of the settings on
the General Setup and Location Information screens.
To generate this report, select the Administrator Setup
Menu from the PbAdmin Main Menu. Then select Print
Setup Information. We show a report sample below and
on the next page.
Administrator Configuration Report - First Page
08/2000
211
Administrator Configuration Report (continued)
212
08/2000
Transaction
History Search
The Transaction History Search is performed from the
View History Transactions screen.
To access this screen, select the Transaction History
Menu from the Main Menu, then select Transaction
History Search. This enables the user to search for
various transactions in a particular month/year for specific
criteria.
View History Transactions Screen
View History Transactions
Screen
Field Name
Description
Select
This field indicates the current status of this transaction. This field will
be a check mark (3
3 or X) or blank. Selected transactions can be
transferred back to the current database for another settlement
attempt.
Ref Num
The 12-digit reference number assigned to this transaction by the
POS package. This screen only shows the first 8 digits of the
reference number.
08/2000
213
Screen
Field Name
Description
Account Number
The credit card, debit card, or check information represented by this
transaction. If the transaction is a check authorization and the
customer’s driver’s license was used for identification, the field
contains “DL: <driver’s license info>”. If the transaction is a check
authorization and the customer’s MICR number was entered, this field
contains “MCR: <MICR info>”. This field is 24 positions.
Amount
The transaction settlement amount. Field is right justified, space
filled.
Date
Date transaction was authorized/added to database. It is in
MM/DD/YY format.
Batch #
This field displays the last six digits of the batch number.
Terminal
Eight position terminal identifier. Represents the terminal to settle
this transaction to. Defaults to the authorized terminal ID.
Function Keys:
Help=[F1]
Available Keys=[Shift]+[F3]
Press the [Shift]+[F3] keys together to view a menu of additional
functions. We describe how to use these functions in detail in the
The available functions are as follows:
[F6] = Transaction detail
[F5] = Reverse and copy to Main database
[Shift]+[F6] = Copy selected transactions to Main database
Exit=[ESC]
214
08/2000
Transaction Log
The Transaction Log keeps track of functions performed
by PBFE, the PbAdmin Front End program. It is used for
data recovery and technical support. All fields in this log
are separated by a [TAB] character. The table on the
following page describes the fields in the Transaction Log.
To access this log, select Database Management from
the Main Menu. Then choose View Log and select
Transaction.
Below is a sample Transaction Log.
Transaction Log
08/2000
215
Transaction Log Entry Layout
Log
Heading
Field Name
08/27/97
Date (MMDDYY)
11:29:44
Time (HHMMSS)
USER
Username. (“PBFE” if run through PBFE; ”PBADSET” if it is an auto-transaction
through PBADSET; user’s name if run through PbAdmin)
TYPE
Program Source ID (See next page for descriptions of these codes)
ADM
PbAdmin Error Code
PB
ProtoBase Error Code
EXT
Additional data corresponding to the error code
MESSAGE
DATA
RECORD
Text Error Message
The following fields may appear as part of the transaction data record:
Miscellaneous ID Code (Usually identifies the field number an error occurred on)
Transaction Type
Terminal Number
Cashier Number
Location Name
Short Card Type
Reference Number
Account Number
Transaction Amount
Authorization Date
Authorization Time
Expiration Date
Long Card Type
Voided Flag
Host Response Message
Authorization Number
Track Data
Cardholder Name
Validation Code
Transaction ID
216
08/2000
Program Source
ID Code
Descriptions
The following table lists the program source ID codes that
correspond to the “Type” field in the Transaction and
Administrator logs.
Type ID
Description
ACL
AIN
API
ARB
ART
ARV
AUT
BOT
CAL
CDB
COT
CRC
CRF
FAT
FIN
FPA
GBR
GLI
GMI
HAA
HDB
HDC
HDD
IDB
INC
INQ
IVT
LDA
LDB
LDC
LDD
Auto Closed Transactions
Auto Incremental
Get API
Auto Reversal backup
Auto Retry
Auto Reversal
Process Auth-only
Batch open transaction
Check account length
Close database
Close open transaction
Check CRC
Check required fields
Force authorization
Forced Incremental authorization
Forced prior authorization
Get bin record
Get location information
Get Mkey information
Added record to history database
Modified record in history database
Created record for history database
Deleted record from history database
Initialize database
Incremental authorization
Batch inquiry transaction
Init validation table
Added record to location database
Modified record in location database
Created record for location database
Deleted record from location database
08/2000
217
Program Source
ID Code
Descriptions
(cont.)
Type ID
Description
MDA
MDB
MDC
MDD
NON
Added record to main database
Modified record in main database
Created record for main database
Deleted record from main database
None; no records found for this
processor. (Appears in Settlement log.)
Open database
Open general setup database
Process Prior Auth sale
Parse card
Added record to packet database
Modified record in packet database
Created record for packet database
Deleted record from packet database
Process partial reversal
Process transaction
Process return
Remove open transaction
Retry
Process sale
Settlement in progress
Transaction inquiry
Added record to user database
Modified record in user database
Created record for user database
Deleted record from user database
Validate API fields
Process void
Void only (Appears in Settlement log.)
Working key exchange
ODB
OGS
PAS
PCD
PDA
PDB
PDC
PDD
PRV
PTN
RET
ROT
RTY
SAL
SIP
TIQ
UDA
UDB
UDC
UDD
VAF
VOI
VON
WKE
218
08/2000
Administrator Log
The Administrator Log keeps track of functions performed
by individual users in PbAdmin. Some functions that are
logged include logging in, adding/ deleting locations,
initiating settlement, and adding/modifying/purging
records. This log is used for technical support.
All fields in this log are separated by a [TAB] character.
The fields vary depending on the function that is logged.
Many of the fields, including TYPE, are the same as the
Transaction Log described earlier. The TYPE field
corresponds to the Program Source ID, whose values are
listed on the previous two pages.
To access this log, select Database Management from
the Main Menu. Then choose View Log and select
Administrator.
Below is a sample Administrator Log.
Administrator Log
08/2000
219
PbAdmin File and
Program
Descriptions
The first set of tables indicates those directories and files
that are part of the ProtoBase Administrator installation.
The second set of charts indicates the directories and files
created by the ProtoBase Administrator during normal
use.
NOTES: The .exe extension is not used in UNIX
systems. Use the program name without
the extension.
Case sensitive filenames and directory
names under UNIX appear as listed in
the following tables.
This listing does not include files
provided with or created by ProtoBase or
the AMEX utility, or provided as
ProtoBase utilities. Also, files used in
and created by upgrade procedures are
not listed, as these are unique for each
implementation. Contact SDC Client
Services if you wish to determine the
origin of a file not listed here. Client
Services may be reached toll free at 1877-SDC-1799. Please have your
customer account number available.
220
08/2000
Files and Directories which are provided as part of the PbAdmin installation:
PBFE directory
(This directory is where ProtoBase resides. It is the directory that the PBPATH
environment variable points to.)
PBFE.EXE
Program that enters transactions into the PbAdmin database. This
program is the equivalent of PB.EXE and is used in a similar way.
PBADSET.EXE
Program that conducts settlement from within PbAdmin.
PBCP.EXE
Shipped with DOS only
Creates a transfer file for users of Control Point software. Used in lieu of
normal settlement through PbAdmin. Not required by most users.
NOTE:
PBSHELL.EXE
This program must not be executed if not required,
since it will delete all settleable transactions from the
database and convert them to Control Point format
without copying records to history. This may be
prevented by creating a dummy offline.dat file (which
will cause PBCP.EXE to return an error message) or
deleting PBCP.EXE if not required.
Shipped with OS/2 only
Program used to shell from DOS programs to OS/2 programs from within
PbAdmin.
PBFEDOS.EXE
Shipped with OS/2 and WinNT
DOS version of PBFE.
08/2000
221
PBADMIN directory
(This directory may be either separate or combined with the PBFE directory. It is the
directory that the PBDBPATH environment variable points to.)
ADMBUILD.EXE
Utility program used to rebuild PbAdmin database indexes in cases
where index has become corrupted or for upgrades to new versions which
require rebuilding of indexes. May also be run to reduce the size of the
indexes (especially for the PBADMAIN.IDX file).
This program is also available as a menu option under Database
Management.
ADMPURGE.EXE
Utility program used to purge log files.
This program is also available as a menu option under Database
Management.
PBADMIN.EXE
Main program allowing users access to features of PbAdmin.
PBADREP.EXE
Program used to create reports from within PbAdmin.
PBCFG.EXE
Program used to configure ProtoBase from within PbAdmin.
READCFG.EXE
Utility program used to read in configuration from an existing
PBCONFIG.CFG file (used when upgrading a ProtoBase site to
PbAdmin).
DBEXPORT.EXE
Utility program used to create field-delimited ASCII copy of all databases
(*.EXP). Used in some upgrade procedures and to fix certain database
problems.
DBIMPORT.EXE
Utility program used to read field-delimited ASCII files into the PbAdmin
databases. User should be sure to remove unwanted transactions from
*.EXP files prior to importing, to prevent duplicating transactions.
PBNTSYS.EXE
Shipped with WIN NT version only
Program used to shell from DOS executables to WIN NT executables
from within PbAdmin. This file should be copied into the PBFE directory.
222
08/2000
DB subdirectory (under PBADMIN)
ADMERROR.TXT
Error text for errors reported by PbAdmin.
ADMHELP.TXT
Help text used for [F1] help feature in PbAdmin.
ADMLIST.TXT
Text used for [F2] lists in PbAdmin and other lists used internally.
Should not be modified.
CTERROR.TXT
Error text for certain database errors reported within PbAdmin.
PBADERRS.TXT
Error text for errors reported by PbAdmin.
PRINT.TXT
Printer setup information used in non-UNIX versions of PbAdmin and
selected on the printer choice menu.
READCFG.TXT
List of processors and numbers used by the READCFG.EXE utility. Also
used by some versions of PBADREP.EXE.
VALID.DAT
Compiled list of validation requirements for fields in PBFE input files.
VVTERMCAP
Shipped with UNIX versions only.
List of terminal characteristics (similar to termcap file on UNIX systems)
used by Vermont Views (screen display library) to determine keystroke
equivalents on UNIX systems.
PROCCPS.TBL
Table of processor equivalents between compliant and non-conpliant
version of ProtoBase (PB). Used by READCFG when converting PB 4.7
configurations to use PB 4.7.6 if the “Y” option is specified on the
command line to indicate conversion should occur.
NOTE:
This only converts the processor numbers used in the
PbAdmin setup files. Conversion of processor numbers
in the existing transaction database (if present) is
handled by the conversion utilities provided.
ADMPROC.TXT
Processor data for PbAdmin.
PBCFGHLP.TXT
Help file for PBCONFIG program.
ADMMODEM.TXT
Modem list for PbAdmin.
DEFAULT subdirectory (under DB)
(These files should be copied into the DB directory for NEW installations only. In older
releases of PbAdmin, these files appeared in the DB subdirectory. These files will also be
present in the DB directory of PbAdmin once configured.)
PBADLOCA.DAT
PBADLOCA.IDX
PBADUSER.DAT
Data file for default location database. Contains entry for the “test
location” location.
Data file for default user database. Contains entry for the “pbadmin” user.
PBADUSER.IDX
08/2000
223
Files and Directories which are created by PbAdmin during normal use:
DB directory
PBADMAIN.DAT
PBADMAIN.IDX
PBADUSER.DAT
PBADUSER.IDX
PBADLOCA.DAT
PBADLOCA.IDX
PBPACKET.DAT
PBPACKET.IDX
Main database which contains all transactions viewable in the
Select/View/Edit Transactions screen of PbAdmin.
User database which contains data entered in the user setup screen of
PBADMIN.EXE.
Location database which contains data entered in the location setup
screen of PBADMIN.EXE.
Packet database which contains data on certain real-time or host
transactions such as checks and debit cards.
*.CRD
Files containing data on cards accepted by each terminal and used
internally by PBCFG.EXE.
MKEYLIST.DAT
File containing list of merchant keys used internally.
UCOMM.DAT
Files containing data on comm ports, processors and terminals and used
internally.
UPROC.DAT
UTERM.DAT
*.LOG
The PbAdmin log file, usually called PBADMIN.LOG but may change if
default log name is changed in location setup. This file keeps track of
actions performed in the PbAdmin program.
*.STL
The PbAdmin settlement log, usually called PBADMIN.STL but may
change if default log name is changed in location setup. This file keeps
track of settlements and is the file displayed on the screen after
completion of a successful settlement in PbAdmin.
224
08/2000
DB directory
*.TRN
The PbAdmin transaction log. The default name is PBADMIN.TRN,
which can be changed in location setup. This file keeps track of
transactions as they occur.
PBCONFIG.LST
The equivalent of PBCONFIG.CFG, created during configuration by
PBCFG.EXE.
PBCFG.OUT
The output from the last time PBCFG.EXE was run.
COMMLIST.TXT
List of comm devices used internally by PBCFG.EXE.
LOCLIST.TXT
List of locations used internally by PBCFG.EXE.
MERCLIST.TXT
List of merchant keys used internally by PBCFG.EXE.
PROCLIST.TXT
List of processors used internally by PBCFG.EXE.
TERMLIST.TXT
List of terminals used internally by PBCFG.EXE.
*.RPT
Report files are generated as temporary files by PbAdmin when they are
viewed on the screen. If you wish to capture a hard copy of a report file,
you may copy this temporary file while the report is being viewed on
another terminal / session / window. Reports can also be generated via
API files in a manner similar to running ProtoBase. Consult the
Integration section for details.
DBHIST subdirectory (under DB)
PBAD????.DAT
PBAD????.IDX
History databases (where ???? is the date of the history file in MMYY
format).
????????.T??
Temporary files which may be left by earlier versions of ProtoBase.
These may safely be deleted as long as ProtoBase is shut down.
OTHER *.DAT
Backup copies of the PbAdmin databases made at the time of last
settlement if the PBBACKUP environment variable is set. In event of
catastrophic loss of data, these may contain valuable backups of the
regular databases at time of last settlement.
OTHER *.IDX
DEBUG subdirectory
(This directory should be under PBADMIN or PBFE. It is lowercase in UNIX. These files
can be safely deleted if no debug information is required.)
Various temporary files
(name varies by
operating system)
This directory contains copies of some or all of the input/output files
passed to ProtoBase by PBFE when DBLEVEL=4 has been set in the
environment (depending on how the operating system handles temporary
files). These files can be useful if unusual errors occur which require
investigation of fields passed from PBFE.EXE to PB.EXE.
????????.H??
History files for good settlements which can be useful when tracking
down problems during settlement.
????????.B??
History files for bad settlements which can be useful when tracking down
problems during settlement.
08/2000
225
BATCH subdirectory
(This directory is used during settlement to store the ProtoBase temporary batch file. It is
usually empty unless a settlement is in progress or catastrophic failure occurred during
settlement. This is the settlement directory specified on the Location Information screen.)
PBmkey.DAT
Temporary batch file created during settlement. This represents only that
subset of records in the database actually being settled. This file is
normally deleted as a routine part of the settlement process. Mkey
represents the particular merchant key being settled.
PBEDC.LCK
This is a lock file created by ProtoBase during the settlement process. If
there was a catastrophic failure during a previous settlement attempt, this
file may remain in this directory and should be deleted prior to attempting
another settlement. Presence of this file during settlement will result in
unusual settlement error messages.
API/Settlement Directory
(These files are located in the individual settlement directory by location. They can be
safely deleted if no debug information is required. These files are the input/output files
created during the last settlement attempted and can be useful for tracing problems with
settlement or duplicating errors. The ??? in the filename is the merchant key being
settled (if settling single merchants) or the name of the settlement group (if settling
multiple merchants). These are produced regardless of debug setting.)
PB???.IN
PB???.OUT
PBR???.IN
PBR???.OUT
PBT???.IN
PBT???.OUT
PBD???.IN
PBD???.OUT
PBS???.IN
PBS???.OUT
226
Prior auth and other transactions created by PBADSET.EXE during
settlement which may be used to re-create the actual batch file used
during settlement. The output file may be checked for errors which
occurred at this point in the settlement process.
Auth reversal transactions created by PBADSET.EXE during autoreversal processing. Errors occurring in these files are normally ignored.
Host totals transactions created by PBADSET.EXE and passed to
PBHSTTOT.EXE file. Errors in these files can lead to an “Out of
Balance” error message when settling.
Host details transactions which may be present if the processor supports
them. These are created by PBADSET.EXE and passed to
PBHSTDET.EXE.
Settlement transactions created by PBADSET.EXE during settlement
which may be used to re-create any settlement errors which occurred.
The output file may be checked for the actual error message returned by
ProtoBase when settling, in cases where the settlement log is suspected
of being in error or inaccurate.
08/2000
PBADMIN / PBFE / other directories
CORE
UNIX only.
These files are created when a program suffers a catastrophic failure and
can be quite lengthy. They may safely be deleted if no debug information
is required. Consult SDC Client Services if core files are continuously
found for no reason when no programs have crashed, since this may
indicate a problem with a program abnormally terminating.
OFFLINE.DAT
DOS only -- for users of the Control Point interface only.
Output file created by the PBCP.EXE utility. This file contains
settlement data being passed to the Control Point software. PBCP.EXE
will not run if this file is present, since it assumes that the previous
settlement has not been completed if this file is found.
PBFE.INI
This is the global INI file, corresponding to the Global INI File screen.
Settings in this file are overridden by settings in the local INI
(PBADMIN.INI) file. This file can be modified in PbAdmin, or by using a
standard text editor. This file is located in the PBFE directory.
PBADMIN.INI
This is the local INI file, corresponding to the Local INI File screen. This
allows executables to reside on a local drive, without interfering with the
setup of other computers. The settings in this file override settings in the
global INI (PBFE.INI) file. This file can be modified in PbAdmin, or by
using a standard text editor. This file is located in the directory in which
PbAdmin is running.
*.EXP
Export files created by running DBEXPORT.EXE. This contains flat-file
representations of the contents of the databases at the time the
DBEXPORT utility was run.
Users may consult these files, but no documentation is provided
regarding content.
These files appear in the directory where DBEXPORT was run.
These files may safely be deleted, and may be re-created by running
DBEXPORT.EXE.
08/2000
227
PBADMIN / PBFE / other directories (cont.)
*.LCK
Lock files created by various programs which may be left if a program is
running or terminates abnormally. If ProtoBase is not running, and no
other users are running PbAdmin, lock files may be safely deleted. Lock
files may appear in many places depending on the program that
generated them, but will always be somewhere in the ProtoBase
directory structure. Consult SDC Client Services if lock files are
continuously found for no reason when no programs are active; this may
indicate a problem with a program abnormally terminating. Client
Services may be reached toll free at 1-877-SDC-1799. Please have your
*.STE
These are debug files created by various programs when run with
DBLEVEL=4 set. They are re-created each time the program is run, so
zero-length files may be present if the programs have been run with
debug turned off. The information in these files is usually used by
development programmers to help track down problems occurring within
specific programs.
Users may consult these files, but they are primarily for internal use by
Southern DataComm staff.
These files appear in the directory where the program in question is
executed.
These files may safely be deleted if no debug information is required.
228
08/2000
ProtoBase Administrator User Guide Version 4.3.002 - How to Use PbAdmin
ProtoBase 
Administrator
Version 4.3.002
User Guide
V. How to Use PbAdmin
08/2000
229
ProtoBase Administrator User Guide - Version 4.3.002 - How to Use PbAdmin
How to Use
PbAdmin
230
When you finish setting up PbAdmin and running test
transactions, you are ready to begin using PbAdmin. This
section describes the various day-to-day functions of the
ProtoBase Administrator. We explain how to perform the
following:
•
Start and exit PbAdmin
•
Select and edit transactions for settlement
•
Generate and view various reports
•
Run deposit transactions (perform settlement)
•
Maintain transaction history
•
Perform database management
08/2000
How to Start
PbAdmin
To start PbAdmin, do the following:
1. Verify you are at the command prompt of the main
PbAdmin directory. Change to the PbAdmin main
directory if needed.
NOTE: This text-based version of PbAdmin
is a console application and must be
run from the command prompt.
2. Type pbadmin [ENTER].
3. Enter a Login ID and Password which you have set
up to log in to PbAdmin.
User Log In Screen
08/2000
231
When you complete these steps, the Main Menu displays,
as shown below:
Main Menu
232
08/2000
How to Exit
PbAdmin
To exit PbAdmin and return to the command prompt, you
have three options, all from the Main Menu:
•
Select Exit Administrator from the Main Menu. We
show a sample Main Menu below with this option
highlighted.
or
•
Press the [F10] key from the Main Menu.
or
•
Press “E” from the Main Menu.
Main Menu
08/2000
233
Select/Edit
Transactions
To select or modify transactions in preparation for
settlement, select the Select/Edit Transactions option
from the Main Menu. You can do this by moving the cursor
to this selection and pressing [ENTER]. You can also do
this by pressing “S” from the Main Menu.
When you do this, the Select/View/Edit Transactions
screen appears. We show a sample below.
Select/View/Edit Transactions Screen
234
08/2000
Select/View/Edit
Transactions
Screen (Main
Screen)
How to Manually
Select or Deselect
Individual
Transactions for
Settlement
Available Function
Keys
The Select/View/Edit Transactions screen shows all the
transactions in the database that have not been settled for
the location currently logged in. For a description of the
fields and transaction indicators on this screen, please
Use this screen to select and deselect specific
transactions to indicate they are ready for settlement or to
be included in reports. To select a transaction, position
the cursor in the Select column for the particular
transaction, then press the [Space] bar. A check mark
(3
3 or X) appears between two brackets to indicate this
transaction is selected. This mark disappears if
deselected.
From this screen, you have access to various functions.
You can press [Shift]+[F3] for a list of all available
functions. The available function key commands are as
follows:
[F1] = Help
[F3] = Add new transaction
[F6] = Transaction detail (To view and modify detail)
[Shift]+[F4] = Select display mode
[Shift]+[F6] = Toggle status
[Space] = Toggles to select or deselect
[ESC] = Exit the screen; returns to Main Menu
We describe functions [F3], [F4], [F6], [F8]/[F9],
[Shift]+[F4], and [Shift]+[F6] in detail in this section.
08/2000
235
Select Display
Mode [Shift]+[F4]
This function enables you to choose which transactions to
display on the Select/View/Edit Transactions screen.
Why You Would
Use this Function
Use this function to limit the number of transactions
displayed on the Select/View/Edit Transactions screen.
For example, you may only want to view the settleable
transactions to determine which ones to select or
deselect.
How to Perform this
Function
From the Select/View/Edit Transactions screen, press
[Shift]+[F4] to set the mode. A window appears showing
the current Display Level, and the three display mode
options. We show a sample below.
The display options are as follows:
Settlement = Displays only settleable transactions (i.e.,
sales, returns, and prior authorized sales).
Auth Only = Displays only Authorization Only
transactions (those marked with “*” ).
All
= Displays all transactions, regardless of
status or type.
NOTE:
The default setting for the display mode
may be set on the Location Information
screen.
Select Display Mode Window
236
08/2000
08/2000
237
Select/Deselect
Transactions [F8]
and [F9]
This function enables you to select or deselect groups of
transactions, based on specific criteria, to indicate they
are ready to be settled or included in reports.
Why You Would
Use these
Functions
Use these functions to select or deselect specific
groups of transactions for settlement or reporting.
For example, you may want to select only VISA
transactions for a particular terminal or cashier to settle or
to include on a report.
How to Initiate
these Functions
To initiate these functions, press [F8] (for select) or [F9]
(for deselect) from the Select/View/Edit Transactions
screen. The select screen is the Select Transaction
Criteria screen. The deselect screen is the Deselect
Transaction Criteria screen. The screen content is the
same for either function. We show a sample below.
238
08/2000
How to Perform the
Select or Deselect
Enter any combination of criteria for any of the five
columns (Card Type, Business Date, Transaction Date,
Terminal ID, or Cashier ID). Up to ten sets of criteria can
be entered for one selection/deselection. If more than one
field is specified per line, only the records matching all
fields will be selected/deselected. To select/deselect all
transactions, leave the criteria columns blank.
NOTE 1: If you are only viewing authorization or
settlement transactions, only those will
be selected/deselected.
NOTE 2:When selecting records to be moved or
deleted from the database (when viewing
from the Database Management screen),
make sure you are viewing all
transactions, since these functions will
affect all selected transactions, even
those not visible on the Select/View/Edit
To accept the criteria and perform the database select or
deselect, press [F10]. PbAdmin prompts you with “About
to modify selection status. Are You Sure?” To
continue, press the [Space] bar, then [ENTER]. To
discontinue, press [ESC].
If you continue with the select/deselect, PbAdmin performs
the function and displays the number of records affected.
It then exits you back to the
The transactions selected show a check mark in the
Select column; the transactions unselected do not show a
check mark.
NOTE3: If you wish to double check your
selection, run a cashier, terminal, or
merchant key “Detail” or “Extended
Detail” report. Choose Selected for the
records to use. For more information,
please read about reports later in this
section.
08/2000
239
Search for
Transaction [F4]
This function enables you to search for a transaction
based on any combination of search criteria.
Why You Would
Use this Function
Use this function to research the PbAdmin database and
find a particular transaction or group of transactions. You
may need to do this for chargebacks, refunds, returns, or if
you wish to edit a particular transaction.
How to Search for a
Transaction
Press [F4] from the Select/View/Edit Transactions screen.
The Search Criteria screen appears. We show a sample
below.
Enter any combination of criteria on the Search Criteria
screen. To accept the criteria and perform the database
search, press the [F4] key again.
How PbAdmin
Performs the
Search
PbAdmin starts the search at the top-most record in the
database. It compares the search criteria you entered
with each transaction in the database and displays a list of
matching transactions from which you may select the
desired record. You will then be returned to the Select/
View/Edit Transactions screen with the record you chose
at the top of the screen.
240
08/2000
How PbAdmin
Performs the
Search (cont.)
Below is a sample of the screen that appears, showing the
records which match the search criteria. If no matching
records are found, the message “No Matching Records
Found” appears. You can modify the data and perform
another search.
Matching Search Criteria
08/2000
241
View/Modify
Transaction Detail
[F6]
This function enables you to view and modify transaction
detail for individual transactions on the Select/View/Edit
Why You Would
Use this Function
You would use this function for the following reasons:
How to Perform this
Function
•
To view the detail for a particular transaction in the
PbAdmin database. This screen displays the basic
transaction detail on the left side (such as customer,
card, and amount data) and any extended industry
data on the right side of the screen.
•
To edit transaction detail, such as adding room
charges, converting an Auth Only transaction to a Prior
Auth to be settled, or to correct an error in the
database.
•
To void a transaction.
From the Select/View/Edit Transactions screen, place the
cursor on the transaction you want to view or modify.
Press the [F6] key to initiate this function. The Detail View
of Transaction screen appears for the transaction you
selected. We show a sample below. You may modify or
delete the transaction here. To save your edits, press
[F10].
NOTE:
Transactions marked with “P”, “U”, “I”, or
“R” in the Select column of the
cannot be modified.
242
08/2000
08/2000
243
Available Function
Keys
From the Detail View of Transaction screen, you have
access to various functions. The function keys display at
the bottom of the screen as follows:
[F1] = Help
Provides help information for each screen field.
[Shift]+[F3] = AVS Info
Displays AVS information that was entered with the
transaction. (This information cannot be edited.) We
show a sample screen below.
[F8] = Delete
Deletes the transaction from the database.
[F10] = Save
Saves the updated screen.
[ESC] = Exit
Exits the screen and returns to the Select/View/Edit
Detail View of Transaction/Address Verification Info Screen
244
08/2000
Toggle Status
[Shift]+[F6]
This function enables you to change the transaction status
on particular real-time or settleable host capture
transactions.
Why You Would
Use this Function
Use this function to change the status on applicable
transactions on the Select/View/Edit Transactions screen.
For example, use this function on a real-time transaction
that you need to edit or deselect by changing the status
from “R” to “r”. It is not advisable to edit a transaction that
is real-time or host capture, since the processor already
has this record. This should only be done to correct a
transaction to match the record at the host, or to allow a
transaction to be deselected so that it does not settle with
the next batch.
Available Status
Codes for this
Function
This function is available only for those transactions that
have the following transaction status codes on the
Select/View/Edit Transactions screen:
U = Host capture pending. Already conveyed to
the host processor during a previous settlement
attempt that was unsuccessful. Used only for host
capture systems or real time. Use [Shift]+[F6] to
toggle to status “h”.
h = Non-pending host capture. Use [Shift]+[F6] to
toggle to status “U”. This transaction may be
deselected.
R = Real Time Transaction (Check, ATM/Debit). It
cannot be edited in this status. Use [Shift]+[F6]
to toggle to status “r”.
r = Toggled real-time transaction. It can be edited in
this status. Use [Shift]+[F6] to toggle to status
“R”. This transaction may be deselected.
NOTE:
How to Toggle the
Status
246
If you attempt this function on a
transaction for which it is not applicable,
the message “Not a Realtime or Settleable
Host Capture Transaction” appears.
From the Select/View/Edit Transactions screen, place the
cursor on a particular transaction that you want to change
the status. Press [Shift]+[F6] to initiate this function for
this transaction. The status code changes as indicated in
the descriptions above.
08/2000
Add Transaction
[F3] - Add New
Detail Transaction
Screen
This function adds a transaction to the PbAdmin
database.
Why You Would
Use this Function
Use this function to manually enter a transaction. This
function enables you to add a transaction to the PbAdmin
database without processing it through your point of sale
system.
How to Add a
Transaction
Press [F3] from the Select/View/Edit Transactions screen.
The Add New Detail Transaction screen appears. We
show a sample below.
Enter all information on the Add New Detail Transaction
screen for each applicable screen field. You can press
[ENTER], [Tab], or the down arrow key to have PbAdmin
accept the information for each field. For certain fields,
you will need to press [F2] for a choice list. Please refer
to the PbAdmin Technical Reference section for
detailed descriptions of each field.
08/2000
247
Add Transaction
[F3] - Add New
Detail Transaction
Screen (cont.)
NOTE:
If you enter and save a transaction
without an authorization number,
PbAdmin will respond with the prompt
“No Auth Number Entered. Attempt
Authorization?” Toggle No or Yes by
using the space bar.
Choosing No will return you to the
Select/View/Edit Transactions screen to
continue entering or editing transactions.
Choose Yes to attempt authorization of
the transaction through PBFE. A
Working…..message will appear while
authorization is being attempted. A
processor response or an error message
will be returned to the screen when
complete.
If the authorization is declined or not
completed, return to the transaction list
to delete the transaction or make any
edits and attempt authorization again.
248
08/2000
Reports
To generate, view, or save any of the transaction reports
available through PbAdmin, select the Reports Menu
option from the Main Menu. You can do this by moving the
cursor to this selection and pressing [ENTER]. You can
also do this by pressing “R” from the Main Menu.
When you do this, the Reports menu screen appears as
shown below.
Reports Menu
08/2000
249
How to Generate
a Report
PbAdmin
Reports
To generate a report, select the report you want to
generate from the Reports menu screen. Except for the
Deposit Status Report (i.e., the Settlement Log), PbAdmin
prompts you for the type of transactions to be reported.
Press [F2] for a choice list. The following choices are
available:
All
All transactions, regardless of status
Selected
All transactions selected on the
(those with a check mark)
Pre-Settle
All transactions selected on the
which will actually be deposited when a
settlement is run
Place the cursor on the type of transactions you want, then
press [ENTER].
PbAdmin generates the report you have chosen and
displays it on the screen.
We provide a brief description of each report beginning
on the next page. For report samples, please refer to the
You can print the report [F7], save the report with a
specific filename [F10], or exit without printing [ESC].
Several reports are available, showing transaction data in
two levels of detail. These levels are:
Standard, which includes the following fields:
Ref # - Reference Number
Account - Account Number
Type - Transaction Type
Amount - Transaction Amount
Date - Transaction Date
Bus. - Business Date for Transaction
Auth# - Authorization Number
Cashier (Server) - Cashier or Server employee number
Detail, which includes all the fields specific to the industry.
250
08/2000
NOTE 1: If you specified an Optional Internal File
Viewer on the Global/Local INI File
screens, this will be run instead of the
default viewer. With an optional viewer,
PbAdmin still enables you to print and
save the report after you view it.
NOTE 2:If you chose a wide (e.g., landscape)
format in the Printer Type field on the
Location Information screen, additional
tax and tip totals display, depending on
the industry.
08/2000
251
Report
Descriptions
PbAdmin
Reports Sorted by
Cashier
ID
Single-location reports are sorted by cashier, terminal,
card type, or merchant key. Multi-location reports are
sorted by location with overall totals. The following is a
description of each report.
Cashier Summary Report
Provides a summary of all transactions sorted by cashier
ID. For the restaurant industry, this is called the Server
Summary Report.
•
•
•
Sort by cashier
Cashier Detail Report
Provides a standard detail list of all transactions, sorted by
cashier ID. For the restaurant industry, this is called the
Server Detail Report.
•
•
•
•
industry data)
Sort by cashier
Cashier Extended Detail
Provides an extended detail list of all transactions, sorted
by cashier ID. For the restaurant industry, this is called the
Server Extended Detail report.
•
•
•
•
•
252
Industry-specific detail
Sort by cashier
08/2000
Report
Descriptions
(cont.)
PbAdmin
Reports Sorted by
Terminal
ID
Provides a summary of all transactions sorted by terminal
ID.
•
•
•
Sort by terminal ID
cashier ID.
•
•
•
•
industry data)
Sort by terminal ID
Terminal Extended Detail
Provides an extended detail list of all transactions, sorted
by terminal ID.
•
•
•
•
•
Industry-specific detail
Sort by terminal ID
08/2000
253
Report
Descriptions
(cont.)
PbAdmin
Reports Others
Deposit Status Report (Log)
Shows the settlement (or deposit) log. It provides all
settlement deposit attempts, both successful and
unsuccessful.
In addition to selecting the Deposit Status Report option
from the Reports Menu, this report can also be generated
two other ways:
•
Select View Deposit Log from the PbAdmin Main
Menu, or
•
Select Database Management Menu from the
PbAdmin Main Menu, select View Log, and then
choose Settlement.
Authorization Date & Time Report
Lists transactions sorted by Authorization Date, and within
each date, by Authorization Time. Totals are provided for
each date by card type, and then for all dates by card type.
Incremental Authorization Report
Lists transactions by location and terminal, showing the
original and total authorization amounts.
Server Tip Report (Restaurant only)
Provides tip and credit totals per restaurant server, and
grand totals for all servers. Applicable to the restaurant
industry only.
254
08/2000
Report
Descriptions
(cont.)
PbAdmin
Reports Sorted by
Card
Type
Provides a summary of all transactions sorted by card
type. This includes any “card type” defined in the
ProtoBase configuration, including CHECK and DEBIT.
•
•
•
Totals by card type
card type. This includes any “card type” defined in the
ProtoBase configuration, including CHECK and DEBIT.
•
•
•
•
industry data)
Totals by card type
08/2000
255
Report
Descriptions
(cont.)
Provides a summary of all transactions sorted by
merchant key (ID).
PbAdmin
Reports Sorted by
Merchant
Key (ID)
•
•
•
merchant key (ID).
•
•
•
•
256
industry data)
08/2000
Deposit
Transactions
(Settlement)
To initiate a settlement transaction, select the Deposit
Selected option or Deposit All option from the Main
Menu.
Deposit Selected deposits only those transactions
selected on the Select/View/Edit Transactions screen.
The Status Window displays the total number and total
amount of selected transactions to be settled.
The Deposit All option deposits all transactions from the
current (main) database that can be settled. When
Deposit All is selected, a Status Window appears as
shown below.
Deposit Transactions Status Window
Press [ESC] to exit the screen without performing the
settlement.
NOTE:
To verify that your settlement and POS
totals balance, run a pre-settlement
balance report prior to running this
selection. You can do this by running
any report and choosing “Pre-settle”
when the screen prompts you to choose
which records to use. The totals for the
selected transactions are shown at the
bottom of the report.
08/2000
257
Available Function
Keys
From this screen, you have access to various functions, as
follows:
[F1] = Help
Provides help information
[F8] = Forced Settlement
Used for host capture processors that support a forced
close of the host batch even if the totals do not match.
Use this if you get a “Batch Out of Balance” error and
want to settle anyway.
[F10] = Normal Settlement
Processes a normal settlement, for the total number of
transactions and amount displayed.
[ESC] = Exit
Exits this screen without performing a settlement.
When You
Perform the
Settlement
To initiate the settlement procedure, press [F8] or [F10]
when the Status Window displays. The actual settlement
process may take a few minutes to complete; the duration
varies according to several factors, including the number
of transactions and communication method used.
NOTE:
You cannot run authorizations while
settlement is in progress if you do not
have more than one communications
device, or if the transaction processor
does not support this.
During the settlement process, the Status Window may
show a series of messages indicating the progress of the
settlement.
If you are set up for automatic Incremental Authorizations
and Authorization Reversals, these are also performed at
this time. Please refer to the Integration section for more
information.
258
08/2000
Multi-Merchant
Settlement
You also have the option of settling multiple
merchants/Terminal ID’s in the same settlement batch file.
You would use this option normally when the transaction
processor has the ability to accept a batch file with
multiple merchant ID’s identified. Some processors
require this type of processing.
To use this option, be sure you have set up the Terminal ID
for each transaction you have selected using the same
Settlement Group name (defined in the Terminals setup in
the ProtoBase Configuration screens).
In addition, all transaction locations should be set to use
the same Log File Base Name and Settlement Directory
Name (defined in the PbAdmin Location Information
screen).
To initiate the settlement, you would perform the same
procedure as for single merchant settlement (i.e., press
[F8] or [F10] when the Status Window displays.) For
more detailed information, please refer to Section 12 of
the ProtoBase Technical Reference Guide.
08/2000
259
When Settlement
is Complete
Upon completion of settlement, two separate reports
display on the screen, one at a time.
The first report is a settlement report, generated by
ProtoBase. We show a sample on the next page. This
report is automatically saved in the following location:
pbadmin\api\settle\location base log name.rpt. where
pbadmin is the main PbAdmin directory path, settle is the
settlement sub-directory name you chose, and location
base log name.rpt is the default filename defined in the
Location Information screen.
After you exit the first report, the second report displays.
This report is the Deposit Status Log (i.e., Settlement
Log), generated by PbAdmin. We show a sample on the
next page.
For each report, you can print [F7], save the report with a
filename you specify [F10], or exit without printing [ESC].
260
08/2000
Settlement Report Generated by ProtoBase
Deposit Status Log (Settlement Log)
08/2000
261
View Deposit Log
(Settlement Log)
To view the deposit log (also called the Deposit Status
Log or Settlement Log) for the current location’s deposit
statuses, select the View Deposit Log option from the
Main Menu. This log automatically displays after you
perform a settlement (i.e., select the Deposit
Transactions option from the Main Menu).
You can also perform this report function two other ways:
•
Select the Deposit Status Report from the Reports
Menu.
or
•
Select Database Management from the Main Menu,
choose View Log, then select Settlement.
Depending on whether an American Express settlement is
currently pending, different screens may appear when you
select the View Deposit Log option. We describe this on
the next page.
262
08/2000
American
Express Status
Check
If you settle with American Express Direct Settlement, and
an American Express settlement is currently pending a
status check, a window displays asking if the user wishes
to initiate the status check at this time. Toggle the value to
“Yes” using the [Space] bar to initiate the check.
A “Working” box displays while the status check is
performed. If the previous settlement was accepted, the
report returned by American Express displays on the
screen. Press the [F7] key to print it or [F10] to save it.
If the settlement was rejected, or was not ready yet, an
error displays and the settlement log updates with the
response.
Available Function
Keys
From this screen, you have access to various functions, as
follows:
[F1] = Help
Provides help information.
[F7] = Print
Prints the status check report.
[F10] = Continue
Accepts values and continues with the status check.
[ESC] = Exit
Exits the screen without performing the status check.
08/2000
263
Viewing the
Deposit
(Settlement) Log
If there is no American Express settlement pending or
when the status check completes, the settlement log
displays on the screen as shown below.
Settlement Log
Available Function
Keys
[F1] = Help
Provides help information based on the display screen.
[F7] = Print
Prints the settlement log.
[F10] = Save As
Saves the report with a filename you specify.
[ESC] = Exit
Exits without saving the report.
264
08/2000
Transaction
History Menu
To research previously settled transactions in history,
select the Transaction History Menu option from the
Main Menu. The Transaction History submenu appears as
shown below.
Transaction History Menu
Using the Transaction History submenu, you can perform
the following functions:
•
•
•
•
Search for transactions in history
View history transaction detail
Move history transactions to the current working
database
Print various history reports
We discuss these functions in detail in this section.
08/2000
265
Transaction
History Search
Use this selection to view historical data and transfer
previously settled transactions to the current database.
Press [ENTER] on the Transaction History Search
option on the Transaction History menu to initiate a search
of transaction history.
The first screen prompts you for the initial history month
and year to view. Since the Administrator system stores
all settled transactions by month, this is necessary as a
starting point for your search.
Transaction History Search Screen
Enter a valid month/year combination to view transaction
history. After you press [F10] to accept the month/year
combination, the View History Transactions screen
appears.
This screen looks similar to the Select/View/Edit
Transactions screen. It lists all transactions in the history
database for the current location by the chosen
month/year. We show a sample on the next page.
266
08/2000
View History
Transactions
Screen
The View History Transactions screen shows all the
transactions in the database that have been settled
successfully for the location currently logged in. The
column headings are the same as those of the
Select/View/Edit Transactions screen, except the Auth #
column is replaced by the six-digit Batch #. For a
description of the fields and transaction indicators on this
screen, please refer to the description of the
Select/View/Edit Transactions screen in the PbAdmin
NOTE:
You cannot edit, toggle status, or delete
transactions from this screen.
08/2000
267
Available Function
Keys
From the View History Transactions screen, you have
access to various functions. You can press [Shift]+[F3]
for a list of all available functions. The available function
key commands are as follows:
[F1] = Help
[F6] = Transaction detail (View only)
[F5] = Reverse and copy to main database
[Shift]+[F6] = Copy selected transaction to main
database
[Shift]+[F7] = Moves to top of history database
[Shift]+[F8] = Moves to bottom of history database
[ESC] = Exit the screen; returns to Transaction History
menu
We describe functions [F4], [F6], [F8]/[F9], [F5], and
[Shift]+[F6] in detail in this section.
268
08/2000
Search for
Transaction [F4]
This function enables you to search history for a
transaction based on any combination of search criteria.
Why You Would
Use this Function
Use this function to research the PbAdmin historical
database and find a particular transaction or group of
transactions. You may need to do this for chargebacks,
refunds, or returns.
How to Search for a
Transaction
How PbAdmin
Performs the
Search
Press [F4] from the View History Transactions screen.
The History Search Criteria screen appears. (We show a
sample below.) Enter any combination of search criteria
and press the [F4] key again. A window displays,
prompting you to enter the date range from which to
search for the history files. Enter a range, then press the
[F10] key to begin the search.
PbAdmin searches the range you select. It compares the
search criteria you entered with each transaction in the
database. You are presented with a list of matching
transactions. You may then select a desired transaction,
and you will be returned to the proper history file with the
requested transaction on the top of the screen. If a
matching record is not found, PbAdmin returns you to the
History Search Criteria screen. You can modify the data
and perform another search.
08/2000
269
History Search Criteria Screen
270
08/2000
View Transaction
Detail [F6]
Why You Would
Use this Function
How to Perform this
Function
This function enables you to view transaction history detail.
Use this function to view the detail for a particular
transaction in the history database. This screen displays
the standard transaction detail on the left side (such as
customer, card, and amount data) and any extended
industry data on the right side of the screen.
From the View History Transactions screen, place the
cursor on the transaction you want to view. Press the [F6]
key to initiate this function. The Detail View of History
Transaction screen appears for the transaction you
selected. We show a sample below.
NOTE:
You cannot modify history transactions.
Detail View of History Transaction Screen
08/2000
271
Available Function
Keys
From the Detail View of History Transaction screen, you
have access to various functions. The function keys
display at the bottom of the screen as follows:
[F1] = Help
Provides help information for each screen field.
[Shift]+[F3] = AVS Info
Displays AVS information that was entered with the
transaction. We show a sample screen below.
[F8] = Copy to main
Copies the transaction from the history database to the
main database (the one displayed on the Select/View/Edit
Transactions screen). The message “Are You Sure?”
prompts the user to toggle “Yes” before continuing. This
function can also be done by pressing [Shift]+[F6] from
the View History Transactions screen.
[ESC] = Exit
Exits the screen and returns to the View History
Detail View of History Transaction/Address Verification Info Screen
272
08/2000
Select/Deselect
Transactions [F8]
and [F9]
This function enables you to select or deselect groups of
transactions in the history database, based on specific
criteria, for reporting or copying to the main database.
Why You Would
Use these
Functions
Use this function to select or deselect specific groups
of transactions for reporting or to copy to the main
database. For example, you may want to select only
VISA transactions for a particular terminal or cashier to run
a report on. Or, you may want to select a transaction from
a certain batch to copy to the main database.
How to Initiate
these Functions
To initiate these functions, press [F8] (for select) or [F9]
(for deselect) from the View History Transactions screen.
The select screen is the Select Transaction Criteria
screen. The deselect screen is the Deselect Transaction
Criteria screen. The screen content is the same for either
function. We show a sample below.
08/2000
273
How to Perform the
Select or Deselect
Enter any combination of criteria for any of the six columns
(Card Type, Business Date, Transaction Date, Terminal
ID, Cashier ID, or Batch Number). Up to ten sets of
criteria can be entered for one selection/deselection. To
select/deselect all transactions, leave the criteria columns
blank.
NOTE 1: If you are only viewing authorization or
settlement transactions, only those will
be selected/deselected.
NOTE 2:When selecting records to be moved or
deleted from the database (when viewing
from the Database Management screen),
make sure you are viewing all
transactions, since these functions will
affect all selected transactions, even
those not visible on the View History
To accept the criteria and perform the database select or
deselect, press [F10]. PbAdmin prompts you with “About
to modify selection status Are You Sure?”. To
If you continue with the select/deselect, PbAdmin performs
the function and displays the number of records affected.
It then exits you back to the
View History Transactions screen.
The transactions selected show a check mark in the
Select column; the transactions unselected do not show a
check mark.
NOTE3: If you wish to double check your
selection, run a cashier, terminal, or
merchant key “Detail” or “Extended
Detail” report. Choose Selected for the
records to use. For more information,
please read about reports later in this
section.
274
08/2000
Reverse and
Copy to Main
Database [F5]
This function enables you to copy selected transactions
from the history database to the main database (the one
displayed by the Select/View/Edit Transactions screen) as
a reversal of the original transaction.
Why You Would
Use this Function
Use this function only for double-deposited batches that
need to be reversed. Prior to performing this function, you
must select the entire batch that was double-deposited
using the Select function ([F8]) described on page 273.
How to Perform this
Function
From the View History Transactions screen, press [F5] to
initiate this function.
PbAdmin prompts you with “About to reverse and copy
records to main database Are You Sure?”. To
What PbAdmin
Does When You
Perform this
Function
If you continue with the reverse and copy function,
PbAdmin copies all transaction records that you have
selected to the main database. The history database is
not affected by this function.
When the transactions are copied, it changes each PriorAuthorized Sale transaction to a Return transaction and
each Return to a Prior-Authorized Sale. It will copy, but not
change, any transaction type selected other than PriorAuthorized Sales and Returns.
PbAdmin shows the results of this function in a Status
Window similar to below.
Reverse and Copy to Main Database Status Window
08/2000
275
Copy to Main
Database
[Shift]+[F6]
This function enables you to copy selected transactions
from the history database to the main database (the one
displayed by the Select/View/Edit Transactions screen).
Why You Would
Use this Function
This can be used if transactions were inadvertently moved
to history without being settled. You can move these
transactions from history back to the main database to
settle them correctly.
How to Perform this
Function
From the View History Transactions screen, press
[Shift]+[F6] to initiate this function.
PbAdmin prompts you with “About to copy records to
main database Are You Sure?”. To continue, press the
[Space] bar, then [ENTER]. To discontinue, press
[ESC].
What PbAdmin
Does When You
Perform this
Function
If you continue with the copy function, PbAdmin copies all
transaction records that you have selected to the main
database. The history database is not affected by this
function.
PbAdmin shows the results of this function in a Status
Window similar to below.
Copy to Main Database Status Window
276
08/2000
Deposit Date and
Time Report
Select this option from the Transaction History Menu to
generate the Deposit Date and Time Report. When
selected, a message prompts you for the month and year
to include in the report.
When generated, this report lists settlements by date and
time with net totals for each, and the message received
from the transaction processor.
Various History
Reports
The rest of the options on the Transaction History Menu
generate reports in the same formats as those on the
Reports submenu. These reports show transaction data
by cashier, terminal, card type, and merchant key. A
message prompts the user for the month and year and the
batch number to include in each history report. To include
all batches, leave the batch number blank.
The reports available are as follows:
•
•
•
Cashier Summary Report
Cashier Detail Report
Cashier Extended Report
NOTE 1: For the restaurant industry, the
word “Cashier” is replaced by
“Server”.
•
•
•
Terminal Extended Report
•
•
•
•
NOTE 2:For batch numbers that have
multiple merchant keys, PbAdmin
also breaks the history report at
each merchant key.
08/2000
277
Database
Management
Menu
To perform database clean-up, select the Database
Management option from the Main Menu. The Database
Management submenu appears as shown below.
NOTE:
The options on this menu should
only be performed by a system
administrator, or only if directed to
do so by qualified personnel.
Database Management Menu
Using the Database Management submenu, you can
perform the following functions:
•
•
278
Modify the status of transactions, or delete them or
move them to history.
• Delete old or expired authorizations.
• Check settlement data for a transaction, or fix it if
changes have been made to the ProtoBase
configuration.
Rebuild or delete the transaction database.
• Rebuild or delete history databases.
• View or delete three separate logs.
08/2000
Modify
Transaction
Status
Use this function to change the transaction status indicator
on particular transactions as viewed on the
Select/View/Edit Transactions screen. It will change every
transaction in the main database that has the indicated
“from” status to the indicated “to” status.
Why You Would
Use this Function
Occasionally, errors may occur that leave transactions in
an invalid status. This function enables the user to change
that status. For example, if several transactions have not
been settled, but settlement was attempted and they are
“stuck” in progress, you can change these transactions
from an “In Progress” to a “Selected” status.
Modify Transaction Status Window
08/2000
279
How to Perform this
Function
Select the Modify Transaction Status option from the
Database Management menu.
A Status Window appears, as shown on the previous
page. It indicates the status you want to move “from” and
“to”.
The default is from “In Progress” to “Settled”. Press [F2]
for a choice list.
The following are the available statuses for both the
“move” and “to” selections, including the corresponding
status code as indicated on the Select/View/Edit
Transactions screen:
Selected = 3or X
Pending = P
In Progress = I
Host Pending = U
Real Time = R
Move to History pending = M
Two additional statuses are available for the “to” field only,
as follows:
History = Move this transaction to history
Be Deleted = Delete this transaction from database
When you have made your choices for “move” and “to”,
press [F10] to accept.
Upon completion, a message appears indicating the
number of records that changed from the chosen “move”
status to the chosen “to” status.
280
08/2000
Purge Old
Authorizations
This function deletes all expired authorization transactions
from the main database based on the particular location
you are logged into.
Why You Would
Use this Function
This function cleans up the main database of any expired
authorizations which were not settled. You define an
expired authorization by the value in the “Days to Keep
Auths” on the Location Information screen for this location.
How to Perform this
Function
Select the Purge Old Authorizations option from the
PbAdmin prompts you with “Continuing will cause all
expired authorizations to be permanently deleted!
Are You Sure?”. To continue, press the [Space] bar,
then [ENTER]. To discontinue, press [ESC].
What PbAdmin
Does When You
Perform this
Function
If you continue with the purge function, PbAdmin deletes all
Authorization Only transaction records from the main
database that have a transaction date older than the value
indicated in the Days to Keep Auths (on the Location
Information screen).
NOTE: If you are logged in as a Master User, the
purge settings for the Master Location will
override the settings for an individual
location.
PbAdmin shows the results of this function in a message
similar to below:
“PBADMAIN OLD AUTHS PURGED: xx Record(s)
Deleted”
xx is the number of authorizations that were deleted.
08/2000
281
Check Settlement
Information
Why You Would
Use this Function
How to Perform this
Function
What PbAdmin
Does When You
Perform this
Function
282
This option checks for discrepancies between settlement
information on all transactions, and the current settlement
terminal and settlement merchant key configuration.
Use this function to check settlement information before
you run settlement. This is necessary if any terminal or
merchant key information has been changed or deleted in
the ProtoBase configuration. You can then use the Fix
Settlement Information option to fix the “fixable”
transactions. We describe the Fix Settlement Information
option on the next page.
To initiate this function, select Check Settlement
Information from the Database Management menu.
PbAdmin prompts you with “About to check settlement
information”. To continue, press the [Space] bar, then
[ENTER]. To discontinue, press [ESC].
If you continue with this function, PbAdmin checks
settlement information on all transactions against the
current terminal and merchant key configuration.
After PbAdmin performs the check, a message displays
at the bottom of the screen. This message indicates the
number of transactions with the following types of
discrepancies:
Fixable
Transaction for which information does
not match the current settlement terminal
or settlement merchant key configuration.
These can be fixed by the Fix Settlement
Information option.
Bad Mkey or
Bad Range
Caused by configuration errors. A
formerly valid card range has been
deleted, or the PBMERC.DAT file has
changed since configuration was run.
These discrepancies cannot be fixed
automatically. They must be fixed by
modifying and re-running configuration.
08/2000
Fix Settlement
Information
Why You Would
Use this Function
This function fixes transactions if there are discrepancies
between settlement information for a transaction and the
current terminal and merchant key configuration.
Use this function to fix any “fixable” transactions, as
indicated by the Check Settlement Information option.
NOTE:
How to Perform this
Function
What PbAdmin
Does When You
Perform this
Function
If you cannot identify the errors in
the terminal or merchant key
configuration, set DBLEVEL=4 and
run the Check Settlement
Information option again. This will
generate error notifications in the
PBADMIN.STE debug file. You may
either review the file or call SDC
Client Services for more
information.
To initiate this function, select the Fix Settlement
Information option from the Database Management
menu. PbAdmin prompts you with the message “About
to Attempt to Fix Settlement Information”. To
If you continue, PbAdmin modifies the information in the
transaction to match the current configuration.
After PbAdmin performs the fix, a message displays at the
bottom of the screen, indicating the number of records
fixed.
08/2000
283
Rebuild
Transaction
Database
Why You Would
Use this Function
This function rebuilds and reindexes the main transaction
database file, PBADMAIN.DAT, and its corresponding
index file, PBADMAIN.IDX. These files are located in the
DB subdirectory under the main PbAdmin directory.
Occasionally, the index to the database file may become
corrupted. Use this selection to create new indexes. You
may want to try this if you are receiving “C-Tree errors”.
Select the Rebuild Transaction Database option from
the Database Management menu.
How to Rebuild all
PbAdmin
Databases within
PbAdmin
PbAdmin prompts you with “About to Rebuild
Transaction Database Are You Sure?”. To continue,
press the [Space] bar, then [ENTER]. To discontinue,
press [ESC].
When completed, the message “Rebuild Complete”
appears.
How to Rebuild
Various Databases
Outside PbAdmin
It is sometimes necessary to rebuild (reindex) the various
PbAdmin databases outside of PbAdmin from the
command prompt. To do this, exit out of PbAdmin until
you get to the main PbAdmin directory (specified in the
PBDBPATH environment variable).
The command admbuild enables you to rebuild and
reindex separate databases. We describe the options
you have with this command on the next page.
284
08/2000
How to Rebuild
Various Databases
Outside PbAdmin
(cont.)
You have the following command options to use with
admbuild:
To rebuild all
databases
admbuild -a
To rebuild history
database only
admbuild -h mmyy (where mmyy is the two-digit
month and year for the history to rebuild - also can be
done using the Rebuild History File option from the
Database Management menu)
To rebuild the
packet database
only
admbuild -p (used for real-time and host capture
transactions)
To rebuild the main
database only
admbuild -m
When you run any of these options, PbAdmin shows a
series of messages indicating the progress of the rebuild.
When completed, you will be returned to the command
prompt.
08/2000
285
Purge
Transaction
Database
Why You Would
Use this Function
This function deletes all records from the main
transaction database for the particular location you
are in.
Use this function to delete all records from the main
database. For example, you can run this function to clear
a database of test transactions prior to going live with a
particular installation. You do not want to use this function
unless you are sure you do not need any of the
transactions in the main database.
If the live database is damaged, you may not want to use
this function. Instead, the PBADMAIN.DAT and
PBADMAIN.IDX files should be backed up and deleted
outside of PbAdmin from the command line.
Select the Purge Transaction Database option from the
How to Perform this
Function
PbAdmin prompts you with “Continuing will cause
transaction database to be permanently deleted! Are
You Sure?” To continue, press the [Space] bar, then
[ENTER]. To discontinue, press [ESC].
When completed, a message appears indicating the
purge has been completed.
286
08/2000
Rebuild History
File
Why You Would
Use this Function
This function rebuilds and reindexes the history transaction
databases, PBADmmyy.DAT, and their corresponding
index files, PBADmmyy.IDX (where mmyy is the two-digit
month and year when these files were moved to history).
These files are located under the DBHIST subdirectory
within the main PbAdmin directory.
Occasionally, the indexes to the history files may become
corrupted. Use this selection to create new indexes. You
may want to try this if you are receiving “C-Tree errors”.
Select the Rebuild History Database option from the
How to Rebuild
History PbAdmin
Database within
PbAdmin
Enter a valid month/year combination to view transaction
history. Press [F10] to accept the month/year
combination.
PbAdmin prompts you with About to Rebuild Selected
History File Are You Sure?”. To continue, press the
[Space] bar, then [ENTER]. To discontinue, press
[ESC].
When completed, the message “Rebuild Complete”
appears.
How to Rebuild
Various Databases
Outside PbAdmin
You can also rebuild the history databases outside of
PbAdmin from the command prompt. To do this, exit out
of PbAdmin until you get to the main PbAdmin directory
(specified in the PBDBPATH environment variable).
Then, type the following:
Admbuild -h mmyy (where mmyy is the two-digit
month and year for the history to rebuild)
08/2000
287
Purge History
Files
Why You Would
Use this Function
This function deletes all transactions from a selected
history database.
Use this function when you want to delete history
databases that you no longer need for research purposes.
Select Purge History Files from the Database
Management menu.
How to Perform this
Function
PbAdmin prompts you to enter the month and year of the
history file to be deleted. Enter the appropriate month and
year, then press [F10] to accept. PbAdmin prompts you
with the message “Continuing will cause selected
history database to be permanently deleted!” To
If you continue, PbAdmin deletes all transactions from the
chosen history file. A message appears indicating the
purge has been completed.
288
08/2000
View Log
This function enables you to view and print the three logs
available in PbAdmin. The logs are as follows:
Administrator
Settlement
The main Administrator log. Lists
process statuses of functions run
through PbAdmin
Lists settlement statuses of all
deposits initiated through
PbAdmin
NOTE: The Settlement Log can also be run two
other ways, as follows:
•
Select View Deposit Log from the PbAdmin
Main Menu, or
•
Select Reports Menu from the PbAdmin Main
Menu, then select Deposit Status Report from
the Reports Menu
Transaction
Why You Would
Use this Function
How to Perform this
Function
The main front end log records all
transactions processed by
PbAdmin
Use this function for snapshots of different aspects of
PbAdmin processing, including general PbAdmin
processes (Administrator Log), the deposit log
(Settlement Log), and transactions processed through
PBFE (Transaction Log).
To view a log, choose the Database Management option
from the main menu. Select View Log and choose the
appropriate log.
If you get the error “File Too Large for Default Viewer”, you
must use a viewer or editor other than the default viewer to
view the log. With an optional viewer, PbAdmin still
enables you to print and save the report after you view it.
To switch from the default viewer, edit the Optional Internal
File Viewer field on the Global INI file screen.
08/2000
289
Administrator Log
Settlement Log (Deposit Status)
Transaction Log
290
08/2000
Available Function
Keys
When you are viewing a log, you have access to various
functions. The function keys display at the bottom of the
screen as follows:
[F7] = Print
Prints the log information that is currently being viewed.
[F10] = Save As
Saves the report, allowing the user to specify the file path.
[ESC] = Exit
Exits the View Log selection.
08/2000
291
Purge Log
Why You Would
Use this Function
How to Perform this
Function
The Purge Log function clears the selected log of all
transactions older than the number of days specified in the
“Days to Keep Logs” field on the Location Information
screen for a selected location.
Use this function to delete old entries from the
Administrator, Settlement, or Transaction logs.
To initiate this function, select Purge Log from the
Database Management menu. Choose the appropriate
log to purge from the list provided (Administrator,
Settlement, or Transaction).
PbAdmin prompts you with: “Continuing will cause all
expired log entries in the (ADMINISTRATOR,
SETTLEMENT, or TRANSACTION) log to be
permanently deleted!” To continue, press the [Space]
bar, then [ENTER]. To discontinue, press [ESC].
What PbAdmin
Does When You
Perform this
Function
If you continue with the purge function, PbAdmin deletes all
records from the selected log that have a transaction date
older than the value indicated in the Days to Keep Logs
field in the Location Information setup.
NOTE: If you are logged in as a Master User, the
purge settings for the Master Location will
override the settings for an individual
location.
After the log is purged, the Database Management menu
displays. The following message appears at the bottom of
the screen:
“(ADMINISTRATOR, SETTLEMENT, OR
TRANSACTION ) log file purged: xx Record(s)
Deleted”.
xx is the number of records that were deleted.
292
08/2000
ProtoBase Administrator User Guide - Version 4.3.002 - Troubleshooting

ProtoBase
Administrator
Version 4.3.002
User Guide
VI. Troubleshooting
08/2000
293
PbAdmin
Troubleshooting
In this section, we provide solutions to troubleshoot
PbAdmin problems. These suggestions should be
addressed prior to calling SDC Client Services. We also
provide a complete list of error messages, including
reasons and solutions to each. Client Services may be
reached at 1-877-SDC-1799. Please have your
NOTE: If you want to view the PbAdmin database
in a different database application (such as
Access), you may use DBEXPORT to export
it and then import it into the other
database application. It is pipe-delimited
data with the first line containing headers
to identify the data.
Issues to Consider
Prior to Calling
SDC Client
Services
1) What version of PbAdmin is it? What version of
ProtoBase is it? What operating system and
version is it? What type of network and version is
in use? What third-party transaction processor(s)
are in use?
a) To indicate a version number, look at the logon
screen for PbAdmin. You can also run pbchkver
pbfe in a Unix environment or pbchkver pbfe.exe
in a DOS or Windows environment.
b) Run pbchkver pb (or pb.exe) to get the
ProtoBase version number.
c) Type ver [ENTER] at the DOS command line for
DOS version. If Windows is involved, look for an
“about program manager” menu item on the help
for the program manager.
294
08/2000
Issues to
Consider Prior to
Calling SDC
Client Services
(cont.)
d) For UNIX or network versions, look for indications
of version numbers at bootup or login, or contact
your system administrator for the version you are
running.
e) Obtain transaction processor information by
determining the SofTrans module number you
have. SofTrans module numbers may be
obtained by examining the Credit Card Tables
setup screens, or by running a copy of the
“Print Configuration” printout from the
ProtoBase Configuration menu, or a copy of
the PBCONFIG.LST file in the pbadmin\DB
subdirectory.
2) Has this installation been running for a while, or is it a
new installation? If running for a while, what, if
anything, has changed recently on either the computer,
modem, network, ProtoBase or merchant setup?
08/2000
295
Issues to Consider
Prior to Calling
SDC Client
Services
(cont.)
3) Is the problem with configuring ProtoBase or
PbAdmin, with running authorizations (or certain types
of transactions), or only during settlement? Or is it a
problem getting PbAdmin to run properly (screens or
programs not running or not working correctly)?
4) Configuration problems –
a) Can you get to the screen that shows Processors,
Devices, etc?
I) If not, either you are running out of memory, or
you are having problems “shelling out” to
subprograms.
A) If on a DOS system, type mem /c |more
[ENTER] at the command prompt and note
available memory under 640K (minimum
largest executable program size is 520K).
Also for DOS systems, note the value of the
COMSPEC environment variable. On the
main ProtoBase directory, type dir /s
command.com [ENTER]. Verify
ProtoBase only has access to one correct
version of the file COMMAND.COM.
B) Set the environment variable DBLEVEL=4
and reproduce the problem (this can be set
on the INI File screen in PbAdmin.) When
you do this, exit out of PbAdmin and then log
in again. Look for the files PBADMIN.STE
and PBCFG.STE in the PbAdmin directory,
and get copies of them for SDC Client
Services to examine.
296
08/2000
Issues to Consider
Prior to Calling
SDC Client
Services
(cont.)
II) If on a DOS system and you get an error when
trying to “Run Configuration”, you may have a
path name length problem. If you are shown a
file with an error message in it, print the file and
obtain a copy for SDC Client Services.
A) Make sure that you have mapped a drive on
the network so that the PBADMIN and
PBFE directories appear at the root for the
mapped drive. If not, the command line
used internally by PbAdmin to run the
ProtoBase configuration may be too long.
You will probably have to edit the
PBADMIN.INI or PBFE.INI file to change
paths. This can be done in PbAdmin on the
INI File screens in the Administrator Setup
Menu, or you can edit the files with a
standard text editor.
B) For DOS operating systems: If you are
getting an error message in a file on the
screen, then either one of your files are not
CPS compliant or you have an error in your
configuration, or ProtoBase may still be
running. If you see text such as “hit a key
to continue” followed by an indication that
it is not CPS compliant, you probably have
the DOS environment variable “DIRCMD”
set to include a “/p” option. Set DIRCMD=
to clear this environment variable and try
again.
b) Problems getting anything to happen at all –
I) If you get an error message such as “Unable to
locate pbaderr.txt”, your environment
variables are not set properly. Or, if you have
copied these files from another directory, your
file may have the incorrect paths in it.
08/2000
297
Issues to Consider
Prior to Calling
SDC Client
Services
(cont.)
II) If on a DOS system and you get to various
points on the screen and suddenly nothing
happens, or you get inconsistent error
messages, you are probably running out of
memory. At the command prompt, type mem /c
| more [ENTER] and note how much low DOS
memory there is (largest available program
size).
c) Problems running READCFG –
I) If you have a previous PbAdmin setup where
you have copied the PBCONFIG.LST file to
PBCONFIG.CFG and are attempting to re-read
the configuration:
A) If you have “Enable Auto Dial Backup” set
on, you must delete the definitions for
terminals ending in “B” from the
configuration file prior to running
READCFG. These are backup terminals
which will cause confusion if they are read in
again. (This only applies to a PbAdmin 4.1
configuration file that does not have backup
terminal information.)
B) If you have more than one location
configured, terminals will only be read into
the location specified when you run
READCFG from the command line. You will
have to manually move any terminals from
secondary locations to the proper location
from within the PbAdmin setup screens.
(This only applies to a PbAdmin 4.1
configuration file that does not have backup
terminal information.)
C) A maximum of 24 BIN ranges can be read in
using READCFG. Make sure you remove
any unnecessary BIN ranges.
298
08/2000
Issues to Consider
Prior to Calling
SDC Client
Services
(cont.)
d) Problems logging into PbAdmin –
I) If you are installing PbAdmin for the first time,
and do not already have PBADLOCA.DAT,
PBADLOCA.IDX, PBADUSER.DAT, and
PBADUSER.IDX in the PBADMIN\DB
directory, copy them from the PBADMIN\DB\
DEFAULT directory. These files contain the
default user “pbadmin” with password
“pbadmin”, and location “Test Location”, which
must be present in order for you to add your
own location data.
5) Problems running authorizations or other transactions
(not settlement) –
a) Make sure the paths are all correctly set, and that
PBDIRECT (for non-DOS) or PBARB (for DOS)
has been started successfully.
b) Make sure that the PBTERM variable is set to a
unique value for NetBIOS applications for each
physical computer. This only applies to DOS
systems.
c) Make sure that the PC running ProtoBase does not
use a screen saver.
08/2000
299
Issues to Consider
Prior to Calling
SDC Client
Services
(cont.)
d) If you are getting errors from the processor on
authorizations, or errors from ProtoBase (such as
invalid transaction codes), create temporary files and
debug files for SDC Client Services. Set the
“DBLEVEL=4” environment variable in the shell where
PBFE is called, or in the INI File. Then run the
transaction in question. If done correctly, there will be
a PBFE.STE file with non-zero size in the PBFE
directory. In addition, there will be temporary files in
the PBFE\DEBUG directory. These are the input files
that PBFE uses to call PB. Make sure the DEBUG
files have a current date/time, or delete files in the
DEBUG directory prior to running the transaction to
make sure the correct files are captured. In some
cases, temporary files may not be created if the error
is occurring prior to calling PB.
e) If the errors are intermittent, try to locate a
transaction that the error is occurring on, preferably
repeatedly. If a transaction that failed once works
when tried again, it is most likely not a data
problem. Contact SDC Client Services to
determine which files are needed in this case.
Client Services may be reached toll free at 1-877SDC-1799. Please have your customer account
number available.
6) Problems running settlement –
a) Try to narrow the problem down. Some problems
may be caused by a single bad transaction, or by a
single type of card. Try settling each half of the
batch separately, to help locate a potentially bad
transaction. Contact SDC Client Services as
soon as possible to resolve the issue, since
delays will only result in expired
authorizations and more transactions not
being settled.
b) Check the Deposit Log to determine if the site has
ever successfully settled, or if anything has changed
since the last successful settlement. This includes any
bad settlements which may have occurred or new
merchant files. Sometimes a bad batch must be
cleared at the processor before any more may be
attempted.
300
08/2000
Issues to Consider
Prior to Calling
SDC Client
Services
(cont.)
c) Collect the files in the PBADMIN\API\settlement
directory for the location in question. These are the
temporary files created during the previous
settlement attempt, and may contain information
that will help us re-create settlement problems. It is
important to capture these prior to attempting
another settlement, since they are cleared prior to
each settlement attempt.
d) If you get “Batch out of Balance” errors, these
can indicate that one of the settlement programs
did not execute successfully (unless the batch really
is out of balance). Set “DBLEVEL=4” and attempt
the settlement again. Collect the PBADSET.STE
file and the files in the API directory for use by SDC
Client Services.
e) Look at the files that created the error. Check for
invalid expiration dates. These problems usually
occur at the beginning of a new month, when cards
which expired the previous month may still be
present in the database.
f) Look for invalid transaction amounts (such as $0
dollar transactions, or transactions for less than
$1.00). These may not be allowed by transaction
processors, or may cause problems with
ProtoBase. Remove any such transactions from
the settlement and try them again.
g) Call the transaction processor to determine if there
is a problem with their settlement system. Also call
SDC Client Services to determine if other sites
using the same processor have been having
problems. These can indicate problems with the
processor or with ProtoBase, which may possibly
be corrected with an updated SofTrans set for the
processor.
08/2000
301
Issues to Consider
Prior to Calling
SDC Client
Services
(cont.)
h) If you are settling an unusually large batch, or if you
are running short of disk space, try reducing the
size of the settlement. Sometimes large
settlements produce unacceptably large temporary
files which may fill up your available disk space.
They also increase the chance of communication
errors.
7) Make sure the attributes on files and directories are
set up so that PbAdmin can access them. Files should
not be read-only. Make sure that if PBFE is executed
remotely, that the user it logs in as is configured
properly.
8) Make sure there are no performance issues on the
network, and that the modem is operating properly. A
slow network can cause errors in ProtoBase interprocess communications. Be sure to check network
loading at the time of day problems are noticed. If the
network has changed recently, make sure that if your
setup uses NetBIOS, that proper software “bridges”
are in place to allow NetBIOS communications
between hubs on a multi-hub network. Also make sure
that network permissions and variables have not been
altered by the installation of a new network.
9) If nothing seems to work on the network drives, copy all
files to a local hard-disk and do not connect the
computer to the network. Change paths in the INI files
(this can be done by using a text editor, or through
PbAdmin on the INI File screens). If it works on the
local drive but not on the network, the network is most
likely at fault.
10) If a program is crashing (leaving core files in
UNIX or raising an exception window in
Windows or OS/2), this can be caused by
bad data in the PBMERC.DAT file or invalid
data in the transaction. Call SDC Client
Services for assistance toll free at 1-877SDC-1799. Please have your customer
account number available.
302
08/2000
Issues to Consider
Prior to Calling
SDC Client
Services
(cont.)
11)
If you get “c-tree” errors such as “c-tree internal
error”, your database may have been corrupted. This
can be caused by the computer going down while a
program is accessing the database. Usually running
“admbuild -a” while ProtoBase is shut down will fix
these kind of problems. These errors can also be
caused by low available memory in DOS.
12) If you get “file locked” errors, there may be a left-over
lock file from a previous program, or someone else
may be running at the same time you are. In DOS,
type dir /s *.lck [ENTER] at the command prompt to
find lock files that may be present. If you know that
nobody else is running PbAdmin, and ProtoBase is
shut down, these may be deleted.
NOTE:
Not all lock files appear in the same
place. Some appear in the DB
directory, the BATCH directory, or the
settlement directory under API or
BATCH.
13) If the .DAT file is corrupted and ADMBUILD cannot fix
it, you should try to dbexport the database, remove
the .DAT and .IDX files, and then dbimport to restore
the file. This may work since dbexport does not try to
use indexes when exporting, and recreating the file will
correct any possible corruption.
08/2000
303
Error Messages/Solutions
The following table describes PbAdmin errors that you may encounter. The table
lists the negative error number, message, reason or cause for the error, and
common solutions. If a positive error message is received, refer to the Error
Messages Addendum for a description of various ProtoBase response codes and
error messages.
Error #
Error Message
Reason/Solutions
-1
INTERNAL ERROR
For reasons unknown, an error occurred while
attempting to access any of the c-tree databases.
Possible reasons:
• Insufficient memory
• The database is corrupted
Try reindexing the databases by using the
“admbuild -a” command in the Administrator
subdirectory or increasing memory size.
-2
INVALID DATABASE
An invalid database number was given while trying
to process a command. Call SDC Client Services
toll free at 1-877-SDC-1799.
-3
DATABASE ALREADY
EXISTS
An attempt was made to create a database that
already exists. Call SDC Client Services.
If you have attempted to delete a database, make
sure you remove both the .DAT and .IDX files.
-4
DATABASE DOES NOT
EXIST
An attempt was made to open a database that
does not exist. Probable cause is that the paths
on the Global/Local INI File screens were not set
up.
Log into PbAdmin, go into Administrator Setup>Global/Local INI File screens and save the
information.
Verify paths on the Global/Local INI File screens
and the environment variables.
-5
DUPLICATE ERROR
A transaction currently being processed or
previously processed has been received a second
time. If the duplicate is of a previous transaction,
setting the “Duplicates Allowed” flag to “Yes” in the
Location Information screen will allow this
transaction into the database.
-6
FIND FIRST OR LAST
An error occurred during a search procedure. Call
SDC Client Services toll free at 1-877-SDC-1799.
-7
NO MATCHING RECORDS
No matching records were found when at least one
was expected. Verify information. (This may be
normal in some cases, when records do not exist.)
304
08/2000
Error #
Error Message
Reason/Solutions
-8
RECORD NOT A SUBSET
Same as error -7 above.
-9
OUT OF MEMORY
The program ran out of memory during processing.
Increase available memory or reduce the number of
transactions being processed.
-10
RECORD LOCKED
An attempt was made to modify a record that was
already locked by another process. Retry the
transaction. If that fails, try reindexing the file
using the Database Management->Rebuild
Database selection in the Administrator System.
-11
DATABASE NOT
INITIALIZED
A transaction could not be processed due to an
internal logic error. Call SDC Client Services toll
free at 1-877-SDC-1799.
-12
LOCATION NOT SET UP
FOR MERCHANT
The terminal given in field 109 does not reference
back to a valid card number/ merchant key/location
combination. Log into the Administrator Setup>ProtoBase Configuration area and verify that:
• The terminal belongs to the proper location
(Terminals).
• The terminal and card type combination is
setup with the proper merchant key (Card
Tables->Edit).
• The settings were successfully configured with
ProtoBase (Run Configuration).
-13
UNABLE TO OPEN FILE
An attempt was made to open a file that does not
exist. Probable cause is that the paths on the
Global/Local INI File screens were not set up.
Log into PbAdmin, go into Administrator Setup>Global/Local INI File screens and save the
information.
Make sure the file MKEYLIST.DAT exists in the
DB directory.
Verify that all of the files in the DB directory have
read/write permissions set for all users.
-14
PROTOBASE OUTPUT
FILE NOT FOUND
ProtoBase did not respond with an output file.
Verify paths are set properly on the Global/Local
INI File screens and the environment variables.
Verify ProtoBase is currently running.
08/2000
305
Error #
Error Message
Reason/Solutions
-15
TRANSACTION NOT YET
SUPPORTED
A transaction was received in the input file that is
not currently supported by PbAdmin. Call SDC
Client Services.
-16
FINAL AMOUNT TOO
LARGE
A prior authorization or close transaction was
received whose final amount exceeds the
previously authorized amount for the matching
reference/card number. Solutions:
Issue an authorization for the difference.
OR
Setup the Administrator System to
automatically do so by setting the “Auto
Authorize Difference” flag to “Yes” in Location
Information.
-17
SETTLEMENT IN
PROGRESS
Transactions cannot currently be run because a
settlement is in progress for this location. Try
again later. If the problem persists and it is
confirmed that no settlement is actually in
progress, set the “Settlement in Progress” flag to
“No” in Location Information.
-18
INVALID DATA IN FIELD
The field number listed contains invalid data.
Consult the Integration section for validation
criteria.
-19
INVALID LENGTH FOR
FIELD
The field number listed is either missing or
contains invalid data. Consult the Integration
section for valid lengths.
-20
ERROR CREATING API
FILE
The ProtoBase file could not be created.
Verify paths are correct on the Global/Local INI File
screens and the environment variables.
Verify that directory permissions for all ProtoBase
and Administrator directories are set for read/write
for all.
-21
CANNOT OPEN TABLE
FILE
The reversal file PBREVSUP.TXT or history file
PBHSTBL.TBL could not be accessed.
Verify the files exist in the DB directory.
Verify files have read/write permissions for all.
-22
BATCH OUT OF
BALANCE
For host capture systems only. The batch totals of
the Administrator “shadow” file do not match what
the host processor expects. Extra reconciliation
with the processor should take place.
306
08/2000
Error #
Error Message
Reason/Solutions
-23
ERROR MOVING TO
HISTORY-BATCH GOOD
An error occurred while moving an approved
settlement to history. These records will usually
show up with a status of “I” on the Select/View/Edit
Confirm with the processor that the settlement was
accepted.
If batch was accepted, use the Database
Management->Modify Transaction Status utility to
move the in-progress (I) transactions to history.
If batch was not accepted, use the Database
Management->Modify Transaction Status utility to
change all of the in-progress (I) back to selected
(X).
-24
ERROR RESETTING
WORKING FLAGS-BATCH
BAD
show up with a status of “I” on the Select/View/Edit
Transactions screen. See above for procedures.
-25
ERROR RESETTING
WORKING FLAGS-BATCH
GOOD
show up with a status of “I” on the Select/Edit/View
Transactions screen. See above for procedures.
-26
FILE NOT FOUND
An attempt was made to open a file that does not
exist.
-27
RETURN CODE NOT
FOUND
An error occurred when trying to access file. Call
SDC Client Services.
-28
SHELL PROGRAM NOT
RUNNING
An error occurred while attempting to run PbAdmin
on an OS/2 operating system and the shell
program has not been started. Start the shell
program (PBSHELL.EXE).
-29
UNABLE TO CREATE
CHILD PROCESS
An error occurred while attempting to spawn a
process. Call SDC Client Services.
-30
FILE LOCKED
An attempt was made to access a file that is
already locked by another process. Try again
later, or look for *.LCK files in the subdirectory. If
message continues, call SDC Client Services.
-31
UNABLE TO OPEN
VALID.DAT
The specified file could not be opened. Check
permissions, see if the file still exists, or look for
*.LCK files.
08/2000
307
Error #
Error Message
Reason/Solutions
-32
UNABLE TO OPEN
REVSUP.TXT
*.LCK files.
-33
(Not used at this time)
(Reserved for future use.)
-34
UNABLE TO OPEN
PBERROR.TXT
*.LCK files.
-35
UNABLE TO OPEN
PBADERRS.TXT
*.LCK files.
-36
UNABLE TO OPEN
MKEYLIST.LCK
*.LCK files.
-37
UNABLE TO OPEN
MKEYLIST.DAT
*.LCK files.
-38
UNABLE TO OPEN
TERM.DAT
*.LCK files.
-39
MASTER INDUSTRY
ERROR
A transaction cannot be run through a terminal set
to a “Master Industry” location.
-40
DEBIT CODE ERROR
A transaction illegal for Debit was attempted with
the Debit qualifier set. This is an integration error.
-41
UNABLE TO OPEN
PROTOBASE BATCH
FILE
A batch file was not successfully created for
ProtoBase to settle, or PbAdmin could not open a
batch file after settlement. Check the batch file or
other files in the settlement directory for errors.
Call SDC Client Services for assistance.
-42
UNABLE TO OPEN
PROTOBASE OUTPUT
FILE
PbAdmin could not open the output file after a
transaction was run through ProtoBase. This
indicates ProtoBase abnormally terminated without
returning an output file. Call SDC Client Services
for assistance.
Any number
not defined
in this table
UNDEFINED ERROR
An unknown error was encountered. Call SDC
Client Services and report the error number.
308
08/2000
Other PbAdmin Errors/Solutions
The following table describes error messages that you may encounter in PbAdmin. The
table lists the message, reason for the error, and common solutions.
Error Message
Reason/Solutions
Access Denied!
The logged in user does not have security permissions to
perform this function.
American Express Pending
There is already an American Express settlement pending.
This deposit must be cleared either manually or by calling
the processor to check the status via the “View Deposit Log”
option. If there is no actual batch pending, change the
“American Express Pending” flag to “No” in Location
Information.
At least two fields must be used
At least two fields must be entered to perform a proper
search.
Cannot access settlement file
The settlement file could not be accessed. ProtoBase is
currently settling another batch. Try again later. Make sure
permissions for the ProtoBase directory are set for
read/write.
Cannot delete Location because
transactions exist
An attempt has been made to delete a location where active
transactions exist. This is not allowed.
Cannot lock file. Already in use
The record is already in use by another process. The
changes could not be saved. Try again later.
Cannot remove current user. NOT
DELETED!
An attempt has been made to remove the logged in user.
This is not allowed.
Card type not valid for this
location
This card type is not set up for the location in question.
Changes have been saved
The changes have been successfully saved.
Choice list program not found
(Not used)
Comm Director not running
During settlement, PbAdmin determines that the ProtoBase
communications director is not running. Ensure the director
is running.
c-tree Error
c-tree encountered a memory error.
Increase the largest executable size (available memory).
c-tree Internal Error
For unknown reasons, an error occurred while attempting to
access any of the c-tree databases. Possible reasons:
• Insufficient memory
• The database is corrupted
Try reindexing the databases by using the “admbuild -a”
command in the Administrator subdirectory or increasing the
available memory.
08/2000
309
Error Message
Reason/Solutions
Delete program not found
The program ADMPURGE was not located in the PbAdmin
directory.
Error configuring card types
The file MASTER.CRD in the PbAdmin DB directory could
not be accessed.
Verify file paths on the Global/Local INI File screens and the
environment variables.
Verify the directory and file permissions for the DB directory
are set to read/write for all.
After running “Run Configuration”, confirm the MASTER.CRD
file exists.
Error configuring modems
The file UCOMM.DAT in the PbAdmin DB directory could not
be accessed.
After running “Run Configuration”, confirm the UCOMM.DAT
file exists.
Error configuring processors
The file UPROC.DAT in the PbAdmin DB directory could not
be accessed.
After running “Run Configuration”, confirm the UPROC.DAT
file exists.
Error configuring terminals
The file UTERM.DAT or <TERMINAL>.DAT files in the
PbAdmin DB directory could not be accessed.
After running “Run Configuration”, confirm the files exist.
Error deleting record
The selected record could not be deleted. Possible causes:
• Record is already locked by another user. Try again
later.
• c-tree encountered a memory error.
• The files in the PbAdmin DB directory do not have
read/write permission.
Error during status check
An error occurred during the American Express status
check. Either no status was available, or some other error
occurred. Try again later.
310
08/2000
Error Message
Reason/Solutions
Error executing ProtoBase
configuration program
The ProtoBase configuration program PBCONFIG could not
be executed. Possible reasons are:
• You are running 32 bit ProtoBase with PBOS=DOS or
PBOS=Client.
• PBCONFIG is not located in the ProtoBase directory.
• The paths on the Global/Local INI File screens or the
environment variables are invalid.
• PBCONFIG does not have read/write/execute
permissions set for all.
Error Loading File – Not enough
Memory
The program is running out of memory. In a DOS system,
increase available memory (largest executable program
size).
Error purging file
An error occurred while attempting to purge records from a
file. Make sure that the PbAdmin DB directory and all of its
files have read/write permissions set for all.
Error rebuilding index
An error occurred attempting to reindex a file. Make sure
that the PbAdmin DB directory and all of its files have
read/write permissions set for all.
Error restarting ProtoBase with
new settings
(Not used)
Error saving file NOT SAVED
An error occurred while attempting to save a file. Verify file
permissions.
Error setting up choice list
The choice list file could not be created and read into
memory. Possible reasons:
• Not enough memory on machine.
• Choice list file ADMLIST.TXT is missing in the PbAdmin
DB directory.
• File paths on the Global/Local INI File screens or
environment variables are incorrect.
• All files in the PbAdmin DB directory do not have
Possible solutions:
• Increase largest executable program size.
• Verify file exists in the DB directory.
• Verify paths are correct on the Global/Local INI File
• Verify that directory permissions for all ProtoBase and
PbAdmin directories are set for read/write for all.
Error writing to printer
Check printer and printer settings.
File list program not found
(Not used)
File Saved Successfully
Your file was saved. (Not an error.)
08/2000
311
Error Message
Reason/Solutions
File Too Large for Default Viewer
File is too large to view with default viewer. Either install an
optional internal viewer, or save/print file when prompted.
History search program not found
(Not used)
Insufficient Memory Available
Increase largest executable program size.
Invalid account number
Possible causes:
• The account number is invalid.
• The card type is not set up to be accepted by this
terminal.
• The card did not pass a MOD 10 check.
• The card number contained invalid data.
• The length is incorrect.
Re-enter, or check configuration.
Invalid amount entered
The dollar amount entered is invalid.
Missing decimal point.
Too many numbers to add decimal point.
Amounts may not be negative.
Invalid expiration date
The card is expired or the date entered is not a proper date.
Invalid login. Access denied
The permissions set for this user do not allow access to this
selection/function.
Invalid mag stripe info entered
The track information does not match between track 1 and
2, or card could not be parsed.
Invalid Merchant Key
One of two errors has occurred:
The merchant key entered does not exist in the
ProtoBase file PBMERC.DAT.
While saving a terminal card table, a blank merchant
key was encountered for a selected “checked” card
range.
Invalid password. Please reenter
The password is incorrect. Remember, password is case
sensitive.
Invalid printer parameters in file
The PbAdmin file PRINT.TXT contains invalid data, or is
corrupted. Try selecting a different printer.
Invalid printer port
The port specified in the Location Information screen cannot
be accessed.
Invalid processor
The transaction processor entered is not in the ProtoBase
merchant file PBMERC.DAT. Make sure you have entered
the transaction processor. Call SDC Client Services.
312
08/2000
Error Message
Reason/Solutions
Invalid Range Entered for Card
A card BIN range must have a lower number on the left and
a greater number on the right.
Invalid Record -- Duplicates
Existing Entry
The entry you are saving already exists in the database.
Invalid selection
The value entered in this field is invalid. Press the [F2] key
to view a list of valid values.
Invalid terminal/location
combination entered
The terminal selected for this transaction does not belong to
the currently logged in location.
No printer defined
No printer type has been defined in Location Information.
No records available for selection
PbAdmin cannot find any records of the requested type in
the database.
No settlement pending
There is not a settlement currently pending with American
Express, so the status check could not be performed. If this
is incorrect, change the “American Express Pending” flag to
“Yes” in Location Information and run again.
Not a Realtime or Settleable Host
Capture Transaction
You have tried to toggle the status on a transaction that is
not real-time or host capture. Transaction must have an “h”,
“U”, “R”, or “r” to be toggled.
Printer is currently busy
Printer has sent back a busy signal; try again later.
Printer is out of paper
Printer is offline or out of paper.
Printer is turned off or is offline
Printer is offline or not turned on.
Processor setup files not found
The ProtoBase setup files PBSET#.DAT and PBMRC#.DAT
are not currently located in the ProtoBase directory. Please
verify. Call SDC Client Services.
ProtoBase Configuration program
not found
The program PBCONFIG was not found in the ProtoBase
directory: To resolve this problem:
• Verify the ProtoBase directories specified in the
Global/Local INI File screens and the environment
variables are correct.
• Verify that the executable PBCONFIG is located in the
ProtoBase directory.
• Verify the PBCONFIG program has read/write/execute
permissions for all.
ProtoBase is currently running a
deposit
The reconfiguration could not be completed because
ProtoBase is currently running a settlement. Try again later.
Record is No Longer Valid
A record on the screen has been deleted or changed. Exit
and re-enter the Select/View/Edit Transactions screen to
refresh the display.
08/2000
313
Error Message
Reason/Solutions
Reference number not found
The reference number entered is not located in the current
database.
Report generator not found
The program PBADREP was not located in the base
PbAdmin directory.
Required Field not Entered – Not
Saved
The cursor will be placed on the missing field when the
message is cleared. Please enter a value for this field.
Restart ProtoBase to activate
new settings
Upon successful completion of “Run Configuration”,
ProtoBase (PBDIRECT or PBARB) must be shut down and
restarted to activate the updated values.
Sale not Valid—Use Prior Auth
Indicates that a Sale transaction has been entered for a nonhost processor. Enter as a Prior Authorization transaction
instead.
Selected file not found
PbAdmin could not locate a required file. This can also
happen if you perform a report that generates no data, or if
your database contains no data. Call SDC Client Services if
you cannot resolve this problem.
Selection program not found
(Not used)
Sorting program not found
PBSORT (for non-UNIX) or SORT (for UNIX) could not be
executed.
Terminal Mkey does not match
transaction Mkey
The terminal deposit Mkey currently defined does not match
information in the transaction. You may attempt to fix this
on the Database Management menu.
Terminal not valid for this location
The specified terminal is not set up for the current location.
Select a valid terminal.
Transaction not found
No transaction was found that matched the entered criteria.
Transaction status error - change
not allowed
The status flag indicator of this transaction is set to a value
that does not allow editing. Status flags that cannot be
edited include:
>U= = Host Pending
>P= = American Express Pending
>I= = In progress for Settlement
Transaction type error - change
not allowed
The transaction type/code of this transaction is set to a
value that does not allow editing. Current transaction types
that cannot be edited are:
• Checks
• Debit Sale
• Debit Return
• Debit Void
314
08/2000
Error Message
Reason/Solutions
Unable to access choice list file
The choice list file could not be created and read into
memory. Possible reasons:
• Choice list file ADMLIST.TXT, ADMMODEM.TXT, or
ADMPROC.TXT is missing in the PbAdmin DB
directory.
• File paths on the Global/Local INI File screens or the
• Exiting ProtoBase and *.lck files still exist.
Possible solutions:
• Increase largest available executable program size.
• Verify file exists in the DB directory.
• Verify paths are correct on the Global/Local INI File
• Verify that directory permissions for all ProtoBase and
Unable to access help text file
The help text file could not be read into memory. Possible
reasons:
• Choice list file ADMHELP.TXT, or PBCFGHLP.TXT is
missing in the Administrator System DB directory.
• File paths on the Global/Local INI File screens or the
Possible solutions:
• Add memory to machine.
Unable to access modem file
•
Verify file exists in the DB directory.
•
Verify paths are correct on the Global/Local INI File
•
Verify that directory permissions for all ProtoBase and
The file UCOMM.DAT in the PbAdmin DB directory could not
be accessed. To resolve this problem:
• Verify file paths on the Global/Local INI File screens and
the environment variables.
• Verify the directory and file permissions for the DB
directory are set for read/write for all.
If running Run Configuration, confirm the UCOMM.DAT file
exists.
08/2000
315
Error Message
Reason/Solutions
Unable to access PBMERC.DAT
The ProtoBase setup file PBMERC.DAT cannot be
accessed. To resolve this problem:
• Verify ProtoBase paths on the Global/Local INI File
screens and the environment variables
• Verify the file PBMERC.DAT exists in the ProtoBase
directory
• Verify the file PBMERC.DAT has read/write permissions
set for all
Unable to access printer defs file
The PbAdmin file PRINT.TXT was unable to be accessed.
To resolve this problem:
• Verify paths on the Global/Local INI File screens and the
environment variables
• Verify the file PRINT.TXT exists in the PbAdmin DB
directory
• Verify the file PRINT.TXT has read/write permissions for
all
Unable to access processor file
The file UPROC.DAT in the PbAdmin DB directory could not
be accessed. To resolve this problem:
the environment variables
directory are set for read/write for all
• If running Run Configuration, confirm the UPROC.DAT
file exists
Unable to access report file
The report file could not be accessed. No records were
found to generate the report.
Unable to access selection list
The processor, terminal, or device list could not be built.
Verify the PbAdmin DB directory has read/write permissions
set.
Unable to access terminal file
The file UTERM.DAT or <TERMINAL>.DAT files in the
PbAdmin DB directory could not be accessed. To resolve
this problem:
the environment variables
directory are set for read/write for all
• If running Run Configuration, confirm the files exist
Unable to build selection list
set.
316
08/2000
Error Message
Reason/Solutions
Unable to change directory
An unsuccessful attempt was made to change to a specific
directory. To resolve this problem:
• Verify the ProtoBase directories specified on the
Global/Local INI File screens and the environment
variables
• Verify the ProtoBase directory has read/write access
set for all
Unable to change industry
because unsettled records exist
An attempt has been made to change the location industry
code while unsettled transactions are still in the current
working database. Settle or remove existing settleable
transactions.
Unable to execute Editor
command
Unable to execute the optional internal viewer program.
Check path on the Global/Local INI File screens.
Unable to execute READCFG
program
(Not used)
Unable to execute settlement
program PBADSET
The settlement program PBADSET could not be executed.
Possible reasons:
• PBADSET is not located in the ProtoBase directory
• The paths on the Global/Local INI File screens or the
environment variables are invalid
• PBADSET does not have read/write/execute
permissions set for this user
Unable to execute System
command
Unable to “shell” to a subprogram. Check for bad
COMPSEL (DOS) or PBOS setting.
Unable to open file
An error occurred while attempting to open a file. To resolve
this problem:
• Verify paths specified on the Global/Local INI file
screens and the environment variables
• Verify all files in the PbAdmin DB directory have
read/write permission set for all.
Unable to open PBCONFIG.CFG
The ProtoBase file PBCONFIG.CFG in the ProtoBase
directory could not be accessed. Verify the directory and
file permissions for this directory are set to read/write for all.
Unable to update selection list
set.
Unable to write to Administrator
Log
The location’s Administrator Log could not be updated.
Make sure all of the files in the PbAdmin DB directory have
Unable to write to printer port
The port specified in Location Information cannot be
accessed. Check permissions, verify path, and configure
the device name.
08/2000
317
Glossary
ProtoBase
®
Glossary
318
08/2000
Glossary
ProtoBase and Payment Services Industry Terms
ABA - See American Bankers Association.
ACCOUNT NUMBER - A primary cardholder account number that is embossed
and encoded on a plastic card. This number identifies the issuing agent and
the cardholder.
ACH - See Automated Clearing house.
ACQUIRER - A bank or company that acquires data relating to transactions from
a merchant or card acceptor for processing. The acquirer enters this data
into interchange, either directly or indirectly. See Interchange.
ACQUIRING BANK - Bank that receives the credit card transactions and then
settles with the issuing banks. This is an acquirer.
ADDRESS VERIFICATION SERVICE (AVS) - A service to help combat fraud in
mail order/telephone order transactions by use of cardholder billing address
information in the authorization request.
AMERICAN BANKERS ASSOCIATION (ABA) - The trade association of
American bankers. This body also has the responsibility of assigning the
registration authority for identification numbers.
AMERICAN EXPRESS - A company that specializes in the issuance of Travel
and Entertainment (T&E) credit cards. They are in competition with Visa,
MasterCard, and other card issuing companies. They offer many different
cards ranging from their Classic card to a Small Business card. American
Express services the cards that they issue. They are their own transaction
processor with their own processing network.
APPROVAL RESPONSE - An authorization response when a transaction is
approved.
ARBITRATION - The procedure used to determine responsibility for a
chargeback-related dispute between two members. To file an arbitration
case, a completed Summary of Arbitration Documentation form is submitted
after unsuccessful dispute resolution through a three-step
chargeback/presentment cycle. This usually occurs between the transaction
processors or institutions and a card company such as Visa or MasterCard.
ATM - See Automated Teller Machine.
08/2000
319
Glossary
ATM/DEBIT CARD - This is a plastic card that is used at ATM’s to access the
cardholder’s monetary accounts (Checking, Saving, Lines of Credit).
AUTHORIZATION - A process where an issuer, an authorizing processor, or
stand-in processing approves an authorization request. This includes
domestic authorization and international authorization. An approved
authorization places a hold against the cardholder’s credit limit for the dollar
amount approved. Most authorizations have a life cycle of three to five days,
then the hold against the cardholder’s credit limit is released. A transaction
which settles will usually match an approved authorization amount and clear it
from the authorization status, thus removing the hold against a cardholder’s
credit limit.
AUTHORIZATION CODE - A code that an issuer, its authorizing processor, or
stand-in processing provides to indicate approval or denial for an
authorization request. The code is returned in the authorization response
message and is usually recorded on the transaction receipt as proof of
authorization.
AUTHORIZATION ONLY - Used to reserve an amount against a credit card’s
available limit for intended purchases. Auth Onlys are most frequently used
in the lodging, restaurant, and car rental industries, where the transaction
amount is finalized later and entered via a Prior Authorized Sale transaction.
AUTHORIZATION PROCESSOR (“AUTHORIZER”) - Third-party transaction
processor such as NaBANCO, FDR, TransNet, or National Data Corp
(NDC). Processors route transactions to the appropriate authorizer services
and settlement banks.
AUTHORIZATION REVERSAL - A transaction for a specified dollar amount used
to reverse an approved authorization request.
AUTHORIZATION TOLERANCE - In PbAdmin, the percentage a PriorAuthorized Sale transaction can vary from the corresponding original
Authorization Only without either returning an error or having to run an
Incremental Authorization or Authorization Reversal.
AVS - See Address Verification Service.
AUTOMATED CLEARING HOUSE (ACH) - A group of processing institutions
linked by a computer network to exchange (clear and settle) electronic
payment transactions. They electronically processes payment of funds and
government securities among financial institutions and businesses.
AUTOMATED TELLER MACHINE (ATM) - An unattended, magnetic stripe
reading terminal that requires the entry of a personal identification number
(PIN). It disburses currency and performs other teller functions, such as
transfer of funds and deposits.
320
08/2000
Glossary
BANK CARD - A debit or credit card issued by a bank.
BANK CARD ASSOCIATION - A group of banks formed either for the purpose of
sponsoring a program, (Visa or MasterCard) or to use common processing
and administrative facilities.
BANK IDENTIFICATION NUMBER (BIN) - A six-digit number assigned by Visa
or MasterCard and used to identify a card issuing institution, who issues
plastic cards with their logos. This number is the first six numbers embossed
on the cards. The ranges are governed by ISO standards.(See International
Organization for Standardization).
BASE I - The data processing systems, networks, and operations that are used to
support and deliver authorization-related services for transactions that are
subsequently cleared and settled through BASE II at Visa.
BASE II - The VisaNet data processing systems, networks, and operations that
are used to support and deliver the clearing and settlement services related
to the interchange of paper with Visa.
BATCH - A group of approved credit card transactions that occurred during a
given time interval. A batch is introduced by a batch header record, contains
one or more batch detail records, and is summarized in a batch trailer
record. Within one batch the following fields are homogeneous: batch
sender, batch receiver, settlement currency. Batches of transactions are
subsequently transmitted to a third-party transaction processor for funds
transfer.
BATCH DEPOSIT - Process by which batch file data has been electronically
transmitted to the transaction processor and is being processed.
BATCH FILE - A computer disk file containing one or more batches of transaction
data.
BATCH PROCESSING - A type of data processing operation and data
communications transmission where related transactions are grouped
together and transmitted for processing, usually by the same computer and
under the same application; generally regarded as non real-time data traffic
comprising large files; type of data traffic where response time is not critical.
BATCH SETTLEMENT - Process by which batch file data is electronically
transmitted to a transaction processor.
BIN - See Bank Identification Number.
CARDHOLDER - An individual to whom a card is issued, or who is authorized to
use an issued card.
08/2000
321
Glossary
CARD ISSUER - Any association member financial institution, bank, credit union,
or company that issues, or causes to be issued, plastic cards to cardholders.
CARD READER - Any device that is capable of reading encoding on plastic
cards. See Magnetic Stripe Reader.
CARD CONFIGURATION - ProtoBase configuration file section that defines the
type of credit, debit, or other tender types accepted by the merchant.
CARD VERIFICATION CODE (CVC) - A unique check value encoded on the
magnetic stripe of a card to validate card information during the authorization
process. The card verification value is calculated from the data encoded on
the magnetic stripe using a secure cryptographic process. This method is
used by MasterCard.
CARD VERIFICATION VALUE (CVV) - A unique check value encoded on the
magnetic stripe of a card to validate card information during the authorization
process. The card verification value is calculated from the data encoded on
the magnetic stripe using a secure cryptographic process. This method is
used by Visa.
CASHIER - Generic term for the employee performing a transaction for a
business.
CARTE BLANCHE - This is a T&E credit card that competes mainly with
American Express, JCB, and Diners Club. See T&E.
CASH ADVANCE - A cash disbursement obtained by a cardholder through
presentation of their card at a financial institution in person, by mail, or
through an ATM.
CASH DISBURSEMENT - A transaction that is posted to a cardholder’s
monetary accounts when they receive cash from a teller, an ATM, or by mail.
CASH DISPENSER - This is the simplest ATM which will only allow cash
withdrawals.
CHARGEBACK - A transaction returned through interchange by an issuer to an
acquirer. A transaction is returned because of rules and regulations
violations or because it is disputed by a cardholder.
CHARGEBACK PERIOD - The number of calendar days from the endorsement
date of a transaction receipt (or processing date, as applicable), during
which time the issuer may exercise a chargeback right.
CHARGEBACK REASON CODE - This is a two-digit code identifying the reason
for a chargeback.
322
08/2000
Glossary
CHECK AUTHORIZATION - This is an authorization request being sent to a
check processing organization to validate a check presented as payment for
services. The processor usually approves or declines the authorization
request based on the presenter’s check writing history.
CHECK DIGIT VERIFICATION - An algorithm that is performed on the primary
account number (PAN) to ensure that numbers were not transposed or
miskeyed. The result is the last position of the account number, or check
digit. It is performed to validate a credit card number. Many card issuers
use the MOD-10 Check Digit routine.
CHECK GUARANTEE - A system providing merchants with varying degrees of
insurance against bad check losses by guaranteeing payment of the check
by the financial institution or the third party processor.
CHECK READER - A device that reads the numbers encrypted on the bottom of
most checks.
CHECK VERIFICATION - A system providing merchants with varying degrees of
insurance against bad check losses by verifying the authenticity of the check
and/or its presenter by using a check processing organization.
CIRRUS - Cirrus System Incorporated, a wholly-owned subsidiary of MasterCard
International Incorporated, operates the international ATM sharing
association known as “MasterCard/Cirrus ATM Network”.
CLEARING - All of the functions necessary to collect a clearing record from an
acquirer in the transaction currency and deliver it to the issuer in the billing
currency. It is used to reverse transactions as well. It can also process a fee
collection transaction. Clearing is part of the settlement process.
CLEARING PROCESSOR - A processor that provides clearing and settlement
services for merchants or other members.
CO-BRANDED CARD - This is a plastic card that is issued to a cardholder where
there is a joint sponsorship of that card between a merchant and the issuer.
Both of their names usually appear on this type of card.
COMMERCIAL CARDS - This is the formal name for the following three types of
plastic cards: Corporate Card, Purchase Card, and Business Card.
• A Corporate card is usually issued to the employees of a corporation,
where the corporation assumes all liability for the card’s usage. This is
usually issued to larger corporations.
• The Purchase card is issued to corporations. It allows the corporation
numerous parameters to control daily and monthly spending limits, total
credit limits, and where the card may be used. Many employees may be
issued the same card number.
08/2000
323
Glossary
•
The Business card is similar to the Corporate card, but issued to a
business with a few employees and where each employee is responsible
for their purchases.
COMMUNICATIONS - Collective term for any electronic transfer of data between
a merchant and a third-party transaction processor.
COMPLIANCE - A process where Visa or MasterCard resolves disputes between
members arising from violations of the International Operating Regulations,
when the requesting member can certify that a financial loss has occurred, or
will occur for a specific amount, and no chargeback right is available.
CONVERSION RATE - The rate applied to convert a transaction amount in the
acquirer's currency to U.S. dollars. The U.S. dollar amount is then converted
to the issuer amount by using the rate of the U.S. dollars to the issuer's
settlement currency.
CORRESPONDENT BANK - A depository institution that holds an account with,
or on behalf of, a settlement bank, and engages in an exchange of services
with that bank.
COUNTERFEIT CARD - One of the following:
• A device or instrument that is printed, embossed, or encoded so as to
purport to be a card, but that is not a card because an issuer did not
authorize its printing, embossing, or encoding.
• An instrument that is printed with the authority of the issuer and that is
subsequently embossed or encoded without the authority of the issuer.
• A card that an issuer has issued and that is altered or re-fabricated,
except one on which the only alteration or re-fabrication compromises
modification of the signature panel or cardholder signature.
CPS - See Custom Payment Service.
CREDIT LIMIT - This is a dollar amount assigned to a cardholder as the limit of
credit that they are approved to borrow. Credit card purchases are actually
loans to the cardholder by the issuer.
CREDIT UNION - A non-bank financial institution that is comprised of individual
members who are depositors, borrowers, and shareholders of the institution.
Credit unions usually offer their members the same services available at
most banks.
CUSTOM PAYMENT SERVICE (CPS) - Visa’s regulations for the information
that must be submitted with each transaction. Transactions must meet CPS
criteria in order to qualify for lowest transaction processing fees available.
Similar to MasterCard’s Merit. Approved transactions will deduct the dollar
amount from the cardholder’s “open to buy” or credit available.
324
08/2000
Glossary
CVC - See Card Verification Code.
CVV - See Card Verification Value.
DATA CAPTURE - Also known as electronic draft capture (EDC) or draft capture.
A data processing term for collecting, formatting, and storing data in
computer memory according to predefined fields, for example, customer
name, account number, and dollar amount of purchase. When a terminal
reads this information from a plastic card or from entries at a terminal, the
information is stored in computer memory for later output as a hard copy
printout or as soft copy on a CRT display. See Electronic Draft Capture.
DATA COMMUNICATIONS - High-speed communications between computers,
or between a computer and an associated input terminal or financial service
terminal (ATM, POS). Data communication involves telephone lines,
interfacing equipment, plus the computer and the terminal.
DATA ENCRYPTION STANDARD (DES) - A cryptographic algorithm adopted
by the National Bureau of Standards for data security. Encryption scrambles
personal identification numbers (PINs) and transaction data for safe
transmission.
DATASWITCH - This is a computer network that primarily serves the credit union
associations and was developed to exchange (clear and settle) electronic
transactions for processing institutions. It is similar in function to the ACH
(Automated Clearing House).
DEBIT - A charge to a customer’s bankcard account. A transaction, such as a
check, automated teller machine (ATM) withdrawal, or point-of-sale (POS)
debit purchase that debits a demand deposit account. On-line transactions
require the use of a personal identification number (PIN) and debit the
amount, usually the same day. Off-line transactions, which use separate
authorization and clearing messages, require a signature, and the account is
debited a few days later.
DEBIT CARD - This term is used to identify an ATM card as well as a Visa Check
card or a MasterCard MasterMoney card. It can also refer to any private
label card that might debit a cardholders cash accounts. Simply it is a
plastic card used to initiate a debit transaction. In general, these
transactions are used primarily to purchase goods and services and to
obtain cash, for which the cardholder's asset account is debited by the
issuer.
DEDICATED LINE - A communications circuit between two endpoints that is
permanently connected and always available. Also called a leased line or
private line.
08/2000
325
Glossary
DEMO MODE - A non-communicating start mode for ProtoBase/PBDIRECT. It
simulates the functions of ProtoBase without communicating or dialing out to
the processor. Adding a –d argument to the command line will start
ProtoBase in Demo mode. Since the processor is not involved, there are no
communication costs involved in testing ProtoBase for successful
integration. Also called No Comm mode.
DEPOSIT - Process of transmitting a batch of transactions from the merchant to
the acquiring institution in preparation for settlement.
DERIVED UNIQUE KEY PER TRANSACTION (DUKPT) - A type of debit
encryption system in which a new key is generated with every transaction.
The other type of debit encryption system is called Master Session.
DEVICE CONFIGURATION - ProtoBase configuration file section that defines the
device information. You must create a device configuration entry for each
port used to dial out or connect to a transaction processor computer.
DEVICE DRIVER - Software module providing for the use of a specific hardware
device, such as a modem or a card reader.
DINERS CLUB - Diners Club International is another T&E credit card. They
compete mostly with American Express, JCB, and Carte Blanche for their
credit card usage.
DISCOUNT FEE - Fee paid by the merchant to the merchant bank or other
contracted party for processing the merchant’s credit card sales
(transactions).
DISCOUNT RATE - This is the percentage rate that a merchant institution
charges the merchant giving deposit credit for handling merchant sales
drafts or electronic sales transmissions. The discount fee is the dollar
amount charged.
DISCOVER - Owned by Dean Witter, Discover & Co., this corporation issues
credit cards to individual cardholders and manages those accounts in-house.
They are a for-profit organization in competition with Visa and MasterCard
and other credit card Issuing Corporations They are closely tied to the Novus
Financial Corporation, another Dean Witter company. See Novus.
DRAFT CAPTURE - The act of electronically capturing transactions.. See
Electronic Draft Capture.
DUKPT - See Derived Unique Key Per Transaction.
EBT - See Electronic Benefits Transfer Card.
EDC - See Electronic Draft Capture.
326
08/2000
Glossary
EFT - See Electronic Funds Transfer.
EFTA - See Electronic Funds Transfer Act.
EFTS - See Electronic Funds Transfer System.
EIRF - See Electronic Interchange Reimbursement Fee.
ELECTRONIC AUTHORIZATION - Obtaining authorization for use of a
credit card by electronic means, as via computer equipment and
telephone line.
ELECTRONIC BENEFITS TRANSFER CARD (EBT) - This card may
have a magnetic stripe or a small microprocessor on it. The card
is used to replace the paper distributed by the government for
programs like the Women, Infants, and Children program and food
stamps. The cardholder may use this card and have the charges
deducted from their available benefit dollars for the program that
they are participating in. It is a card that is increasing in popularity
and use throughout the United States.
ELECTRONIC CREDIT APPLICATION - A credit application that is
transmitted electronically to a credit evaluation company (such as
Equifax) for approval recommendations.
ELECTRONIC DRAFT CAPTURE (EDC) - Use of electronic communications to
deposit credit card transactions for funding. This method routes the
transactions to Visa, MasterCard, American Express, Discover, other card
companies, or third-party processors.
ELECTRONIC FUNDS TRANSFER (EFT) - Process of electronically transferring
funds to or from an account. This evolved to eliminate the costly and time
consuming paper method.
ELECTRONIC FUNDS TRANSFER ACT (EFTA) - This is the federal regulation
which governs the electronic transfer of funds between all parties concerned.
It sets the guidelines or parameters for transferring funds electronically.
ELECTRONIC FUNDS TRANSFER SYSTEM (EFTS) - An electronic system
that moves financial data, designed to eliminate the paper instruments
normally associated with such fund movement. Examples classified as
EFT’s are ACH, POS, ATM, direct deposit, telephone bill paying, ECR’s,
automated merchant authorization systems, and pre-authorized payments.
ELECTRONIC INTERCHANGE REIMBURSEMENT FEE (EIRF) - An
intermediate Visa program for transactions that do not meet CPS criteria but
are cleared within three days.
08/2000
327
Glossary
ELECTRONIC WARNING BULLETIN - This is a data file containing all of the
restricted accounts or ranges on the Account Management System. This is a
file comprised of Visa and MasterCard account numbers that have
restrictions against them. An example would be a lost or stolen card. This
file is updated daily and is formatted to include each restricted account
number or range, chargeback effective date, and purge dates.
EMBOSSING - This is the term referring to the information that is printed in raised
lettering on the front of plastic cards. For example: There are four possible
lines which may be embossed on a Visa plastic card. They are the Account
number, the Expiration date, and two lines for the cardholder(s) name(s).
ENCRYPTION - The technique of modifying a known bit stream on a transmission
line so that it appears to be a random sequence of bits to an unauthorized
observer. It often is done automatically in the terminal or computer before
data is transmitted.
EXPIRATION DATE - The date, expressed numerically as month and year, after
which a plastic card is considered invalid.
EXPIRED CARD -A card on which the embossed, encoded, or printed expiration
date has passed.
FIELDS - Smallest data element defined within a file. A series of fields make up a
record; a group of records make up a file.
FLOOR LIMIT - An amount that Visa and MasterCard have established for single
transactions at specific types of merchant outlets and branches, above which
authorization is required. Many companies have their own floor limits and
some merchants have agreements with their merchant banks that include
floor limits. The two types of floor limits are:
• Standard Floor Limit. (Transaction amounts above this limit must request
an authorization.)
• Zero-Floor Limit (All transaction amounts must request an authorization.)
328
08/2000
Glossary
FORCED AUTHORIZATION - In PbAdmin, a manual authorization, such as a
voice authorization.
FRAUDULENT USER - An individual who is not the cardholder or designee and
who uses a card (or, in a mail/phone order or recurring transaction, an
account number) to obtain goods or services without the cardholder’s
consent.
FRAUDULENT TRANSACTION - A transaction unauthorized by the cardholder of
a bankcard. Such transactions are categorized as lost, stolen, not received,
issued on a fraudulent application, counterfeit, fraudulent processing of
transactions, account takeover, or other fraudulent conditions as defined by
the card company or the member company.
FULFILLMENT - The satisfaction of a retrieval request. The acquirer supplies the
issuer with the original slip, a legible reproduction thereof, or a substitute
draft if applicable. The fulfillment record confirms the completion of that
action and effects reimbursement to the acquirer. See Retrieval Request.
GATEWAY - A node or switch that permits communication between two dissimilar
networks. A technical means by which users of one computer system can
access another computer system without a separate connection.
GLOBAL PAYMENT SYSTEMS (GPS) - Parent company of the MasterCard
Automated Point-of-Sale Program (MAPP). They are another third-party
processor entity that processes all tender types.
GPS - See Global Payment Systems.
GUEST FOLIO - A lodging merchant's guest record that contains the cardholder's
transaction information, including check-in and departure dates, rate,
anticipated length of stay at check-in time, applicable charges, and taxes.
The check-in date and the dated amount and authorization approval code of
each authorization must be included on the folio if not on the sales draft.
HARDWARE CONFLICTS - Caused when two devices are in contention for the
same interrupt(s). Each communications port, network card, and printer port
should have the exclusive use of a hardware interrupt.
HOLOGRAM - A laser-created photograph that produces a three dimensional
image used to make counterfeiting plastic cards more difficult.
HOST CAPTURE - Method where transaction data is stored in batches on the
host computer at the third-party transaction processor.
IMPRINTER - A device used to imprint the embossed lines of a plastic card on a
paper transaction sales draft.
08/2000
329
Glossary
INCREMENTAL AUTHORIZATION - This is a request for an additional dollar
amount on a prior authorization. It is used when a transaction is for a greater
dollar amount than the original authorization was for. See Authorization
Tolerance.
INDEPENDENT SERVICE ORGANIZATION (ISO) - Similar to a third party
INET - The MasterCard clearing and settlement system which is a centralized
facility owned and operated by MasterCard International.
INITSTRING - String of commands that is sent to the modem prior to every dialout attempt.
INPUT FILE - File that provides ProtoBase with the necessary information to
perform a transaction, that is, transaction type, transaction amount, account
number, etc.
INTEGRATED - When two or more automated systems work together and share
data, as when a property management system calls an integrated utility at
credit card tendering time and then receives output data back from that utility.
INTEGRATED SERVICES DIGITAL NETWORK (ISDN) - An all-digital
telephone line that offers the ability to transmit digital data and voice data
without a modem.
INTERCHANGE - The exchange of clearing records between members through
Visa or MasterCard in accordance with their rules and regulations.
INTERCHANGE FEE - Charge levied and collected by either the merchant bank
or card issuer for the processing of interchange credit card transactions.
INTERCHANGE REIMBURSEMENT FEE - One of the following:
• A fee that an acquirer pays to an issuer in the clearing and settlement of
an interchange transaction, based on either the standard (paper-based)
rate or electronic rate.
• A fee that an issuer pays to an acquirer for making a cash disbursement
to a cardholder or cheque purchaser.
INTERRUPT REQUEST (IRQ) - A mechanism that forces the computer
processor to briefly interrupt the current program and execute an interrupt handler.
330
08/2000
Glossary
INTERNATIONAL ORGANIZATION FOR STANDARDIZATION - An
international organization that provides industry standards for financial
transactions and telecommunications messages. They work with other
committees to maintain financial services standards, such as bank
identification numbers and merchant category codes. The standards set by
this organization are sometimes referred to as ISO standards (not to be
confused with Independent Service Organization).
IRQ - See Interrupt Request.
ISDN - See Integrated Services Digital Network.
ISO - See Independent Service Organization.
ISSUER - See Card Issuer.
JCB CARD - Card issued by JCB (Japan Credit Bureau) International Credit Card
Company, Ltd. JCB Is now issuing this credit card in thirteen countries.
(1997) Seventy percent of the card’s usage takes place in Japan, but they
are now concentrating on the US and other countries. Their merchant base
now rivals American Express. This card is a T&E credit card. JCB is also
getting involved in the co-branded card business. See Co-Branded Cards.
JULIAN DATE - Day of the year expressed as a three-position number, with a
range of 001 through 366 (for example, 001 on 1 January).
LIVE MODE - The normal communicating start mode for ProtoBase/PBDIRECT.
It allows ProtoBase to perform all of its normal functions, including
communicating and dialing out to the processor. Leaving off the –d
argument from the command line will start ProtoBase in Live mode.
LOCATION INFORMATION - In PbAdmin, a set of information tied to a particular
location. This is usually a separate POS terminal, group of terminals, or work
station within a business. Each location must have a unique user/login
name.
MAGNETIC INK CHARACTER RECOGNITION (MICR) - The process used to
read the numbers on a check. The MICR characters (0-9 and 4 special
characters) are printed in special toner or ink. When the check is passed
through a reader/sorter, it passes by two magnetic heads. The first one
magnetizes the MICR character and the second one reads the (now)
magnetic MICR character. The character quickly loses its magnetic charge
after that.
08/2000
331
Glossary
MAGNETIC STRIPE - A stripe of magnetic information affixed to the back of a
plastic credit or debit card. It contains customer and account information
required to complete electronic financial transactions. The physical and
magnetic characteristics of this stripe are specified in the International
Organization for Standardization standards 7810, 7811, and 7813.
MAGNETIC-STRIPE READER - A device that reads information from the
magnetic stripe and transmits that information to a transaction processor or
computer terminal. Also referred to as card reader..
MAGNETIC-STRIPE TERMINAL - A terminal that reads the magnetic stripe on a
plastic card.
MAIL/PHONE ORDER MERCHANT - A merchant that transacts business by mail
or phone.
MAIL/PHONE ORDER TRANSACTION - A transaction where a cardholder
orders goods or services from a merchant by telephone, mail or other means
of telecommunication, and neither the card nor the cardholder is present at
the merchant outlet.
MASTERCARD - MasterCard International Inc., and all of its subsidiaries and
affiliates.
MASTERCARD ACQUIRER - A member that signs a MasterCard merchant or
disburses currency to a MasterCard cardholder in a cash disbursement, and
directly or indirectly enters the resulting transaction receipt into interchange.
MASTERCARD CARD - A card that bears the MasterCard symbol, enabling a
MasterCard cardholder to obtain goods, services, or cash from a
MasterCard merchant or an acquirer. A MasterCard card is always one of
the following: MasterCard Card, Gold MasterCard, Platinum Class
MasterCard, MasterCard BusinessCard, MasterCard Corporate Card,
MasterCard Corporate Purchasing Card, MasterCard Corporate Fleet Card,
or MasterCard MasterMoney Card.
MASTERCARD ISSUER - A member that issues MasterCard cards.
MASTER SESSION ENCRYPTION - The simplest form of debit encryption, in
which the customer’s PIN pad is preprogrammed or “injected” with a master
key. Also called “Static”. The other type of debit encryption is called Derived
Unique Key Per Transaction.
MEMBER - An entity that is a member of Visa or MasterCard and refers to
acquirer, associate, ATM acquirer, charter member, disbursing member,
electron acquirer, electron issuer, group member, issuer, merchant bank,
participant, principal, Visa or MasterCard acquirer, and Visa or MasterCard
issuer.
332
08/2000
Glossary
MEMORY CONFLICT - A situation where more than one piece of hardware
and/or software is attempting to access the same memory block.
MERCHANT - An entity that contracts with merchant banks or ISO’s to originate
transactions an that displays the Visa or MasterCard symbol and refers to
airline, car rental company, cash disbursement merchant, electron merchant,
high-risk telemarketing merchant, hotel, international airline, mail/phone
order merchant, prepaid card merchant, quasi-cash merchant, retail
merchant, single merchant, T&E merchant, timeshare merchant, and wire
transfer merchant. There may be additional types of merchants not
specifically mentioned.
MERCHANT AGREEMENT - A written agreement between a merchant and a
bank containing their respective rights, duties, and warranties with respect to
acceptance of the bankcard and matters related to the bankcard activity.
MERCHANT BANK - Bank that has a merchant agreement with a merchant to
accept (acquire) deposits generated by bank card transactions.
MERCHANT CATEGORY CODE - Four-digit classification codes used in the
warning bulletin, authorization, clearing, and settlement systems to identify
the type of merchant business in various stages of transaction processing.
MERCHANT DEPOSITORY ACCOUNT - Demand deposit account established
by a merchant with the acquiring bank to receive payment for sales drafts
submitted to the bank card plan.
MERCHANT DISCOUNT - Compensation received by a bank from a merchant
for processing and accepting credit card risk on the merchant’s credit card
sales.
MERCHANT NUMBER - A series or group of digits that uniquely identifies the
merchant to the merchant signing bank for account and billing purposes.
MERIT - MasterCard’s latest series of regulations that are similar to CPS
requirements by Visa.
MICR - See Magnetic Ink Character Recognition.
MODEM - A communication device that enables computers to talk to each other by
converting digital signal to analog and then back to digital.
MULTIPLE TRANSACTION PROCESSING (MULTI-TRANS) - Electronic
communications process where multiple authorization requests and
responses are exchanged during a single phone connection with the thirdparty transaction processor.
08/2000
333
Glossary
MULTI-THREADING - The process of transmitting multiple transaction requests
on one communications device, and receive multiple responses
simultaneously, relating them each back to each original request.
NEGATIVE FILE - A file used for Stand-In purposes that identifies those
cardholders and accounts for which charge privileges have been revoked or
restricted by the issuer.
NETWORK ADAPTER - A piece of firmware (card) that resides in your
workstation or server, which enables access to the LAN or WAN.
NO COMM - See Demo Mode.
NO-SHOW TRANSACTION - A transaction that a hotel participating in the Hotel
Reservation Service or a Car Rental Company participating in the
Specialized Vehicle Reservation Service completes, resulting from a
cardholder’s alleged failure to cancel or use the reservation.
NOTIFICATION - Written notice delivered by mail, courier, facsimile, telex, or
hand. Notification is effective when posted, sent , or transmitted by Visa or
MasterCard to the member or its agent.
NOVUS - The Novus Network is a Dean Witter company and is the third largest
credit card network in the United States. Their cards include the Discover
Card and Bravo brands.
NSF - This stands for Non-sufficient funds. It refers to a check or check card
transaction that exceeds the amount of funds available in a person’s
checking or share draft account.
OFFLINE - This refers to requesting an authorization non-electronically.
OFFLINE DEBIT - This refers to a debit transaction that gets treated the same as
a credit card transaction. It will not debit the cardholder’s account
immediately, but will be processed through a normal credit card venue
settlement.
ONLINE - A method of requesting an authorization through a communications
network other than voice, to an issuer, an authorizing processor, or stand-in
processing.
ONLINE DEBIT - This is a debit or ATM transaction that has used a PIN pad to
process the transaction and it should have a real-time affect on the
cardholder’s checking or share draft account.
ONLINE FINANCIAL TRANSACTION - A transaction that is authorized, cleared,
and settled in a single online message.
334
08/2000
Glossary
ON-US TRANSACTION - A transaction where the issuer and the acquirer are the
same.
OPEN TO BUY AMOUNT - Dollar amount of credit remaining for customer at the
time of authorization.
OUTPUT FILE - A file containing all response data to be parsed by the calling
program.
OVERDRAFT PROTECTION - This is a means of reducing the risk of loss by
identifying a backup account to access when a cardholder’s account is
overdrawn by a check or debit transaction.
OVERLIMIT - This refers to a cardholder’s account that has surpassed its credit
limit with a transaction. (Their outstanding balance is beyond their credit
limit.)
PAPER DRAFT - Sales slips, credit slips, cash disbursement slips, drafts,
vouchers, and other obligations indicating use of a card or a card account.
PARALLEL PORT - Sometimes referred to as a printer port. Parallel ports
conduct signals through eight separate wires simultaneously, one for each bit
of a byte of data, that re enclosed together in a single cable.
PB - The executable file which acts as a front end for ProtoBase. PB interacts with
the POS software.
PBADMIN - See ProtoBase Administrator.
PBCOM - ProtoBase program that defines which protocol to use with the host and
adds the necessary characters for communication. Multiple copies of
PBCOM run simultaneously of multiple devices (modems) are configured.
PBCONFIG - Configuration compiler executable program that creates
PBDEV.DAT, PBROC.DAT, and TTTT.TRM data files. Run this program
after you edit the PBCONFIG.CFG file.
PBCONFIG.CFG - System configuration file used by PBCONFIG. Contains all
processor configuration and phone data, system terminal and credit card
data, and system device data.
PBDIRECT - A program that acts as the ProtoBase director. It waits continually
for transactions and performs load balancing and scheduling.
PBFE (PROTOBASE ADMINISTRATOR FRONT END PROGRAM) - Front end
program for PbAdmin that parses and builds transaction processor
messages. It also verifies the fields passed in the input file.
08/2000
335
Glossary
PBKILL - ProtoBase Communications Director termination executable program.
It is used to queue a shutdown request to stop and restart the system.
PERSONAL IDENTIFICATION NUMBER (PIN) - A number (alpha or numeric
code) that identifies a cardholder in an authorization request originating at a
terminal with authorization-only or data capture-only capability.
PER TRANSACTION FEES - Fees paid by the merchant to the merchant bank or
other contracted party on a per transaction basis.
PIN - See Personal Identification Number.
PIN ENCRYPTION - The technique of scrambling a personal identification
number, so that it is illegible to unauthorized observers.
PIN GENERATION - The production of PINs for allocation to cardholders, done
under strict security to prevent fraud.
PIN OFFSET - The difference between the customer’s chosen or assigned PIN
and the PIN derived based on a specific algorithm that is applied against the
primary account number (PAN). If used, PIN offset information is encoded on
track 2 of the card’s magnetic stripe.
PIN PAD - A numeric key pad, which is connected to a terminal or POS, used by
the cardholder to enter the PIN and/or other information.
PIN VERIFICATION - A procedure that enables the issuer to validate the
cardholder identity when making a comparison with the PIN and cardholder
account number..
PLASTIC (CARD) - This is a generic term used to identify any of the various cards
issued to cardholders.
PLUS PROGRAM - A program through which a PLUS participant provides ATM
services to cardholders by acting as an issuer, an ATM acquirer, or both.
POINT OF SALE (POS) - Location in a merchant establishment at which sale is
consummated by payment for goods or services received. Can also refer to
the direct debit of a purchase amount to a customer’s checking account.
POS ENTRY MODE - A V.I.P system field indicating the method by which a pointof-transaction terminal obtains and transmits the cardholder information
necessary to complete a transaction.
POS SYSTEM - Point-of-sale system that processes sale and other transactions,
such as an electronic cash register with specialized software.
336
08/2000
Glossary
POSITIVE BALANCE - This usually refers to the cash balance in a person’s
checking or share draft account. Offline debit card transactions place holds
against this balance. Online debit card transactions deduct from this
balance.
POSTING - The process of updating individual cardholder account balances to
reflect merchandise sales, instant cash, cash advances, adjustments,
payments, and any other charges or credits.
PRESENTMENT - A clearing record that an acquirer presents to an issuer
through interchange, either initially (a first presentment) or after a chargeback
(a re-presentment).
PRIMARY ACCOUNT NUMBER (commonly called PAN) - The number that is
embossed, encoded, or both, on a plastic card that identifies the issuer and
the particular cardholder account. The PAN consists of a major industry
identifier, issuer identifier, individual account identifier, and check digit.
PRIVATE LABEL CARD - A merchant’s proprietary card that is accepted only at
its own locations. ATM cards are actually considered private label cards. A
merchant whose cards are considered private label must be member
sponsored and also accept Visa and MasterCard.
PRIOR AUTHORIZATION - An authorization usually done before a transaction
takes place. The approved authorization request may be held for an
extended length of time before a card is present or not.
PROCESSING DATE - The date on which the transaction is processed by the
acquiring bank.
PROCESSOR - Third-party transaction processor such as Envoy or NaBANCO.
Processors aid in routing transactions to the appropriate authorizer services.
PROCESSOR CONFIGURATION - A section of the ProtoBase PBCONFIG.CFG
file which contains information pertinent to communications with the
processor.
PROPRIETARY CARD - A card issued by financial institutions and other
organizations to their customers, primarily for the purpose of accessing
credit or deposit accounts. These cards are considered "proprietary" if they
are issued with the logo or emblem of the issuing organization being the
acceptance mark instead of a "national" or "global" service mark or logo
such as Visa or MasterCard.
08/2000
337
Glossary
PROTOBASE - Data communication software developed by Southern
DataComm, Inc. for electronic payments processing. Along with processorspecific software modules called SofTrans, ProtoBase provides the link
between the third-party transaction processor or acquirer and the merchant
at the point-of-sale (POS). ProtoBase is fully integrated into the point-of-sale
system. It works directly with the POS system to accept credit card, check,
and other payment media for various transactions, including authorization,
sale, and settlement.
PROTOBASE ADMINISTRATOR (PBADMIN) - A screen-based, data base
application that stores data for several transaction and payment types during
electronic payment processing, including credit cards, debit cards, and
checks. It is an add-on product and intermediate interface to ProtoBase.
PROTOBASE DIRECTOR - Program, known as PBDIRECT, that directs the flow
of communication to PBCOM.
REAL-TIME TRANSACTION - An online transaction, such as an ATM withdrawal,
which is usually settled immediately.
RECEIPT - A hard copy document recording a transaction that took place at the
point of sale, with a description that usually includes: date, merchant
name/location, primary account number, amount, and reference number.
REFERENCE NUMBER - Number assigned to each monetary transaction in a
descriptive billing system. Each reference number is printed on the monthly
statement to aid in retrieval of the document, should it be questioned by the
cardholder.
REGULATION E - This federal regulation governs the electronic access to a
person’s account or funds. See EFTA for additional information.
REGULATION Z - This federal regulation governs all aspects concerning credit
cards. It pertains to the issuer and cardholder, as well as any organization
involved in the processing of credit cards.
REPORTS SECURITY - In PbAdmin, a screen which defines the access a
particular user has within a location to particular reports.
REPRESENTMENT - A clearing record that an acquirer presents to an issuer
through interchange after a chargeback.
RETAIL MERCHANT - A merchant that provides goods and/or services in the
retail industry, but is not a mail/phone merchant, a recurring services
merchant, or a T&E merchant.
338
08/2000
Glossary
RETRIEVAL REQUEST - An issuer’s request for a transaction receipt, which
could include the original, a paper copy or facsimile, or an electronic version
thereof.
REVERSAL - An online financial transaction used to negate or cancel a
transaction that has been sent through interchange in error.
SALES DRAFT - A paper record evidencing the purchase of goods or services by
a cardholder from a merchant using a plastic card.
SELECTED - In PbAdmin, indicates transactions that are check-marked on the
Select/View/Edit Transactions screen (main database) or the View History
Transactions screen (history database) to be included in various functions.
SERIAL PORT - Data communications port, usually asynchronous. The port takes
8, 16, or 32 parallel bits and turns them into a long series pulse chain.
SERVER - In PbAdmin, this is the employee performing a transaction in the
restaurant industry.
SETTLEMENT - The reporting of settlement amounts owed by one member to
another, or to a card issuing concern, as a result of clearing. This is the
actual buying and selling of transactions between the merchants, processors,
and acquirers; along with the card issuing entities.
SETTLEMENT BANK - A bank, including a correspondent or intermediary bank,
that is both located in the country where a member’s settlement currency is
the local currency, and authorized to execute settlement of interchange on
behalf of the member or the member’s bank.
SETTLEMENT OF TRANSACTION - A process in which the Property
Management System software requests a Deposit transaction to send or
release the current batch of transactions to the transaction processor.
SMART CARD - A credit or debit card embodying a computer chip with memory
and interactive capabilities used for identification and to store additional
data about the cardholder, cardholder account, or both. Also called an
integrated circuit card or a chip card.
SOFTRANS - The part of the ProtoBase application that contains all data files
required to operate with a third-party transaction processor.
STANDARD FLOOR LIMIT - A floor limit that varies by merchant type. This refers
to a dollar limit on transactions above which authorization requests are
required.
STAND-BESIDE TERMINAL - A terminal connected to the POS system for the
purpose of communicating with transaction processors.
08/2000
339
Glossary
STAND-IN PROCESSING - The V.I.P. system component that provides
authorization services on behalf of an issuer when the Positive Cardholder
Authorization System is used or when the issuer or its authorizing processor
is unavailable.
STATIC KEY - See Master Session Encryption.
T&E - An abbreviation for Travel and Entertainment.
T&E MERCHANT - An airline, car rental company, or hotel whose primary function
is to provide travel-related services. A travel agency (excluding one that is
primarily engaged in the sale of transportation or travel-related arrangement
services by mail/phone order) is a T&E merchant to the extent that it acts as
the agent of an airline, car rental company, or hotel.
TCP/IP - Transport Control Protocol/Internet Protocol. A standard format for
transmitting data from one computer to another. TCP deals with the
construction of the data. IP routes the data from one computer to another.
TERMINAL - An input-output device whereby a user is able to communicate
directly with a computer.
TERMINAL CAPTURE - Method where transaction data is stored in the POS
terminal until the batch is settled.
TERMINAL CONFIGURATION - A section of the ProtoBase PBCONFIG.CFG
file which contains information pertinent to the terminal. The terminal
configuration entry specifies, for one terminal or many terminals, the valid
credit card (or other payment) types and the transaction processor(s) through
which each type will be authorized and settled.
TERMINAL ID - Name of the terminal initiating a transaction. This name must
match a .TRM file defined in the Terminal configuration file. Can be used to
sort and total the reports produced by ProtoBase. Defined as Field 109 in
the Input and Output File. This file is in all ProtoBase versions prior to 4.8.
THIRD-PARTY TRANSACTION PROCESSOR - An entity that validates and
authorizes credit card purchases. They may also service the actual accounts
on behalf of the issuers, emboss cards, and mail cards to cardholders.
TRACK 1 - Bank discretionary data encoded on a magnetic stripe. Includes credit
card account number, card holder name, and expiration date. It is read-only,
and its contents are defined in ISO 7813.
TRACK 2 - Bank discretionary data encoded on a magnetic stripe. Track 2
includes credit card account number and expiration date. It is read-only, and
its contents are defined in ISO 7813.
340
08/2000
Glossary
TRANSACTION - Action between a cardholder and a merchant or a cardholder
and a member that results in activity on the cardholder account.
TRANSACTION DATE - The date on which a transaction between a cardholder
and a merchant, an acquirer, or a carrier, occurs.
TRANSACTION PROCESSOR - See Third-Party Transaction Processor.
TRANSACTION TYPE - A specific type of financial detail transaction activity that
can be submitted to the clearing system.
UDP/IP - User Datagram Protocol/Internet Protocol. UDP is a connectionless
protocol that offers a direct way to send and receive datagrams over an IP
network. UDP is useful when TCP would be too complex, too slow, or just
unnecessary.
USER SECURITY - In PbAdmin, defines the access a particular user has within a
location to particular functions.
UNBUNDLED FEES - Other fees paid by the merchant to the merchant bank or
other contracted party for transaction processing.
VISA - Visa International Service Association and all of its subsidiaries and
affiliates.
VISA ACQUIRER - A member that signs a Visa merchant or disburses currency
to a Visa cardholder in a cash disbursement, and directly or indirectly enters
the resulting transaction receipt into interchange.
VISA CARD - A card that bears the Visa symbol, enabling a Visa cardholder to
obtain goods, services, or cash from a Visa merchant or an acquirer. A Visa
Card is always one of the following: Visa Business Card, Visa Classic Card,
Visa Corporate Gold, Visa Gold Card, Visa Premier Card, Visa Purchasing
Card, or Visa Check Card.
VISA ISSUER - A member that issues Visa Cards.
VISA MERCHANT - A merchant that displays the Visa symbol and accepts all
Visa cards.
VISA/PLUS ATM - An ATM that displays both the Visa symbol and the PLUS
symbol.
VISANET - The systems and services, including the V.I.P. system and BASE II,
through which Visa delivers online financial processing, authorization,
clearing, and settlement services to members.
08/2000
341
Glossary
VOID - Nullifies a transaction that has been recorded for settlement, but not yet
settled. This removes the transaction from the batch of transactions to be
settled.
VOICE AUTHORIZATION - An approval response obtained through interactive
communication between an issuer and an acquirer, their authorizing
processors, or stand-in processing, through telephone, facsimile, or telex
communications.
VSAT (VERY SMALL APERTURE TERMINAL) - Satellite systems that provide
wireless connection between a data center and remote user equipment or
between the remote user equipment. The user equipment can be telephone,
fax, personal computer (PC), minicomputer, computer with the function of
interfacing the local area networks (LAN) or their combination.
WIRE TRANSFER TRANSACTION - A transaction representing the sale of a
check or money order for transfer to a payee (who may or may not be the
cardholder) by electronic funds transfer.
ZERO-FLOOR LIMIT - A floor limit with a currency amount of zero (meaning
authorization is required for all transactions).
342
08/2000
Glossary
INDEX
overview
running
steps to configure
Configuration, manual
accessing configuration menu
activating new values
credit card tables
devices
overview
payment types
processors
ProtoBase Configuration menu
running
terminals
Copy to main database
CPS compliance, error messages
C-tree errors
A
Add transaction
Address Verification Info Screen
Administrator Configuration Report
Administrator Log
American Express Status Check
American Express Utility
integration considerations
Authorization Date & Time Report
Authorization Date and Time Report
Authorization Only
Authorization problems
Authorization Reversal
Authorization, incremental
Authorization, incremental
Auto close
AVS (address verification)
151–54, 244
244
99, 137–40
242
211–12
219
88
260
18
251
198
21
292, 296–97
23, 36–37
23
36–37
40
38
D
275
Databases
exporting
60, 68, 69
importing
62, 70
DBEXPORT
Export to different database to troubleshoot 291
Delete logs
289
Deleting transactions
all records in transaction database
283
from selected history database
285
individual
242
Deposit Date and Time Report
274
Deposit Status Log
251, 258
viewing
259–61
197
254–58
Deselect transactions, for settlement
individual
235
multiple
237–38
Deselect transactions, history
270–71
Detail View of History Transaction Screen
268–69
156–57, 241
Direct Marketing
173–75
Lodging/Front Desk
167–69
Lodging/Restaurant
163–66
Lodging/Retail
161–62
Rental Car
170–72
Restaurant
163–66
Retail
32–33
Device Edit Screen
101, 141–47
Device List Screen
100
Directories
API/Settlement
226
B
Batch Out of Balance
298
C
Card number validations
Card Type Reports
Cashier (Server) Detail Report
Cashier (Server) Summary Report
Cashier Extended Detail Report
Direct Marketing
Lodging
Rental Car
Retail
Cashier Reports
Check Authorization
Check settlement information
Close of Open Transaction
Configuration
automatic, overview
DB directory, backing up
manual, overview
printing
running
Configuration problems
READCFG
Configuration, automatic
activating new values
82
85–86
84
87–106
87–88
102–5
96–100
100–101
82
96–100
90–92
89
102–5
93–95
273
294
300
42
202–3
252
200–201
179–80
177–78
190–91
186–87
188–89
181–83
249
23
279
24
82–106
82
83
82
106
102–5
82–106
295
83–86
85–86
08/2000
343
ProtoBase Administrator User Guide – Index
BATCH subdirectory
created by PbAdmin during use
DB
DB subdirectory
DBHIST subdirectory
DEBUG subdirectory
DEFAULT subdirectory
descriptions
PBADMIN
PBFE
provided as part of installation
226
224–27
224–25
223
225
225
223
220–27
222
221
221–23
Input fields
address verification
checks
direct marketing
lodging
rental car
required, by transaction type
restaurant
retail
suggested, by industry type
table of
Installing PbAdmin
DOS/LAN, Windows NT/95, OS/2
steps to install first time
steps to upgrade
system requirements
UNIX
steps to install first time
steps to upgrade
system requirements
Integration
diagram
introduction
PBFE
E
Editing transactions
Environment Settings Screen
Error messages, table of
PbAdmin errors
Exiting PbAdmin
Exporting databases
97, 136
235–44
147
301–5
306–15
233
60, 68, 69
F
Files
API/Settlement directory
BATCH subdirectory
created by PbAdmin during use
DB directory
DB subdirectory
DBHIST subdirectory
DEBUG subdirectory
DEFAULT subdirectory
descriptions
PBADMIN directory
PBFE directory
provided as part of installation
Fix settlement information
Force field (12)
226
226
224–27
224–25
223
225
225
223
220–27
222
221
221–23
280
41
M
Main Menu
Memory, running out
Merchant Key reports
Modify transaction status
Multi-merchant settlement
Multiple locations
40
51–53
245–47
73, 112–15
344
232–33
295
206–7
253
204–5
275–77
95, 135, 226, 256
40
N
Network problems
267
299
O
263–65
Output fields
I
Importing databases
Incremental Authorization
Incremental Authorization Report
20
18
18
Local INI File
Integrating with File Server Gateway
51–53
Local INI File Screen
73, 112–15
76–77, 76–77
Locations Screen
75
Locations, multiple
40
locked files
300
H
History Transactions
viewing
65–67
68–71
64
L
G
Gateways
Integrating with File Server Gateway
Generating reports
Global INI File Screen
34
35
34–35
31–32
33–34
25
31
32–33
26
29–35
55–109
56–63
58–59
60–63
57
27–28
P
62, 70
23
36–37
199, 251
PBADREP (PbAdmin Report Generator)
PBFE
test transactions
08/2000
43–53
107–9
PBFE (ProtoBase Administrator Front End)
American Express Utility
18
Authorization Reversal
20
functions of
19
19
Printer setup
41
Prior-Authorized Sale
19, 22, 38
Problems
authorizations
293, 296–97
configuration
82–106
READCFG
295
running
296–97
settlement
293, 297
transactions, running
296
92, 130
Processor List Screen
90
Processors Screen
91
89, 102
Purge history files
285
Purge log
289
Purge old authorizations
278
Purge transaction database
283
Server Extended Detail
Server Tip
Settlement from ProtoBase
Terminal
Terminal Detail
Terminal Extended Detail
Terminal Summary
Transaction Log
Reports Menu
Reports security screen
Reports, Generating Outside PbAdmin
Return
Reverse and copy to main database
S
Sale
21
Screens
244
151
Add/Edit Credit Cards
137
Add/Edit Credit Cards
99
Address Verification Info
242
88
275
Deposit Transactions Status Window
254
Detail View of History Transaction
268–69
Detail View of Transaction
156, 241
Direct Marketing
173
Lodging/Front Desk
167
Lodging/Restaurant
163
Lodging/Retail
161
Rental Car
170
Restaurant
163
Retail
160
Device Edit
101, 141
Device List
100
Edit Credit Card Table
97, 136
Environment Settings
147
Global INI File
73, 112
267
Local INI File
112
Location Information
76–77, 116
Locations
75
Main Menu
232–33
Processor Edit
92, 130
Processor List
90
Processors
91
89, 102
Reports Menu
246
Reports Security
80–81, 127
Search Criteria
155, 239
158, 237, 270
148, 234
R
READCFG, problems running
Real-Time transactions
Rebuild history file
Rebuild transaction database
Remove Open Transaction
Reports
Administrator Configuration
Administrator Log
Authorization Date & Time
Authorization Date and time
Card Type
Card Type Detail
Card Type Summary
Cashier
Cashier (Server) Detail
Cashier (Server) Summary
Cashier Extended Detail
Direct Marketing
Lodging
Rental Car
Retail
configuration report
Deposit Date and Time
Deposit Status
Deposit Status Log
generating
Merchant Key
Merchant Key Detail
Merchant Key Summary
184–85
208–9, 251
258
250
194–95
196
192–93
215
246
80–81
80–81
43–53
22
272
295
40
284
281–82
24
249–53
211–12
219
251
198
252
202–3
200–201
249
179–80
177–78
190–91
186–87
188–89
181–83
106
274
197
251, 258
245–47
199, 251
253
206–7
204–5
08/2000
345
Terminal Edit
94, 95
134
Terminal List
93, 96, 98
262
Transaction History Search
263
User Login
74
User Security
78–79, 124
213–14, 264
155, 239
Search for transaction, history
266
Search for transaction, main
239–40
Select display mode
236
Select Transaction Criteria Screen 158–59, 237, 270
Select transactions, for settlement
individual
235
multiple
237–38
Select transactions, history
270–71
Select/View/Edit Transactions Screen 148–50, 235–44
add transaction
244
search for transaction
239–40
select display mode
236
select transactions
235
select/deselect multiple transactions
237–38
toggle status
243
view/modify transaction detail
241–42
Server Extended Detail Report
184–85
Server Tip Report
208–9, 251
Setting up PbAdmin
72–81
global INI file
73
location information
76–77
locations
75
reports security
80–81
user login
74
user security
78–79
Settlement
39
Settlement Group
95, 135, 256
Settlement Log
251, 258
viewing
259–61
Settlement problems
293
Settlement Report from ProtoBase
258
Settlement, problems running
254–58
Settling
254–58
multi-merchant
256
Starting PbAdmin
231
System requirements
DOS/LAN, Windows NT/95, OS/2
57
UNIX
64
Terminal Extended Detail Reports
Terminal Reports
Test transactions, running
Time out reversal
Toggle Status (R/r or U/h)
reports
Transaction history search
copy to main database
reverse and copy to main database
search for transaction
Select/deselect transactions
view transaction detail
Transaction History Search Screen
Transaction inquiry
Transaction Inquiry
Transaction Log
layout
program source ID codes
sample
Transaction qualifier field (115)
Transaction types
input fields, required
input fields, suggested
table of
346
25
26
21–24
U
User defined field (11)
User login screen
User security screen
41
74
78–79
124–26
V
VALID.DAT
validation of field data
Version number, checking
View Deposit (Settlement) Log
View history transactions
View logs
View transaction detail
View/modify transaction detail
Void return
Void Return
Void sale
Void Sale
T
Technical reference
introduction
196
93, 96, 98
250
192–93
107–9
41
243
262
274
213–14
273
272
266
270–71
268–69
263
42
23
215–18
216
217–18
215
40
21
21
291
259–61
263–65
213–14
286–88
268
241–42
38
22
38
22
W
111
194–95
94, 134–35
Working Key Update
08/2000
24

ProtoBase User`s Guide

Transcription

Similar documents

RE/MAX vs. THE INDUSTRY

Morgan Stanley Smith Barney Benefit Access Quick

instructions for housing deposit ($250.00 usd)

How to Pay My Bill - Students and Authorized Payers

TCPDF Example 021

AISD AMEX Purchasing Card Corporate Account Reconciliation

Forex trading. Earn money with foreign exchange

Cybex Trazer

CAR Training Guide - Cardmembers

ETRM Solutions - Primetech Systems Inc.