Sie sind auf Seite 1von 584

DATABASE REFERENCE

VOL. 1 (ADMIN)

ABP-9.1-DR1-1999/09/30

ARBOR /BP

1990, 1995, 1996, 1997, 1998, 1999 Kenan Systems Corporation. All Rights Reserved.
The information in this manual is furnished for your use only and is subject to change without notice. Kenan
Systems Corporation assumes no responsibility or liability for any errors or inaccuracies that may appear in this
manual. This documentation is the property of Kenan Systems Corporation and its licensors, contains
proprietary information and trade secrets of Kenan Systems Corporation, and is provided in accordance with a
Kenan Systems Corporation license agreement or confidentiality agreement. Copying, modifying, or
distributing this documentation in violation of a license agreement, confidentiality agreement, United States
Copyright Law, or the copyright law of any applicable foreign jurisdiction is expressly prohibited.
Kenan, the Kenan logo, the Lucent logo, Arbor, and iCARE are trademarks of Kenan Systems Corporation in
the United States and other countries.
All other brand and product names are trademarks, service marks, registered trademarks, or registered service
marks of their respective companies.
American Express is a registered trademark of American Express Company.
Discover is a registered trademark of Novus Credit Services, Inc.
MasterCard is a registered trademark of Mastercard International Incorporated.
Oracle is a registered trademark of the Oracle Corporation.
Sybase is a registered trademark of Sybase, Inc. and/or one or more of its subsidiaries.
UNIX is a registered trademark of The Open Group.
Visa is a registered trademark of Visa International Service Association.
CIBER is a trademark of the CIBERNET Corporation.
Printed in the United States of America.

Table of Contents
Table of Contents..................................................................................iii
1

Introduction ............................................................................................1
Whats New in This Manual...........................................................................1
Tables Added ..............................................................................................2
Information Added ....................................................................................4
Additional Documents ....................................................................................4

Admin Tables..........................................................................................7
ABI_SOURCE_RECORD_TYPES ..................................................................9
ABI_SOURCE_REF ........................................................................................10
ABI_SOURCE_VALUES ...............................................................................11
ACCESS_REGION_REF................................................................................12
ACCESS_REGION_VALUES .......................................................................13
ACCOUNT_CATEGORY_REF ....................................................................14
ACCOUNT_CATEGORY_VALUES ...........................................................15
ACCOUNT_MOVE_TABLES.......................................................................16
ACCT_SEG_MAP ..........................................................................................17
ACCT_SEG_REF ............................................................................................18
ACCT_SEG_VALUES....................................................................................19
ADJ_REASON_CODE_REF .........................................................................20
ADJ_REASON_CODE_VALUES.................................................................21
ADJ_TRANS_DESCR ....................................................................................22
AGGR_USAGE_DEFINITIONS_REF .........................................................25
AGGR_USAGE_DEFINITIONS_VALUES.................................................26
AGGR_USAGE_RESTRICTIONS ................................................................27
ARB_TAB_DEPENDS ...................................................................................28
ARCHIVE_ACTION_REF ............................................................................29
ARCHIVE_ACTION_VALUES....................................................................30
ARCHIVE_TAPES .........................................................................................31
ARCHIVE_TASKS .........................................................................................32
ARCH_MODE_REF.......................................................................................34
ARCH_MODE_VALUES ..............................................................................35
ARCH_TABLE_DEPENDS_REF..................................................................36
ARCH_TYPE_REF .........................................................................................37
ARCH_TYPE_VALUES.................................................................................38
ATM_CUSTOM_TABLE_DEF .....................................................................39
ATM_FIELD_DEF ..........................................................................................40
ATM_POPLIST_REF......................................................................................41

ABP-9.1-DR1-1999/09/30

T
iv

Table of Contents

ATM_POPLIST_VALUES .............................................................................42
BILLING_FREQUENCY_REF ......................................................................43
BILLING_FREQUENCY_VALUES .............................................................44
BILL_ADDRESS .............................................................................................45
BILL_CLASS_REF ..........................................................................................47
BILL_CLASS_VALUES .................................................................................48
BILL_CYCLE...................................................................................................49
BILL_DISP_METH_REF................................................................................50
BILL_DISP_METH_VALUES.......................................................................51
BILL_EXPRESSION_GROUPS.....................................................................52
BILL_EXPRESSION_GROUP_REF..............................................................53
BILL_EXPRESSION_GROUP_VALUES.....................................................54
BILL_EXPRESSION_REF ..............................................................................55
BILL_EXPRESSION_VALUES .....................................................................56
BILL_FMT_OPT_REF ....................................................................................57
BILL_FMT_OPT_VALUES ...........................................................................58
BILL_FMT_SECTION_EXCL_REF ..............................................................59
BILL_FMT_SECTION_EXCL_VALUES .....................................................60
BILL_FMT_SECTION_TYPE_REF...............................................................61
BILL_FMT_SECTION_TYPE_VALUES......................................................62
BILL_FMT_TEMPLATE_CODE_REF .........................................................63
BILL_FMT_TEMPLATE_CODE_VALUES ................................................64
BILL_FONT_REF ...........................................................................................65
BILL_FONT_VALUES...................................................................................67
BILL_FONT_WIDTH.....................................................................................68
BILL_FORMAT_CODE_TYPE_REF............................................................69
BILL_FORMAT_CODE_TYPE_VALUES ...................................................70
BILL_FORMAT_DISPLAY_TYPES .............................................................71
BILL_FORMAT_PRODUCTS.......................................................................72
BILL_FORMAT_TEMPLATE .......................................................................73
BILL_INSERTS................................................................................................75
BILL_INSERT_GROUPS ...............................................................................76
BILL_LINE_REF .............................................................................................78
BILL_LINE_VALUES ....................................................................................80
BILL_MESSAGES...........................................................................................81
BILL_MESSAGE_GROUPS ..........................................................................82
BILL_PERIOD_REF .......................................................................................84
BILL_PERIOD_VALUES...............................................................................85
BILL_REF_NO_MASTER..............................................................................86
BILL_SECTIONS ............................................................................................87
BILL_SIZE .......................................................................................................88
BILL_TEXT_GROUPS ...................................................................................89
BILL_TEXT_GROUP_REF ............................................................................90
BILL_TEXT_GROUP_VALUES ...................................................................91
ABP-9.1-DR1-1999/09/30

Table of Contents

BILL_TEXT_REF.............................................................................................92
BILL_TEXT_VALUES....................................................................................93
BMF_TRANS_DESCR ...................................................................................94
CCARD_AVS_RESPONSE_CODES............................................................97
CCARD_RESPONSE_CODE_REF...............................................................98
CCARD_RESPONSE_CODE_VALUES......................................................99
CCARD_TYPE_CODE_RANGE ................................................................100
CCARD_TYPE_CODE_REF .......................................................................101
CCARD_TYPE_CODE_VALUES ..............................................................102
CC_BALANCE .............................................................................................103
CDR_COMP_STATUS_REF .......................................................................104
CDR_COMP_STATUS_VALUES ..............................................................105
CDR_CONSOLIDATION_KEYS ...............................................................106
CDR_DATA_WORK....................................................................................107
CDR_OUTCOLLECTS.................................................................................114
CDR_RAW_USAGE ....................................................................................119
CDR_RUNNING_TOTAL_MASK ............................................................120
CELL_ID_REF...............................................................................................121
CELL_ID_VALUES ......................................................................................122
CELL_ID_ZONE_ID_MAP.........................................................................123
CIBER_ARBOR_FLD_XREF .......................................................................124
CIBER_ARBOR_USAGE_TYPE_XREF .....................................................125
CIBER_FLD_ERROR_CODES ....................................................................126
CIBER_FROM_NPANXX............................................................................127
CIBER_INCOLLECTS..................................................................................128
CIBER_INCOLLECTS_ERROR ..................................................................133
CIBER_LINE_RANGES...............................................................................138
CIBER_OPERATOR_SID_BID ...................................................................139
CIBER_ROAMING_AGREEMENT...........................................................141
CIBER_SID_BID_DEF..................................................................................143
CIBER_SID_BID_MARKET ........................................................................144
CIBER_SID_BID_SEQ_NUM......................................................................145
CLASS_OF_SERVICE_CODE_REF ...........................................................146
CLASS_OF_SERVICE_CODE_VALUES ..................................................147
CLEARING_HOUSE_CONTACTS ...........................................................148
CLEARING_HOUSE_DIVISION...............................................................150
CLEARING_HOUSE_ID_REF ...................................................................151
CLEARING_HOUSE_ID_VALUES...........................................................152
CLEARING_HOUSE_INFO .......................................................................153
CMF_STATUS_CHG_REASON_REF .......................................................157
CMF_STATUS_CHG_REASON_VALUES ..............................................158
CMF_STATUS_REF .....................................................................................159
CMF_STATUS_VALUES ............................................................................160
COLLECTION_STATUS_REF....................................................................161
ABP-9.1-DR1-1999/09/30

T
vi

Table of Contents

COLLECTION_STATUS_VALUES...........................................................162
COL_COLLECTOR......................................................................................163
COL_COLLECTOR_GROUP .....................................................................164
COL_EVENT_DEFINITION.......................................................................165
COL_MESSAGES_TEXT .............................................................................166
COL_ORDER_ASSOC .................................................................................167
COL_ORDER_REF.......................................................................................168
COL_ORDER_VALUES ..............................................................................169
COL_SCENARIO_DEFINITION ...............................................................170
COL_SCENARIO_PARAMETERS ............................................................171
COL_THRESH_PARAMETERS.................................................................173
COMPONENT_CMF_ELIGIBILITY..........................................................174
COMPONENT_DEFINITION_REF ..........................................................175
COMPONENT_DEFINITION_VALUES..................................................176
COMPONENT_EMF_ELIGIBILITY ..........................................................177
COMPONENT_NRCS.................................................................................178
CONTRACT_TYPES....................................................................................179
CORRIDOR_PLAN_GROUPS ...................................................................182
CORRIDOR_PLAN_ID_REF ......................................................................184
CORRIDOR_PLAN_ID_VALUES .............................................................186
COUNTRY_CODE_REF..............................................................................187
COUNTRY_CODE_VALUES.....................................................................188
COUNTRY_DIAL_CODES.........................................................................189
COUNTRY_JURISDICTION ......................................................................190
CSR_ACCT_SEG ..........................................................................................191
CSR_INFORMATION .................................................................................192
CSR_SUPERVISORS ....................................................................................194
CURRENCY_LOCALE................................................................................195
CURRENCY_TYPE_REF.............................................................................196
CURRENCY_TYPE_VALUES ....................................................................197
DB_MESSAGES ............................................................................................199
DENIAL_REASON_REF.............................................................................200
DENIAL_REASON_VALUES ....................................................................201
DEPOSIT_TYPE_REF ..................................................................................202
DEPOSIT_TYPE_VALUES..........................................................................203
DESCRIPTIONS ...........................................................................................204
DEVICES .......................................................................................................205
DISCONNECT_REASON_REF..................................................................206
DISCONNECT_REASON_VALUES.........................................................207
DISCOUNT_DEFINITIONS .......................................................................208
DISCOUNT_PLANS....................................................................................211
DISCOUNT_RESTRICTIONS ....................................................................212
DISCOUNT_TARGETS ...............................................................................214
DISTANCE_BANDS....................................................................................216
ABP-9.1-DR1-1999/09/30

Table of Contents

vii

DISTANCE_BANDS_ID_REF ....................................................................217
DISTANCE_BANDS_ID_VALUES ...........................................................218
EFT_CONTROL ...........................................................................................219
EFT_RESPONSE_CODE_REF ....................................................................220
EFT_RESPONSE_CODE_VALUES ...........................................................221
EMF_CONFIGURATION ...........................................................................222
EMF_CONFIG_ID_REF ..............................................................................224
EMF_CONFIG_ID_VALUES......................................................................225
EMF_STATUS_CHG_REASON_REF .......................................................226
EMF_STATUS_CHG_REASON_VALUES...............................................227
EMF_STATUS_REF......................................................................................228
EMF_STATUS_VALUES.............................................................................229
EQUIP_CLASS_CODE_REF.......................................................................230
EQUIP_CLASS_CODE_VALUES ..............................................................231
EQUIP_TYPE_CODE_REF .........................................................................232
EQUIP_TYPE_CODE_VALUES.................................................................233
ERROR_SEVERITIES...................................................................................234
EXRATE_CLASS_REF .................................................................................235
EXRATE_CLASS_VALUES ........................................................................236
EXTERNAL_ID_TYPE_REF .......................................................................237
EXTERNAL_ID_TYPE_VALUES...............................................................238
EXT_ACCESS_METHOD_REF ..................................................................239
EXT_ACCESS_METHOD_VALUES .........................................................240
EXT_CONTACTS.........................................................................................241
EXT_CONTACTS_STATUS .......................................................................245
EXT_FTP_ACCESS.......................................................................................246
EXT_KERMIT_ACCESS ..............................................................................247
EXT_LOCAL_DIR_ACCESS.......................................................................248
EXT_SOCKET_ACCESS..............................................................................249
EXT_SOURCE_ID_REF ...............................................................................250
EXT_SOURCE_ID_VALUES ......................................................................251
EXT_SOURCE_TYPE_REF .........................................................................252
EXT_SOURCE_TYPE_VALUES.................................................................253
FILE_STATUS...............................................................................................254
FILE_TYPE_REF...........................................................................................258
FILE_TYPE_VALUES ..................................................................................259
FRANCHISE_CODE_REF ..........................................................................260
FRANCHISE_CODE_VALUES..................................................................261
GEOCODE_OVERRIDES............................................................................262
GROUP_AMOUNT .....................................................................................264
GROUP_FUNCTION ..................................................................................265
GSM_ROAMING_AGREEMENT..............................................................266
GUI_INDICATOR_REF ..............................................................................269
GUI_INDICATOR_VALUES......................................................................270
ABP-9.1-DR1-1999/09/30

T
viii

Table of Contents

GUI_MESSAGES ..........................................................................................271
IGEN_ADDRESS_FORMATS ....................................................................272
IGEN_ADDRESS_FORMAT_REF .............................................................273
IGEN_ADDRESS_FORMAT_VALUES ....................................................274
INDUSTRY_TYPE_REF...............................................................................276
INDUSTRY_TYPE_VALUES......................................................................277
INSERT_FOREIGN_KEY_REF...................................................................278
INSERT_FOREIGN_KEY_VALUES ..........................................................279
INSERT_GRP_ID_REF ................................................................................280
INSERT_GRP_ID_VALUES........................................................................281
IO_DEVICES .................................................................................................282
JNL_CUSTOM ..............................................................................................283
JNL_CYCLE ..................................................................................................285
JNL_EMF_BOOK_REF ................................................................................286
JNL_EMF_BOOK_VALUES .......................................................................287
JNL_FEED_HEADER ..................................................................................288
JNL_FEED_LAYOUT ..................................................................................290
JNL_FEED_TRAILER ..................................................................................293
JNL_KEYS .....................................................................................................295
JNL_KEYS_MASK........................................................................................302
JNL_RUNS ....................................................................................................304
JNL_SUBCYCLE...........................................................................................305
JURISDICTIONS ..........................................................................................306
JURISDICTION_CLASS_REF.....................................................................307
JURISDICTION_CLASS_VALUES............................................................308
LANGUAGE_CODE_REF ..........................................................................309
LANGUAGE_CODE_VALUES .................................................................310
LANGUAGE_LOCALE...............................................................................311
LBX_ERROR .................................................................................................313
LBX_ERROR_STATUS_REF.......................................................................315
LBX_ERROR_STATUS_VALUES ..............................................................316
LBX_FILE_STATUS .....................................................................................317
LBX_PAYMENT_TYPES.............................................................................319
LBX_POST_DATED.....................................................................................320
LBX_SOURCE_ID_REF ...............................................................................322
LBX_SOURCE_ID_VALUES ......................................................................324
MKT_CODE_REF.........................................................................................325
MKT_CODE_VALUES................................................................................326
MSG_GRP_ID_REF......................................................................................327
MSG_GRP_ID_VALUES .............................................................................328
NET_ACTION_REF.....................................................................................329
NET_ACTION_VALUES ............................................................................330
NET_INTERFACE_ACTIONS ...................................................................331
NET_INTERFACE_ELIGIBILITY ..............................................................332
ABP-9.1-DR1-1999/09/30

Table of Contents

ix

NET_INTERFACE_REF ..............................................................................333
NET_INTERFACE_VALUES .....................................................................334
NOTE_CODES..............................................................................................335
NOTE_TEXT .................................................................................................336
NRC_TRANS_DESCR .................................................................................337
NRC_TYPE_GROUPS .................................................................................341
OPEN_ITEM_ID_REF .................................................................................342
OPEN_ITEM_ID_VALUES.........................................................................343
OPEN_ITEM_PRIORITY.............................................................................344
OWNING_COST_CTR_REF.......................................................................345
OWNING_COST_CTR_VALUES..............................................................346
PACKAGE_CMF_ELIGIBILITY.................................................................347
PACKAGE_COMPONENTS......................................................................348
PACKAGE_COMPONENT_MEMBERS ..................................................349
PACKAGE_DEFINITION_REF .................................................................351
PACKAGE_DEFINITION_VALUES.........................................................352
PACKAGE_GROUP_REF ...........................................................................353
PACKAGE_GROUP_VALUES ..................................................................354
PACKAGE_NRCS........................................................................................355
PAYMENT_FILE_DETAIL .........................................................................356
PAYMENT_FILE_HEADER .......................................................................357
PAYMENT_FILE_TRAILER.......................................................................358
PLAN_ID_CREDIT_REF.............................................................................359
PLAN_ID_CREDIT_VALUES ....................................................................360
PLAN_ID_DISCOUNT_REF ......................................................................361
PLAN_ID_DISCOUNT_VALUES .............................................................362
POINT_CATEGORY_REF ..........................................................................363
POINT_CATEGORY_VALUES .................................................................364
POINT_CLASS_REF ....................................................................................365
POINT_CLASS_VALUES ...........................................................................366
POINT_REGION_REF.................................................................................367
POINT_REGION_VALUES........................................................................368
PRIVACY_LEVEL_REF...............................................................................369
PRIVACY_LEVEL_VALUES ......................................................................370
PROCESS_QUEUE.......................................................................................371
PROCESS_SCHED .......................................................................................372
PROCESS_STATUS......................................................................................374
PRODUCT_ELEMENTS .............................................................................375
PRODUCT_ELEMENT_RELATIONS.......................................................380
PRODUCT_GROUPS ..................................................................................381
PRODUCT_LINES .......................................................................................382
PROVIDER_ADDRESS ...............................................................................384
PROVIDER_CLASS_REF ............................................................................385
PROVIDER_CLASS_VALUES ...................................................................386
ABP-9.1-DR1-1999/09/30

T
x

Table of Contents

RATABLE_UNIT_CLASS_REF..................................................................387
RATABLE_UNIT_CLASS_VALUES .........................................................388
RATE_AGGR_USAGE ................................................................................389
RATE_CLASS_DESCR ................................................................................391
RATE_CURRENCY .....................................................................................392
RATE_CURRENCY_GROUP .....................................................................394
RATE_CURRENCY_GROUP_REF............................................................395
RATE_CURRENCY_GROUP_VALUES ...................................................396
RATE_CURRENCY_REF ............................................................................397
RATE_CURRENCY_VALUES ...................................................................399
RATE_DISCOUNT.......................................................................................400
RATE_LATE_FEE ........................................................................................402
RATE_NRC ...................................................................................................404
RATE_PERIODS...........................................................................................406
RATE_PERIOD_REF ...................................................................................409
RATE_PERIOD_VALUES...........................................................................410
RATE_RC ......................................................................................................411
RATE_UNIT_CR ..........................................................................................413
RATE_USAGE ..............................................................................................415
RATE_USAGE_BANDS ..............................................................................418
RATE_USAGE_BANDS_OVERRIDES .....................................................419
RATE_USAGE_OVERRIDES .....................................................................420
RAW_USAGE_FIELD_MAPPING ............................................................423
RECORD_FIELD_DEF ................................................................................426
RECORD_FIELD_MAP ...............................................................................429
RECORD_TYPE_MAP ................................................................................432
RECORD_TYPE_REF ..................................................................................433
RECORD_TYPE_SEQ_NUM ......................................................................436
RECORD_TYPE_VALUES..........................................................................437
REFUND_REASON_CODE_REF ..............................................................438
REFUND_REASON_CODE_VALUES .....................................................439
REGULATORY_ID_REF .............................................................................440
REGULATORY_ID_VALUES ....................................................................441
REPLICATION_TABLES ............................................................................442
REV_RCV_COST_CENTER_REF ..............................................................443
REV_RCV_COST_CENTER_VALUES .....................................................444
ROAMING_CLEARING_HOUSE_MEMBERS .......................................445
ROAMING_INVOICE_SUMMARY..........................................................446
ROAMING_OPERATOR_REF...................................................................447
ROAMING_OPERATOR_VALUES ..........................................................448
ROAMING_RATE_KEYS ...........................................................................449
ROAMING_TRANSFER_DETAIL ............................................................450
ROAMING_TRANSFER_TAX_DETAIL ..................................................454
SALES_CHANNEL_REF ............................................................................456
ABP-9.1-DR1-1999/09/30

Table of Contents

xi

SALES_CHANNEL_VALUES....................................................................458
SDR_EXCHANGE_RATES.........................................................................459
SEQ_NUM.....................................................................................................460
SERVER_CATEGORY_REF........................................................................461
SERVER_CATEGORY_VALUES ...............................................................462
SERVICE_CENTERS....................................................................................463
SERVICE_CENTER_TYPES........................................................................465
SERVICE_CENTER_TYPE_REF ................................................................466
SERVICE_CENTER_TYPE_VALUES........................................................467
SERVICE_PROVIDERS_REF......................................................................468
SERVICE_PROVIDERS_VALUES .............................................................471
STATE_REF...................................................................................................472
STATE_VALUES ..........................................................................................473
SUSPENDED_REASON_REF ....................................................................474
SUSPENDED_REASON_VALUES............................................................475
SYSTEM_MESSAGES ..................................................................................476
SYSTEM_MODULES ...................................................................................477
SYSTEM_PARAMETERS ............................................................................478
TAP_MAPPING ...........................................................................................479
TAX_ASSIGNMENTS .................................................................................481
TAX_CHARGE_ELEMENTS......................................................................483
TAX_CODES_COMM .................................................................................486
TAX_ELEM_DEFAULT_LOC ....................................................................489
TAX_OVERRIDES........................................................................................491
TAX_PKG_INST_ID_REF ...........................................................................493
TAX_PKG_INST_ID_VALUES ..................................................................495
TAX_RATES_VAT .......................................................................................496
TAX_STATUS_REF......................................................................................498
TAX_STATUS_VALUES .............................................................................499
TAX_TYPE_COMM_REF............................................................................500
TAX_TYPE_COMM_VALUES...................................................................501
TICKLER........................................................................................................502
TIMEZONE_REF..........................................................................................504
TIMEZONE_VALUES .................................................................................505
TRANSLATION ...........................................................................................506
TRANS_SOURCE_REF ...............................................................................507
TRANS_SOURCE_VALUES.......................................................................508
UNIT_CR_DEFINITIONS...........................................................................509
UNIT_CR_PLANS .......................................................................................511
UNIT_CR_RESTRICTIONS ........................................................................512
USAGE_ALARM_REF ................................................................................514
USAGE_ALARM_VALUES........................................................................515
USAGE_JURISDICTION.............................................................................516
USAGE_POINTS ..........................................................................................519
ABP-9.1-DR1-1999/09/30

T
xii

Table of Contents

USAGE_POINTS_TEXT ..............................................................................521
USAGE_TYPES.............................................................................................522
USAGE_TYPES_SPLIT ................................................................................531
USAGE_TYPES_UNITS ..............................................................................532
USAGE_TYPE_GROUPS ............................................................................533
USAGE_UNITS_CONVERT.......................................................................534
USAGE_UNITS_TYPE_REF .......................................................................535
USAGE_UNITS_TYPE_VALUES ..............................................................536
VIP_CODE_REF ...........................................................................................537
VIP_CODE_VALUES ..................................................................................538
ZIPCODE.......................................................................................................539
ZONE_CLASS_REF .....................................................................................540
ZONE_CLASS_VALUES ............................................................................541
ZONE_REF....................................................................................................542
ZONE_VALUES ...........................................................................................543
Fields...................................................................................................545

ABP-9.1-DR1-1999/09/30

Introduction
Welcome to the Database Reference. This document contains a
description of every table used by Arbor/BP, with descriptions of
fields, rules, triggers, indexes, and related information.
This is a reference document intended for use by individuals who are
already familiar with the architecture and data model for the Arbor/BP
billing system. See other Arbor/BP documents listed in Additional
Documents on page 4 for more information about Arbor/BP. In
particular, see the Configuration Guide for instructions on populating
configurable Arbor/BP tables.
This document is published in three volumes:
Volume 1, describing Admin database tables
Volume 2, describing Catalog and Customer database tables
Volume 3, containing a master index for the previous volumes
and a summary of each table
An index of fields appears at the end of volumes 1 and 2.

Whats New in This Manual


If you are familiar with the Database Reference for release 8.1, you
may find the following list of changes useful. This is not a complete list
of improvements and alterations made to this document or the product;
rather, it is an overview of major changes in document organization
and/or product functionality. For more complete information about
product changes, see the Product Release Bulletin.

ABP-9.1-DR1-1999/09/30

1
2

Chapter 1 Introduction

Tables Added

Table 1 lists the tables added to the Admin database in Release 8.5.
Table 1 New Tables - Release 8.5
ARB_TAB_DEPENDS

INDUSTRY_TYPE_REF

CIBER_ARBOR_FLD_XREF

INDUSTRY_TYPE_VALUES

CIBER_ARBOR_USAGE_TYPE_XREF

INSERT_FOREIGN_KEY_REF

CIBER_FLD_ERROR_CODES

INSERT_FOREIGN_KEY_VALUES

CIBER_FROM_NPANXX

LBX_POST_DATED

CIBER_LINE_RANGES

PAYMENT_FILE_DETAIL

CIBER_OPERATOR_SID_BID

PAYMENT_FILE_HEADER

CIBER_ROAMING_AGREEMENT

PAYMENT_FILE_TRAILER

CIBER_SID_BID_DEF

PROCESS_QUEUE

CIBER_SID_BID_MARKET

REFUND_REASON_CODE_REF

CIBER_SID_BID_SEQ_NUM

SALES_CHANNEL_REF

CIBER_SID_BID

SALES_CHANNEL_VALUES

ABP-9.1-DR1-1999/09/30

Whats New in This Manual

Table 2 lists the tables added to the Admin database in Release 9.0
Table 2 New Tables - Release 9.0
ACCOUNT_MOVE_TABLES

CDR_CONSOLIDATION_KEYS

BILL_EXPRESSION_GROUP_REF

CDR_RUNNING_TOTAL_MASK

BILL_EXPRESSION_GROUP_VALUES

COL_ORDER_ASSOC

BILL_EXPRESSION_GROUPS

COL_ORDER_ASSOC

BILL_EXPRESSION_REF

COL_ORDER_REF

BILL_EXPRESSION_VALUES

COL_ORDER_VALUES

BILL_FONT_REF

CURRENCY_LOCALE

BILL_FONT_VALUES

LANGUAGE_LOCALE

BILL_FONT_WIDTH

OPEN_ITEM_ID_REF

BILL_LINE_REF

OPEN_ITEM_ID_VALUES

BILL_LINE_VALUES

OPEN_ITEM_PRIORITY

BILL_TEXT_GROUPS

REGULATORY_ID_REF

BILL_TEXT_GROUP_REF

REGULATORY_ID_VALUES

BILL_TEXT_GROUP_VALUES

TAP_MAPPING

BILL_TEXT_REF

USAGE_ALARM_REF

BILL_TEXT_VALUES

USAGE_ALARM_VALUES

Table 3 lists the tables added to the Admin database in Release 9.1
Table 3 New Tables - Release 9.1
CLEARING_HOUSE_DIVISION

IGEN_ADDRESS_FORMAT_VALUES

IGEN_ADDRESS_FORMATS

ZIPCODE

IGEN_ADDRESS_FORMAT_REF

Table 4 lists the tables removed from the Admin database:


Table 4 Removed Tables
TAX_PARAMS (9.0)

ABP-9.1-DR1-1999/09/30

1
4

Chapter 1 Introduction

Information Added

The Database Reference Guide now lists foreign keys and check
constraints, in addition to triggers and indexes.

Additional Documents
The documentation set for this release consists of the following
manuals:
API Guide
ABP-9.1-APIG-1999/09/30
Overview of functions in, and use of, the Application
Programmer Interface.
API Reference
ABP-9.1-APIR-1999/09/30
Detailed description of all fields and objects in the Application
Programmer Interface.
Billing Operations Guide
ABP-9.1-BOG-1999/09/30
Operation and maintenance instructions for modules.
Configuration Guide, Vol. 1 (Modules)
ABP-9.1-CG1-1999/09/30
Detailed instructions for configuring modules.
Configuration Guide, Vol. 2 (Tables)
ABP-9.1-CG2-1999/09/30
Detailed instructions for configuring database tables.
Database Reference, Vol. 1 (Admin)
ABP-9.1-DR1-1999/09/30
Detailed description of fields and tables in the Admin database.
Database Reference, Vol. 2 (Catalog & Customer)
ABP-9.1-DR2-1999/09/30
Detailed description of fields and tables in the Catalog and
Customer databases.
Database Reference, Vol. 3 (Summary)
ABP-9.1-DR3-1999/09/30
Summary of all database tables.

ABP-9.1-DR1-1999/09/30

Additional Documents

Guide to Invoice Design


ABP-9.1-GID-1999/09/30
Instructions for using the Invoice Designer interface.
Guide to Products, Rates & Discounts
ABP-9.1-GPRD-1999/09/30
Overview of data model entities (such as products and rate
schedules) and how to configure them in the database.
iCARE Developers Kit
ABP-9.1-iC-1999/09/30
Operation, configuration, and maintenance instructions for
iCARE, a Web-based customer-care solution.
Journals Guide
ABP-9.1-JG-1999/09/30
Detailed description of Journal module functionality.
Product Release Bulletin
ABP-9.1-PRB-1999/09/30
High-level overview of new features added between releases
8.1 and 9.1.
Reports & File Layouts
ABP-9.1-RFL-1999/09/30
Detailed descriptions of control reports, summary and detail
reports, and input and output file formats.
System Administrator Guide
ABP-9.1-SAG-1999/09/30
Installation, configuration, and maintenance instructions for
the Arbor/BP system.
Technical Reference
ABP-9.1-TR-1999/09/30
Detailed descriptions of inputs, outputs, and processing flow of
all modules.
User Guide
ABP-9.1-UG-1999/09/30
Instructions for using the Customer Care interface.
Additionally, a Software Documentation Update (SDU) or Release
Notes may be available for your deployment, containing additional
information not covered in other documents.
You may also need to refer to documentation for other products, such
as operating systems, database management systems, tax packages,

ABP-9.1-DR1-1999/09/30

1
6

Chapter 1 Introduction

and third-party software integrated with Arbor/BP.

ABP-9.1-DR1-1999/09/30

Admin Tables
This chapter contains a detailed description of every table in the
Arbor/BP Admin database, in alphabetical order. The description of
each table includes the following information:
Table name and brief description of table.
List of Arbor/BP modules that use the table.
Descriptions of triggers, check constraints, foreign keys, and
indexes defined on the table.
Descriptions of every field in the table.
The description of each field includes the following information:
Field name
Data type and size (see below)
Comments brief field description
Values rules that constrain field values (preceded by R:) and
default values for the field (preceded by D:)
Null indicates whether a NULL value is allowed in the field
The data type associated with each field depends on the relational
database (RDB) system in use in your deployment. For example, the is_
default field in ACCESS_REGION_REF is a Number(1) field in an
Oracle database and a bit field in a Sybase database.
Every field description in this document contains a single documented
data type. Table 5 lists the valid documented data types and their
corresponding RDB data types for Oracle and Sybase.

ABP-9.1-DR1-1999/09/30

2
8

Chapter 2 Admin Tables

Table 5 Field Types


Documented
Type

Oracle
Type

Sybase
Type

bit

Number(1,0)

bit (1 byte)

char[N]

char(N)

char[N]

Minimum
Value

Maximum
Value
0

N characters

N characters

Fixed-length string, padded with blanks if smaller than N. N cannot exceed 255.
date

datetime

datetime (8 bytes)

varies

varies

For Oracle, stores date/time between January 1, 4712 B.C. and December 31, 4712.
For Sybase, stores date/time between January 1, 1753 and December 31, 9999.
long raw

image

image (16 bytes)

For Oracle, stores variable-length binary data up to 2 GB. For Sybase, stores a pointer to
a memory space allocated in multiples of 2 KB which cannot exceed 2 GB.
int

Number(10,0)

int
(4 bytes)

numeric

Number(18,0)

numeric (10)
(8 bytes)

smalldt

date

smalldatetime
(4 bytes)

-2,147,483,648
(-231)

2,147,483,647
(231 - 1)

-999,999,999,
999,999,999

999,999,999,
999,999,999

varies

varies

For Oracle, stores date/time between January 1, 4712 (B.C.) and December 31, 4712.For
Sybase, stores date/time between January 1, 1900 and June 6, 2079.
smallint

Number(6,0)

smallint
(2 bytes)

text

long

text (16 bytes)

-32,768
(-215)

32,767
(215 - 1)

For Oracle, stores variable-length character data up to 2 GB. For Sybase, stores a pointer
to a memory space allocated in multiples of 2 KB which cannot exceed 2 GB.
tinyint

Number(3,0)

tinyint (1 byte)

varchar[N]

varchar2(N)

varchar[N]

255

0 characters

N characters

Variable-length string.N cannot exceed 255.

Table 5 also includes minimum and maximum values for each


documented type. These are not necessarily the minimum and
maximum supported by your database; rather, they are the minimum
and maximum values supported by Arbor/BP for fields of this type.
Therefore, you should not enter field values that exceed the minimum
or maximum values documented here, even if the corresponding RDB
data type allows those values.
Admin Tables

ABP-9.1-DR1-1999/09/30

Configurable. Reserved for future use. Admin table. Read-only copy on exists on Customer server.
Used by the following modules: ABI

target_type has a valid type code that corresponds to the value of target_table.
unique on source_id, abi_source_record_type
unique on target_table, target_type

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

source_id

int

Data source ID, from ABI_SOURCE_REF.

abi_source_
record_type

tinyint

Type of record from source biller:


1 = credit invoice record
2 = debit invoice
3 = postbill adjustment
4 = non-recurring charge

target_table

tinyint

Table to which Arbor/BP should write record based on record type: (R: 1, 2, 3)
1 = ADJ
2 = NRC
3 = BMF

target_type

smallint

Corresponding type code for the NRC, ADJ, or BMF record.

Null

(R: 1, 2, 3, 4)

Triggers:
Indexes:

ABI_SOURCE_RECORD_TYPES

ABI_SOURCE_RECORD_TYPES

A
10

ABI_SOURCE_REF
Configurable. Reserved for future use.
Describes valid billing sources. Admin table. Read-only copy exists on Customer server.
Used by the following modules: ABI
Only one row may have is_default = 1.
unique on source_id

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

source_id

int

Unique internal ID for ABI source.

missed_bill_
code

tinyint

Indicates behavior if records from this billing source are missing at (R: 1, 2, 3)
billing time:
1 = create bill showing zero due for source
2 = create bill omitting section associated with source
3 = hold the bill until data received

revenue_owner

tinyint

Defines who owns the revenue associated with this billing source: (R: 1, 2)
1 = Arbor/BP
2 = someone else

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

ABI_SOURCE_REF

Configurable. Reserved for future use.


Describes billing sources defined in ABI_SOURCE_REF. Admin table. Read-only copy exists on Customer server.
Used by the following modules: ABI

language_code exists in LANGUAGE_CODE_REF.


source_id exists in ABI_SOURCE_REF.
unique on source_id, language_code

Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

source_id

int

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

Source ID, from ABI_SOURCE_REF.


Language code, from LANGUAGE_CODE_REF.
Short text description for ABI source.

Null

11

Triggers:

ABI_SOURCE_VALUES

ABI_SOURCE_VALUES

A
12

ACCESS_REGION_REF
Static. Defines valid access regions for vertical and horizontal rating. Populated via the LOAD_USG_PTS utility. Admin
table. Read-only copy exists on Customer server.
Only one row may have is_default = 1.
clustered, unique on access_region

Triggers:
Indexes:

Field Name

Data Type
5

Comments

Values

ABP-9.1-DR1-1999/09/30

access_region

char

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

Unique identifier of an access region (LATA).


(D: 0)

ACCESS_REGION_REF

Configurable. Describes access regions defined in ACCESS_REGION_REF. Admin table. Read-only copy exists on
Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


access_region exists in ACCESS_REGION_REF.
clustered, unique on access_region, language_code
Data Type

ABP-9.1-DR1-1999/09/30

access_region

char

language_code

smallint

Comments

Values

Null

Access region, from ACCESS_REGION_REF.


Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

13

Triggers:

ACCESS_REGION_VALUES

ACCESS_REGION_VALUES

A
14

ACCOUNT_CATEGORY_REF
Configurable. Defines all account categories (for example, business or residential) for this deployment. Admin table.
Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
non-unique on is_business, account_category
unique on account_category

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

tinyint

Unique identifier of an account category.

(R: != 255)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

is_reseller

bit

Are accounts of this category resellers? (1=yes)

is_business

tinyint

Is the account a business (1) or residential (0) account? This is is


only used by Arbor/BP in CommTax or CTM taxation.

interim_due_
days

smallint

Number of days after interim_bill_date to set ppdd_date for interim (D: -1) (R: >= -1)
bills for ac-counts of this category. If -1 (default), use ppdd_date
from customers next bill cycle.

consolidate_
usage

bit

Does the account category allow CAP to summarize usage?


(1 = yes)

(D: 0)

ACCOUNT_CATEGORY_REF

account_
category

Null

Configurable. Describes account categories defined in ACCOUNT_CATEGORY_REF. Admin table. Read-only copy exists
on Customer server.
Used by the following modules: CUSTINFO

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


account_category exists in ACCOUNT_CATEGORY_REF.
unique on account_category, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

account_
category

tinyint

Account category identifier, from ACCOUNT_CATEGORY_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

15

Triggers:

ACCOUNT_CATEGORY_VALUES

ACCOUNT_CATEGORY_VALUES

A
16

ACCOUNT_MOVE_TABLES
Configurable. Contains information about what data in which tables needs to be moved. Admin table. Read-only copy
exists on Customer server.
Used by the following modules: AMP
Indexes: This table has no indexes.

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

table_name

varchar

30

Name of the table.

table_alias

varchar

10

Alias for the table name. It can be Null if no aliases are used in
from_tables.

from_tables

varchar

255 The FROM clause of the SQL query used to find the information to
move.

where_clause

varchar

255 The WHERE conditions of the SQL query used to find the
information to move.

run_order

smallint

Order in the execution sequence for insert. Tables with higher


order will be inserted first and deleted last. If Null, the order is not
important.

Values

Null

Null

Null

ACCOUNT_MOVE_TABLES

Configurable. Maps customer segments to other branding fields. Admin table. Read-only copy exists on Customer
server.
Indexes: clustered, unique on acct_seg_id

Data Type

Comments

acct_seg_id

int

Account segment ID, from ACCT_SEG_REF.

mkt_code

smallint

Market code, from MKT_CODE_REF.

franchise_code

smallint

Franchise code, from FRANCHISE_CODE_REF.

ABP-9.1-DR1-1999/09/30

rev_rcv_cost_ctr smallint

Revenue receivable cost center ID, from REV_RCV_COST_


CENTER_REF.

remit_service_
center

smallint

Remittance service center ID, from SERVICE_CENTERS.

billing_service_
center

smallint

Billing service center ID, from SERVICE_CENTERS.

service_inquiry_ smallint
center

Inquiry service center ID, from SERVICE_CENTERS.

collections_
center

smallint

Collections service center ID, from SERVICE_CENTERS.

msg_grp_id

smallint

Message group ID, from MSG_GRP_ID_REF.

insert_grp_id

smallint

Insert group ID, from INSERT_GRP_ID_REF.

vip_code

tinyint

VIP code, from VIP_CODE_REF.

rate_class

smallint

Rate class, from RATE_CLASS_DESCR.

Values

Null

17

Field Name

ACCT_SEG_MAP

ACCT_SEG_MAP

A
18

ACCT_SEG_REF
Configurable. Describes customer account segments. Read-only copies exist on Customer and Catalog servers. Run the
replicate.pl script after modifying this table. See the System Administrator Guide for more information about
replicate.pl. Admin table.
Used by the following modules: CUSTINFO, API
Triggers:
Indexes:

Field Name

No row may have is_default = 1.


unique on acct_seg_id

Data Type

ABP-9.1-DR1-1999/09/30

acct_seg_id

int

is_default
is_internal

Comments

Values

Unique internal ID for a segment of accounts.

(R: > 0)

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

ACCT_SEG_REF

Configurable. Describes account segments defined in ACCT_SEG_REF. Read-only copies exist on Customer and Catalog
servers. Run the replicate.pl script after modifying this table. See the System Administrator Guide for more information
about replicate.pl. Admin table.
Used by the following modules: CUSTINFO, API

language_code exists in LANGUAGE_CODE_REF.


acct_seg_id exists in ACCT_SEG_REF.
unique on acct_seg_id, language_code

Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

acct_seg_id

int

Account segment ID, from ACCT_SEG_REF.

language_code

int

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Short text description for account segment.

Values

Null

Null

19

Triggers:

ACCT_SEG_VALUES

ACCT_SEG_VALUES

A
20

ADJ_REASON_CODE_REF
Configurable. Defines valid adjustment reasons, which are included in pop-up selection lists in the GUI and used for
booking adjustments. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, JNL
Only one row may have is_default = 1.
clustered, unique on adj_reason_code

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

adj_reason_
code

smallint

Unique internal identifier of a reason for an adjustment:


-2 = bill backout
-1 = service termination

journal_code

smallint

Indicates the classification of the revenue. This is used to book to


the proper journal account.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

ADJ_REASON_CODE_REF

Configurable. Describes adjustment reason codes defined in ADJ_REASON_CODE_REF. Admin table. Read-only copy
exists on Customer server.
Used by the following modules: CUSTINFO

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


adj_reason_code exists in ADJ_REASON_CODE_REF.
clustered, unique on adj_reason_code, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

adj_reason_
code

smallint

Adjustment reason code, from ADJ_REASON_CODE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

21

Triggers:

ADJ_REASON_CODE_VALUES

ADJ_REASON_CODE_VALUES

A
22

ADJ_TRANS_DESCR
Configurable. Defines valid adjustment types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, BIP, BIF, JNL
Triggers:

ABP-9.1-DR1-1999/09/30

Indexes:

If trans_target_id is not zero, then it must exist in PRODUCT_ELEMENTS, NRC_TRANS_DESCR, USAGE_TYPES,


or PRODUCT_LINES tables.
description_code must exist in DESCRIPTIONS.
If is_refinance = 1, trans_target_type must be 4 (misc adjustment).
If adj_trans_category = 1 and trans_sign = -1, billing_category must be 2 or 3 (credit adjustments to postbilled charges go against past charges or credit notes).
If adj_trans_category = 1 and trans_sign = 1, billing_category must be 1 (Debit adjustments to post-billed
charges go against current charges).
If adj_trans_category = 5, trans_target_type must be 3 and billing_category = 1 (ensure category 5 can only be
used for pre-billed usage adjs).
If adj_trans_category = 6 or 7, billing_category must be 2.
trans_target_id is updated with correct value, depending on value of trans_target_type, as specified in field
description.
Only one row can have trans_target_type = 9 and trans_sign = 1.
Only one row can have trans_target_type = 9 and trans_sign = -1.
Reversal adjustments (adj_trans_category = 6 or 7) can only be applied to past charges or credit note reversals
(billing_category = 2 or 4)
On insert or update of tax_class either tax_class exists in TAX_RATES_VAT or is = -1, -2, or NULL.
unique on adj_trans_code

ADJ_TRANS_DESCR

Comments

Values

ABP-9.1-DR1-1999/09/30

adj_trans_code

smallint

Unique internal identifier of an adjustment type.

trans_target_
type

smallint

Transaction target type:


(R: 1, 2, 3, 4, 5,
1 = recurring charge for a product defined in PRODUCT_ELEMENTS 9)
2 = non-recurring charge defined in NRC_TRANS_DESCR
3 = usage charge defined in USAGE_TYPES
4 = open item id, defined in OPEN_ITEM_ID_REF
5 = recurring charge for product line, from PRODUCT_LINES
6 = taxes
9 = system-generated reversal, in other words, not in a specific
table.

trans_target_id

smallint

Identifier of transaction target type. This is to cross-reference the


appropriate table. For transaction type 9 this field will be zero.

adj_trans_
category

tinyint

Category of adjustment transaction:


1 = pre-rated
5 = pre-billed usage adjustment
6 = adj backout for new charges
7 = backout for adjustments

(R: 1, 5, 6, 7)

trans_sign

smallint

Indicates whether adjustment is a debit or a credit:


1 = debit
-1 = credit

(R: -1, 1)

billing_category

smallint

Category for billing:


1 = apply to current charges
2 = apply to past charges
3 = apply to credit note
4 = apply to credit note reversals. Non-balance affecting, usually
generated during invoice backout.

(R: 1, 2, 3, 4)

billing_level

smallint

Billing level: 0 = account level

(R: 0, 1)

description_code smallint

1 = service instance level

Null

Description from DESCRIPTIONS table.

23

Data Type

ADJ_TRANS_DESCR

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

tax_class

smallint

Tax class from TAX_RATES_VAT, or


-1 = exempt
-2 = outside scope of law
Null indicates that the deployment doesnt required VAT taxation.

is_viewable

bit

Is the adjustment type viewable through the GUI? (1 = yes)

(D: 1)

is_modifiable

bit

Is the adjustment type modifiable through the GUI? (1 = yes)

(D: 1)

is_adjustable

bit

Can the adjustment type be adjusted? (1 = yes)

(D: 1)

is_journalable

bit

Should the adjustment type be booked? (1 = yes) Set to 1 unless (D: 1)


booked by another system.

is_displayed_
onbill

bit

Is the adjustment type displayed on the bill? (1 = yes)

(D: 1)

is_disconnect_
credit

bit

Is this adjustment type a disconnect credit? (1 = yes)

(D: 0)

is_refinance

bit

Is this adjustment a refinancing adjustment? (1 = yes)

(D: 0)

Null

24

Field Name

Null

ADJ_TRANS_DESCR

Configurable. Defines aggregate usage rate structures. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CAP, BIP, CUSTINFO
Only one row may have is_default = 1.
inactive_dt must be later than active_dt, or NULL.
unique on aggr_usage_id

Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

aggr_usage_id

smallint

Unique ID of an aggregate usage rate structure.

aggr_usage_
type

tinyint

2 = incremental aggregate usage rate


6 = bulk aggregate usage rate

(R: 2, 6)

aggr_usage_
quantum

tinyint

2 = aggregation by unit (for example, minutes)


3 = aggregation by item (for example, calls)

(R: 2, 3)

active_dt

smalldt

Date the rate structure becomes active.

inactive_dt

smalldt

Date the rate structure becomes inactive.

create_dt

smalldt

Date the rate structure was defined.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

Null
(D: 0)

25

Triggers:

AGGR_USAGE_DEFINITIONS_REF

AGGR_USAGE_DEFINITIONS_REF

A
26

AGGR_USAGE_DEFINITIONS_VALUES
Configurable. Describes aggregate usage definitions defined in AGGR_USAGE_DEFINITIONS_REF. Admin table. Readonly copy exists on Customer server.
Used by the following modules: BIF, CUSTINFO
Triggers:

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


aggr_usage_id exists in AGGR_USAGE_DEFINITIONS_REF.
language_code and aggr_usage_id cannot be updated.
unique on aggr_usage_id, language_code

Data Type

Comments

smallint

Aggregate rate ID, from AGGR_USAGE_DEFINITIONS_REF.

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

Null

AGGR_USAGE_DEFINITIONS_VALUES

ABP-9.1-DR1-1999/09/30

aggr_usage_id
language_code

Values

Configurable. Controls which entities have their usage aggregated by each aggregate usage rate structure. Admin table.
Read-only copy exists on Customer server.
Used by the following modules: CAP, BIP

aggr_usage_id exists in AGGR_USAGE_DEFINITIONS_REF.


restricted_id exists in appropriate table, based on restriction_type (see below).
Rows with the same aggr_usage_id and restriction_type should have the same is_exclusion value.
non-unique on aggr_usage_id
unique on aggr_usage_id, restriction_type, restricted_domain, restricted_id

Indexes:

ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

Values

aggr_usage_id

smallint

Aggregate rate ID, from AGGR_USAGE_DEFINITIONS_REF.

restriction_type

tinyint

2 = rate is restricted to a product.


5 = rate is restricted to a usage type.

(R: 2, 5)

restricted_
domain

tinyint

If restriction_type = 5, this field should be 3 (usage charge).


Otherwise, leave Null.

(R: NULL, 3)

restricted_id

smallint

If restriction_type = 2, PRODUCT_ELEMENTS.element_id.
If restriction_type = 5, USAGE_TYPES.type_id_usg.

is_exclusion

bit

0 = aggregate rate should be applied only to the restricted entity


1 = aggregate rate should be applied to everything except the
restricted entity

Null

Null
Null

27

Triggers:

AGGR_USAGE_RESTRICTIONS

AGGR_USAGE_RESTRICTIONS

A
28

ARB_TAB_DEPENDS
Static. Defines table constraints used during an Arbor/OM installation.
Admin table. Read-only copies exist on Customer and Catalog servers.
Indexes: primary-key on depend_id

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

depend_id

smallint

key_nm

varchar

255

Used by Arbor/OM.

parent_nm

varchar

255

Used by Arbor/OM.

child_nm

varchar

255

Used by Arbor/OM.

Values

Null

Used by Arbor/OM.

parent_cols

varchar

255

Used by Arbor/OM.

child_cols

varchar

255

Used by Arbor/OM.

ARB_TAB_DEPENDS

Static. Reserved for future use.


Describes valid archiving actions (one entry for each action type). Admin table. Read-only copy exists on Customer
server.

Field Name

Only one row may have is_default = 1.


unique on arch_action

Data Type

ABP-9.1-DR1-1999/09/30

arch_action

smallint

is_default
is_internal

Comments

Values

Archive action code:


1 = database move data
2 = database delete data
3 = flat file move
4 = flat file delete
5 = database external archive (in other words, to tape device)

(R: 1, 2, 3, 4, 5)

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

29

Triggers:
Indexes:

ARCHIVE_ACTION_REF

ARCHIVE_ACTION_REF

A
30

ARCHIVE_ACTION_VALUES
Configurable. Reserved for future use.
Describes archive actions defined in ARCHIVE_ACTION_REF. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


arch_action exists in ARCHIVE_ACTION_REF.
unique on arch_action, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

arch_action

smallint

Archive action, from ARCHIVE_ACTION_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Description of archive action.

Short description of form ssdd, where:


ss (source) = DB for database, FF for flat file.
dd (destination) = SH for shadow, DL for delete,
AR for external archive.

Values

Null

Null

ARCHIVE_ACTION_VALUES

ARCHIVE_TAPES

ARCHIVE_TAPES
Configurable. Reserved for future use. Admin table. Read-only copy exists on Customer server.
Indexes: clustered, unique on table_name, arch_date, db_name
non-unique on tape_id, serv_tape_id

Data Type

Comments

ABP-9.1-DR1-1999/09/30

table_name

char

30 Reserved for future use.

db_name

char

30 Reserved for future use.

arch_date

datetime

Reserved for future use.

num_rows

int

Reserved for future use.

tape_id

int

Reserved for future use.

file_no

int

Reserved for future use.

earliest

varchar

20 Reserved for future use.

latest

varchar

20 Reserved for future use.

arch_tag

varchar

40 Reserved for future use.

arch_flag

smallint

Reserved for future use.

serv_tape_id

tinyint

Reserved for future use.

Values

Null

(D: 0)

31

Field Name

A
32

ARCHIVE_TASKS
Configurable. Reserved for future use. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

If arch_action = 5 (archive to tape), there can only be one table per archive task.
task_name must exist in PROCESS_SCHED or be NULL.
unique on task_name, arch_action, arch_from

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

task_name

char

10 Name used to identify this archive task.

arch_action

smallint

arch_from

char

80 Table or directory to be archived.

arch_to

char

80 Archive data destination: either a valid table name (action 1),


directory name (action 3), or tape device (action 5). Not used for
delete actions.

Null

file_pattern

char

16 Files matching file_pattern will be archived.

Null

file_age

smallint

db_criteria1

Archive action code, from ARCHIVE_ACTION_REF.

(R: 1, 2, 3, 4, 5)

Null

char

80 Used only for database archiving. Contains where clause (without


the word where) defining which rows to archive.

Null

db_criteria2

char

80 Used only for database archiving. This optional field contains


additional components to the where clause (without preceding
and).

Null

in_use_by

char

Null

Process currently performing archive task, or Null if not currently


active.

ARCHIVE_TASKS

Used only for flat file archiving. Files older than the specified age
(in days) will be archived. If Null, all files matching file_pattern will
be archived.

Data Type

Comments

last_arch

datetime

Date and time this archive task was last run.

do_not_arch

bit

Should this entry be archived? (1 = no) Allows an archive task to be


disabled.

test_flag

bit

Test mode? If true (1), data is not deleted. If false (0), data is
deleted normally.

Values

Null
Null

ARCHIVE_TASKS

Field Name

ABP-9.1-DR1-1999/09/30

33

A
34

ARCH_MODE_REF
Static. Defines valid archive modes. Admin table. Read-only copy exists on Customer server.
Used by the following modules: ARCH
Only one row can have is_default = 1.
clustered, unique on arch_mode_id

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

arch_mode_id

smallint

Unique archive mode ID:


1 = Count Only
2 = Archive and Delete
3 = Delete Only
4 = Full Archive Restore
5 = Invoice-level Restore

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

Null

(D: 0)

ARCH_MODE_REF

ARCH_MODE_VALUES

ARCH_MODE_VALUES
Configurable. Describes archive modes. Admin table. Read-only copy exists on Customer server.
Used by the following modules: ARCH

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


arch_mode_id exists in ARCH_MODE_REF.
clustered, unique on arch_mode_id, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

arch_mode_id

smallint

Archive mode ID, from ARCH_MODE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

80 Text description to be displayed on screen.

short_display

char

Values

Null

Short text description.

35

Triggers:

A
36

ARCH_TABLE_DEPENDS_REF
Static. Identifies the tables associated with each archive type. Admin table. Read-only copy exists on Customer server.
Used by the following modules: ARCH
Triggers:
Indexes:

Field Name

Ensure arch_type_id exists in ARCH_TYPE_REF.


clustered, unique on arch_table_id

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

smallint

Unique table ID.

arch_type_id

smallint

Archive type used to archive this table, from ARCH_TYPE_REF. A


given table can only be archived by one archive type.

is_master

bit

Is this the master table? (1 = yes, 0 = no)


Only one master table is allowed per archive type.

(D: 0)

is_deletable

bit

Delete records from this table after archiving? (1 = yes, 0 = no)

(D: 0)

arch_table_nm

varchar

255 Table name.

arch_key_fld_
nm

varchar

64

Key field for this table (for example, index_bill_ref for BILL_
INVOICE).

arch_key_
resets_fld_nm

varchar

64

Key resets field for this table (for example, index_bill_ref_resets for
BILL_INVOICE).

ARCH_TABLE_DEPENDS_REF

arch_table_id

Null

ARCH_TYPE_REF

ARCH_TYPE_REF
Static. Defines valid archive types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: ARCH
Only one row can have is_default = 1.
clustered, unique on arch_type_id

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

arch_type_id

smallint

Archive type:
1 = Archive old invoices (BILL_INVOICE table)
2 = Archive bill images (BILL_IMAGE table)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

Null

(D: 0)

37

Triggers:
Indexes:

A
38

ARCH_TYPE_VALUES
Configurable. Describes archive types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: ARCH
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


arch_type_id exists in ARCH_TYPE_REF.
clustered, unique on arch_type_id, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

arch_type_id

smallint

Archive type ID, from ARCH_TYPE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

80 Text description to be displayed on screen.

short_display

char

Values

Null

Short text description.

ARCH_TYPE_VALUES

Configurable. Identifies deployment-specific tables for inclusion in the ACE interface. Admin table.
Used by the following modules: ATM
Indexes: unique on table_name

Field Name

Data Type

table_name

char

server_type

tinyint

Comments

Values

Null

30 Name of deployment-specific table.


Type of server on which the table resides.

(R: 1, 2, 3)

ATM_CUSTOM_TABLE_DEF

ATM_CUSTOM_TABLE_DEF

Null

ABP-9.1-DR1-1999/09/30

39

A
40

ATM_FIELD_DEF
Static/configurable. Defines field information used by ATM. Edit this table for custom tables defined in ATM_CUSTOM_
TABLE_DEF, otherwise do not edit. This table cannot be modified through ATM. Admin table.
Used by the following modules: ATM
Indexes: unique on table_name, field_name

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

table_name

varchar

30 Table in whose maintenance windows a pop-up list exists.

field_name

varchar

30 Field name in the given table for which the pop-up list exists.

field_type

tinyint

cross_table_
name

varchar

30 Table from which pop-up list values are drawn.

Null

cross_field_
name

varchar

30 Field from which pop-up list values are drawn.

Null

poplist_type

tinyint

Reserved for future use; leave Null.

1 = cross_field_name is described in DESCRIPTIONS.


2 = cross_field_name is described in a _VALUES table.
3 = cross_field_name is not described in the database.

Null

Null

ATM_FIELD_DEF

Static/configurable. Holds values for certain pop-up selection lists in ATM. Edit this table for custom tables defined in
ATM_CUSTOM_TABLE_DEF, otherwise do not edit. This table cannot be modified through ATM. Admin table.
Used by the following modules: ATM

Field Name

Only one row may have is_default = 1.


clustered, unique on table_name, field_name, int_value, char_value

Data Type

Comments

ABP-9.1-DR1-1999/09/30

table_name

varchar

32 Table in whose maintenance windows a pop-up list exists.

field_name

varchar

32 Field name in the given table for which the pop-up list exists.

Values

int_value

int

char_value

varchar

Field value (if int, smallint, tinyint or numeric).

is_default

bit

Always set to 0.

(D: 0)

is_internal

bit

Always set to 0.

(D: 0)

Null

Null

12 Field value (if char or varchar).

Null

41

Triggers:
Indexes:

ATM_POPLIST_REF

ATM_POPLIST_REF

A
42

ATM_POPLIST_VALUES
Configurable. Describes values defined in ATM_POPLIST_REF. Admin table. Read-only copy exists on Customer server.

language_code exists in LANGUAGE_CODE_REF.


table_name, field_name, char_value, and int_value exist in ATM_POPLIST_REF.
clustered, unique on table_name, field_name, language_code, char_value, int_value

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

table_name

varchar

30 Table in whose maintenance windows a pop-up list exists.

field_name

varchar

30 Field name in the given table for which the pop-up list exists.

int_value

int

char_value

varchar

language_code

smallint

short_display

char

display_value

varchar

80 Description used in the pop-up list.

Field value (if int, smallint, tinyint or numeric).


12 Field value (if char or varchar).

Values

Null

Null
Null

Language code, from LANGUAGE_CODE_REF.


Leave blank.

Null

ATM_POPLIST_VALUES

Static. Describes the valid billing frequencies (daily, monthly, and so on). Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO, BIP
Only one row may have is_default = 1.
unique on billing_frequency

Field Name

Data Type

billing_frequency tinyint

Comments

ABP-9.1-DR1-1999/09/30

Billing frequency code:


1 = daily
2 = weekly
6 = annually

Values

Null

3 = monthly 4 = quarterly

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

43

Triggers:
Indexes:

BILLING_FREQUENCY_REF

BILLING_FREQUENCY_REF

B
44

BILLING_FREQUENCY_VALUES
Configurable. Describes billing frequencies defined in BILLING_FREQUENCY_REF. Admin table. Read-only copy exists
on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


billing_frequency exists in BILLING_FREQUENCY_REF.
clustered, unique on billing_frequency, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

billing_frequency tinyint

Billing frequency, from BILLING_FREQUENCY_REF.

language_code

Language code, from LANGUAGE_CODE_REF.

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

BILLING_FREQUENCY_VALUES

Configurable. Provides support for deployment-specific bill formatting for front-page address. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: BIF

bill_fmt_opt exists in BILL_FMT_OPT_REF.


country_code exists in COUNTRY_CODE_REF.
Only one row may have is_default = 1.
unique on bill_fmt_opt, country_code, address_line, address_line_order
unique on bill_fmt_opt, country_code, address_field

Indexes:

ABP-9.1-DR1-1999/09/30

Data Type

Comments

Values

bill_fmt_opt

int

Bill format option, from BILL_FMT_OPT_REF.

country_code

smallint

Country code, from COUNTRY_CODE_REF.

address_field

smallint

Specifies for which field this record specifies formatting:


1 = prefix
6 = title
11 = city
2 = first name
7 = company
12 = county
3 = middle initial 8 = address (line 1) 13 = state
4 = last name
9 = address (line 2) 14 = zip
5 = suffix
10 = address (line 3)
15 = COUNTRY_CODE_VALUES.display_value

(R: 1, 2, 3, 4, 5,
6, 7, 8, 9, 10, 11,
12, 13, 14, 15)

address_line

tinyint

Line of address on which this field appears.

(R: 1, 2, 3, 4, 5,
6)

Null

45

Triggers:

Field Name

BILL_ADDRESS

BILL_ADDRESS

Data Type

Comments

Values

address_line_
order

tinyint

Order within the address line in which this field falls.

(R: 1, 2, 3, 4, 5,
6, 7, 8, 9, 10, 11,
12, 13, 14, 15)

field_status

tinyint

Status of this address field:


1 = required
2 = optional

(R: 1, 2, 3)

is_default

bit

Null

46

Field Name

3 = ignored

Use this record as the default? (1 = yes)

ABP-9.1-DR1-1999/09/30

BILL_ADDRESS

Configurable. Associates usage record types with each bill class (for example; priority or grade of service). Admin table.
Read-only copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU, BIP
Only one row may have is_default = 1.
clustered, unique on bill_class

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

bill_class

smallint

Unique internal identifier of the bill class, priority, or grade of


service.

bill_class_type

tinyint

Defines the overall type of the usage record:


(R: 0, 1)
0 = normal; record to be guided and rated normally
1 = free; record will not be guided or rated. Record started in CDR_
FREE instead of CDR_DATA.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(R: != 0)

(D: 0)

47

Triggers:
Indexes:

BILL_CLASS_REF

BILL_CLASS_REF

B
48

BILL_CLASS_VALUES
Configurable. Describes bill classes defined in BILL_CLASS_REF. Admin table. Read-only copy exists on Customer
server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


bill_class exists in BILL_CLASS_REF.
clustered, unique on bill_class, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

bill_class

smallint

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

Bill class, priority, or grade of service identifier, from BILL_CLASS_


REF.
Language code, from LANGUAGE_CODE_REF.
Abbreviated version of the display value.

Null

BILL_CLASS_VALUES

Configurable. Defines the dates and cycles when bills should be prepared, formatted, and dispatched. Contains one row
for each defined billing cycle. Admin table. Read-only copy exists on Customer server.

BILL_CYCLE

BILL_CYCLE
Used by the following modules: CUSTINFO, BIP

Indexes:
ABP-9.1-DR1-1999/09/30

Field Name
bill_period

bill_period exists in BILL_PERIOD_REF.


bill_period does not end with 00.
billing_frequency exists in BILLING_FREQUENCY_REF.
Only one value for billing_frequency exists for a given bill_period value.
ppdd_date earlier than next_ppdd_date; same as next_ppdd_date of previous row.
Automatically set prep_date to cutoff_date + prep_delay /24(in hours).
clustered, unique on bill_period, ppdd_date
unique on bill_period, cutoff_date

Data Type
char

Comments

Billing frequency code, from BILLING_FREQUENCY_REF.

ppdd_date

Date on which the payment is due for this cycle.

next_ppdd_date datetime

Null

Bill cycle identifier, from BILL_PERIOD_REF.

billing_frequency tinyint
datetime

Values

Date on which payment is due for the following cycle.

statement_date

datetime

Statement date to print on the bill for this cycle.

cutoff_date

datetime

Cutoff date for transactions appearing on the bill.

prep_delay

smallint

Number of hours BIP delays after cutoff time before processing


invoices for this cycle. Used to ensure that all usage for the cycle is
able to be processed.

prep_date

datetime

Modified cuttoff date, calculated by:cuttoff_date + (prep_delay/24).

Null

49

Triggers:

B
50

BILL_DISP_METH_REF
Configurable. Defines valid bill dispatch methods, which are included in pop-up selection lists in CUSTINFO. Admin
table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, BIF, BID
Only one row may have is_default = 1.
unique on bill_disp_meth

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

bill_disp_meth

smallint

Internal identifier of bill dispatch methods:


0 = no dispatching
1 = print on paper (P)
(Individual deployments may support additional values.)

(R: 0, 1)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

BILL_DISP_METH_REF

Configurable. Describes bill dispatch methods defined in BILL_DISP_METH_REF. Admin table. Read-only copy exists
on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


bill_disp_meth exists in BILL_DISP_METH_REF.
clustered, unique on bill_disp_meth, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

bill_disp_meth

smallint

Bill dispatch method, from BILL_DISP_METH_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Abbreviated version of the display value.

Null

Null

51

Triggers:

BILL_DISP_METH_VALUES

BILL_DISP_METH_VALUES

B
52

BILL_EXPRESSION_GROUPS
Configurable. For internal use only. Defines which expressions are in which expression groups. Admin table.
Used by the following modules: IGEN
Ensure expression_id type is the same as expression_group_id type
unique on expression_id, expression_group_id

Triggers:
Indexes:

Foreign Keys:(expression_id) must exist in BILL_EXPRESSION_REF(expression_id)


(expression_group_id) must exist in BILL_EXPRESSION_GROUP_REF(expression_group_id)

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

expression_id

int

Expression ID.

expression_
group_id

int

Expression group ID.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

is_hidden

bit

If 1, the expression will not be displayed in the expression group.

Null

BILL_EXPRESSION_GROUPS

Configurable. For internal use only. Defines the groupings of available expressions for the invoice designer. Admin table.
Used by the following modules: IGEN
Group type must be the same as the parent groups group type if parent group type is not NULL.
primary-key on expression_group_id

Foreign Keys:(parent_group_id) must exist in BILL_EXPRESSION_GROUP_REF(expression_group_id)


Check Constraints:parent_group_id != expression_group_id
Field Name
ABP-9.1-DR1-1999/09/30

expression_
group_id

Data Type
int

Comments

Values

Null

Unique expression group ID.

parent_group_id int

Expression group ID of the parent of this group.

group_type

tinyint

Type of group: 1 = expression 2 = filters

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

is_hidden

bit

If 1, this expression group is not displayed to invoice designers.

3 = restrictions

Null
(R: 1, 2, 3)

53

Triggers:
Indexes:

BILL_EXPRESSION_GROUP_REF

BILL_EXPRESSION_GROUP_REF

B
54

BILL_EXPRESSION_GROUP_VALUES
Configurable. For internal use only. Describes expression groups defined in BILL_EXPRESSION_GROUP_REF. Admin
table.
Used by the following modules: IGEN
Indexes: unique on expression_group_id, language_code
Foreign Keys:(language_code) must exist in LANGUAGE_CODE_REF(language_code)
(expression_group_id) must exist in BILL_EXPRESSION_GROUP_REF(expression_group_id)

Field Name

Data Type

Comments

int

Unique expression group ID, from BILL_EXPRESSION_GROUP_


REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

Null

BILL_EXPRESSION_GROUP_VALUES

ABP-9.1-DR1-1999/09/30

expression_
group_id

Values

Configurable. For internal use only. This table lists the expressions that can be inserted into <EXPRESSION> tags in a
layout specification XML file. Admin table.
Used by the following modules: IGEN
Indexes: primary-key on expression_id
unique on tag
Check Constraints:(expression_type = 1 and return_type in (1,2,3,4,6,7)) or (expression_type in (2,3) and return_type = 5)
Data Type

ABP-9.1-DR1-1999/09/30

expression_id

int

tag

varchar

Comments

Values

Unique expression ID.


64 Tag used in XML to identify expression.

expression_type tinyint

Type of expression:
1 = expression
2 = filter
3 = restriction

return_type

Data type of the value returned by the represented function.


(R: 1, 2, 3, 4, 5,
Possible values include:
6, 7)
1 = expression returns an integer (int)
2 = expression returns a string
3 = expression returns a date
4 = expression returns a numeric
5 = expression returns a bool (it is a filter or restriction)
6 = expression returns an address from IGEN_FORMAT_ADDRESS

tinyint

Null

(R: 1, 2, 3)

varchar

is_internal

bit

10 Reserved for future use.


If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)
modify.

is_hidden

bit

If 1, this expression is not displayed.

55

tables_used

Field Name

BILL_EXPRESSION_REF

BILL_EXPRESSION_REF

B
56

BILL_EXPRESSION_VALUES
Configurable. For internal use only. Describes expression functions defined in BILL_EXPRESSION_REF. Admin table.
Used by the following modules: IGEN
Indexes: unique on expression_id, language_code
Foreign Keys:(expression_id) must exist in BILL_EXPRESSION_REF(expression_id)
(language_code) must exist in LANGUAGE_CODE_REF(language_code)

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

expression_id

int

Unique expression ID, from BILL_EXPRESSION_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

BILL_EXPRESSION_VALUES

Configurable. Lists valid bill format options (for example; summary or detail). Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO, BIF
Only one row may have is_default = 1.
unique on bill_fmt_opt

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

bill_fmt_opt

int

External bill format option ID.

format_code

int

Internal bill format option ID, defined and used by BIF. Deployment- (R: 1, 2)
specific.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

57

Triggers:
Indexes:

BILL_FMT_OPT_REF

BILL_FMT_OPT_REF

B
58

BILL_FMT_OPT_VALUES
Configurable. Describes bill format options defined in BILL_FMT_OPT_REF. Admin table. Read-only copy exists on
Customer server.

language_code exists in LANGUAGE_CODE_REF.


bill_fmt_opt exists in BILL_FMT_OPT_REF.
clustered, unique on bill_fmt_opt, language_code

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

bill_fmt_opt

int

Bill format option identifier, from BILL_FMT_OPT_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

BILL_FMT_OPT_VALUES

Configurable. Defines valid bill sections. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIF
Only one row can have is_default = 1.
clustered, unique on section_exclude

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

section_exclude int

Unique bill section ID. Some standard values include:


1 = Balance brought forward section
5 = Usage charges detail section
7 = Remittance coupon section
10 = All charges detail section
11 = Charges detail by owning account
Additional values may be available; see client-specific bill format
documentation for more information.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is used by Arbor/BP modules; do not delete or


modify.

(D: 0)

Null

59

Triggers:
Indexes:

BILL_FMT_SECTION_EXCL_REF

BILL_FMT_SECTION_EXCL_REF

B
60

BILL_FMT_SECTION_EXCL_VALUES
Configurable. Describes bill section IDs. Admin table. Read-only copy exists on Customer server.

language_code exists in LANGUAGE_CODE_REF.


section_exclude exists in BILL_FMT_SECTION_EXCL_REF.
clustered, unique on section_exclude, language_code

Triggers:
Indexes:

Field Name

Data Type

Comments
Bill section ID, from BILL_FMT_SECTION_EXCL_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Short text description of the bill section.

Null

(D: 1)
Null

BILL_FMT_SECTION_EXCL_VALUES

ABP-9.1-DR1-1999/09/30

section_exclude int

Values

Configurable. Defines valid bill section types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIF
Only one row can have is_default = 1.
primary-key on section_type

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

section_type

tinyint

Unique bill section type ID. Some standard values include:


1 = Usage charges detail
2 = Recurring charges detail
Additional values may be available; see client-specific bill format
documentation for more information.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is used by Arbor/BP modules; do not delete or


modify.

(D: 0)

Null

61

Triggers:
Indexes:

BILL_FMT_SECTION_TYPE_REF

BILL_FMT_SECTION_TYPE_REF

B
62

BILL_FMT_SECTION_TYPE_VALUES
Configurable. Describes bill section type IDs. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


section_type exists in BILL_FMT_SECTION_TYPE_REF.
clustered, unique on section_type, language_code

Data Type

Comments

tinyint

Bill section type ID, from BILL_FMT_SECTION_TYPE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Short text description of the bill section type.

Null

(D: 1)
Null

BILL_FMT_SECTION_TYPE_VALUES

ABP-9.1-DR1-1999/09/30

section_type

Values

Configurable. Defines valid bill format templates. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIF
Only one row can have is_default = 1.
primary-key on template_code

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

template_code

smallint

Unique template ID. Some standard values include:


16 = Usage charges detail
17 = Recurring charges detail
18 = Recurring charges detail for leased line circuits
19 = Recurring charges detail in multiple currencies
20 = Usage charge detail in multiple currencies
Additional values may be available; see client-specific bill format
documentation for more information.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is used by Arbor/BP modules; do not delete or


modify.

(D: 0)

Null

63

Triggers:
Indexes:

BILL_FMT_TEMPLATE_CODE_REF

BILL_FMT_TEMPLATE_CODE_REF

B
64

BILL_FMT_TEMPLATE_CODE_VALUES
Configurable. Describes template IDs. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


template_code exists in BILL_FMT_TEMPLATE_CODE_REF.
clustered, unique on template_code, language_code

Data Type

Comments

smallint

Template ID, from BILL_FMT_TEMPLATE_CODE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Short text description of the template.

Null

(D: 1)
Null

BILL_FMT_TEMPLATE_CODE_VALUES

ABP-9.1-DR1-1999/09/30

template_code

Values

BILL_FONT_REF

BILL_FONT_REF
Configurable. For internal use only. Defines the available fonts for invoices. Admin table.
Used by the following modules: IGEN
Indexes: unique on tag, test_flag
primary-key on font_id, test_flag

Data Type

Comments

ABP-9.1-DR1-1999/09/30

font_id

smallint

Unique font ID.

test_flag

tinyint

Reserved for future use.

tag

varchar

Values

Null

(D: 0) (R: 0, 1)

30 Tag name, as appearing in font specification XML tags.

hp_symbol_set

smallint

PCL symbol set identifier.

hp_spacing

smallint

Spacing: 0 = fixed width font

hp_pitch

smallint

For fixed width fonts, the pitch of the font.

hp_height

smallint

Height, in points, of the font.

hp_style

smallint

Style: 0 = regular

hp_stroke_
weight

smallint

Weight of the font: 0 = regular

hp_typeface

smallint

Typeface identifier of the font.

1 = proportional font

1 = italic

(D: 0)

(D: 0)
3 = bold

(D: 0)

bit

Is the font underlined? (1 = yes)

(D: 0)

hp_direction

smallint

Direction in which to print the font:


0 = left to right
90 = vertical, bottom to top

(D: 0)

hp_outline

bit

Is the font outlined? (1 = yes)

(D: 0)

afp_trcref

smallint

AFP code indicating the font.

Null

afp_pitch

smallint

Pitch of the font.

Null

65

hp_underline

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

afp_code_page

varchar

15 AFP reference for the name of the code page.

Null

afp_char_set

varchar

15 AFP reference for the character set of the font.

Null

html_start_tag

varchar

70 Font text that precedes the output text in the HTML stream (for
example <FONT size = 2><B>).

Null

html_end_tag

varchar

70 Font text that follows the output text in the HTML stream (for
example </B></FONT>).

Null

win_facename

varchar

32 Face name of the font for display in Windows.

win_pointsize

smallint

Point size of the font for display in Windows; either this or win_
height = 0.

win_height

smallint

Height of the font for display in Windows; either this or win_


pointsize = 0.

win_weight

smallint

Weight of the font for display in Windows.

(D: 0)

win_italic

bit

Is the font italic? (1 = yes)

(D: 0)

bit

Is the font underlined? (1 = yes)

(D: 0)

win_strikeout

bit

Is the font strikeout? (1 = yes)

(D: 0)

win_color

int

A COLORREF value indicating the color to use in Windows to


represent this font:
0 = black
0x00FF0000 = red
0x0000FF00 = green
0x000000FF = blue

(D: 0)

win_direction

smallint

Direction in which to print the font:


0 = left to right
90 = vertical, bottom to top

win_outline

bit

Is the font outlined? (1 = yes)

(D: 0)

BILL_FONT_REF

win_underline

66

Field Name

BILL_FONT_VALUES

BILL_FONT_VALUES
Configurable. For internal use only. Describes fonts defined in BILL_FONT_REF. Admin table.
Used by the following modules: IGEN
Indexes: unique on font_id, test_flag, language_code
Foreign Keys:(font_id, test_flag) must exist in BILL_FONT_REF(font_id, test_flag)
(language_code) must exist in LANGUAGE_CODE_REF(language_code)

Data Type

Comments

ABP-9.1-DR1-1999/09/30

font_id

smallint

Font ID, from BILL_FONT_REF.

test_flag

tinyint

Reserved for future use.

language_code

smallint

Language code.

short_display

char

display_value

varchar

80 Description text for display.

Values

Null

(D: 0) (R: 0, 1)

Abbreviated version of the display value.

Null

67

Field Name

B
68

BILL_FONT_WIDTH
Configurable. For internal use only. Describes the width of individual characters of fonts defined in BILL_FONT_REF.
Admin table.
Used by the following modules: IGEN
Indexes: unique on font_id, test_flag, char_code
Foreign Keys:(font_id, test_flag) must exist in BILL_FONT_REF(font_id, test_flag)

Field Name
ABP-9.1-DR1-1999/09/30

font_id

Data Type
smallint

Comments

Values

Null

Font ID, from BILL_FONT_REF.

test_flag

tinyint

Reserved for future use.

char_code

smallint

ASCII character code.

width

smallint

Width of character.

(D: 0) (R: 0, 1)

BILL_FONT_WIDTH

Configurable. Defines valid bill format code type IDs. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIF

Field Name

Only one row can have is_default = 1.


primary-key on code_type

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

code_type

tinyint

Unique code type ID. Some standard values include:


1 = product line (PRODUCT_LINES.product_line_id).
2 = usage type (USAGE_TYPES.type_id_usg).
7 = jurisdiction (JURISDICTIONS.jurisdiction).
Additional values may be available; see client-specific bill format
documentation for more information.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

69

Triggers:
Indexes:

BILL_FORMAT_CODE_TYPE_REF

BILL_FORMAT_CODE_TYPE_REF

B
70

BILL_FORMAT_CODE_TYPE_VALUES
Configurable. Describes format code type IDs. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


code_type exists in BILL_FORMAT_CODE_TYPE_REF.
clustered, unique on code_type, language_code

Data Type

Comments

tinyint

Code type ID, from BILL_FORMAT_CODE_TYPE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Short text description of the code type.

Null

(D: 1)
Null

BILL_FORMAT_CODE_TYPE_VALUES

ABP-9.1-DR1-1999/09/30

code_type

Values

Configurable. Contains invoice display information for specific charge types. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: BIF
Indexes: clustered, unique on format_code, type_code, subtype_code, billing_category, billing_level

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

format_code

int

Format ID, from BILL_FMT_OPT_REF.

type_code

smallint

Charge type identifier. If positive, matches BILL_INVOICE_


DETAIL.type_code. Otherwise can be -4 (discount summary) or
-5 (taxation summary) to match BILL_INVOICE_
DETAIL.subtype_code.

subtype_code

smallint

If type_code is positive, this field matches BILL_INVOICE_


DETAIL.subtype_code. Otherwise, this field matches the
BILL_INVOICE_DETAIL.tracking_id.

billing_category

smallint

Does this record apply to current, past, or all charges?


1 = current charges 2 = past charges
3 = credit notes
4 = no charges
100 = all charges.

billing_level

smallint

Does this record apply to account-level or subscription-level


charges?
0 = account charges 1 = subscription charges 100 = all
charges

display_type

tinyint

1 = Display charge normally.


(R: 1, 2)
2 = Display charge as a fixed string (default is Free) if amount is
zero.

Null

71

Field Name

BILL_FORMAT_DISPLAY_TYPES

BILL_FORMAT_DISPLAY_TYPES

B
72

BILL_FORMAT_PRODUCTS
Configurable. Contains bill formatting information for each product line. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: BIF

format_code exists in BILL_FMT_OPT_REF.


product_line_id exists in PRODUCT_LINES.
msg_trigger_id exists in BILL_MESSAGES, if not NULL.
clustered, unique on product_line_id, format_code
unique on sort_priority, format_code

Triggers:

Indexes:

ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

int

Format option, from BILL_FMT_OPT_REF.

product_line_id

smallint

Product line ID, from PRODUCT_LINES.

msg_trigger_id

smallint

Bill message ID for message displayed on bill (from BILL_


MESSAGES).

printer_text

varchar

sort_priority

smallint

alt_printer_text

varchar

40 Resource name for logo or icon printed on bill.

(R: < 10)

Null

Null
Null

Sort order of product line on bill.


40 Resource name for alternate logo or icon printed on bill.

Null

BILL_FORMAT_PRODUCTS

format_code

Values

Configurable. Specifies a formatting template for each charge type area on a bill. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: BIF

code_type is unique for every combination of format_code and section_type.


format_code, section_type, code_type, template_code, equip_type_code, equip_class_code, class_of_
service_code and provider_id exist in the appropriate tables (see below), if not NULL.
If code_type = 1, code_value exists as PRODUCT_LINES.product_line_id; if code_type = 2, code_value
exists as USAGE_TYPES.type_id_usg; if code_type = 7, jurisdiction exists in JURISDICTIONS.
jurisdiction, and element_id exist in the appropriate tables (see below) or are NULL.
unique on sort_priority, section_type, code_value, format_code
clustered, unique on section_type, code_value, equip_type_code, format_code

Triggers:

Indexes:

BILL_FORMAT_TEMPLATE

BILL_FORMAT_TEMPLATE

ABP-9.1-DR1-1999/09/30

Foreign Keys:(template_code) must exist in BILL_FMT_TEMPLATE_CODE_REF(template_code)


(section_type) must exist in BILL_FMT_SECTION_TYPE_REF(section_type)
(element_id) must exist in PRODUCT_ELEMENTS(element_id)
(provider_id) must exist in SERVICE_PROVIDERS_REF(provider_id)
(jurisdiction) must exist in JURISDICTIONS(jurisdiction)
(code_type) must exist in BILL_FORMAT_CODE_TYPE_REF(code_type)
(equip_type_code) must exist in EQUIP_TYPE_CODE_REF(equip_type_code)
(equip_class_code) must exist in EQUIP_CLASS_CODE_REF(equip_class_code)
(class_of_service_code) must exist in CLASS_OF_SERVICE_CODE_REF(class_of_service_code)

Data Type

Comments

format_code

int

Format option, from BILL_FMT_OPT_REF.

section_type

tinyint

Invoice section, from BILL_FMT_SECTION_TYPE_REF.

code_type

tinyint

Charge domain included in section, from BILL_FORMAT_CODE_


TYPE_REF.

Values

Null

73

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

code_value

smallint

Specific charge type (product, usage type, and so on), based on


code_type.

equip_type_
code

smallint

Service instance type, from EQUIP_TYPE_CODE_REF.

template_code

smallint

Invoice template code, from BILL_FMT_TEMPLATE_CODE_REF.

sort_priority

smallint

Sort order of product lines and usage information on bill.

equip_class_
code

smallint

Service instance class, from EQUIP_CLASS_CODE_REF.

Null

class_of_
service_code

smallint

Equipment service class identifier, from CLASS_OF_SERVICE_


CODE_REF.

Null

provider_id

smallint

Service provider identifier, from SERVICE_PROVIDERS_REF.

Null

jurisdiction

smallint

Territorial division, from JURISDICTIONS.

Null

element_id

smallint

Product identifier from PRODUCT_ELEMENTS.

Null

table_order

smallint

Order in which sections appear if they have the same template_


code.

format_display

varchar

74

Field Name

Null

80 Text description for bill format display.

BILL_FORMAT_TEMPLATE

Configurable. Defines the characteristics of a specific bill insert. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIF
Indexes: clustered, unique on insert_id, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

insert_id

smallint

Unique internal ID of a specific bill insert. The insert code will be


translated into OMR marks to be printed on the bill.

insert_pages

tinyint

Indicates the number of bill pages that are equivalent to the weight
of the bill insert. BIF will use this data in order to calculate the
weight of the invoice.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

description

varchar

Values

Null

40 Description of bill insert (for example, envelope, special promotion,


and so on).

75

Field Name

BILL_INSERTS

BILL_INSERTS

B
76

BILL_INSERT_GROUPS
Configurable. Defines the bill inserts to be received by each customer group. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: BIF
Triggers:
Indexes:

Field Name

insert_grp_id, insert_id, and mkt_code exist in the appropriate tables (see below).
insert_foreign_key exists in INSERT_FOREIGN_KEY_REF.
unique on insert_grp_id, insert_bin_num
clustered, unique on insert_grp_id, insert_id, geo_key, mkt_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

insert_grp_id

smallint

Customer group ID, from INSERT_GRP_ID_REF, to receive insert.

insert_id

smallint

Bill insert ID from BILL_INSERTS, to be printed as OMR marks on


the bill.

Values

Used for selection of event-driven bill inserts.

insert_bin_num

tinyint

Position of OMR mark on printed bill, which tells the insert machine (R: 3, 4, 5, 6, 7,
which inserts to pull.
8, 9, 11, 12, 13,
14, 15, 16, 17,
19, 20, 21, 22,
23, 24, 25)

geo_key

char

mkt_code

smallint

Internal Arbor code representing geographical region, for grouping


insert recipients, composed of 2-character state abbreviation plus
zip code. 00000 indicates all regions.
Market code identifier, from MKT_CODE_REF, of market segment to
receive insert.

BILL_INSERT_GROUPS

insert_trigger_id smallint

Null

Data Type

Comments

active_dt

smalldt

Date on which the insert becomes applicable.

inactive_dt

smalldt

Date on which the insert is no longer applicable.

insert_foreign_
key

int

Client-specific key value, from INSERT_FOREIGN_KEY_REF.

Values

Null

Null
(D: 0)

BILL_INSERT_GROUPS

Field Name

ABP-9.1-DR1-1999/09/30

77

B
78

BILL_LINE_REF
Configurable. For internal use only. Defines the available line formats. Admin table.
Used by the following modules: IGEN
Indexes: unique on tag, test_flag
primary-key on line_id, test_flag

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

line_id

smallint

Unique line format ID.

test_flag

tinyint

Reserved for future use.

tag

varchar
varchar

15 Line type specifier for PCL.

hp_pen_width

varchar

15 Pen width specifier for PCL.

screen_version

varchar

80 ASCII text drawn on ASCII representation of BILL for this line


format.

int

afp_line_name

varchar

Null

(D: 0) (R: 0, 1)

30 Tag name, as appearing in layout specification XML tags.

hp_line_type

afp_line_width

Values

Line width for AFP.


15 Line name for AFP.

BILL_LINE_REF

int

Comments
Pen style for drawing the line in Windows:
0 = solid pen
1 = dashed line (---)
2 = dotted line (...)
3 = dashdot line (_._.)
4 = dashdotdot line (_.._..)
5 = no line (Null pen)

Values
(D: 0)

ABP-9.1-DR1-1999/09/30

win_pen_width

int

Thickness of the line in pixels (at 100% magnification).

(D: 1)

win_pen_color

int

A COLORREF value indicating the color to use in Windows to


represent this line:
0 = black
0x00FF0000 = red
0x0000FF00 = green
0x000000FF = blue

(D: 0)

Null

79

win_pen_style

Data Type

BILL_LINE_REF

Field Name

B
80

BILL_LINE_VALUES
Configurable. For internal use only. Describes line formats. Admin table.
Used by the following modules: IGEN
Indexes: unique on line_id, test_flag, language_code
Foreign Keys:(language_code) must exist in LANGUAGE_CODE_REF(language_code)
(line_id, test_flag) must exist in BILL_LINE_REF(line_id, test_flag)

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

line_id

smallint

Line format ID, from BILL_LINE_REF.

test_flag

tinyint

Reserved for future use.

language_code

smallint

short_display

char

display_value

varchar

80 Description text for display.

Values

Null

(D: 0) (R: 0, 1)

Language code.
Abbreviated version of the display value.

Null

BILL_LINE_VALUES

Configurable. Defines text messages which can appear in bill images. CMF.msg_grp_id and CMF.mkt_code determine
which messages appears on the customer bill. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIF
Indexes: clustered, unique on message_id, line_num, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

message_id

smallint

Message ID, from BILL_MESSAGES_TEXT.

line_num

smallint

Line number for non-word wrapped messages.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

message_text

text

Message text.

Values

Null

81

Field Name

BILL_MESSAGES

BILL_MESSAGES

B
82

BILL_MESSAGE_GROUPS
Configurable. Maps message groups to bill messages and other customer segment information. Admin table. Read-only
copy exists on Customer server.
Triggers:
Indexes:

Field Name

msg_grp_id, mkt_code, and message_id exist in appropriate tables (see below) or are 0.
clustered, unique on msg_grp_id, message_id, geo_key, mkt_code, service_center_id, msg_foreign_key

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

msg_grp_id

smallint

Bill message group ID, from MSG_GRP_ID_REF.

message_id

smallint

Message ID, from BILL_MESSAGES.

msg_trigger_id

smallint

Triggering event for event-triggered messages. Standard values (R: 0, 1, 2, 3, 4,


include:
5, 6, 7, 8, 9)
0 = no event
4 = secondary collections message
1 = collections
5 = tax message
2 = first bill
6, 7, 8, 9 = reserved (system defined)
3 = final bill
See client-specific bill format documentation for additional values,
if any.
Position of message_id in msg_grp_id.

geo_key

char

Geocode to which message should be sent, or 00000000 for all


regions.

mkt_code

smallint

Market code, from MKT_CODE_REF, for group to receive message


(or 0).

active_dt

smalldt

Date on which the message can first appear.

(R: > 0)

BILL_MESSAGE_GROUPS

msg_sequence_ smallint
num

Null

inactive_dt

Data Type
smalldt

Comments

Values

Null

Date on which the message can no longer appear.

Null

service_center_ smallint
id

Bill message service center ID, from SERVICE_CENTERS.

Null

msg_foreign_
key

Deployment-specific key field.

Null

int

BILL_MESSAGE_GROUPS

Field Name

ABP-9.1-DR1-1999/09/30

83

B
84

BILL_PERIOD_REF
Configurable. Defines valid bill periods. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIP, CUSTINFO
Triggers:
Indexes:

Field Name

Only one row may have is_default = 1.


clustered, unique on bill_period

Data Type
3

Comments

Values

ABP-9.1-DR1-1999/09/30

bill_period

char

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

Identifier of a bill cycle.


(D: 0)

BILL_PERIOD_REF

Configurable. Describes bill periods defined in BILL_PERIOD_REF. Admin table. Read-only copy exists on Customer
server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


bill_period exists in BILL_PERIOD_REF.
clustered, unique on bill_period, language_code
Data Type

ABP-9.1-DR1-1999/09/30

bill_period

char

language_code

smallint

Comments

Values

Null

Bill period, from BILL_PERIOD_REF.


Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

85

Triggers:

BILL_PERIOD_VALUES

BILL_PERIOD_VALUES

B
86

BILL_REF_NO_MASTER
Dynamic. Used to allocate groups of unique invoice identifiers to each server. Should always have exactly 1 row. Admin
table.
Used by the following modules: BIP
Indexes: unique on bill_ref_no, bill_ref_resets

Field Name

Data Type

Comments

bill_ref_no

int

Invoice identifier.

bill_ref_resets

tinyint

Reset counter value for bill_ref_no.

Values

Null

ABP-9.1-DR1-1999/09/30

BILL_REF_NO_MASTER

Configurable. Associates sections of a bill with existing bill formats. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: BIF

bill_fmt_opt exists in BILL_FMT_OPT_REF.


section_exclude exists in BILL_FMT_SECTION_EXCL_REF.
clustered, unique on bill_fmt_opt, section_exclude

Indexes:

Field Name
ABP-9.1-DR1-1999/09/30

bill_fmt_opt

Data Type
int

section_exclude int

Comments

Values

Null

Bill format code, from BILL_FMT_OPT_REF.


Section (from BILL_FMT_SECTION_EXCL_REF) to exclude from
bills with a given bill_fmt_opt.

87

Triggers:

BILL_SECTIONS

BILL_SECTIONS

B
88

BILL_SIZE
Configurable. Specifies paper size for various bill formats. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIF, ATM

bill_fmt_opt exists in BILL_FMT_OPT_REF.


Only one row may have is_default = 1
clustered, unique on bill_fmt_opt, paper_size

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

bill_fmt_opt

int

Identifier of bill format option, from BILL_FMT_OPT_REF.

paper_size

smallint

0 = US Letter Size

is_default

bit

Is this paper size the default? (1 = yes)

1 = A4

Values

Null

(R: 0, 1)

BILL_SIZE

BILL_TEXT_GROUPS

BILL_TEXT_GROUPS
Configurable. For internal use only. Defines which text items are in which text groups. Admin table.
Used by the following modules: IGEN

text_id exists in BILL_TEXT_REF.


unique on text_id, text_group_id

Foreign Keys:(text_group_id) must exist in BILL_TEXT_GROUP_REF(text_group_id)

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

text_id

int

Text item ID.

text_group_id

int

Text group ID.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

is_hidden

bit

If 1, the text item will not be displayed in the text group.

Null

89

Triggers:
Indexes:

B
90

BILL_TEXT_GROUP_REF
Configurable. Defines the groupings of available text items for the invoice designer. Admin table.
Used by the following modules: IGEN
Indexes: primary-key on text_group_id
Foreign Keys:(parent_group_id) must exist in BILL_TEXT_GROUP_REF(text_group_id)
Check Constraints:parent_group_id != text_group_id
Field Name
text_group_id

Data Type
int

Comments

Values

Null

Unique text group ID.

ABP-9.1-DR1-1999/09/30

parent_group_id int

Text group ID of the parent of this group.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

is_hidden

bit

If 1, this text group is not displayed.

Null

BILL_TEXT_GROUP_REF

Configurable. Describes text groups defined in BILL_TEXT_GROUP_REF. Admin table.


Used by the following modules: IGEN
Indexes: unique on text_group_id, language_code
Foreign Keys:(language_code) must exist in LANGUAGE_CODE_REF(language_code)
(text_group_id) must exist in BILL_TEXT_GROUP_REF(text_group_id)

Data Type

Comments

ABP-9.1-DR1-1999/09/30

text_group_id

int

Unique text group ID, from BILL_TEXT_GROUP_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Description text for display.

Values

Abbreviated version of the display value.

Null

Null

91

Field Name

BILL_TEXT_GROUP_VALUES

BILL_TEXT_GROUP_VALUES

B
92

BILL_TEXT_REF
Configurable. Defines the available format and text strings for invoices. Admin table.
Used by the following modules: IGEN
Indexes: unique on tag, test_flag
primary-key on text_id, test_flag

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

text_id

int

tag

varchar

test_flag

tinyint

Reserved for future use.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or


modify.

is_hidden

bit

If 1, the text will not be displayed.

Values

Null

Unique text ID.


60 Tag name, as appearing in layout specification XML tags.
(D: 0) (R: 0, 1)

BILL_TEXT_REF

BILL_TEXT_VALUES

BILL_TEXT_VALUES
Configurable. Contains the format strings defined in BILL_TEXT_REF. Admin table.
Used by the following modules: IGEN
Indexes: unique on text_id, test_flag, language_code
Foreign Keys:(text_id, test_flag) must exist in BILL_TEXT_REF(text_id, test_flag)
(language_code) must exist in LANGUAGE_CODE_REF(language_code)

Data Type

Comments

ABP-9.1-DR1-1999/09/30

text_id

int

Text ID, from BILL_TEXT_REF.

test_flag

tinyint

Reserved for future use.

language_code

smallint

short_display

char

display_value

varchar

80 UTF-8 encoding of invoice text string.

Values

Null

(D: 0) (R: 0, 1)

Language code.
Abbreviated version of the display value.

Null

93

Field Name

B
94

BMF_TRANS_DESCR
Configurable. Describes valid payment and refund types for BMF and REFUND. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: BIP, CUSTINFO, JNL, CPM, LBX, EFT
Triggers:

Indexes:

description_code exists in DESCRIPTIONS


If bmf_trans_category = 12, ensure that billing_category, allow_suspense_acnt, and allow_autotransfer are 1,
and allow_manual_entry, is_displayed_onbill, and is_journalable are 0.
unique on bmf_trans_type

ABP-9.1-DR1-1999/09/30

BMF_TRANS_DESCR

Comments

Values

ABP-9.1-DR1-1999/09/30

bmf_trans_type

smallint

Type of transaction (client-defined transaction types have negative


values):
1 = payment
2 = pre-payment
3 = correction payment
4 = OCA payment
11 = payment reversal
12 = pre-payment reversal
13 = correction reversal
14 = OCA payment reversal
15 = dishonored check reversal 16 = Tax portion of pre-payment
17 = Tax portion of pre-payment reversal
21 = deposit payment
22 = deposit interest
23 = tax liability
24 = deposit payment reversal
25 = deposit interest reversal 26 = tax liability reversal
27 = refund
28 = refund reversal
29 = IDB credit/payment
51 = backout payment reversal 52 = backout payment

bmf_trans_
category

tinyint

Transaction category:
1 = payment
2 = adjustment (reversal)
3 = payment (A/R but not invoice item)
4 = deposit
5 = deposit refund
6 = bill backout
9 = system generated payments
11 = credit note
12 = rounding payment

trans_sign

smallint

Sign of the transaction: 1 = debit

Null

(R: 1, 2, 3, 4, 5,
6, 9, 11, 12)

-1 = credit

(R: -1, 1)

95

Data Type

BMF_TRANS_DESCR

Field Name

billing_category

Data Type
smallint

Comments
Category for billing:
1 = apply to current charges
2 = apply to past charges
3 = apply to credit note
4 = apply to credit note reversals

Values

Null

96

Field Name

(R: 1, 2, 3, 4)

ABP-9.1-DR1-1999/09/30

description_code smallint

Description from DESCRIPTIONS.

allow_manual_
entry

bit

Can payments of this type be entered manually? (1 = yes)

allow_
suspense_acnt

bit

Can payments of this type be applied to the suspense account


(invoice 0)? (1 = yes). Should only be true for prepayments.

is_displayed_
onbill

bit

Is the record displayed on the bill? (1 = yes)

(D: 1)

is_journalable

bit

Should the transaction be booked? (1 = yes)

(D: 1)

allow_
autotransfer

bit

Can a payment of this type be allocated to an invoice other than the (D: 1)
one specified? (1 = yes)

BMF_TRANS_DESCR

Static. Holds Address Verification Processing response codes and their descriptions. Admin table. Read-only copy exists
on Customer server.
Used by the following modules: CPM, CCIU

Indexes:

Field Name

clearing_house_id exists in CLEARING_HOUSE_ID_REF.


ccard_carrier exists in CCARD_TYPE_CODE_REF.
clustered, unique on clearing_house_id, ccard_carrier, avs_response_code
Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

clearing_house_ char
id

Clearing house ID, from CLEARING_HOUSE_ID_REF.

ccard_carrier

char

Type of credit care, from CCARD_TYPE_CODE_REF.

avs_response_
code

char

Return code from the credit card clearinghouse.

response_code_ varchar
descr

Null

40 Description of the AVS response.

97

Triggers:

CCARD_AVS_RESPONSE_CODES

CCARD_AVS_RESPONSE_CODES

C
98

CCARD_RESPONSE_CODE_REF
Static, configurable if necessary. Describes and categorizes known credit-card clearinghouse response codes. Admin
table. Read-only copy exists on Customer server.
Used by the following modules: CPM, CCIU
Only one row may have is_default = 1.
clustered, unique on clearing_house_id, response_code

Triggers:
Indexes:

Field Name

Data Type

ABP-9.1-DR1-1999/09/30

response_code

char

response_
category

tinyint

Null

Return code from the clearinghouse.


Category of the transaction failure:
0 = success
5 = data error
1 = comm
6 = forced deposit
2 = hard decline
7 = call company
3 = soft decline
8 = do not use, treated as soft decline
4 = referral

Values

(R: 0, 1, 2, 3, 4,
5, 6, 7)

Clearinghouse ID, from CLEARING_HOUSE_ID_REF.

treatment_ind

smallint

0 = do not disconnect account


1 = disconnect account
2 = suspend account

resend_delay

tinyint

If non-zero, number of days to delay resending this transaction if


errored.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

(D: 0) (R: 0, 1, 2)

Null
(D: 0)

CCARD_RESPONSE_CODE_REF

clearing_house_ char
id

Comments

Configurable. Describes clearinghouse response codes defined in CCARD_RESPONSE_CODE_REF. Admin table. Readonly copy exists on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


clearing_house_id, response_code exist in CCARD_RESPONSE_CODE_REF.
clustered, unique on clearing_house_id, response_code, language_code
Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

clearing_house_ char
id

Clearinghouse ID, from CCARD_RESPONSE_CODE_REF.

response_code

char

Credit card clearinghouse return code, from CCARD_RESPONSE_


CODE_REF.

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Null

Language code, from LANGUAGE_CODE_REF.


Abbreviated version of the display value.

Null

99

Triggers:

CCARD_RESPONSE_CODE_VALUES

CCARD_RESPONSE_CODE_VALUES

C
100

CCARD_TYPE_CODE_RANGE
Configurable. Defines ranges of valid account numbers for each credit card type. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

ccard_type_code exists in CCARD_TYPE_CODE_REF.


maximum_range_value must be greater than minimum_range_value and may not overlap.
clustered, unique on minimum_range_value
unique on ccard_type_code, minimum_range_value

Data Type

Comments

ABP-9.1-DR1-1999/09/30

ccard_type_
code

tinyint

minimum_
range_value

char

22 Lowest number in the range.

maximum_
range_value

char

22 Highest number in the range.

Values

Null

Valid initial digit of credit card, from CCARD_TYPE_CODE_REF.

CCARD_TYPE_CODE_RANGE

Static. Defines valid credit card types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CPM, CCIU
Only one row may have is_default = 1.
clustered, unique on ccard_type_code
unique on ccard_carrier

Field Name

Data Type
4

Comments

Values

ABP-9.1-DR1-1999/09/30

ccard_carrier

char

ccard_type_
code

tinyint

Credit card type ID, typically first digit of credit card number. For
example:
4 = Visa
5 = MasterCard
3 = American Express

6 = Discover
7 = Diners Club

(R: not in (99,


255))

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

check_digit_alg

tinyint

Defines which checksum algorithm is used to validate credit card (R: 0, 1, 2, 3)


numbers.
0 = no check
1 = modulus 10
2 = AMEX
3 = Diners Club

Null

Credit card carrier.

101

Triggers:
Indexes:

CCARD_TYPE_CODE_REF

CCARD_TYPE_CODE_REF

C
102

CCARD_TYPE_CODE_VALUES
Configurable. Describes credit cards defined in CCARD_TYPE_CODE_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


ccard_type_code exists in CCARD_TYPE_CODE_REF.
clustered, unique on ccard_type_code, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

ccard_type_
code

tinyint

language_code

smallint

short_display

char

display_value

varchar

80 Full name of credit card type (for example, American Express).

Values

Null

Valid initial digit of credit card, from CCARD_TYPE_CODE_REF.


Language code, from LANGUAGE_CODE_REF.
Abbreviated version of the display value.

Null

CCARD_TYPE_CODE_VALUES

CC_BALANCE

CC_BALANCE
Dynamic. Lists batch totals transmitted to and received from credit card clearinghouses. Admin table.
Used by the following modules: CPM, LBX. CCIU
Indexes: unique on file_name

Data Type

Comments

clearing_house

char

10 Name of the credit card clearinghouse.

sent_receive

char

transaction_date smalldt

Values

Identifies if the record was sent (S) or received (R).


Date of transaction.

ABP-9.1-DR1-1999/09/30

file_name

char

15 UNIX file name transmitted.

visa_total

numeric

18 VISA total sent/received.

msc_total

numeric

18 MasterCard total sent/received.

amex_total

numeric

18 American Express total sent/received.

disc_total

numeric

18 Discover total sent/received.

batch_total

numeric

18 Total of all credit card transactions sent/received.

clearing_house_ char
id

Null

Clearinghouse ID, from CLEARING_HOUSE_ID_REF.

103

Field Name

C
104

CDR_COMP_STATUS_REF
Configurable. Defines all valid completion status values that may be provided on input usage records. Admin table.
Read-only copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU
Only one row may have is_default = 1.
clustered, unique on comp_status

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

comp_status

tinyint

Internal identifier used by other tables to uniquely reference a


completion status.

(R: < 255)

comp_status_
type

tinyint

Completion status types:


0 = Should be processed normally; will be put into CDR_DATA
1 = FREE; pass-thru; will be put into CDR_FREE
2 = External error; will be put into CDR_DATA_WORK

(R: 0, 1, 2)

guide_flag

bit

Should the usage be guided and rated? (0 = no) Useful for free
comp_status_type.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

CDR_COMP_STATUS_REF

Configurable. Describes completion statuses defined in CDR_COMP_STATUS_REF. Admin table. Read-only copy exists
on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


comp_status exists in CDR_COMP_STATUS_REF.
clustered, unique on comp_status, language_code
Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

comp_status

tinyint

Completion status identifier, from CDR_COMP_STATUS_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

Null

105

Triggers:

CDR_COMP_STATUS_VALUES

CDR_COMP_STATUS_VALUES

C
106

CDR_CONSOLIDATION_KEYS
Configurable. Indicates by which fields charges will be consolidated. Admin table. Read-only copy exists on Customer
server.
Disallow rows with is_consolidation_key = 1 and is_empty = 1.
Disallow rows in which is_consolidation_key = 1 and field_name is one of the following: bill_class, country_
code_origin, country_code_target, jurisdiction, point_tax_code_origin, point_tax_code_target, point_tax_
code_type_origin, point_tax_code_type_target, provider_id, rate_class, rate_currency_code, rate_dt, rate_
period .
Disallows rows in which is_empty = 1 and field_name is one of the following: annotation, bill_class, cell_id_
origin, country_code_origin, country_code_target, country_dial_code_origin, customer_tag, external_id,
external_id_type, external_tracking_id, jurisdiction, point_origin, point_target, point_tax_code_origin, point_
tax_code_target, point_tax_code_type_origin, point_tax_code_type_target, provider_id, rate_class,rate_
period, timezone, trans_id.
This table has no indexes.

Triggers:

ABP-9.1-DR1-1999/09/30

Indexes:

Field Name

Data Type

Comments

varchar

is_
consolidation_
key

bit

Indicates whether a field is a consolidation key.

is_empty

bit

Indicates whether a field will be emptied, consolidated rows.

Null

30 One of a group of selected field names from CDR_DATA.

CDR_CONSOLIDATION_KEYS

field_name

Values

Dynamic. Holds usage detail records flagged for manual correction. May contain multiple rows per transaction, as
records are corrected or marked uncorrectable. Fields marked with an asterisk (*) are obtained directly from the input
usage record, derived, or not populated, depending on the MPS configuration and the usage record format. Other fields
are derived or not populated. Admin table.
Used by the following modules: CAP, MIU, JNL, RAP
Indexes: non-unique on subscr_no, subscr_no_resets, trans_dt
non-unique on msg_id2, msg_id, msg_id_serv

Data Type

Comments

ABP-9.1-DR1-1999/09/30

msg_id

int

Unique internal record ID.

msg_id2

tinyint

Alternate unique internal record ID.

msg_id_serv

tinyint

Server ID, to uniquely identify msg_id.

Values

Audit trail tracking ID for record.

Null

ext_tracking_id * varchar

32

Null

trans_id *

char

20

element_id *

smallint

Product identifier, defined in PRODUCT_ELEMENTS.

type_id_usg *

smallint

Usage type identifier, defined in USAGE_TYPES.

rate_class *

smallint

Rate class, defined in RATE_CLASS_DESCR.

bill_class *

smallint

Bill class ID, defined in BILL_CLASS_REF.

Null

provider_id *

smallint

Service provider, defined in SERVICE_PROVIDERS_REF.

Null

jurisdiction *

smallint

Territorial range of usage, defined in JURISDICTIONS.

Null

rate_currency_
code *

smallint

Currency code for usage charge, defined in RATE_CURRENCY_


REF.

account_no *

int

Arbor/BP account number, from CMF.

Optional network transaction ID.

107

Field Name

CDR_DATA_WORK

CDR_DATA_WORK

Data Type

Comments

account_
category

tinyint

Account category identifier, from ACCOUNT_CATEGORY_REF.

subscr_no

int

Service instance mapped to external_id in EXTERNAL_ID_


EQUIP_MAP.

subscr_no_
resets

smallint

Reset counter value for subscr_no.

external_id *

varchar

48

external_id_type smallint
*

Null
Null

ABP-9.1-DR1-1999/09/30

External ID of subscription.

Null

Type of external_id, defined in EXTERNAL_ID_TYPE_REF.

Null

Origin point or prefix, defined in USAGE_POINTS. Often identical to,


or determined from, subscr_no.

Null

char

mkt_code

smallint

Market code, from MKT_CODE_REF.

Null

country_code_
origin

smallint

Identifier of origin point country, from COUNTRY_CODE_REF.

Null

country_dial_
code_origin *

char

International dialing code for country_code_origin, defined in


COUNTRY_DIAL_CODES.

Null

point_id_origin

int

Point ID, from USAGE_POINTS, for point_origin.

Null

Taxing authorities for point_origin, defined in TAX_ELEM_


DEFAULT_LOC, or Null (non-taxable).

Null

Identifies type of point_tax_code_origin.


3 = Vertex geocode 4 = Custom tax package geocode

Null

Target point or prefix, defined in USAGE_POINTS.

Null

Identifier of target point country, from COUNTRY_CODE_REF.

Null

15

point_tax_code_ tinyint
type_origin *
point_target *

char

country_code_
target

smallint

24

CDR_DATA_WORK

point_origin *

point_tax_code_ varchar
origin *

24

Values

108

Field Name

country_dial_
code_target

char

point_id_target

int

point_tax_code_ varchar
target *

15

point_tax_code_ tinyint
type_target *

Comments

Values

Null

International dialing code for country_code_target, defined in


COUNTRY_DIAL_CODES.

Null

Point ID for point_target, from USAGE_POINTS.

Null

Taxing authorities for point_target, defined in TAX_ELEM_


DEFAULT_LOC, or Null (non-taxable).

Null

Identifies type of point_tax_code_target:


3 = Vertex geocode 4 = Custom tax package geocode

Null

ABP-9.1-DR1-1999/09/30

base_amt *

numeric

18

Usage charge without time of day discounts applied.

rate_dt *

char

20

Date and time the record was rated.

trans_dt *

char

20

Date and time the usage event (transaction) took place.

second_dt *

char

20

Optional date and time for reports. Not used for billing.

Null

timezone *

tinyint

Timezone identifier, defined in TIMEZONE_REF.

primary_units *

int

Number of raw units to be rated.

second_units *

int

Optional number of units for reports. Not used for billing.

Null

third_units *

int

Optional number of units for reports. Not used for billing.

Null

units_currency_ smallint
code *

Currency code, defined in RATE_CURRENCY_REF, for pre-rated


usage.

Null

billing_units_
type

smallint

Billing units type, from USAGE_TYPES_UNITS for type_id_usg.

Null

ccard_id

int

Credit card ID from CCARD_LIST, for pre-rated usage.

Null

ccard_id_serv

tinyint

Server ID, to uniquely identify ccard_id.

Null

miu_ccard_
account

varchar

Credit card account number, from CCARD_LIST.

Null

22

109

Data Type

CDR_DATA_WORK

Field Name

Data Type

miu_ccard_
carrier_code

tinyint

miu_ccard_
ownr_name

varchar

miu_ccard_
expire

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

CCARD_TYPE_CODE_REF.ccard_type_code for credit card.

Null

40

Name of the credit card owner.

Null

varchar

Date the credit card expires.

Null

federal_tax *

numeric

18

Federal tax amount, for pre-rated usage only.

Null

state_tax *

numeric

18

State tax amount, for pre-rated usage only.

Null

county_tax *

numeric

18

County tax amount for pre-rated usage only.

Null

city_tax *

numeric

18

City tax amount, for pre-rated usage only.

Null

other_tax *

numeric

18

Other tax amount, for pre-rated usage only.

Null

annotation *

varchar

255 Free form comments. Not used for billing.

Null

customer_tag *

varchar

80

Null

rated_units

int

amount *

numeric

18

Amount of the transaction, must be positive.

foreign_amount

numeric

18

Prerated GSM roaming usage amount based on rating currency


and SDR amount in usage record.

rate_period *

char

Rate period identifier, defined in RATE_PERIOD_REF, for the


period the usage event occurred in, or + (multiple periods).

no_bill *

bit

Is this record billable? (1 = no).

comp_status *

tinyint

Completion status, defined in CDR_COMP_STATUS_REF.

Optional customer supplied data. Not used for billing.

110

Field Name

Number of rated units.

CDR_DATA_WORK

Comments

Values

cdr_status *

tinyint

Indicates the current processing status for this record:


0 = unguided, unrated
4 = do not rate
1 = guided, unrated
5 = aggregate rated by BIP
2 = pre-rated, unguided
8 = processed
3 = guided and rated
12, 13, 15 like 2, 3, and 5, but included in reseller feed file.

bill_ref_no *

int

Identifier of invoice the record appears on, from BILL_INVOICE.

bill_ref_resets

tinyint

Reset counter value for bill_ref_no.

file_id

int

File ID of usage file, from FILE_STATUS.

file_id_serv

tinyint

Server ID, to uniquely identify file_id.

(R: 0, 1, 2, 3, 4,
5, 8, 12, 13, 15)

Null

ABP-9.1-DR1-1999/09/30

rev_rcv_cost_ctr smallint

Revenue receiving cost center ID, from REV_RCV_COST_CENTER_


REF.

arch_flag

Has this record been archived? (1 = yes)

bit

Null

(D: 0)

miu_error_code1 smallint

Error causing guiding/rating failure, from SYSTEM_MESSAGES.

miu_error_code2 smallint

Error causing guiding/rating failure, from SYSTEM_MESSAGES.

miu_error_code3 smallint

Error causing guiding/rating failure, from SYSTEM_MESSAGES.

mps_miu_dt

Date and time MIU processed the usage.

Null

datetime

miu_investigator char

16

Arbor/BP login of the user who last modified the record.

Null

miu_queue

16

Arbor/BP login of the user assigned to investigate record.

Null

char

miu_disp_status tinyint

0 = Complete; the record is no longer available for review.


1 = Incomplete; visible in MIU. No more than one incomplete
record exists for a given msg_id, msg_id2, msg_id_serv
combination.

(R: NULL, 0, 1,
2, 3)

Null

111

Data Type

CDR_DATA_WORK

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

miu_disp_code

tinyint

miu_locked_by

char

30

miu_notes

varchar

255 Free form text or comment.

unrounded_
amount *

numeric

18

Values

Null

0 = new record
(R: NULL, 0, 1,
1 = attempted to correct but failed processing
2, 3, 4, 5)
2 = released for processing, after successful correction (miu_disp_
status = 0)
3 = written off (deleted) (miu_disp_status = 0)
4 = put in hold queue
5 = put in work queue

Null

Username or process ID locking this record for processing.

Null

Rated amount or charge for usage event, before rounding.

Null
(D: 0)

corridor_plan_id int

Corridor plan ID, from CORRIDOR_PLAN_ID_REF.

Null

cell_id_origin *

Originating cell ID, defined in CELL_ID_REF.

Null

Alphanumeric name for the originating cell_id for the mobile


telephone call.

Null

smallint

cell_name_origin varchar

15

112

Field Name

tinyint

Distinguishes this row from other rows split from the same usage
event. 0 indicates no split usage.

(D: 0)

orig_type_id_
usg

smallint

Original usage type, for split usage only.

access_region_
origin

varchar

Origin access region, from CDR_DATA.

Null

access_region_
target

varchar

Target access region, from CDR_DATA.

Null

amount_
reduction

numeric

18

Amount reduced off call due to corridor plan.

CDR_DATA_WORK

split_row_num

Data Type

Comments

Values

Null

amount_
reduction_id

smallint

Corridor discount plan ID of plan that reduces call amount, from


CDR_DATA. Defined in CORRIDOR_PLAN_ID_REF.

(D: 0)

open_item_id

int

Open item ID, from OPEN_ITEM_ID_REF.

raw_rec_id

smallint

Identifier of raw usage record in CDR_RAW_USAGE.

Null

raw_rec_size

smallint

Size of raw usage record in CDR_RAW_USAGE.

Null

CDR_DATA_WORK

Field Name

ABP-9.1-DR1-1999/09/30

113

C
114

CDR_OUTCOLLECTS
Dynamic. Holds usage detail records for local roaming usage. Fields marked with an asterisk (*) are obtained directly
from the input usage record, derived, or not populated, depending on the MPS configuration and the usage record
format. Other fields are derived or not populated. Admin table.
Used by the following modules: CAP, TIP, TOP, MIU
Indexes: non-unique on operator_id, cdr_status
unique on msg_id2, msg_id, msg_id_serv, split_row_num

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

msg_id

int

Unique internal record ID.

msg_id2

tinyint

Alternate unique internal record ID.

msg_id_serv

tinyint

Server ID, to uniquely identify msg_id.

split_row_num

tinyint

Distinguishes this row from other rows split from the same usage
event. 0 indicates no split usage.
32

Audit trail tracking ID for record.

trans_id *

char

20

Optional network transaction ID.

element_id *

smallint

Product identifier, defined in PRODUCT_ELEMENTS.

type_id_usg *

smallint

Usage type ID, defined in USAGE_TYPES.

orig_type_id_
usg

smallint

Original usage type, for split usage only.

rate_class *

smallint

Rate class, defined in RATE_CLASS_DESCR.

bill_class *

smallint

Bill class ID, defined in BILL_CLASS_REF.

provider_id *

smallint

Service provider, defined in SERVICE_PROVIDERS_REF.

jurisdiction *

smallint

Territorial range of usage, defined in JURISDICTIONS.

Null

(D: 0)
Null

Null
Null

CDR_OUTCOLLECTS

ext_tracking_id * varchar

Values

Comments

Values

rate_currency_
code *

smallint

Currency code for usage charge, defined in RATE_CURRENCY_


REF.

account_no *

int

Arbor/BP account number, from CMF.

subscr_no

int

Service instance mapped to external_id in EXTERNAL_ID_


EQUIP_MAP.

subscr_no_
resets

smallint

Reset counter value for subscr_no.

external_id *

varchar

48

ABP-9.1-DR1-1999/09/30

external_id_type smallint
*
point_origin *

char

country_code_
origin

smallint

country_dial_
code_origin *

char

point_id_origin

int

point_tax_code_ varchar
origin *

24

15

point_tax_code_ tinyint
type_origin *
24

Null

External ID of subscription.

Null

Type of external_id, defined in EXTERNAL_ID_TYPE_REF.

Null

Origin point or prefix, defined in USAGE_POINTS. Often identical to,


or determined from, subscr_no.

Null

Identifier of origin point country, from COUNTRY_CODE_REF.

Null

International dialing code for country_code_origin, defined in


COUNTRY_DIAL_CODES.

Null

Point ID, from USAGE_POINTS, for point_origin.

Null

Taxing authorities for point_origin, defined in TAX_ELEM_


DEFAULT_LOC, or Null (non-taxable).

Null

Identifies type of point_tax_code_origin:


3 = Vertex geocode 4 = Custom tax package geocode

Null

Target point or prefix, defined in USAGE_POINTS.

Null

char

country_code_
target

smallint

Identifier of target point country, from COUNTRY_CODE_REF.

Null

point_id_target

int

Point ID, from USAGE_POINTS, for point_target.

Null

115

point_target *

Data Type

CDR_OUTCOLLECTS

Field Name

Data Type

point_tax_code_ varchar
target *

15

point_tax_code_ tinyint
type_target *
18

Comments

Values

Null

Taxing authorities for point_target, defined in TAX_ELEM_


DEFAULT_LOC, or Null (non-taxable).

Null

Identifies type of point_tax_code_target:


3 = Vertex geocode 4 = Custom tax package geocode

Null

ABP-9.1-DR1-1999/09/30

base_amt *

numeric

rate_dt *

smalldt

Date and time the record was rated.

trans_dt *

datetime

Date and time the usage event (transaction) took place.

second_dt *

datetime

Optional date and time for reports. Not used for billing.

timezone *

tinyint

Timezone identifier, defined in TIMEZONE_REF.

primary_units *

int

Number of raw units to be rated.

second_units *

int

Optional number of units for reports. Not used for billing.

Null

third_units *

int

116

Field Name

Usage charge without time of day discounts applied.

Null

Null

Currency code defined in RATE_CURRENCY_REF, for pre-rated


usage.

Null

billing_units_
type

smallint

Billing units type, from USAGE_TYPES_UNITS for type_id_usg.

Null

ccard_id

int

Credit card ID from CCARD_LIST, for pre-rated usage.

Null

ccard_id_serv

tinyint

Server ID, to uniquely identify ccard_id.

Null

federal_tax *

numeric

18

Federal tax amount, for pre-rated usage only.

Null

state_tax *

numeric

18

State tax amount, for pre-rated usage only.

Null

county_tax *

numeric

18

County tax amount for pre-rated usage only.

Null

city_tax *

numeric

18

City tax amount, for pre-rated usage only.

Null

other_tax *

numeric

18

Other tax amount, for pre-rated usage only.

Null

CDR_OUTCOLLECTS

Optional number of units for reports. Not used for billing.

units_currency_ smallint
code *

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

annotation *

varchar

255 Must begin with 20 or 30.

Null

customer_tag *

varchar

80

Null

rated_units

int

amount *

numeric

18

Amount of the transaction, must be positive.

rate_period *

char

Rate period identifier, defined in RATE_PERIOD_REF, for the


period the usage event occurred in, or + (multiple periods).

no_bill *

bit

Is this record billable? (1 = no).

comp_status *

tinyint

Completion status, defined in CDR_COMP_STATUS_REF.

cdr_status *

tinyint

Indicates the current processing status for this record:


0 = unguided, unrated
4 = do not rate
1 = guided, unrated
5 = aggregate rated by BIP
2 = pre-rated, unguided
8 = processed
3 = guided and rated
12, 13, 15 like 2, 3, and 5, but included in reseller feed file.

bill_ref_no *

int

Identifier of invoice this record appears on, from BILL_INVOICE.

Optional customer supplied data. Not used for billing.


Number of rated units.

bill_ref_resets

tinyint

Reset counter value for bill_ref_no.

file_id

int

File ID of usage file, from FILE_STATUS.

file_id_serv

tinyint

Server ID, to uniquely identify file_id.

(R: 0, 1, 2, 3, 4,
5, 8, 12, 13, 15)

rev_rcv_cost_ctr smallint

Revenue receiving cost center ID, from REV_RCV_COST_CENTER_


REF.

arch_flag

bit

Has this record been archived? (1 = yes)

(D: 0)

unrounded_
amount *

numeric

Rated amount or charge for usage event, before rounding.

(D: 0)

Corridor plan ID, from CORRIDOR_PLAN_ID_REF.

Null

117

corridor_plan_id int

18

Data Type

CDR_OUTCOLLECTS

Field Name

Data Type

Comments

Values

Null

cell_id_origin *

smallint

Originating cell ID, defined in CELL_ID_REF.

Null

raw_rec_id

smallint

ID of raw usage record in CDR_RAW_USAGE.

Null

raw_rec_size

smallint

Size of raw usage record in CDR_RAW_USAGE.

Null

operator_id

int

home_sid_bid

varchar

Home market (CIBER SID or BID) for the roaming subscriber.

Null

serving_sid_bid

varchar

Serving market (CIBER SID or BID) for the roaming subscriber.

Null

seq_num

int

Unique file transfer ID.

Null

118

Field Name

Roaming operator ID, from ROAMING_OPERATOR_REF.

ABP-9.1-DR1-1999/09/30

CDR_OUTCOLLECTS

Dynamic. Stores raw usage record data used for update and retrieval when an error condition results (written to CDR_
DATA_WORK) or for records originating from foreign service providers (CDR_OUTCOLLECTS). Admin table.
Used by the following modules: CAP, TOP, MIU
Indexes: non-unique on msg_id2, msg_id, msg_id_serv

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

msg_id

int

Unique internal ID of a message.

msg_id2

tinyint

Second unique internal ID of a message.

msg_id_serv

tinyint

Server ID, to uniquely identify msg_id.

row_count

tinyint

Row index for this raw usage record (if spanning multiple rows).

raw_rec

varbinary 255 Raw usage data for this message.

Null

119

Field Name

CDR_RAW_USAGE

CDR_RAW_USAGE

C
120

CDR_RUNNING_TOTAL_MASK
Configurable. Describes the mask identifiers. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CAP
Indexes: This table has no indexes.

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

subscr_no_mask bit

Service instance identifier masking flag.

element_id_
mask

bit

Product masking flag.

type_id_usg_
mask

bit

Usage type masking flag.

rate_period_
mask

bit

rate_period masking flag.

jurisdiction_
mask

bit

Jurisdiction masking flag.

Values

Null

CDR_RUNNING_TOTAL_MASK

CELL_ID_REF

CELL_ID_REF
Configurable. Defines valid cell IDs. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CAP, RAP, CUSTINFO
Only one row may have is_default = 1.
unique on cell_id

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

cell_id

smallint

Unique cell ID.

cell_name

varchar

15 Description of the cell_id.

Null

ciber_sid_bid

varchar

Null

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Market (CIBER SID or BID) where the cell is located.


(D: 0)

121

Triggers:
Indexes:

C
122

CELL_ID_VALUES
Configurable. Describes cell IDs defined in CELL_ID_REF. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

cell_id exists in CELL_ID_REF.


language_code exists in LANGUAGE_CODE_REF.
unique on cell_id, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

cell_id

smallint

Cell ID, from CELL_ID_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

CELL_ID_VALUES

Configurable. Specifies which cells participate in which zones as which zone class. Admin table. Read-only copy exists
on Customer server.
Used by the following modules: CAP, RAP, CUSTINFO

Indexes:

ABP-9.1-DR1-1999/09/30

Field Name

cell_id exists in CELL_ID_REF.


zone_id exists in ZONE_REF.
zone_class exists in ZONE_CLASS_REF.
Each zone_id belongs to one and only one zone_class.
unique on cell_id, zone_id

Data Type

Comments

cell_id

smallint

Cell ID, from CELL_ID_REF.

zone_id

smallint

Zone ID, from ZONE_REF.

zone_class

tinyint

Zone class identifier, from ZONE_CLASS_REF.

Values

Null

(R: > 1)

123

Triggers:

CELL_ID_ZONE_ID_MAP

CELL_ID_ZONE_ID_MAP

C
124

CIBER_ARBOR_FLD_XREF
Configurable. Maps CIBER table values required for validation to corresponding Arbor/BP table values. Admin table.
Indexes: non-unique on ciber_tbl_no

Field Name
ciber_tbl_no

Data Type
tinyint

ciber_tbl_name

varchar

ciber_int_value

int

ABP-9.1-DR1-1999/09/30

varchar

ciber_description varchar
arbor_int_value

Values

Null

CIBER table number.


64

ciber_int_value2 int
ciber_char_
value

Comments

CIBER table name.


Value column for the table.

Null

Second value column for the table.

Null

255 Value column for the table.

Null

255 Description of the field.

Null

int

arbor_int_value2 int

First value in the Arbor/BP table, used for integers.

Null

Second value within the Arbor table, used for integers.

Null

varchar

255 Character value for character columns in the Arbor/BP table.

Null

arbor_tbl_name

varchar

30

Null

arbor_field_
description

varchar

255 Description of the field in Arbor/BP.

mapping_
direction

tinyint

Name of the corresponding Arbor/BP table.

Direction for mapping this cross-reference:


0 = type_id_usg to ciber_record_no (Arbor/BP to CIBER)
1 = ciber_record_no to Arbor/BP type_id_usg (CIBER to Arbor/BP)
Use all four fields to map from CIBER to Arbor/BP.

Null
Null

CIBER_ARBOR_FLD_XREF

arbor_char_
value

Configurable. Stores the mapping direction between an Arbor/BP field and a CIBER record field. Admin table.
Indexes: unique on serving_sid_bid, orig_cell_id, ciber_call_direction
unique on type_id_usg

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

serving_sid_bid

varchar

Identifier for the serving SID or BID, from CIBER_SID_BID_DEF.


Leave blank to match all SIDs or BIDs.

orig_cell_id

varchar

Initial cell site from the incollect CIBER record. Leave blank to
match all cell sites for the SID or BID.

ciber_call_
direction

varchar

Call direction from the incollect CIBER record. Leave blank to


match all call directions.

ciber_rec_type

varchar

CIBER record type.

type_id_usg

smallint

Usage type ID, from USAGE_TYPES.

priority

int

Priority used to determine which usage type to use when more than
one is valid.

mapping_
direction

tinyint

Direction for mapping this cross-reference:


0 = type_id_usg to ciber_record_no (Arbor/BP to CIBER)
1 = ciber_record_no to Arbor/BP type_id_usg (CIBER to Arbor/BP)
Use all four fields to map from CIBER to Arbor/BP.

Null

Null
Null

125

Field Name

CIBER_ARBOR_USAGE_TYPE_XREF

CIBER_ARBOR_USAGE_TYPE_XREF

C
126

CIBER_FLD_ERROR_CODES
Configurable. Stores CIBER error codes that identify why a CIBER field fails a CIBER edit. Admin table.
Indexes: unique on field_name, reason_code

Field Name

Data Type

Comments

field_name

varchar

error_code

int

CIBER error code.

reason_code

int

Code that identifies the reason the CIBER edit on this field failed.

Values

Null

64 CIBER field name.

ABP-9.1-DR1-1999/09/30

CIBER_FLD_ERROR_CODES

Configurable. Stores the NPA and NXX values for a point class ID. Admin table.
Indexes: non-unique on point_class

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

point_class

int

Unique internal ID for a usage point class, from POINT_CLASS_


REF.

npa

smallint

NPA value for this point class ID, defined by NANP. This value
populates the NPA portion of the Toll from Rating NPA NXX field
on the CIBER Type 20 outcollect record.

nxx

smallint

NXX value for this point class ID. This value populates the NXX
portion of the Toll from Rating NPA NXX field on the CIBER Type
20 outcollect record.

Null

127

Field Name

CIBER_FROM_NPANXX

CIBER_FROM_NPANXX

C
128

CIBER_INCOLLECTS
Dynamic. Contains wireless usage messages destined for the CIBER clearinghouse. Typically these message have been
generated by customers of another wireless carrier. Admin table.
Used by the following modules: MCAP, CAP, TIP
Indexes: unique on msg_id2, msg_id, msg_id_serv

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

msg_id

int

Unique internal ID of a message.

msg_id2

tinyint

Second unique internal ID of a message.

msg_id_serv

tinyint

Server ID, to uniquely identify msg_id.

home_carrier_
sid_bid

int

System ID (SID) or CiberNet billing ID (BID) for the wireless carrier


that this message will be routed to, from CIBER_SID_BID.

point_origin

char

point_origin_len tinyint
ext_tracking_id

varchar

trans_dt

datetime

federal_tax

numeric

Values

Null

24 Usage point or usage point prefix, from USAGE_POINTS. Usually


same as, or determined from, subscr_no.
Actual length of the number stored in point_origin.
32 Audit trail tracking ID for usage message, supplied by client.
Date and time event took place, from usage record.
18 Federal tax amount for pre-rated usage only.

numeric

18 State tax amount for pre-rated usage only.

county_tax

numeric

18 County tax amount for pre-rated usage only.

city_tax

numeric

18 City tax amount for pre-rated usage only.

other_tax

numeric

18 Other tax amount for pre-rated usage only.

CIBER_INCOLLECTS

state_tax

Data Type

Comments

Values

tinyint

1 = call originated from mobile roamer


2 = call terminated at mobile roamer
3 = mobile roamer call forward
4 = mobile roamer to mobile
6 = call originated from mobile home unit
7 = call terminated at mobile home unit
8 = mobile home call forward
9 = mobile home to mobile

comp_status

tinyint

Completion status of call:


1 = incomplete
2 = called party answered
3 = call completed but midnight passed before called party
answered

term_status

tinyint

Termination status of call:


1 = abnormal
2 = normal
3 = unknown

point_target

char

point_target_len tinyint
temp_local_dir_ char
num

24 Target usage point or prefix, from USAGE_POINTS.


Actual length of the number stored in point_target.
10 Temporary local directory number assigned to roamer by local
carrier.

rate_currency_
code

smallint

Currency code of currency in which the transaction is rated, from


RATE_CURRENCY_REF.

initial_cell_site

smallint

Initial cell site of the call.

timezone

tinyint

Timezone identifier, from TIMEZONE_REF.

daylight_savings bit

Is it currently daylight savings time in timezone? (0 = yes)


10 End-user specific accounting codes.

Null

129

msg_acct_digits char

Null

ABP-9.1-DR1-1999/09/30

call_direction

Null

CIBER_INCOLLECTS

Field Name

Data Type

Comments

Values

Null

130

Field Name

Units for amount, from USAGE_TYPES_UNITS.

rated_units

int

rate_period

char

base_amt

numeric

18 Usage charge without time of day discounts applied.

amount

numeric

18 Amount of the transaction, must be positive.

Rate period identifier, from RATE_PERIOD_REF, for the period the


usage event occurred in, or + (multiple rate periods).

18 Miscellaneous surcharge imposed on this call.

misc_
char
surcharge_desc

printed_call

char

15 The number called, or, in some cases, a text string that is shown
on the bill in place of the number called.

fraud_ind

char

ABP-9.1-DR1-1999/09/30

misc_surcharge numeric

Code that describes the purpose of the surcharge:


0 = no surcharge
1 or A = airtime
4 = other charges imposed by the carrier
5 = voice mail - retrieve
6 = feature activate/deactivate via cellular networking
7 = national/regional roam network call
U = call forward
V = 3-way call
W = call waiting
X = speed calling
Y = fax
Z = voice mail - record

CIBER_INCOLLECTS

Indicates whether the usage event might be fraudulent. Values of


01-99 are assigned based on prior agreements between carriers.
00 or " " = no fraud involved
01-33 = indicators assigned by the serving carrier
34-66 = indicators assigned by the home carrier
67-99 = inter-carrier indicators

Null

Comments

Values

ABP-9.1-DR1-1999/09/30

char

Indicates that the record was fraudulent.

special_features char

0 = none
1 = call forward
2 = 3-way call
3 = call waiting
4 = speed dialing
5 = switch-to-switch
6 = fax
7 = data
8 = record voicemail
9 = retrieve voicemail

called_place

char

10 Geographic point (usually city) to which the call was placed.


Contains the country name if this was an international call.

called_state_
prov

char

serving_place

char

10 Geographic point (usually city) where the call originated.

serving_state_
prov

char

type_id_usg

smallint

rate_class

smallint

Rating component for the service instance.

bill_class

smallint

Bill class ID, from BILL_CLASS_REF.

provider_id

smallint

Service provider identifier, from SERVICE_PROVIDERS_REF.

jurisdiction

smallint

Territorial range of usage, from JURISDICTIONS.

country_code_
origin

smallint

Identifier of usage origin point, from COUNTRY_CODE_REF.

A = operator assisted
B = other
C = activate/deactivate feature
D = international call
E = national/regional roam network call
F = no airtime charge
G = satellite voice service
H = satellite data transmission
I = satellite fax

Null

State or province to which the call was placed.

State or province where the call originated.


Usage type ID, from USAGE_TYPES.

131

fraud_sub_ind

Data Type

CIBER_INCOLLECTS

Field Name

Data Type
6

Comments

country_dial_
code_origin

char

International dialing code for origin country, from COUNTRY_DIAL_


CODES.

country_code_
target

smallint

Identifier of usage target point, from COUNTRY_CODE_REF.

primary_units

int

Units to be billed, from USAGE_TYPES_UNITS and input usage


record.

second_units

int

Additional units for adhoc reports. Not used for billing.

Values

Null
Null

ABP-9.1-DR1-1999/09/30

int

Additional units for adhoc reports. Not used for billing.

point_id_origin

int

Origin point ID, from USAGE_POINTS.

point_id_target

int

Target point ID, from USAGE_POINTS.

rate_dt

datetime

Date and time the record was rated.

file_id_in

int

File ID, from FILE_STATUS, of input usage file.

file_id_serv_in

tinyint

Server ID, to uniquely identify file_id_in.

file_id_out

int

File ID, from FILE_STATUS, of output usage file.

Null

file_id_serv_out

tinyint

Server ID, to uniquely identify file_id_out.

Null

arch_flag

bit

Has this record been archived? (1 = yes)

process_status

bit

Has this message been processed? (1 = yes)

chg_dt

datetime

Date and time that this record was last modified.

chg_who

char

Null
Null

CIBER_INCOLLECTS

third_units

30 The username or process ID (for example; cap01) of the


user/process that last modified this record.

132

Field Name

Dynamic. Contains wireless usage messages that have been flagged for manual correction. May hold multiple rows per
transaction, as records are corrected or marked uncorrectable. Admin table.
Used by the following modules: MCAP, CAP, MIU
Indexes: This table has no indexes.

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

msg_id

int

Unique internal ID of a message.

msg_id2

tinyint

Second unique internal ID of a message.

msg_id_serv

tinyint

Server ID, to uniquely identify msg_id.

home_carrier_
sid_bid

int

System ID (SID) or CiberNet billing ID (BID) for the wireless carrier


that this message will be routed to, from CIBER_SID_BID.

point_origin

char

24

Usage point or usage point prefix, from USAGE_POINTS. Usually


same as, or determined from, subscr_no.

32

Audit trail tracking ID for usage message, supplied by client.

Actual length of the number stored in point_origin.

point_origin_len tinyint
ext_tracking_id

varchar

trans_dt

datetime

Null

Date and time the usage event (transaction) took place. From the
input usage record.

federal_tax

numeric

18

Federal tax amount for pre-rated usage only.

state_tax

numeric

18

State tax amount for pre-rated usage only.

county_tax

numeric

18

County tax amount for pre-rated usage only.

city_tax

numeric

18

City tax amount for pre-rated usage only.

other_tax

numeric

18

Other tax amount for pre-rated usage only.

133

Field Name

CIBER_INCOLLECTS_ERROR

CIBER_INCOLLECTS_ERROR

Data Type

Comments

ABP-9.1-DR1-1999/09/30

call_direction

tinyint

1 = call originated from mobile roamer


2 = call terminated at mobile roamer
3 = mobile roamer call forward
4 = mobile roamer to mobile
6 = call originated from mobile home unit
7 = call terminated at mobile home unit
8 = mobile home call forward
9 = mobile home to mobile

comp_status

tinyint

Completion status of call:


1 = incomplete
2 = called party answered
3 = call completed but midnight passed before called party
answered

term_status

tinyint

Termination status of call:


1 = abnormal
2 = normal
3 = unknown

point_target

char

24

Target usage point or prefix, from USAGE_POINTS.


Temporary local directory number assigned to a roamer by the
local carrier.

smallint

Currency code of currency in which to rate the transaction, from


RATE_CURRENCY_REF.

initial_cell_site

smallint

Initial cell site of the call.

timezone

tinyint

Timezone identifier, from TIMEZONE_REF.

Null

Is it currently daylight savings time in timezone? (0 = yes)

daylight_savings bit
10

End-user specific accounting codes.

Null

CIBER_INCOLLECTS_ERROR

10

rate_currency_
code

msg_acct_digits char

Null

Actual length of the number stored in point_target.

point_target_len tinyint
temp_local_dir_ char
num

Values

134

Field Name

Comments

Values

Units for amount, from USAGE_TYPES_UNITS.

ABP-9.1-DR1-1999/09/30

rated_units

int

rate_period

char

Rate period identifier, from RATE_PERIOD_REF, for the period the


usage event occurred in, or + (multiple rate periods).

base_amt

numeric

18

Rated amount or charge of the usage event without time of day


discounts applied.

amount

numeric

18

Amount of the transaction, must be positive.

misc_surcharge numeric

18

Miscellaneous surcharge imposed on this call.

misc_
char
surcharge_desc

Code that describes the purpose of the surcharge. Values for this
field are the same as those in CIBER_INCOLLECTS.

printed_call

char

15

The number called, or, in some cases, a text string that is shown
on the bill in place of the number called.

fraud_ind

char

Indicates whether the usage event might be fraudulent. Values of


01-99 are assigned based on prior agreements between carriers.
00 or " " = no fraud involved
01-33 = indicators assigned by the serving carrier
34-66 = indicators assigned by the home carrier
67-99 = inter-carrier indicators

fraud_sub_ind

char

Indicates what action should be taken for fraudulent messages:


0 or " " = no fraud involved
1 = reporting purposes only
2 = other action

special_features char

Special features used. Values for this field are the same as those
in CIBER_INCOLLECTS.

called_place

10

Geographic point (usually city) to which the call was placed.


Contains the country name if this was an international call.

char

Null

Null

135

Data Type

CIBER_INCOLLECTS_ERROR

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

char

State or province to which the call was placed.

serving_place

char

10

Geographic point (usually city) where the call originated.

serving_state_
prov

char

State or province where the call originated.

type_id_usg

smallint

Usage type ID, from USAGE_TYPES.

rate_class

smallint

Account level rating component for the service instance, from


EMF.rate_class_default.

bill_class

smallint

Bill class, priority, or grade of service identifier, from BILL_CLASS_


REF.

provider_id

smallint

Service provider identifier, from SERVICE_PROVIDERS_REF.

jurisdiction

smallint

Territorial range of usage, from JURISDICTIONS.

country_code_
origin

smallint

Identifier of usage origin point, from COUNTRY_CODE_REF.

country_dial_
code_origin

char

country_code_
target

smallint

Identifier of usage target point, from COUNTRY_CODE_REF.

primary_units

int

Units to be billed, from USAGE_TYPES_UNITS and input usage


record.

second_units

int

Additional units for adhoc reports. Not used for billing.

third_units

int

Additional units for adhoc reports. Not used for billing.

point_id_origin

int

Origin point identifier, from USAGE_POINTS.

point_id_target

int

Target point identifier, from USAGE_POINTS.

International dialing code for origin country, from COUNTRY_DIAL_


CODES.

Null

Null

CIBER_INCOLLECTS_ERROR

called_state_
prov

Values

136

Field Name

Data Type

Comments

Values

rate_dt

datetime

Date and time the record was rated.

file_id_in

int

File ID of input usage file, from FILE_STATUS.

file_id_serv_in

tinyint

Server ID, to uniquely identify file_id_in.

Null

file_id_out

int

File ID of output usage file, from FILE_STATUS.

Null

file_id_serv_out

tinyint

Server ID, to uniquely identify file_id_out.

Null

arch_flag

bit

Has this record been archived? (1 = yes)

process_status

bit

Has this message been processed? (1 = yes)

datetime

chg_who

char

error_code1

smallint

30

Date and time that this record was last modified.

Null

The username or process ID (for example; cap01) of the


user/process that last modified this record.

Null

Error causing failure, from SYSTEM_MESSAGES.

smallint

Error causing failure, from SYSTEM_MESSAGES.

smallint

Error causing failure, from SYSTEM_MESSAGES.

disp_status

tinyint

Indicates the records disposition status:


0 = the correction is completed.
1 = correction is incomplete, ready for disposition.

disp_code

tinyint

0 = new record
1 = attempted to correct but failed processing
2 = released for processing, after successful correction
3 = written off (deleted)
4 = put on hold
5 = placed in work queue

notes

varchar

255

Free form text or comments.

Null

investigator

char

16

Arbor/BP login of the user who last modified the record.

Null

137

error_code2
error_code3

ABP-9.1-DR1-1999/09/30

chg_dt

CIBER_INCOLLECTS_ERROR

Field Name

C
138

CIBER_LINE_RANGES
Configurable. MPS uses this table to check the home vs.roam status of usage records. Primarily for cellular mobile
telephony. Admin table. Read-only copy exists on Customer server.
Indexes: unique on npa, nxx, line_range_low, active_dt
non-unique on npa, nxx, line_range_low, sid_bid

Field Name

Data Type
5

Comments

ABP-9.1-DR1-1999/09/30

sid_bid

varchar

npa

smallint

NPA number (area code) for this line range, for deployments in
North America deployments, or the analogous value in
deployments outside North America.

nxx

smallint

NXX number (office code) for this line range, for deployments in
North America deployments, or the analogous value in
deployments outside North America.

line_range_low

smallint

Lowest number in this number range.

line_range_high smallint

Values

Null

SID or BID number, from CIBER_SID_BID_DEF.

Highest number in this line range.

varchar

80 Geographical location for this number range.

Null

state

varchar

Two-character abbreviation for the state or province for this


number range.

Null

carrier_code

smallint

CIBER carrier code as listed in Chapter 12-3A of the CIBER


manual. Optional.

Null

arp

smallint

Designated authorized receipt point for this range, from CIBER


tables. Optional.

Null

active_dt

smalldt

Date that this number range was assigned to the SID or BID.

inactive_dt

smalldt

Date on which this number range is no longer assigned to the SID


or BID.

Null

CIBER_LINE_RANGES

market_name

Configurable. Maps CIBER roaming operators to SID or BID numbers. Admin table. Read-only copy exists on Customer
server.
Indexes: unique on sid_bid

Data Type

Comments

Values

Null

operator_id for the roaming operator for this SID or BID, from
ROAMING_OPERATOR_REF.

ABP-9.1-DR1-1999/09/30

operator_id

int

sid_bid

varchar

version_in

tinyint

CIBER file version number for incoming files from this roaming
operator.

Null

version_out

tinyint

CIBER file version number for outgoing files to this roaming


operator.

Null

max_days_in

smallint

Number of days after call date by which call data must be received
by this roaming operator. Two months (~60 days) is typical.

Null

max_days_out

smallint

Number of days after call date by which call data must be sent to
this roaming operator. Two months (~60 days) is typical.

Null

seq_num_in

int

Unique file transfer ID for incoming files from this roaming operator.

Null

seq_num_out

int

Unique file transfer ID for outgoing files to this roaming operator.

Null

last_file_in

smalldt

Timestamp when the last file was received.

Null

last_file_out

smalldt

Timestamp when the last file was sent out.

Null

ext_contact_id_
in

int

ext_contact_id for the roaming operator that is sending incollect


records.

Null

SID or BID number to map to this roaming operator.

139

Field Name

CIBER_OPERATOR_SID_BID

CIBER_OPERATOR_SID_BID

Data Type

Comments

ext_contact_id_
out

int

ext_contact_id for the roaming operator that receives outcollect


records.

active_dt

smalldt

Date the relationship between the roaming operator and SID or BID
becomes active.

inactive_dt

smalldt

Date the relationship between the roaming operator and SID or BID
is no longer active.

Values

Null

140

Field Name

Null

Null

ABP-9.1-DR1-1999/09/30

CIBER_OPERATOR_SID_BID

Configurable. Stores contact information and roaming agreement details for mobile carriers and roaming clearinghouses
that use the CIBER record standard. Read-only copy exists on Customer server. Admin table.
Indexes: unique on operator_id
non-unique on active_dt

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

operator_id

int

Roaming operator ID, from ROAMING_OPERATOR_REF.

rate_key_id

smallint

Roaming rate key ID, from ROAMING_RATE_KEYS.

ciber_operator_
type

tinyint

Type of CIBER operator. Valid values are:


1 = Home operator
2 = Other CIBER operator
3 = Clearinghouse

operator_
address_1

varchar

75 Operators address line 1.

Null

operator_
address_2

varchar

75 Operators address line 2.

Null

operator_
address_3

varchar

75 Operators address line 3.

Null

operator_city

varchar

35 Operators city.

Null

operator_state

varchar

28 Operators state.

Null

28 Operators county.

Null

operator_county varchar
varchar

16 Operators ZIP or Postal Code.

Null

operator_
contact_name

varchar

60 Operators contact name.

Null

141

operator_zip

Field Name

CIBER_ROAMING_AGREEMENT

CIBER_ROAMING_AGREEMENT

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

varchar

20 Operators contact phone.

Null

operator_
contact_faxno

varchar

20 Operators fax telephone number.

Null

operator_
description

varchar

80 Descriptive name for this operator.

Null

rate

numeric

18 Recurring charge rate for this operator.

Null

rc_charge_type

tinyint

Recurring charge type for this operator.

Null

country_code

smallint

Operator country code, from COUNTRY_CODE_REF.

Null

currency_code

smallint

Operator currency code, from RATE_CURRENCY_REF. Required if


ciber_operator_type is 1 (Home operator).

Null

ext_contact_id_
in

smallint

External data source ID for clearinghouse (ciber_operator_type is


3), from EXT_CONTACTS, used for incollect records.

Null

ext_contact_id_
out

smallint

External data source ID for clearinghouse (ciber_operator_type is


3), from EXT_CONTACTS, used for outcollect records.

Null

active_dt

smalldt

Date that this roaming agreement becomes active.

inactive_dt

smalldt

Date that this roaming agreement becomes inactive.

Null

CIBER_ROAMING_AGREEMENT

operator_
contact_phone

142

Field Name

Configurable. For mobile telephony, specifically cellular. Stores all SID and BID numbers for CIBER data exchange.
Admin table. Read-only copy exists on Customer server.
Indexes: unique on sid_bid

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

sid_bid

varchar

SID or BID number.

band

varchar

Band in which this SID or BID operates. Valid values are: A, B, C,


D, E, F.

carrier

varchar

80 Name of the carrier from the CIBER table 12-4.

Null

143

Field Name

CIBER_SID_BID_DEF

CIBER_SID_BID_DEF

C
144

CIBER_SID_BID_MARKET
Configurable. Stores one or more market names for each SID or BID in CIBER_SID_BID_DEF. Admin table.
Indexes: non-unique on sid_bid

Field Name

Data Type

sid_bid

varchar

market_city

varchar

35 City name for the SIDs or BIDs market.

market_state_
abbr

varchar

ABP-9.1-DR1-1999/09/30

market_country_ smallint
code

Comments

Values

Null

SID or BID number, as defined in CIBER_SID_BID_DEF.


State name for the SIDs or BIDs market.

country_code from COUNTRY_CODE_REF.

CIBER_SID_BID_MARKET

Configurable. Stores sequence numbers by SID or BID for each file exchanged with other roaming operators. Admin
table.
Indexes: unique on serving_sid_bid, receiving_sid_bid

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

serving_sid_bid

varchar

SID or BID number of the serving carrier.

receiving_sid_
bid

varchar

SID or BID number of the receiving carrier.

seq_num_in

int

Last unique transfer number for incoming files for this SID or BID.

seq_num_out

int

Last unique transfer number for sending files for this SID or BID.

last_file_in_dt

smalldt

Timestamp when the last file was received.

Null

last_file_out_dt

smalldt

Timestamp when the last file was sent.

Null

145

Field Name

CIBER_SID_BID_SEQ_NUM

CIBER_SID_BID_SEQ_NUM

C
146

CLASS_OF_SERVICE_CODE_REF
Configurable. Defines valid service instance classes of service (e.g, grades of data lines). Admin table. Read-only copy
exists on Customer server.
Used by the following modules: CUSTINFO, BIP, BIF, JNL
Only one row may have is_default = 1.
primary-key on class_of_service_code

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

smallint

Unique internal identifier of a specific class of service.

(R: != 0)

class_of_
service_value

int

Reserved for future use.

service_group

char

foreign_code

varchar

10 Reserved for future use.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Reserved for future use.

Null
(D: 0)

CLASS_OF_SERVICE_CODE_REF

ABP-9.1-DR1-1999/09/30

class_of_
service_code

Null

Configurable. Describes classes of service defined in CLASS_OF_SERVICE_CODE_REF. Admin table. Read-only copy
exists on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


class_of_service_code exists in CLASS_OF_SERVICE_CODE_REF.
unique on class_of_service_code, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

class_of_
service_code

smallint

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

Class of service identifier, from CLASS_OF_SERVICE_CODE_REF.


Language code, from LANGUAGE_CODE_REF.
Abbreviated version of the display value.

Null

147

Triggers:

CLASS_OF_SERVICE_CODE_VALUES

CLASS_OF_SERVICE_CODE_VALUES

C
148

CLEARING_HOUSE_CONTACTS
Configurable. Defines the external contacts associated with each clearinghouse. Used by CPM and EFT to determine
where outgoing files for clearinghouses should go, and to determine which incoming files are intended for them. Admin
table. Read-only copy exists on Customer server.
Used by the following modules: CPM, EFT
Triggers:
Indexes:

Field Name

ext_contact_id exists in EXT_CONTACTS.


unique on clearing_house_id, module, is_send
unique on ext_contact_id

Data Type

Comments

ABP-9.1-DR1-1999/09/30

Clearinghouse ID, from CLEARING_HOUSE_ID_REF.

module

char

Module name, from SYSTEM_MODULES (eg; CPM).

ext_contact_id

smallint

External contact ID, from EXT_CONTACTS.

is_send

tinyint

Is this a send contact point (1) or a receive contact point (0)?

ch_format_type

tinyint

Clearinghouse file format type. Values are:


1 = CheckFree (CKF)
2 = Kenan Systems (KNN)
3 = First USA (FUS)
4 = Standard French clearinghouse (FRN)
5 = First Data Merchant Services/NaBANCO (FDM)
6 = Toronto Dominion Bank (DOM)
7 = First USA 96-Byte (F96)

credit_trans_
type

smallint

BMF_TRANS_DESCR.bmf_trans_type for credit payments, or 0


if not used.

Null

CLEARING_HOUSE_CONTACTS

clearing_house_ char
id

Values

Comments

Values

ABP-9.1-DR1-1999/09/30

debit_trans_type smallint

BMF_TRANS_DESCR.bmf_trans_type for debit payments, or 0 if


not used.

allow_auto_post bit

Should automatic posting be allowed to this clearinghouse?


(1 = yes, 0 = no)

auto_post_delay tinyint

Days to wait before automatic posting, if allow_auto_post = 1.

chgb_resubmit_ tinyint
delay

Days to wait before resubmitting a chargeback.

collection_delay smallint

Depending on the value of the PAYMENT_DATE_DELAY (CPM or


EFT) system parameter:
Number of days to wait after generating charges, before contacting
this clearinghouse, or the number of days to wait after the payment
due date, before contacting this clearinghouse. If a negative value,
the number of days before the payment due date that the
clearinghouse should be contacted.

suppress_
prenotes

Suppress EFT prenotes for this clearinghouse? (1 = yes, 0 = no)

bit

Null

(D: 0)

149

Data Type

CLEARING_HOUSE_CONTACTS

Field Name

C
150

CLEARING_HOUSE_DIVISION
Configurable. Defines division number codes, to support transactions in multiple currencies, and to enable service
provider identification. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CPM
Indexes: primary-key on clearing_house_id, currency_code, rev_rcv_cost_ctr
Foreign Keys:(clearing_house_id) must exist in CLEARING_HOUSE_ID_REF(clearing_house_id)
(currency_code) must exist in RATE_CURRENCY_REF(currency_code)
(rev_rcv_cost_ctr) must exist in REV_RCV_COST_CENTER_REF(rev_rcv_cost_ctr)

Field Name

Data Type

ABP-9.1-DR1-1999/09/30

clearing_house_ char
id
currency_code

smallint

rev_rcv_cost_ctr smallint
division_number char

Comments

Values

Null

Clearinghouse ID (CKF, "FUS", and so on) from CLEARING_


HOUSE_ID_REF.
Internal currency ID, from RATE_CURRENCY_REF.
Revenue receiving cost center ID, from REV_RCV_COST_CENTER_
REF.

12 Unique division number.

CLEARING_HOUSE_DIVISION

Configurable. Describes the clearinghouses supported for credit card and EFT transactions. Admin table. Read-only copy
exists on Customer server.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
primary-key on clearing_house_id

Field Name

Data Type

ABP-9.1-DR1-1999/09/30

clearing_house_ char
id

Comments

Values

Null

Clearinghouse ID (CKF, "FUS", and so on.)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

(D: 0)

151

Triggers:
Indexes:

CLEARING_HOUSE_ID_REF

CLEARING_HOUSE_ID_REF

C
152

CLEARING_HOUSE_ID_VALUES
Configurable. Describes clearinghouses defined in CLEARING_HOUSE_ID_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


clearing_house_id exists in CLEARING_HOUSE_ID_REF.
unique on clearing_house_id, language_code
Data Type

clearing_house_ char
id

Comments

Values

Null

Clearinghouse ID, from CLEARING_HOUSE_ID_REF.

ABP-9.1-DR1-1999/09/30

language_code

smallint

short_display

char

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

CLEARING_HOUSE_ID_VALUES

Configurable. Stores clearinghouse-specific information for clearinghouse IDs defined in CLEARING_HOUSE_ID_REF.


Admin table. Read-only copy exists on Customer server.
Used by the following modules: CPM, EFT.

Field Name

clearing_house_id exists in CLEARING_HOUSE_ID_REF for the module.


unique on clearing_house_id, module

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

clearing_house_ char
id

Clearinghouse ID, from CLEARING_HOUSE_ID_REF.

module

char

Payment module using this clearinghouse.

ckf_client_id

char

10 CheckFree client ID.

Null

ckf_var_
descriptor

char

40 CheckFree variable descriptor, which appears on the customers


credit card bill.

Null

knn_merchant_
acct

char

12 Internal merchant account number.

Null

knn_merchant_
id

char

Null

Internal merchant ID.

fus_pres_id

char

Presenter ID.

Null

fus_pres_pass

char

Presenter password.

Null

fus_sub_id

char

Submitter ID.

Null

fus_sub_pass

char

Submitter password.

Null

fus_avs_type

tinyint

First USA address verification code.

Null

153

Triggers:
Indexes:

CLEARING_HOUSE_INFO

CLEARING_HOUSE_INFO

Data Type

Comments

frn_unique_
dates

bit

Send only transactions with the same ppdd_date? (0 = no, 1 = yes)

frn_fast_mode

bit

Use fast mode? (0 = no, 1 = yes)


2

Values

Null

ABP-9.1-DR1-1999/09/30

char

frn_norm_post_
delay

tinyint

frn_fast_op_id

char

frn_fast_post_
delay

tinyint

frn_national_
num

char

frn_company_
name

char

24 Company name of sender.

Null

frn_agency_
code

char

Null

frn_account_
num

char

11 Bank account to be credited.

Null

frn_bank_code

char

Null

fdm_merchant_
name

char

16 FDMS/NaBANCO mechant name.

Null

fdm_merchant_
number

char

11 FDMS/NaBANCO mechant ID.

Null

fdm_avs_type

tinyint

dom_rcon_
number

char

Normal mode operation ID (Normal Direct Debit).

Null

Normal mode posting date delay (for example, 7 days).

Null

Fast mode operation ID (Accelerated Direct Debit).

Null

Fast mode posting date delay (for example, 3 days).

Null

Sender national number.

Null

Bank agency code to be credited.

Bank code to be credited.

FDMS/NaBANCO address verification code.


15 Reserved for future use.

Null
Null

CLEARING_HOUSE_INFO

frn_norm_op_id

154

Field Name

Comments

Values

Null

dom_mailbox_id char

Reserved for future use.

Null

dom_fund_orig

char

10 Reserved for future use.

Null

dom_fund_dest

char

Null

Reserved for future use.

ABP-9.1-DR1-1999/09/30

dom_visa_orig

char

10 Reserved for future use.

Null

dom_visa_dest

char

Reserved for future use.

Null

dom_msc_orig

char

10 Reserved for future use.

Null

dom_msc_dest

char

Reserved for future use.

Null

dom_amex_
process_id

char

Reserved for future use.

Null

dom_amex_
receiver_id

char

Reserved for future use.

Null

dom_amex_
format_code

char

Reserved for future use.

Null

dom_phone_
dest

char

Reserved for future use.

Null

dom_currency_
ind

char

Reserved for future use.

Null

dom_fund_inst_ char
id

Reserved for future use.

Null

dom_fund_acct_ char
num

12 Reserved for future use.

Null

Reserved for future use.

Null

dom_batch_limit int

155

Data Type

CLEARING_HOUSE_INFO

Field Name

Data Type

Comments

Values

Null

dom_visa_
merchant

char

Reserved for future use.

Null

dom_msc_
merchant

char

Reserved for future use.

Null

dom_amex_
merchant

char

10 Reserved for future use.

Null

156

Field Name

ABP-9.1-DR1-1999/09/30

CLEARING_HOUSE_INFO

Configurable. Describes the valid reasons which may be given for changes in account status within CMF_STATUS_
HISTORY. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
unique on cmf_status_chg_reason

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

cmf_status_chg_ smallint
reason

Unique reason identifier for the status change.


97 = Disconnect requested.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

157

Triggers:
Indexes:

CMF_STATUS_CHG_REASON_REF

CMF_STATUS_CHG_REASON_REF

C
158

CMF_STATUS_CHG_REASON_VALUES
Configurable. Describes account status change reasons defined in CMF_STATUS_CHG_REASON_REF. Admin table. Readonly copy exists on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


cmf_status_chg_reason exists in CMF_STATUS_CHG_REASON_REF.
unique on cmf_status_chg_reason, language_code
Data Type

cmf_status_chg_ smallint
reason

Comments

Values

Null

Reason for account status change, from CMF_STATUS_CHG_


REASON_REF.

smallint

display_value

varchar

80 Text description to be displayed on screen.

Language code, from LANGUAGE_CODE_REF.

short_display

char

10 Abbreviated version of the display value.

(D: 1)

CMF_STATUS_CHG_REASON_VALUES

ABP-9.1-DR1-1999/09/30

language_code

Static. Describes the account statuses (suspend, active, new, and so on) that can be included in CMF_STATUS_HISTORY.
Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO

Field Name

Only one row may have is_default = 1.


unique on cmf_status

Data Type

Comments

Values

smallint

Account status:
20 = active (the default)
21 = suspended
22 = terminated
23 = disconnect requested
24 = closed
25 = pending
Individual deployments may support additional values.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

ABP-9.1-DR1-1999/09/30

cmf_status

Null

(D: 0)

159

Triggers:
Indexes:

CMF_STATUS_REF

CMF_STATUS_REF

C
160

CMF_STATUS_VALUES
Configurable. Describes account statuses defined in CMF_STATUS_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


cmf_status exists in CMF_STATUS_REF.
unique on cmf_status, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

cmf_status

smallint

Account status, from CMF_STATUS_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

80 Text description to be displayed on screen.

short_display

char

10 Abbreviated version of the display value.

Values

Null

(D: 1)

CMF_STATUS_VALUES

Configurable. Describes user-defined collection status codes used in COL_SCENARIO_DEFINITION. Admin table. Readonly copy exists on Customer server.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
clustered, unique on collection_status

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

collection_status tinyint

Unique internal identifier of a collection status.

(R: 0, 1, 2, 3, 4,
5, 6, 7, 8, 9)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

161

Triggers:
Indexes:

COLLECTION_STATUS_REF

COLLECTION_STATUS_REF

C
162

COLLECTION_STATUS_VALUES
Configurable. Describes collection statuses defined in COLLECTION_STATUS_REF. Admin table. Read-only copy exists
on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


collection_status exists in COLLECTION_STATUS_REF.
clustered, unique on collection_status, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

collection_status tinyint

Collection status identifier, from COLLECTION_STATUS_REF.

language_code

Language code, from LANGUAGE_CODE_REF.

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

COLLECTION_STATUS_VALUES

Configurable. Defines independent collections agency contacts. Admin table. Read-only copy exists on Customer server.
Used by the following modules: COL, ATM, CUSTINFO

Field Name

group_id exists in COL_COLLECTOR_GROUP.


unique on collector_id

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

collector_id

smallint

Collections agency ID.

group_id

smallint

Collections group ID, from COL_COLLECTOR_GROUP.

first_name

varchar

Null

28 First name of contact.

last_name

varchar

28 Last name of contact.

company

varchar

56 Company name of the collections agency.

Null

address1

varchar

75 First line of the companys address.

Null

address2

varchar

75 Second line of the companys address.

Null

address3

varchar

75 Third line of the companys address.

Null

city

varchar

35 City that the company is in.

Null

state

varchar

28 State that the company is in.

Null

zip

varchar

16 Company zip or postal code.

Null

phone

varchar

20 Company phone number.

active_flag

bit

Is this independent collections agency active? (1 = yes)

163

Triggers:
Indexes:

COL_COLLECTOR

COL_COLLECTOR

C
164

COL_COLLECTOR_GROUP
Configurable. Defines one or more scenario_id ranges for each independent collections agency used. Admin table. Readonly copy exists on Customer server.
Used by the following modules: COL, ATM, CUSTINFO
Triggers:
Indexes:

Field Name
ABP-9.1-DR1-1999/09/30

group_id

max_scenario_id is greater than or equal to min_scenario_id, and both exist in COL_SCENARIO_


DEFINITION.
unique on group_id, min_scenario_id
Data Type

smallint

Comments

Values

Null

Internal ID for this collections group.

min_scenario_id smallint

Lower band of scenario_id, from COL_SCENARIO_DEFINITION.

max_scenario_id smallint

Upper band of scenario_id, from COL_SCENARIO_DEFINITION.

COL_COLLECTOR_GROUP

Configurable. Defines unique collection events. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, COL
Indexes: primary-key on event

Data Type

Comments

Values
(R: 1, 7, 8, 9)

ABP-9.1-DR1-1999/09/30

event_category

smallint

Category of event:
1 = KSC collections report
7 = Not a system operation event
8 = Event can be completed by API only
9 = Network event - used with Arbor/OM.

event

varchar

20 Name of event.

event_process

varchar

40 Process to be executed.

is_system_
complete

bit

1 = event completed manually, 0 = event completed by the system.


See Configuration Guide for more details.

process_if_disc

bit

Should this event occur if the account has status DISC_REQ?


(1 = yes, 0 = no)

(D: 1)

reschedule_
delay

tinyint

Reschedule time delay for the event.

(D: 0)

Null

165

Field Name

COL_EVENT_DEFINITION

COL_EVENT_DEFINITION

C
166

COL_MESSAGES_TEXT
Static. Reserved for future use. Admin table. Read-only copy exists on Customer server.

language_code exists in LANGUAGE_CODE_REF.


unique on report_name, message_id, language_code

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

report_name

char

message_id

smallint

Reserved for future use.

language_code

smallint

Reserved for future use.

message_text

text

Reserved for future use.


In Oracle, the data type for this is varchar2(4000).

Values

Null

40 Reserved for future use.

COL_MESSAGES_TEXT

Configurable. Determines the collection network event identifier for a given collections event and service instance type.
Read-only copy of exists on Customer server. A Null value for emf_config_id means that the event applies to all service
instance types. For use with Arbor/OM version 3.0 or above. Admin table. Read-only copy exists on Customer server.
Used by the following modules: COL
Triggers:

Indexes:

event must be defined in COL_EVENT_DEFINITION.


emf_config_id must be defined in EMF_CONFIG_ID_REF.
col_order_type_id must be defined in COL_ORDER_REF.
unique on event, emf_config_id

COL_ORDER_ASSOC

COL_ORDER_ASSOC

Field Name

Data Type

event

varchar

emf_config_id

smallint

col_order_type_ smallint
id

Comments

Values

Null

20 Event name, from COL_EVENT_DEFINITION


A configuration ID, from EMF_CONFIG_ID_REF.

Null

Collection order ID of the collection event, from COL_ORDER_REF.

167

ABP-9.1-DR1-1999/09/30

Foreign Keys:(col_order_type_id) must exist in COL_ORDER_REF(col_order_type_id)


(event) must exist in COL_EVENT_DEFINITION(event)
(emf_config_id) must exist in EMF_CONFIG_ID_REF(emf_config_id)

C
168

COL_ORDER_REF
Configurable. Defines the order of collections activites and their reversals. For use with Arbor/OM version 3.0 or above.
Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, COL
Indexes: primary-key on col_order_type_id

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

col_order_type_ smallint
id

A unique ID for the collections event order.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1 this record is required by Arbor/BP modules; do not delete or


modify.

action_type

tinyint

Type of action:
1 = terminate service
3 = add product

member_id

smallint

Null

Null
2 = suspend service
4 = add NRC

If action_type = 3, element_id from PRODUCT_ELEMENTS


If action_type = 4, type_id_nrc from NRC_TRANS_DESCR
Type of reversal action:
3 = add product
4 = add NRC
10 = reverse action

reversal_
member_id

If reversal_member_id = 4, element_id from PRODUCT_


ELEMENTS.
If reversal_member_id = 5, type_id_nrc from NRC_TRANS_DESCR.

Null

Null

COL_ORDER_REF

reversal_action_ tinyint
type

smallint

Values

Configurable. Describes the orders defined in COL_ORDER_REF. For use with Arbor/OM version 3.0 or above. Admin
table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, COL
Indexes: unique on col_order_type_id, language_code
Foreign Keys:(language_code) must exist in LANGUAGE_CODE_REF(language_code)
(col_order_type_id) must exist in COL_ORDER_REF(col_order_type_id)

Data Type

Comments

ABP-9.1-DR1-1999/09/30

col_order_type_ smallint
id

col_order_type_id from COL_ORDER_REF.

language_code

smallint

language_code from LANGUAGE_CODE_REF.

short_
description

char

display_value

varchar

80 Text description of this event.

Values

Null

Short description for this event.

169

Field Name

COL_ORDER_VALUES

COL_ORDER_VALUES

C
170

COL_SCENARIO_DEFINITION
Configurable. Defines scenario IDs and lists the events associated with each collections scenario. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: CUSTINFO, COL
Triggers:
Indexes:

Field Name

event_category, event exist in COL_EVENT_DEFINITION.


collection_status exists in COLLECTION_STATUS_REF.
unique on scenario_id, event_no
Data Type

Comments

ABP-9.1-DR1-1999/09/30

scenario_id

smallint

event_no

tinyint

Event number within scenario.

event_category

smallint

Event category, from COL_EVENT_DEFINITION.

event

varchar

days_from_
prev_event

tinyint

Null

Unique ID of a collections scenario.

20 Event name, from COL_EVENT_DEFINITION.


How many days after previous event should this event be
scheduled?
Value from COLLECTION_STATUS_REF to set COL_
CUSTOMER.collection_status to after event is processed.

COL_SCENARIO_DEFINITION

collection_status tinyint

Values

Configurable. Defines the parameters used to assign a collections scenario to an account. Admin table. Read-only copy
exists on Customer server.
Used by the following modules: CUSTINFO, COL

Indexes:

scenario_id and currency_code exist in the appropriate tables (see below).


upper_balance_due > = lower_balance_due
upper_credit_rating > = lower_credit_rating
vip_code exists in VIP_CODE_REF.
unique on scenario_id, open_item_id, currency_code

ABP-9.1-DR1-1999/09/30

Foreign Keys:(open_item_id) must exist in OPEN_ITEM_ID_REF(open_item_id)


(account_category) must exist in ACCOUNT_CATEGORY_REF(account_category)

Field Name

Data Type

scenario_id

smallint

currency_code

smallint

Comments

Values

Null

Unique scenario ID from COL_SCENARIO_DEFINITION.


Currency code, from RATE_CURRENCY_REF.

(D: 1)

upper_balance_ numeric
due

18 Upper band of balance due.

Null

lower_balance_
due

numeric

18 Lower band of balance due.

upper_credit_
rating

smallint

Upper band of credit rating.

lower_credit_
rating

smallint

Lower band of credit rating.

vip_code

tinyint

Indicates whether an account is a very important account,


possibly requiring special collections treatment.

Null

171

Triggers:

COL_SCENARIO_PARAMETERS

COL_SCENARIO_PARAMETERS

Data Type

Comments

Values
(R: 1, 2, 3)

Null

pay_method

smallint

Valid Payment Types from CMF:


1 = check
2 = credit card
3 = direct debit
otherwise Null = not used.

account_
category

tinyint

Account Category ID from ACCOUNT_CATEGORY_REF. Null = not


used.

Null

open_item_id

int

Open item ID from OPEN_ITEM_ID_REF, or Null.

Null

172

Field Name

Null

ABP-9.1-DR1-1999/09/30

COL_SCENARIO_PARAMETERS

Configurable. Defines balance-due thresholds for entering and exiting collections. Admin table. Read-only copy exists on
Customer server.

Field Name

currency_code exists in RATE_CURRENCY_REF.


unique on currency_code

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

enter_thresh

numeric

18 Minimum amount due before an account or invoice enters


collections.

(R: >= 0)

exit_thresh

numeric

18 Amount due for the account or invoice to be cured (taken out of


collections).

(R: >= 0)

currency_code

smallint

Null

Currency code, from RATE_CURRENCY_REF.

173

Triggers:
Indexes:

COL_THRESH_PARAMETERS

COL_THRESH_PARAMETERS

C
174

COMPONENT_CMF_ELIGIBILITY
Configurable. Associates each account-level product package component with rating keys which determine whether it
can be provisioned to a particular account. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO

component_id exists in COMPONENT_DEFINITION_REF where component_level = 1.


mkt_code, rate_class and account_category exist in the appropriate tables (see below).
unique on component_id, mkt_code, rate_class, account_category

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

component_id

int

Component ID, from COMPONENT_DEFINITION_REF.

Values

Null

mkt_code

smallint

Value to be matched against CMF.mkt_code, or Null.

Null

rate_class

smallint

Value to be matched against CMF.rate_class, or Null.

Null

account_
category

tinyint

Value to be matched against CMF.account_category, or Null.

Null

COMPONENT_CMF_ELIGIBILITY

Configurable. Describes each product package component. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
unique on component_id

Field Name
component_id

Data Type
int

Comments

Values

Null

Unique ID for component.

ABP-9.1-DR1-1999/09/30

component_level tinyint

Identifies type of package component:


1 = Account level component
2 = Service instance level component

(R: 1, 2)

active_dt

smalldt

Date component becomes available for provisioning.

inactive_dt

smalldt

Date component becomes unavailable for provisioning.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null
(D: 0)

175

Triggers:
Indexes:

COMPONENT_DEFINITION_REF

COMPONENT_DEFINITION_REF

C
176

COMPONENT_DEFINITION_VALUES
Configurable. Describes product package components defined in COMPONENT_DEFINITION_REF. Admin table. Readonly copy exists on Customer server.

language_code exists in LANGUAGE_CODE_REF.


component_id exists in COMPONENT_DEFINITION_REF.
unique on component_id, language_code

Triggers:
Indexes:

Field Name

Data Type

Comments

int

Component ID, from COMPONENT_DEFINITION_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

Null

COMPONENT_DEFINITION_VALUES

ABP-9.1-DR1-1999/09/30

component_id

Values

Configurable. Associates each service-instance level product package component with rating keys which determine
whether the component can be provisioned to a particular service instance. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO

component_id exists in COMPONENT_DEFINITION_REF where component_level = 2.


rate_class, equip_type_code, equip_class_code, and class_of_service_code exist in the appropriate tables
(see below).
unique on component_id, equip_type_code, equip_class_code, class_of_service_code, rate_class

Indexes:

ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

Values

Null

component_id

int

Component ID, from COMPONENT_DEFINITION_REF.

equip_type_
code

smallint

Equipment type (from EQUIP_TYPE_CODE_REF) for which this


component is valid, or Null (all).

Null

equip_class_
code

smallint

Service instance class (from EQUIP_CLASS_CODE_REF) for which


this component is valid, or Null (all).

Null

class_of_
service_code

smallint

Class of service (from CLASS_OF_SERVICE_CODE_REF) for which


this component is valid, or Null (all).

Null

rate_class

smallint

Rate class (from RATE_CLASS_DESCR) for which this component


is valid, or Null (all).

Null

177

Triggers:

COMPONENT_EMF_ELIGIBILITY

COMPONENT_EMF_ELIGIBILITY

C
178

COMPONENT_NRCS
Reserved for future use. Admin table. Read-only copy exists on Customer server.

component_id and type_id_nrc exist in appropriate tables, and type_id_nrc has trigger_level 0.
unique on component_id, action_code, type_id_nrc, active_dt

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

component_id

int

Reserved for future use.

action_code

smallint

Reserved for future use.

type_id_nrc

smallint

Reserved for future use.

active_dt

smalldt

Reserved for future use.

inactive_dt

smalldt

Reserved for future use.

Values

Null

(R: 0, 1, 2)

Null

COMPONENT_NRCS

Configurable. Identifies all valid contract types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, BIF

ABP-9.1-DR1-1999/09/30

Indexes:

Field Name

Ensure element_id, commitment_reference, plan_id_discount, plan_id_credit, activation_type_id_nrc,


termination_type_id_nrc, commitment_type_id_nrc, and description_code exist in the appropriate tables
unless NULL.
Ensure inactive_date >= fixed_end_date >= fixed_start_date >= active_date for non-NULL dates.
If contract_category is 6 or 8, commitment_reference must be NULL.
If contract_category = 7, element_id and commitment_reference cannot both be NULL.
start_by can be NULL only if start_by_units = -1.
commitment_type_id_nrc must be NULL if commitment_reference is NULL.
commitment_type_id_nrc and commitment_reference must use the same currency code.
activation_type_id_nrc, termination_type_id_nrc, contract_type, contract_category, element_id, commitment_
reference, duration_units, duration, plan_id_discount, plan_id_credit, and is_promotion cannot be updated.
unique on contract_type

Data Type

Comments

Values

Null

contract_type

smallint

Unique internal identifier of a specific type of contract.

contract_
category

smallint

Indicates the category of the contract type:


6 = standard promotion
9 = HQ discount contract
7 = commitment
10 = reserved for future use
8 = free usage contract
11 = global contract (all accounts)

element_id

smallint

Used to associate a recurring charge with a contract.


Product identifier, from PRODUCT_ELEMENTS, or Null if no
recurring charge is to be associated with this contract.

Null

commitment_
reference

smallint

If contract_category = 7, contains product whose recurring charge


is used as the commitment fee. Otherwise Null.

Null

(R: 6, 7, 8, 9, 10,
11)

179

Triggers:

CONTRACT_TYPES

CONTRACT_TYPES

Data Type

Comments

Values

duration_units

smallint

Defines the units of the contract duration:


140 = days 150 = weeks 160 = months
170 = quarters
180 = years -1 = unspecified duration (no time limit)
-2 = terminate on first charge reduction (obsolete)
-3 = bill cycles in which contract was used

duration

smallint

Duration of the contract in the specified duration_units, or


-1 for contracts with infinite duration or unspecified units.

Null

(R: 140, 150,


160, 170, 180,
-1, -2, -3)

ABP-9.1-DR1-1999/09/30

plan_id_discount smallint

Discount plan ID, from PLAN_ID_DISCOUNT_REF.

Null

plan_id_credit

Unit credit plan ID, from PLAN_ID_CREDIT_REF.

Null

activation_type_ smallint
id_nrc

NRC type, from NRC_TRANS_DESCR, of activation charge.

Null

termination_
type_id_nrc

smallint

NRC type, from NRC_TRANS_DESCR, of early termination charge.

Null

is_promotion

bit

Reserved for future use.

smallint

description_code smallint
foreign_code

varchar

start_by_units

smallint

(R: = 1)

Description from DESCRIPTIONS table.


10 An external systems identifier of a contract type.
Units in which start_by is measured:
140 = days 150 = weeks 160 = months
180 = years -1=none

170 = quarters

Null
(D: -1) (R: 140,
150, 160, 170,
180, -1)

smallint

Interval after which the contract will expire if not started, measured
in start_by_units, figured from date of provisioning.

Null

active_date

smalldt

Date this contract type becomes available for provisioning.

Null

inactive_date

smalldt

Date this contract type is no longer available for provisioning.

Null

fixed_start_date smalldt

Date on which instances of this contract begin.

Null

fixed_end_date

Date on which instances of this contract terminate.

Null

CONTRACT_TYPES

start_by

smalldt

180

Field Name

Data Type

Comments

Values

Null

partial_period

bit

Reserved for future use.

(D: 0)

commitment_
type_id_nrc

smallint

Commitment amount/type, from NRC_TRANS_DESCR.

discount_
activation_code

smallint

Reserved for future use.

(D: 0) (R: 0, 1, 2) Null

discount_
termination_
code

smallint

Reserved for future use.

(D: 0) (R: 0, 1, 2) Null

discount_base_ smallint
period

Reserved for future use.

(D: 1) (R: 1, 2)

Null

CONTRACT_TYPES

Field Name

Null

ABP-9.1-DR1-1999/09/30

181

C
182

CORRIDOR_PLAN_GROUPS
Configurable. Associates corridor plans with displayable corridor characteristics. See also CMF_CORRIDORS. Admin
table. Read-only copy exists on Customer server.

corridor_plan_id and point_category must exist in the appropriate tables (see below).
point_origin and point_target must exist in USAGE_POINTS or be NULL.
unique on point_origin, origin_is_xact, country_code_origin, point_target, target_is_xact, country_code_
target, point_category, access_region_target, access_region_origin
non-unique on , corridor_plan_id

Triggers:
Indexes:

ABP-9.1-DR1-1999/09/30

Foreign Keys:(country_code_origin) must exist in COUNTRY_CODE_REF(country_code)


(country_code_target) must exist in COUNTRY_CODE_REF(country_code)
(corridor_plan_id) must exist in CORRIDOR_PLAN_ID_REF(corridor_plan_id)
(point_category) must exist in POINT_CATEGORY_REF(point_category)

Field Name

Data Type

corridor_plan_id int

Comments

Values

Null

Corridor plan ID, from CORRIDOR_PLAN_ID_REF.

char

24 Usage point or usage point prefix of origin, from USAGE_POINTS.

Null

point_category

smallint

Point category, from POINT_CATEGORY_REF.

(D: 0)

origin_is_xact

tinyint

0 indicates that point_origin is a prefix


1 indicates that point_origin is exact

(R: 0, 1)

country_code_
origin

smallint

Origin country, from COUNTRY_CODE_REF.

point_target

char

target_is_xact

tinyint

Null

24 Usage point or usage point prefix of target, from USAGE_POINTS.


0 indicates that point_target is a prefix
1 indicates that point_target is exact

Null

Null
(R: 0, 1)

Null

CORRIDOR_PLAN_GROUPS

point_origin

Data Type

country_code_
target

smallint

access_region_
origin

varchar

access_region_
target

varchar

Comments

Values

Null

Target country, from COUNTRY_CODE_REF.

Null

Origin access region, from ACCESS_REGION_REF.

Null

Target access region, from ACCESS_REGION_REF.

Null

CORRIDOR_PLAN_GROUPS

Field Name

ABP-9.1-DR1-1999/09/30

183

C
184

CORRIDOR_PLAN_ID_REF
Configurable and dynamic. Defines valid corridor rate plans. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
discount_id must be Null if plan_type is not equal to 4.
discount_id cannot be Null if plan_type = 4.
discount_id cannot be in DISCOUNT_PLANS.
primary-key on corridor_plan_id

Triggers:

Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

Unique internal ID of the corridor plan.

is_icb_corridor

bit

Is this corridor plan an Individual Case Basis plan? (1 = yes)

plan_type

tinyint

1 = normal corridor rating plan (default)


2 = special corridor discounting plan
3 = special double rating corridor plan
4 = double-rated, booked as discount

(R: 1, 2, 3, 4)

plan_level

tinyint

1 = account level
2 = service instance level

(R: 1, 2)

1 = no restriction
2 = restricted to external_ids from EXTERNAL_ID_EQUIP_MAP
3 = restricted to usage points
4 = restricted to countries
5 = restricted to access regions

(R: 1, 2, 3, 4, 5)

origin_restriction tinyint

(R: > 0)

Null

CORRIDOR_PLAN_ID_REF

corridor_plan_id int

Null

Data Type

Comments

Values

target_restriction tinyint

1 = no restriction
2 = restricted to external_ids from EXTERNAL_ID_EQUIP_MAP
3 = restricted to usage points
4 = restricted to countries
5 = restricted to access regions

discount_id

smallint

Unique internal ID of discount, from DISCOUNT_DEFINITIONS.


Only populated if plan_type = 4.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(R: 1, 2, 3, 4, 5)

Null
(D: 0)

CORRIDOR_PLAN_ID_REF

Field Name

ABP-9.1-DR1-1999/09/30

185

C
186

CORRIDOR_PLAN_ID_VALUES
Configurable. Describes corridor plans defined in CORRIDOR_PLAN_ID_REF. Admin table. Read-only copy exists on
Customer server.

language_code exists in LANGUAGE_CODE_REF.


corridor_plan_id exists in CORRIDOR_PLAN_ID_REF.
clustered, unique on corridor_plan_id, language_code

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

corridor_plan_id int

Corridor plan ID, from CORRIDOR_PLAN_ID_REF.

language_code

Language code, from LANGUAGE_CODE_REF.

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

CORRIDOR_PLAN_ID_VALUES

Configurable. Associates country code numbers with country names. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CUSTINFO, BIF, CAP, RAP, MIU
Only one row may have is_default = 1.
primary-key on country_code

Foreign Keys:(default_currency_code) must exist in RATE_CURRENCY_REF(currency_code)

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

country_code

smallint

Unique country identifier (840 = U.S.).

tax_identifier

int

Identifies special tax features for country. This value is a special


internal country ID (US=1, Mexico=2, Canada=3,
Luxembourg=254, additional identifiers may be supported by your
deployment) plus one or more of the following additional values:
If covered by Vertex Quantum, add 256.
If covered by Vertex CommTax, add 512.
If covered by Custom tax, add 1024.
If country is in the EU, add 2048.

default_
currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 840) (R: != 0)


Null

(D: 0)

187

Triggers:
Indexes:

COUNTRY_CODE_REF

COUNTRY_CODE_REF

C
188

COUNTRY_CODE_VALUES
Configurable. Describes country codes defined in COUNTRY_CODE_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


country_code exists in COUNTRY_CODE_REF.
unique on country_code, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

country_code

smallint

Country code, from COUNTRY_CODE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

(D: 840)
Null

COUNTRY_CODE_VALUES

Configurable. Defines international dialing codes for countries. Allows the message-processing system to determine if a
call is international, and allows different countries to use different mechanisms for international access. Admin table.
Read-only copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU

Field Name

country_code exists in COUNTRY_CODE_REF.


clustered, unique on country_code, country_dial_code
unique on country_dial_code

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

country_code

smallint

country_dial_
code

char

Dialing code for country (for example; 44 for U.K.).

intl_dial_code

varchar

This field indicates whether the intl_dial_access field is a prefix


used to make an international call.
If the intl_dial_code = 1 and the CDR begins with the value of intl_
dial_access, then the call is international.

Prefix that must be dialed within country to access international


service (for example; 011 for U.S.).

intl_dial_access char

Null

Country code, from COUNTRY_CODE_REF.

Null

189

Triggers:
Indexes:

COUNTRY_DIAL_CODES

COUNTRY_DIAL_CODES

C
190

COUNTRY_JURISDICTION
Configurable. Used to assign jurisdiction to a usage event based on the source and target countries. Admin table. Readonly copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU
Triggers:
Indexes:

Field Name

jurisdiction, country_code_origin, and country_code_target exist in the appropriate tables (see below).
clustered, unique on country_code_origin, country_code_target

Data Type

Comments

ABP-9.1-DR1-1999/09/30

country_code_
origin

smallint

Country code, from COUNTRY_CODE_REF, for origin country.

country_code_
target

smallint

Country code, from COUNTRY_CODE_REF, for target country.

jurisdiction

smallint

Territorial range of usage, from JURISDICTIONS.

Values

Null

COUNTRY_JURISDICTION

Configurable. Specifies which account segments (defined in ACCT_SEG_REF) are viewable by the specified CSR. Run the
replicate.pl script after modifying this table. See the System Administrator Guide for more information about
replicate.pl. Read-only copies exist on Customer and Catalog servers. Admin table.
Used by the following modules: CUSTINFO, API

acct_seg_id exists in ACCT_SEG_REF, and cannot be zero.


For a given csr_name, only one row may have is_csr_default = 1.
unique on csr_name, acct_seg_id

Indexes:

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

csr_name

varchar

acct_seg_id

int

ID of customer account segment. From ACCT_SEG_REF.

is_csr_default

bit

Use this record as the default for a given CSR? (1 = yes)

Null

30 CSR username.
(D: 0)

191

Triggers:

Field Name

CSR_ACCT_SEG

CSR_ACCT_SEG

C
192

CSR_INFORMATION
Configurable. Stores extended contact information for CSRs. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO
Triggers:
Indexes:

Field Name

user_name, supervisor_name must exist in SYBASE table, sysusers or Oracle table, ALL_USERS.
Active date ranges may not overlap for a single user_name.
unique on user_name, date_active

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

user_name

char

30 CSR username.

supervisor_
name

char

30 CSR supervisors username.

csr_lname

varchar

56 CSR last name.

csr_fname

varchar

56 CSR first name.

csr_minit

varchar

30 CSR middle initial.

Null

csr_title

varchar

40 CSR job title.

Null

csr_phone

char

20 CSR telephone number.

csr_email

varchar

60 CSR electronic mail address.

csr_address1

varchar

75 CSR postal address, line 1.

csr_address2

varchar

75 CSR postal address, line 2.

Null

csr_address3

varchar

75 CSR postal address, line 3.

Null

csr_city

varchar

35 CSR city or municipality.

csr_state

varchar

28 CSR state or province.

Null

csr_zip

varchar

16 CSR ZIP or postal code.

Null

Null

Null

CSR_INFORMATION

Data Type

csr_country_
code

smallint

csr_county

varchar

Comments

Values

Null

CSR country code.


28 CSR county.

date_active

smalldt

Date that this record becomes active.

date_inactive

smalldt

Date that this record becomes inactive.

Null
Null

CSR_INFORMATION

Field Name

ABP-9.1-DR1-1999/09/30

193

C
194

CSR_SUPERVISORS
Reserved for future use. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

Supervisor must be able to access all account segments (in CSR_ACCT_SEG) accessible by associated users.
unique on supervisor_name, user_name

Data Type

supervisor_
name

varchar

30 Supervisor name.

user_name

varchar

30 User name.

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

CSR_SUPERVISORS

Configurable. For internal use only. Defines currency formatting information for currency codes. Admin table.
Used by the following modules: IGEN
Indexes: unique on currency_code
Foreign Keys:(currency_code) must exist in RATE_CURRENCY_REF(currency_code)

Data Type

ABP-9.1-DR1-1999/09/30

currency_code

smallint

symbol

char

decimal_count

smallint

decimal_string

char

Comments

Null

Currency code, from CURRENCY_CODE_REF.


5

Currency symbol.
Number of digits to display for fractional amounts.

separator_count tinyint

Character to print for decimal symbols.


Number of digits to display between separators.

separator_string char

Character to print for separate symbols.

position

Position of the symbol relative to the numerals:


A = after
B = before

char

Values

(R: A, B)

195

Field Name

CURRENCY_LOCALE

CURRENCY_LOCALE

C
196

CURRENCY_TYPE_REF
Configurable. Describes valid types of currencies used in RATE_CURRENCY_REF (for example, hard or soft currencies).
Admin table. Read-only copy exists on Customer server.
Only one row may have is_default = 1.
unique on currency_type

Triggers:
Indexes:

Field Name

Data Type
1

Comments

Values

ABP-9.1-DR1-1999/09/30

currency_type

char

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

Type of currency. (H = Hard currency)


(D: 0)

CURRENCY_TYPE_REF

Configurable. Describes currency types defined in CURRENCY_TYPE_REF. Admin table. Read-only copy exists on
Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


currency_type exists in CURRENCY_TYPE_REF.
unique on currency_type, language_code
Data Type

ABP-9.1-DR1-1999/09/30

currency_type

char

language_code

smallint

Comments

Values

Null

Currency type, from CURRENCY_TYPE_REF.


Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display screen.

Null

197

Triggers:

CURRENCY_TYPE_VALUES

CURRENCY_TYPE_VALUES

Static. Holds messages that are included in database interactions (for example, trigger warning messages). Admin table.
Read-only copy exists on Customer server.
Used by the following modules: ATM, CUSTINFO

language_code exists in LANGUAGE_CODE_REF.


clustered, unique on msgno, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

msgno

int

Message number; must be greater than 20,000.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

msg

varchar

Values

Null

255 Text of the message to be displayed.

199

Triggers:
Indexes:

Field Name

DB_MESSAGES

DB_MESSAGES

D
200

DENIAL_REASON_REF
Configurable. Defines valid denial reasons used by supervisors. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
clustered, unique on denial_reason

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

denial_reason

smallint

Reason for the supervisor denial.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

DENIAL_REASON_REF

Configurable. Describes denial reasons defined in DENIAL_REASON_REF. Admin table. Read-only copy exists on
Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


denial_reason exists in DENIAL_REASON_REF.
clustered, unique on denial_reason, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

denial_reason

smallint

Denial reason, from DENIAL_REASON_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

201

Triggers:

DENIAL_REASON_VALUES

DENIAL_REASON_VALUES

D
202

DEPOSIT_TYPE_REF
Configurable. Defines valid deposit types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, JNL
Only one row may have is_default = 1.
clustered, unique on deposit_type

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

deposit_type

smallint

Type of the deposit: 1 = general deposit

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

DEPOSIT_TYPE_REF

Configurable. Describes deposit types defined in DEPOSIT_TYPE_REF. Admin table. Read-only copy exists on
Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


deposit_type exists in DEPOSIT_TYPE_REF.
clustered, unique on deposit_type, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

deposit_type

smallint

Deposit type, from DEPOSIT_TYPE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

203

Triggers:

DEPOSIT_TYPE_VALUES

DEPOSIT_TYPE_VALUES

D
204

DESCRIPTIONS
Configurable. Describes products, services, charge types, and so on. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CUSTINFO, BIF
Indexes: unique on description_code, language_code
Foreign Keys:(language_code) must exist in LANGUAGE_CODE_REF(language_code)

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

description_code smallint

Internal identifier of a description.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

description_
group

smallint

Used to group like descriptions (not currently supported).

description_text

varchar

80 Description text for display.

short_
description_text

char

Brief description text for the same entity.

Values

Null

Null

DESCRIPTIONS

Configurable and Dynamic. Describes each UNIX device (in other words, actual device name) used by Arbor/BP, and
controls access to those devices to avoid deadlocks. (See also IO_DEVICES.) Admin table. Read-only copy exists on
Customer server.

DEVICES

DEVICES

Used by the following modules: BID


Indexes: unique on server_id, device_id
non-unique on usage_type
non-unique on task_id

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

Server ID, to uniquely identify device_id.

server_id

tinyint

device_id

char

32 Internal device ID for printers and the UNIX device name for other
devices.

ndevice_id

char

32 Non-rewinding device name for some devices.

device_name

char

32 UNIX device name for printers, and a device description for other
devices.

device_type

smallint

usage_type

char

device_class

char

16 Not used for printers, and a device class description for other
devices.

oper_assist

bit

task_id

char

Type of device is 1 for tape, and ignored for other devices.


Usage type code is P for printers, and ignored for other devices.

Is operator assistance required? (1 = yes)


8

Task that has locked this device.

start_time

datetime

Date/time task_id took control of device.

end_time

datetime

Date/time device was last used by an Arbor/BP task.

Null

205

Field Name

D
206

DISCONNECT_REASON_REF
Configurable. Defines valid reason codes for disconnecting accounts, service instances, and products. Admin table.
Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, CPM
Only one row may have is_default = 1.
unique on disconnect_reason

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

disconnect_
reason

smallint

Unique internal identifier of a disconnect reason:


88 = account termination (used by CUSTINFO)
99 = product disconnected by CPM

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

DISCONNECT_REASON_REF

Configurable. Describes disconnect reasons defined in DISCONNECT_REASON_REF. Admin table. Read-only copy exists
on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


disconnect_reason exists in DISCONNECT_REASON_REF.
clustered, unique on disconnect_reason, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

disconnect_
reason

smallint

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

Disconnect reason identifier, from DISCONNECT_REASON_REF.


Language code, from LANGUAGE_CODE_REF.
Abbreviated version of the display value.

Null

207

Triggers:

DISCONNECT_REASON_VALUES

DISCONNECT_REASON_VALUES

D
208

DISCOUNT_DEFINITIONS
Configurable. For each discount, defines what products or services it affects and how it reduces their cost. Admin table.
Read-only copy exists on Customer server.
Used by the following modules: BIP, BIF, JNL
Triggers:

ABP-9.1-DR1-1999/09/30

Indexes:

Field Name

element_id, format_code, domain_id, product_line_id, rate_period, jurisdiction, provider_id, corridor_plan_id,


and description_code exist in the appropriate tables (see below) or are NULL.
Rows with discount_type = 5 (in other words, 4-digit usage discounts) apply only to rows where discount_
domain = 3 (usage charges).
domain_id exists in NRC_TRANS_DESCR if discount_domain = 2.
Disallow an incremental discount on units or items applies to more than one charge domain, i.e. when a row
is inserted or updated having discount_type of 2, discount_quantum of 2 or 3, and discount_domain is not 1, 2,
or 3.
Ensure discount_quantum is not equal to 3 or 4 when discount_type = 2.
If discount_quantum is not NULL and domain = 3, discount_quantum exists in USAGE_TYPES.
discount_quantum = 1 if discount_type = 8.
Row can have element_id or product_line_id, but not both.
unique on discount_id

Data Type

Comments

Values

smallint

Unique internal ID of a discount.

(R: > 0)

discount_level

smallint

Specifies the level at which the discount is valid:


1 = service instance
2 = account

(R: 1, 2)

discount_domain smallint

Indicates the category of charges the discount is applied against: (R: 1, 2, 3, 4)


1 = recurring charges
2 = non-recurring charges
3 = usage charges
4 = all categories of charges

Null

DISCOUNT_DEFINITIONS

discount_id

Null

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

smallint

Item to be aggregated and compared to discount thresholds:


(R: NULL, 1, 2,
1 = charge amounts (money) 2 = items (usage, NRC, and RC) 3, 4)
3 = primary units
4 = secondary units

Null

discount_type

smallint

Type of discount calculation that will be performed:


2 = incremental
3 = minimum-price discount (bulk/tiered)
4 = minimum-price discount (incremental/tapered)
5 = 4-digit usage rounding
6 = bulk
7 = guaranteed minimum discount (customer wins discount)
8 = incremental cross-product discount. If you enter this value,
discount quantum must be 1.

element_id

smallint

Discount restricted to charges associated with this product, from


PRODUCT_ELEMENTS. Leave Null for all products.

Null

product_line_id

smallint

Discount restricted to charges associated with this product line,


from PRODUCT_LINES. Leave Null for all product lines.

Null

format_code

tinyint

Format option, from BILL_FMT_OPT_REF.

Null

domain_id

smallint

ID of particular charge or usage type to discount, or Null (all).


If discount_domain = 1, PRODUCT_ELEMENTS.element_id or
Null (all).
If discount_domain = 2, NRC_TRANS_DESCR.type_id_nrc or
Null (all).
If discount_domain = 3, USAGE_TYPES.type_id_usg or Null
(all).
Otherwise Null (all).

Null

provider_id

smallint

Identifier, from SERVICE_PROVIDERS_REF, for the provider


whose charges should be discounted; or Null or 0 (all).

Null

date_active

smalldt

Date and time the discount becomes available for provisioning.

(R: 2, 3, 4, 5, 6,
7, 8)

209

discount_
quantum

Data Type

DISCOUNT_DEFINITIONS

Field Name

Data Type

Comments

date_inactive

smalldt

System date and time when the discount is no longer available for
provisioning.

date_created

smalldt

System date and time when the record was created.

description_code smallint

Description from DESCRIPTIONS table.

save_detail

bit

0 = discount is aggregated
1 = discount is detailed

rate_period

char

Values

Null

(D: 0)

Rate period identifier, from RATE_PERIOD_REF.

Null
Null

ABP-9.1-DR1-1999/09/30

jurisdiction

smallint

Jurisdiction identifier, from JURISDICTIONS.

is_gross

bit

Calculate discount based on net charge, including previously


(D: 0)
applied discounts, or gross charge amount, excluding discounts?
(1 = gross, 0 = net)

is_exclusive

bit

1 = Once applied to a charge, another exclusive discount plan


cannot be applied.

(D: 0)

Corridor ID, from CORRIDOR_PLAN_ID_REF, or 0 (no plan).

(D: 0)

corridor_plan_id int

Null

210

Field Name

DISCOUNT_DEFINITIONS

Configurable. Defines discount plans, which consist of one or more discounts from DISCOUNT_DEFINITIONS. Admin
table. Read-only copy exists on Customer server.
Used by the following modules: BIP, BIF, JNL

discount_id exists in DISCOUNT_DEFINITIONS and RATE_DISCOUNT.


discount_id cannot exist in CORRIDOR_PLAN_ID_REF.
plan_id_discount cannot be updated, and must exist in PLAN_ID_DISCOUNT_REF.
If not otherwise set, plan_order is set to plan_id_discount and def_order to discount_id.
unique on plan_order, def_order
unique on plan_id_discount, discount_id

Indexes:

ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

Values

Null

plan_id_discount smallint

Discount plan ID, from PLAN_ID_DISCOUNT_REF.

discount_id

smallint

Discount ID, from DISCOUNT_DEFINITIONS.

plan_order

int

Application order for discount plan. Defaults to plan_id_discount


value.

(R: > 0)

Null

def_order

int

Application order for discount within the plan. Defaults to discount_ (R: > 0)
id value.

Null

211

Triggers:

DISCOUNT_PLANS

DISCOUNT_PLANS

D
212

DISCOUNT_RESTRICTIONS
Configurable. Associates a given discount with one or more restriction parameters, each of which defines a restriction or
exclusion within a particular domain (for example, usage charges) for a particular entity receiving the discount. Admin
table. Read-only copy exists on Customer server.
Used by the following modules: BIP, BIF, JNL
Triggers:

Indexes:
ABP-9.1-DR1-1999/09/30

Field Name

discount_id, restricted_id exist in the appropriate tables (see below) or are NULL.
If restriction_type is 1 or 5, restricted_domain must be 1, 2, or 3; otherwise, must be NULL
is_exclusion must be constant for a single discount type.
Cannot update discount_id, type, or is_exclusion.
clustered, unique on discount_id, restriction_type, restricted_domain, restricted_id
Data Type

Comments

smallint

Discount ID, from DISCOUNT_DEFINITIONS.

restriction_type

tinyint

Identifies the restriction parameter type:


1 = charge domain
2 = product
3 = product line
4 = service provider
5 = charge type
6 = jurisdiction
7 = rate period

Null

(R: 1, 2, 3, 4, 5,
6, 7)

DISCOUNT_RESTRICTIONS

discount_id

Values

Comments

tinyint

Identifies the charge domain if restriction_type is 1 or 5.


1 = recurring charge 2 = non-recurring charge
3 = usage charge

restricted_id

smallint

Restriction entity, based on restriction_type:


If restriction_type = 1, leave Null.
If restriction_type = 2, PRODUCT_ELEMENTS.element_id.
If restriction_type = 3, PRODUCT_LINES.product_line_id.
If restriction_type = 4, SERVICE_PROVIDERS_REF.provider_
id.
If restriction_type = 5, depends on restriction_domain:
If restriction_domain = 1, PRODUCT_ELEMENTS.element_id.
If restriction_domain = 2, NRC_TRANS_DESCR.type_id_
nrc.
If restriction_domain = 3, USAGE_TYPES.type_id_usg.
If restriction_type = 6, JURISDICTIONS.jurisdiction.
If restriction_type = 7, ASCII equivalent of RATE_PERIOD_
REF.rate_period.
If restriction_type = 7, ASCII equivalent of RATE_PERIOD_
REF.rate_period. The type_id_usg associated with this
restriction must have USAGE_TYPES.bill_aggr_level = 255.

is_exclusion

bit

If 0, discount_id is applied only to the restriction entity.


If 1, it is applied to everything but the restriction entity.

ABP-9.1-DR1-1999/09/30

restricted_
domain

Values
(R: NULL, 1, 2,
3)

Null
Null

Null

213

Data Type

DISCOUNT_RESTRICTIONS

Field Name

D
214

DISCOUNT_TARGETS
Configurable. Associates cross-product discounts, defined in DISCOUNT_DEFINITIONS, with the charges they are
applied to. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIP, BIF, JNL
Triggers:

Indexes:
ABP-9.1-DR1-1999/09/30

Field Name

discount_id exists in DISCOUNT_DEFINITIONS.


If target_type is 1 or 5, target_domain must be 1, 2, or 3; otherwise NULL.
target_id must exist in the appropriate table.
is_exclusion must be constant for a given discount type.
Cannot update discount_id, type, or is_exclusion.
clustered, unique on discount_id, target_type, target_domain, target_id
Data Type

Comments

smallint

Cross-product discount ID, from DISCOUNT_DEFINITIONS.

target_type

tinyint

Identifies the target parameter type:


1 = charge domain
2 = product
3 = product line
4 = service provider
5 = charge type
6 = jurisdiction
7 = rate period

Null

(R: 1, 2, 3, 4, 5,
6, 7)

DISCOUNT_TARGETS

discount_id

Values

Comments

ABP-9.1-DR1-1999/09/30

target_domain

smallint

Identifies the charge domain of the target, if target_type is 1 or 5.


1 = recurring charge 2 = non-recurring charge
3 = usage
charge

target_id

smallint

Target entity, based on target_type:


If target_type = 1, leave Null.
If target_type = 2, PRODUCT_ELEMENTS.element_id.
If target_type = 3, PRODUCT_LINES.product_line_id.
If target_type = 4, SERVICE_PROVIDERS_REF.provider_id.
If target_type = 5, depends on restriction_domain:
If restriction_domain = 1, PRODUCT_ELEMENTS.element_id.
If restriction_domain = 2, NRC_TRANS_DESCR.type_id_nrc.
If restriction_domain = 3, USAGE_TYPES.type_id_usg.
If target_type = 6, JURISDICTIONS.jurisdiction.
If target_type = 7, ASCII equivalent of RATE_PERIOD_REF.rate_
period.

is_exclusion

bit

If 0, discount_id is applied only to the target entity.


If 1, it is applied to everything but the target entity.

Values
(R: NULL, 1, 2,
3)

Null
Null

Null

215

Data Type

DISCOUNT_TARGETS

Field Name

D
216

DISTANCE_BANDS
Configurable. Defines distance ranges (or bands) to be used in vertical and horizontal rating. Admin table. Read-only
copy exists on Customer server.

max_distance > min_distance or is NULL.


distance_band_id, jurisdiction, access_region_origin, element_id, and type_id_usg exist in the appropriate
tables (see below).
Rows with a given set of type_id_usg, jurisdiction, and access_region_origin values must have contiguous,
non-overlapping max_distance/min_distance bands.
access_region_origin and element_id exist in the appropriate tables.
clustered, unique on type_id_usg, access_region_origin, min_distance, jurisdiction, element_id

Triggers:

Indexes:
ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

Values

Null

distance_band_ tinyint
id

ID for this distance band, from DISTANCE_BANDS_ID_REF.

type_id_usg

smallint

Usage type ID, from USAGE_TYPES.

jurisdiction

smallint

Jurisdiction identifier, from JURISDICTIONS.

Null

access_region_
origin

char

Access region of the origin point, from ACCESS_REGION_REF.

Null

int

Minimum distance for this band.

max_distance

int

Maximum distance for this band. Null if this distance band is openended.

Null

element_id

smallint

Product element ID, from PRODUCT_ELEMENTS.

Null

DISTANCE_BANDS

min_distance

Configurable. Defines distance band identifiers. Admin table. Read-only copy exists on Customer server.
Only one row may have is_default = 1.
clustered, unique on distance_band_id

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

distance_band_ tinyint
id

Unique ID for this distance band.

(R: > 0)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

217

Triggers:
Indexes:

DISTANCE_BANDS_ID_REF

DISTANCE_BANDS_ID_REF

D
218

DISTANCE_BANDS_ID_VALUES
Configurable. Describes distance bands defined in DISTANCE_BANDS_ID_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


distance_band_id exists in DISTANCE_BANDS_ID_REF.
clustered, unique on distance_band_id, language_code
Data Type

distance_band_ tinyint
id

Comments

Values

Null

Distance band ID, from DISTANCE_BANDS_ID_REF.

ABP-9.1-DR1-1999/09/30

language_code

smallint

short_display

char

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

DISTANCE_BANDS_ID_VALUES

Dynamic. Holds information about the client bank. Reserved for future use. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: EFT
Indexes: clustered, unique on xfer_user_id

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

xfer_user_id

char

10 Bank sort code.

xfer_sort_code

char

Reserved for future use.

Null

xfer_acnt_id

char

Reserved for future use.

Null

xfer_acnt_type

smallint

Reserved for future use.

Null

xfer_acnt_name varchar

18 Reserved for future use.

Null

xfer_acnt_limit

numeric

18 Reserved for future use.

Null

xfer_acnt_limit_
cycle

char

Reserved for future use.

Null

xfer_transact_
limit

numeric

18 Reserved for future use.

Null

xfer_transact_
delay

smallint

Reserved for future use.

Null

xfer_prenote_
status_delay

smallint

Reserved for future use.

Null

expiration_date

smalldt

Reserved for future use.

Null

219

Field Name

EFT_CONTROL

EFT_CONTROL

E
220

EFT_RESPONSE_CODE_REF
Configurable. Defines valid EFT response codes. Admin table. Read-only copy exists on Customer server.
Used by the following modules: EFT
Only one row may have is_default = 1.
clearing_house_id and reversal_trans_type must exist in the appropriate tables or be NULL (see below).
clustered, unique on clearing_house_id, response_code

Triggers:
Indexes:

Field Name

Data Type

ABP-9.1-DR1-1999/09/30

response_code

char

response_
category

int

Null

Return code from the clearinghouse.


Category of the transaction failure:
0 = success
5 = data error
1 = comm
6 = forced deposit
2 = hard decline
7 = call company
3 = soft decline
8 = chargeback resubmit
4 = referral

Values

(R: 0, 1, 2, 3, 4,
5, 6, 7, 8)

Clearinghouse ID, from CLEARING_HOUSE_ID_REF.

treatment_ind

smallint

0 = no disconnect
1 = disconnect
2 = suspend account

reversal_trans_
type

smallint

BMF_TRANS_DESCR.bmf_trans_type for payment reversal


based on response code, if response_category = 8.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

(R: 0, 1, 2)

Null
(D: 0)

EFT_RESPONSE_CODE_REF

clearing_house_ char
id

Comments

Configurable. Describes response codes defined in EFT_RESPONSE_CODE_REF. Admin table. Read-only copy exists on
Customer server.

Indexes:

Field Name
response_code

language_code exists in LANGUAGE_CODE_REF.


response_code exists in EFT_RESPONSE_CODE_REF.
clearing_house_id exists in CLEARING_HOUSE_ID_REF.
clustered, unique on clearing_house_id, response_code, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

char

Response code, from EFT_RESPONSE_CODE_REF.

clearing_house_ char
id

Clearinghouse ID, from CLEARING_HOUSE_ID_REF.

language_code

smallint

display_value

varchar

80 Text description to be displayed on screen.

short_display

char

Values

Null

Language code, from LANGUAGE_CODE_REF.


Abbreviated version of the display value.

Null

221

Triggers:

EFT_RESPONSE_CODE_VALUES

EFT_RESPONSE_CODE_VALUES

E
222

EMF_CONFIGURATION
Configurable. Defines configurations can be assigned to service instances. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO
Triggers:

Indexes:

ABP-9.1-DR1-1999/09/30

Field Name

plan_id_discount, rate_class, and emf_config_id exist in the appropriate tables (see below).
equip_type_code, equip_class_code, class_of_service_code, and emf_book_id exist in the appropriate tables
(see below) or are 0.
Ensure industry_type exists in INDUSTRY_TYPE_REF.
unique on emf_config_id

Data Type

Comments

Values

Null

smallint

Service instance configuration ID, from EMF_CONFIG_ID_REF.

emf_type

smallint

0 = standard EMF (1 service address and no circuit ID required) (R: 0, 1, 2, 3)


1 = optional EMF (1 service address and circuit ID required)
2 = circuit/leased-line (2 service addresses and circuit ID required)
3 = B-end address enabled, circuit ID, description, and distance
disabled

equip_type_
code

smallint

Service instance type, from EQUIP_TYPE_CODE_REF.

equip_class_
code

smallint

Service instance class, from EQUIP_CLASS_CODE_REF.

class_of_
service_code

smallint

Class of service, from CLASS_OF_SERVICE_CODE_REF.

rate_class

smallint

Rating class, from RATE_CLASS_DESCR.

Null

plan_id_credit

smallint

Unit credit plan, from UNIT_CR_PLANS.

Null

plan_id_discount smallint

Discount plan, from DISCOUNT_PLANS.

Null

EMF_CONFIGURATION

emf_config_id

Data Type

Comments

Values

active_dt

smalldt

Date configuration becomes available.

inactive_dt

smalldt

Date configuration becomes unavailable.

emf_book_id

smallint

Service instance journalizing id, from JNL_EMF_BOOK_REF.

(D: 0)

is_prepaid

bit

Is the service instance prepaid? (1 = yes)

(D: 0)

industry_type

smallint

Arbor/OM only.

Null

Null

Null

EMF_CONFIGURATION

Field Name

ABP-9.1-DR1-1999/09/30

223

E
224

EMF_CONFIG_ID_REF
Configurable. Describes the set of configurations which are available to be assigned to a given service instance. Readonly copy exists on Customer server. Admin table.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
unique on emf_config_id

Triggers:
Indexes:

Field Name
emf_config_id

Data Type
smallint

Comments
Unique ID for service instance configuration.

Values

Null

(R: != 0)

ABP-9.1-DR1-1999/09/30

default_
smallint
external_id_type

External ID type (from EXTERNAL_ID_TYPE_REF) used to display


subscriptions of this type in CUSTINFO.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

(D: 0)

EMF_CONFIG_ID_REF

Configurable. Describes service instance configurations defined in EMF_CONFIG_ID_REF. Admin table. Read-only copy
exists on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


emf_config_id exists in EMF_CONFIG_ID_REF.
unique on emf_config_id, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

emf_config_id

smallint

Service instance configuration ID, from EMF_CONFIG_ID_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

format_display

varchar

80 Text description for bill format display.

Values

Null

Null
Null

225

Triggers:

EMF_CONFIG_ID_VALUES

EMF_CONFIG_ID_VALUES

E
226

EMF_STATUS_CHG_REASON_REF
Configurable. Defines reasons for changing service instance status. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
unique on emf_status_chg_reason

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

smallint

Unique identifier of a reason for changing service instance status:


1 = Customer request
2 = Customer in collections
3 = Customer violated service terms
4 = Network out of service
5 = Network back in service
97 = Disconnect requested (used by BIP)
-99 = Account suspended (used by BIP)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

(D: 0)

EMF_STATUS_CHG_REASON_REF

ABP-9.1-DR1-1999/09/30

emf_status_
chg_reason

Null

Configurable. Describes service instance status change reasons defined in EMF_STATUS_CHG_REASON_REF. Admin
table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


emf_status_chg_reason exists in EMF_STATUS_CHG_REASON_REF.
unique on emf_status_chg_reason, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

emf_status_
chg_reason

smallint

Service instance status change reason, from EMF_STATUS_CHG_


REASON_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

80 Text description to be displayed on screen.

short_display

char

10 Abbreviated version of the display value.

Values

Null

227

Triggers:

EMF_STATUS_CHG_REASON_VALUES

EMF_STATUS_CHG_REASON_VALUES

E
228

EMF_STATUS_REF
Configurable. Defines all service instance statuses supported in this deployment. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO
Triggers:
Indexes:

Field Name

Only one row may have is_default = 1.


unique on emf_status

Data Type

Comments

Values

smallint

Unique identifier of a service instance status:


10 = 30 days overdue
11 = 60 days overdue
12 = 90 days overdue
13 = 120 days overdue
14 = In collections
20 = Active
21 = Suspended
22 = Terminated
23 = Disconnect requested
24 = Account closed
25 = Account pending

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

ABP-9.1-DR1-1999/09/30

emf_status

Null

(D: 0)

EMF_STATUS_REF

Configurable. Describes service instance statuses defined in EMF_STATUS_REF. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO

Indexes:

Field Name
ABP-9.1-DR1-1999/09/30

emf_status

language_code exists in LANGUAGE_CODE_REF.


emf_status exists in EMF_STATUS_REF.
unique on emf_status, language_code
Data Type

smallint

Comments

Values

Null

Service instance status identifier, from EMF_STATUS_REF.

language_code

smallint

display_value

varchar

80 Text description to be displayed on screen.

Language code, from LANGUAGE_CODE_REF.

short_display

char

10 Abbreviated version of the display value.

229

Triggers:

EMF_STATUS_VALUES

EMF_STATUS_VALUES

E
230

EQUIP_CLASS_CODE_REF
Configurable. Lists valid classes (for example, rating zones) used to specify service instances. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: CUSTINFO, BIP, BIF, JNL
Only one row may have is_default = 1.
primary-key on equip_class_code

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

equip_class_
code

smallint

Unique identifier of a service instance class, used in other tables. (R: != 0)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

EQUIP_CLASS_CODE_REF

Configurable. Describes service instance classes defined in EQUIP_CLASS_CODE_REF. Admin table. Read-only copy
exists on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


equip_class_code exists in EQUIP_CLASS_CODE_REF.
unique on equip_class_code, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

equip_class_
code

smallint

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

Service instance class identifier, from EQUIP_CLASS_CODE_REF.


Language code, from LANGUAGE_CODE_REF.
Abbreviated version of the display value.

Null

231

Triggers:

EQUIP_CLASS_CODE_VALUES

EQUIP_CLASS_CODE_VALUES

E
232

EQUIP_TYPE_CODE_REF
Configurable. Lists all valid service instance types (for example, electronic mail account or telephone number). Admin
table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, BIP, BIF, JNL
Only one row may have is_default = 1.
primary-key on equip_type_code

Triggers:
Indexes:

Field Name

ABP-9.1-DR1-1999/09/30

equip_type_
code

Data Type
smallint

Comments

Values

Null

Unique internal identifier of a specific type of service instance, used (R: != 0)


in other tables.

foreign_code

varchar

is_default

bit

10 Reserved for future use.


Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

(D: 0)

EQUIP_TYPE_CODE_REF

Configurable. Describes service instance types defined in EQUIP_TYPE_CODE_REF. Admin table. Read-only copy exists
on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


equip_type_code exists in EQUIP_TYPE_CODE_REF.
unique on equip_type_code, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

equip_type_
code

smallint

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

Service instance type code, from EQUIP_TYPE_CODE_REF.


Language code, from LANGUAGE_CODE_REF.
Abbreviated version of the display value.

Null

233

Triggers:

EQUIP_TYPE_CODE_VALUES

EQUIP_TYPE_CODE_VALUES

E
234

ERROR_SEVERITIES
Static, for internal use only. Defines severities of messages that appear in batch process logs. Admin table. Read-only
copy exists on Customer server.
Indexes: unique on message_language, message_severity

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

message_
language

varchar

20 Language the severity is in; for example, English.

message_
severity

char

10 Severity of the error.

code

int

Values

Null

Coded value of severity.

ERROR_SEVERITIES

Configurable. Defines valid exchange rate classes. Admin table. Read-only copy exists on Customer server.
Only one row can have is_default = 1.
unique on exrate_class

Field Name
exrate_class

Data Type
smallint

Comments

Values

Null

Unique exchange rate class ID.

ABP-9.1-DR1-1999/09/30

conversion_date tinyint

1 = Use exchange rate transaction effective date.


2 = Use exchange rate for invoice statement date.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

(D: 0)

235

Triggers:
Indexes:

EXRATE_CLASS_REF

EXRATE_CLASS_REF

E
236

EXRATE_CLASS_VALUES
Configurable. Describes exchange rate classes. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


exrate_class exists in EXRATE_CLASS_REF.
unique on exrate_class, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

exrate_class

smallint

Exchange rate class ID, from EXRATE_CLASS_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Short text description of the exchange rate class.

Values

Null

Null

EXRATE_CLASS_VALUES

Configurable. Defines external ID types. Read-only copies exist on Customer and Catalog servers. Run the replicate.pl
script after modifying this table. See the System Administrator Guide for more information about replicate.pl. Admin
table.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
Rows with is_default set to 1 cannot have uniqueness_type set to 2.
clustered, unique on external_id_type

Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

external_id_type smallint

External ID type ID associated with source.

uniqueness_type tinyint

How are external_id of this type mapped to internal IDs?


(R: 0, 1, 2)
0 = one external ID is mapped to many internal IDs (one-to-many).
1 = unique; one external ID is mapped to one internal ID (one-toone).
2 = more than one external ID is mapped to one internal ID (manyto-one).

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(R: != 0)

(D: 0)

237

Triggers:

EXTERNAL_ID_TYPE_REF

EXTERNAL_ID_TYPE_REF

E
238

EXTERNAL_ID_TYPE_VALUES
Configurable. Describes external ID types defined in EXTERNAL_ID_TYPE_REF. Read-only copies exist on Customer
and Catalog servers. Run the replicate.pl script after modifying this table. See the System Administrator Guide for more
information about replicate.pl. Admin table.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


external_id_type exists in EXTERNAL_ID_TYPE_REF.
clustered, unique on external_id_type, language_code

Data Type

external_id_type smallint

Comments

Values

Null

External ID type ID, from EXTERNAL_ID_TYPE_REF.

ABP-9.1-DR1-1999/09/30

language_code

smallint

short_display

char

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

EXTERNAL_ID_TYPE_VALUES

Static. Read-only table that defines valid access methods for COM. Generally, each access method has an EXT_
<method>_ACCESS table associated with it (for example, EXT_FTP_ACCESS). Admin table. Read-only copy exists on
Customer server.
Used by the following modules: COM
Only one row may have is_default = 1.
unique on access_method

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

access_method

tinyint

Access method identifier:


1 = Local directory structure
2 = FTP
4 = Kermit (only for CheckFree access)
7 = Socket

(R: 1, 2, 4, 7)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

239

Triggers:
Indexes:

EXT_ACCESS_METHOD_REF

EXT_ACCESS_METHOD_REF

E
240

EXT_ACCESS_METHOD_VALUES
Configurable. Describes access methods defined in EXT_ACCESS_METHOD_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


access_method exists in EXT_ACCESS_METHOD_REF.
unique on access_method, language_code
Data Type

Comments

tinyint

Access method, from EXT_ACCESS_METHOD_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

Null

EXT_ACCESS_METHOD_VALUES

ABP-9.1-DR1-1999/09/30

access_method

Values

Configurable. Defines the external contacts (for example, other applications) that Arbor/BP can exchange data with.
Each row joins to a single row in EXT_CONTACTS_STATUS and in the external access tables (for example, EXT_FTP_
ACCESS or EXT_LOCAL_DIR_ACCESS). Admin table. Read-only copy exists on Customer server.
Used by the following modules: COM

ext_contact_id cannot be updated.


access_method and description_code exist in the appropriate tables (see below).
active_dt is earlier than or equal to inactive_dt and date bands do not overlap.
When is_rfr_required = 1, is_send must be 0 and rfr_path and rfr_filename cannot be NULL.
When a row is inserted or deleted into this table, a row is also inserted or deleted (respectively) in the EXT_
CONTACTS_STATUS table. Upon insert into this table, the corresponding row in EXT_CONTACTS_STATUS
has the same ext_contact_id but all other fields set to NULL or 0 as appropriate.
On updating source_id, ensure that source_id exists in EXT_SOURCE_ID_REF.
unique on ext_contact_id

ABP-9.1-DR1-1999/09/30

Indexes:

Data Type

Comments

ext_contact_id

smallint

Unique external data source identifer, used in other tables.

is_send

tinyint

Is this an input/retrieve contact (0) or an output/send contact (1)?

source_id

int

Source ID of the data source that COM accesses, from EXT_


SOURCE_ID_REF. There may be multiple ext_contact_ids for each
source_id.

ext_client_id

varchar

description_code smallint

32 ID which identifies Arbor/BP or Arbor/BP Client to external system


(for example, Client ID for credit card clearinghouse for outgoing
files).

Values

Null

Null

Description of this external contact, from DESCRIPTIONS.

241

Triggers:

Field Name

EXT_CONTACTS

EXT_CONTACTS

E
Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

access_method

tinyint

Identifier of file transfer mechanism or external system access


method (for example, FTP, local, ...), from EXT_ACCESS_METHOD_
REF.

respond_to_id

smallint

This is the ext_contact_id that Arbor/BP will send a response file to.
If Null, no response file will be sent.

ext_ebcdic

bit

Reserved for future use.

prefix_match

varchar

30 File name prefix of files to be sent or retrieved.

Null

postfix_match

varchar

30 File name postfix of files to be sent or retrieved.

Null

unique_ext_
name

bit

arbor_ready

varchar

80 Directory to copy files to (IN) or send files from (OUT).

arbor_done

varchar

80 Directory to which files are moved once successfully sent to


external data source (OUT) or successfully processed within
Arbor/BP (IN).

arbor_error

varchar

80 Directory to which errored files are moved.

arbor_work

varchar

80 Directory in which file-level work is done.

max_time_gap

int

242

Field Name

Null
(R: 0)

Are duplicate file names allowed from this ext_contact_id (0) or


must new retrieved files have unique names (1)? (All files are
renamed after retrieval to guarantee unique file names.)

Null

EXT_CONTACTS

Maximum number of seconds between files retrieved/sent. If no


files retrieved/sent within this time period, an ALARM will be
issued. Null or 0 means gap not checked. Note that this gap should
not be less than the task interval time (as defined in PROCESS_
SCHED) or else the max_time_gap will always be exceeded.

Null

Data Type

Comments

Values

Null

int

Minimum delay (in seconds) before this ext_contact_id will be


contacted after an error occurs. Delay may be longer than this
based on the task schedule. Once error is cleared (after successful
connection), the delay will be ignored. If retry_delay is Null or 0,
COM will retry this ext_contact_id every time the corresponding
task runs.

Null

retry_limit

int

Number of times to retry this ext_contact_id after a failure occurs.


After this number of communication failures, COM will no longer try
to access this ext_contact_id. To re-access, user must manually
reset the error_code to Null and the retry_count to 0. If retry_limit is
Null or 0, COM will retry this ext_contact_id indefinitely.

Null

active_dt

smalldt

Date and time this external data source becomes active.

inactive_dt

smalldt

Date and time this external data source becomes inactive.

change_who

char

change_dt

smalldt

Date and time that this entry was last modified.

control_file_
expected

bit

Are header and trailer information included in the file (0) or in a


(D: 0)
separate control file (1)? If 1, the data file must have a .data suffix
and the control file must have a .ctrl suffix. If 0, there is no
restriction on the filename, except it may not begin with a dot (.).

is_rfr_required

tinyint

Is a request for response file required by the contact? (1 = yes)

rfr_path

varchar

80 Pathname of the request for response file.

Null

rfr_filename

varchar

40 File name of the request for response file.

Null

rfr_delay

smallint

Wait time in seconds before data can be received.

file_type

smallint

File type identifier from FILE_TYPE_REF.

Null

30 The Arbor/BP username or process ID (for example, bip01, cap01)


of the user/process that last modified the record.

(R: >= 0 or =
NULL)

Null

Null

243

(D: 0)

ABP-9.1-DR1-1999/09/30

retry_delay

EXT_CONTACTS

Field Name

E
Data Type

file_name_alter_ tinyint
type

arbor_detail

varchar

use_raw_usage tinyint

Comments

Values

Leave Null if is_send = 0. Otherwise, set as follows:


(R: 0, 1, 2, 3)
Null or 0 = Leave the filename unchanged on send.
1= Strip off numeric prefix (one or more numbers followed by .)
2 = Strip off numeric suffix (one or more numbers preceded by .)
3 = Strip off all leading digits before and after .
80 Indicates where the output detail records/files will be written.
0 = raw usage is not used by this contact.
1 = raw usage data is appended when a usage event is guided.
2 = like 1, except the raw data is discarded after processing.

Null

244

Field Name

Null

Null
(D: 0) (R: 0, 1, 2)

ABP-9.1-DR1-1999/09/30

EXT_CONTACTS

Dynamic. Records interactions with external contacts. Should not be modified by users. Admin table. Read-only copy
exists on Customer server.
Used by the following modules: COM
Indexes: unique on ext_contact_id

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

ext_contact_id

smallint

Joins to exactly 1 row in EXT_CONTACTS table.

error_code

int

Numeric error code indicating why communication failed. Does not


reflect any errors that occur during file processing. Once the
contact is successfully accessed, the error_code will be reset to
Null.

retry_count

int

Number of times COM has attempted to access this ext_contact_ (D: 0)


id during error condition, in other words, number of consecutive
times access to this contact has errored out. Once this contact is
successfully accessed, retry_count is reset to 0.

last_access_dt

datetime

Date and time this ext_contact_id was accessed, whether or not


files were retrieved or sent.

Null

process_name

char

Name of process instance (for example, cap01, com04) that is


currently processing this data source. Prevents multiple processes
from accessing the same source at the same time.

Null

Null

245

Field Name

EXT_CONTACTS_STATUS

EXT_CONTACTS_STATUS

E
246

EXT_FTP_ACCESS
Configurable. Contains information specific to exchanging files with a remote system using FTP. Each row in this table
joins to exactly one row in the EXT_CONTACTS table. Admin table. Read-only copy exists on Customer server.
Used by the following modules: COM
Triggers:
Indexes:

Field Name

ext_contact_id exists in EXT_CONTACTS.


unique on ext_contact_id

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

smallint

External data source ID from EXT_CONTACTS.

remote_host

char

16 Remote system (host) name.

remote_login

char

16 Login ID on remote host.

remote_
password

char

16 Password for above login.

remote_ready

varchar

80 Directory on remote host where to retrieve files from or send files


to.

remote_done

varchar

80 IN ONLY: directory on remote host to move files to once they have


been successfully retrieved.

Null

remote_work

varchar

80 OUT ONLY: directory on remote host to which to FTP files. Once


FTP is complete, files will then be moved to remote_ready.
Directories specified by remote_ready and remote_work must be in
the same file system to prevent an external process from picking
up a file while it is in process of being transferred.

Null

EXT_FTP_ACCESS

ext_contact_id

Configurable. Facilitates external communication with external clearinghouses via the Kermit protocol. Admin table.
Read-only copy exists on Customer server.
Used by the following modules: COM

ext_contact_id exists in EXT_CONTACTS.


unique on ext_contact_id

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

ext_contact_id

smallint

External data source ID from EXT_CONTACTS.

local_loginfile_
path

varchar

80 Pathname of login file expected by clearinghouse.

local_modem

varchar

80 Local device used for external Kermit access.

local_port_path

varchar

80 Pathname of port used by local modem.

local_speed

int

local_work_dir

varchar

80 Pathname of directory where files to be transferred and files


received are kept.

remote_phone_
num

varchar

80 Telephone number of modem at clearinghouse.

Values

Null

Null

Baud rate of local_modem.

247

Triggers:
Indexes:

EXT_KERMIT_ACCESS

EXT_KERMIT_ACCESS

E
248

EXT_LOCAL_DIR_ACCESS
Configurable. Contains information specific to exchanging files with a remote system using the local Arbor/BP file
system. External processes must handle placing and/or retrieve files in the appropriate directories. Each row in this table
joins to exactly one row in the EXT_CONTACTS table. Admin table. Read-only copy exists on Customer server.
Used by the following modules: COM
Triggers:
Indexes:

Field Name

ext_contact_id exists in EXT_CONTACTS.


remote_ready is not the same as EXT_CONTACTS.arbor_ready for the given ext_contact_id.
unique on ext_contact_id

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

smallint

remote_ready

varchar

80 Directory on local (Arbor/BP) system from which, or to which files


are to be retrieved or sent, respectively. Files are retrieved from, or
sent to this directory by a process external to Arbor/BP.

External data source ID from EXT_CONTACTS.

remote_work

varchar

80 OUT ONLY: file will first be moved to remote_work. Then file will be
linked to remote_ready (and unlinked from remote_work). Both
remote_ready and remote_work must be in the same file system to
prevent an external process from picking up file that is in the
process of being copied to the remote_ready directory.

Null

remote_done

varchar

80 IN ONLY: directory on local host to move files to once they have


been successfully retrieved.

Null

EXT_LOCAL_DIR_ACCESS

ext_contact_id

Configurable. Contains information specific to exchanging files with a remote system using TCP/IP and sockets. Each
row in this table joins to exactly one row in the EXT_CONTACTS table. Admin table. Read-only copy exists on Customer
server.

ext_contact_id exists in EXT_CONTACTS.


remote_host and ip_address may not both be NULL.
EXT_CONTACTS.control_file_expected must be 0 for this contact.
unique on ext_contact_id

Indexes:

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

ext_contact_id

smallint

remote_host

char

32 Remote system (host) name.

External data source ID, from EXT_CONTACTS.


Null

ip_address

char

15 IP address of the remote system.

Null

port

int

Port number.

(R: >= 0)

timeout

int

Reserved for future use.

(R: >= 0 or =
NULL)

eof_data

varbinary 40 Code indicating that the end of the file has been reached. For
example, EOFEOFEOF and a carriage return, in hexadecimal
notation.

Null
Null

249

Triggers:

EXT_SOCKET_ACCESS

EXT_SOCKET_ACCESS

E
250

EXT_SOURCE_ID_REF
Configurable. Defines external sources with which Arbor/BP exchanges files. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: COM
Triggers:
Indexes:

Field Name

Only one row may have is_default = 1.


source_type exists in EXT_SOURCE_TYPE_REF.
unique on source_id

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

source_id

int

External data source ID.

source_type

smallint

Source type, from EXT_SOURCE_TYPE_REF.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

EXT_SOURCE_ID_REF

Configurable. Describes data sources defined in EXT_SOURCE_ID_REF. Admin table. Read-only copy exists on
Customer server.

language_code exists in LANGUAGE_CODE_REF.


source_id exists in EXT_SOURCE_ID_REF.
unique on source_id, language_code

Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

source_id

int

Data source ID, from EXT_SOURCE_ID_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

251

Triggers:

EXT_SOURCE_ID_VALUES

EXT_SOURCE_ID_VALUES

E
252

EXT_SOURCE_TYPE_REF
Static. Describes the types of external sources supported by Arbor/BP. Read-only table; should not be modified. Admin
table. Read-only copy exists on Customer server.
Used by the following modules: COM
Triggers:
Indexes:

Field Name

Only one row may have is_default = 1.


unique on source_type

Data Type

Comments

Values

Type of source:
1 = usage
3 = ABI (reserved for future use)
4 = CPM (credit card)
5 = EFT (electronic funds transfer)
6 = LBX (lockbox)
7, 8, 9 = TIP (usage preprocessor)
21 through 31 = (used by Arbor/OM)
99 = other

(R: 1, 3, 4, 5, 6,
7, 8, 9, 21, 22,
23, 24, 25, 26,
27, 28, 29, 30,
31, 99)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

EXT_SOURCE_TYPE_REF

smallint

ABP-9.1-DR1-1999/09/30

source_type

Null

Configurable. Describes source types defined in EXT_SOURCE_TYPE_REF. Admin table. Read-only copy exists on
Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


source_type exists in EXT_SOURCE_TYPE_REF.
unique on source_type, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

source_type

smallint

Source type, from EXT_SOURCE_TYPE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

253

Triggers:

EXT_SOURCE_TYPE_VALUES

EXT_SOURCE_TYPE_VALUES

F
254

FILE_STATUS
Dynamic. Used by COM to handle interactions between external files and other Arbor/BP processes (for example,
payments processing). Admin table. Read-only copy exists on Customer server.
Used by the following modules: COM, EFT, CAP, MCAP, BIP, and CPM

ext_contact_id exists in EXT_CONTACTS.


non-unique on ext_contact_id, file_name
unique on file_id, file_id_serv

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

file_id

int

Unique file ID appended to file name. Created by COM for input (is_
send = 0) files and by processing modules for output (is_send = 1)
files.

file_id_serv

tinyint

Server the file goes to or comes from.

file_group_id

int

ID to associate multiple files together; for example, Arbor/BP


receives a file and assigns it file_id X. The appropriate Arbor/BP
module creates a result file to be sent back to the external system
and assigns it file_id Y. Both files receive a common file_group_id
to tie together the original & result files. file_group_id is determined
by Arbor/BP processing module, COM ignores this field.

file_name

char

Null

Null

FILE_STATUS

80 Simple file name. Directory is in EXT_CONTACTS.arbor_ready,


and file_id is appended to the disk file name (for example, if file_
name is foo.950704 and file_id is 12, data file name is
foo.950704.12).

Values

Data Type

Comments

char

80 Name of control file, if used. In MPS, the header and trailer records
may be in a separate control file, instead of first and last record of
data file. In this case, data file must have a .data suffix and ctrl file
must have a .ctrl suffix. Like the file_name, the ctrl_file_name will
also consist of the file_id appended to the disk file name.

ext_contact_id

smallint

External file source and destination, from EXT_CONTACTS. Must be


non-Null for output files (is_send = 1).

ext_file_id

varchar

16 Code or grouping ID used by the external file source to identify the


file (other than the file name).

is_send

tinyint

Is this an input/retrieve file (0) or an output/send file (1)? If 1, ext_


contact_id for this record should be an output contact.

file_type

smallint

File type identifier. This is set by the processing module as needed.


COM ignores this field.

file_status

tinyint

1 (retrieved files) = New file from external contact, ready to be


processed.
(send files) = New file created by Arbor/BP module, ready to
send.
2 = An Arbor/BP module is currently processing the file.
3 (send files only) = File successfully sent to external contact.
4 (retrieved files only) = File successfully processed by Arbor/BP
module.
5 = Error during file transfer.
6 = Transfer successful, but error during processing.
7 = File has been identified for type.
9 = Transfer failed, no further attempts will be made.
10 = File processed successfully (MCAP/CAP).

error_code

int

Error causing file processing failure, from SYSTEM_MESSAGES.

Null
Null

Null

Null
(R: 1, 2, 3, 4, 5,
6, 7, 9, 10, 11,
12, 16)

Null

255

ABP-9.1-DR1-1999/09/30

ctrl_file_name

Values

FILE_STATUS

Field Name

F
Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

entry_create_dt

datetime

For input files, this is roughly the date and time the file was
retrieved.
For output files, this is roughly the date and time the file was
created.

file_process_dt

datetime

Date and time file was last processed, even if processing errored
out.

file_byte_count

int

File info to help verify success/failure of file transfer. This is


populated when COM or Arbor/BP processing module creates this
entry.

num_failed_
attempts

int

Number of times this file has failed processing.

current_rec_no

int

Last record processed within file; enables modules to continue


processing after a failure without having to reprocess the entire file.

total_records

int

Total number of data records in file.

Null

num_good

int

Total number of good records.

Null

num_soft_errors int

Number of soft, or correctable errors.

Null

num_hard_
errors

int

Number of hard, or non-correctable errors.

Null

num_discarded

int

Number of records discarded (not saved in database). Includes


incomplete calls, non-billing status info, and so on.

Null

num_pass_thru

int

Number of pass-through or non-billable records that have no billing


implication but are saved in the database anyway (for example,
CDR_FREE records).

Null

256

Field Name

Null

int

Sum of primary_units fields on incoming usage.

Null

int

Sum of secondary_units fields on incoming usage.

Null

FILE_STATUS

checksum1
checksum2

Data Type

Comments

checksum3

int

Sum of third_units fields on incoming usage.

corrected_
records

int

Number of errored records (soft or hard) that have been corrected.

written_off_
records

int

Number of errored records (soft or hard) that have been written off
(in other words, no further processing will be attempted).

process_name

char

change_dt

smalldt

change_who

char

Process ID (for example, cap01, com04) currently processing this


file.

Values

Null
Null

FILE_STATUS

Null

Date and time that this entry was last modified.

ABP-9.1-DR1-1999/09/30

30 Process ID (for example, bip01, cap01) of the process that last


modified the record.

257

Field Name

F
258

FILE_TYPE_REF
Configurable. Stores the difference outcollect file types (for example, TAP2, EMR, or MPS Centex) as well as file types
corresponding to FILE_STATUS.file_type. On Admin server. Admin table.
Used by the following modules: TOP
Indexes: unique on file_type

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

file_type

smallint

Unique identifier of an outcollect file type.

(D: 0)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

FILE_TYPE_REF

FILE_TYPE_VALUES

FILE_TYPE_VALUES
Configurable. Describes file types defined in FILE_TYPE_REF. Admin table.

Indexes:

Field Name

file_type exists in FILE_TYPE_REF.


language_code exists in LANGUAGE_CODE_REF.
clustered, unique on file_type, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

file_type

smallint

File type identifier, from FILE_TYPE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

259

Triggers:

F
260

FRANCHISE_CODE_REF
Configurable. Defines franchise code numbers. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, BIF
Only one row may have is_default = 1.
primary-key on franchise_code
non-unique on tax_exception, franchise_code

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

franchise_code

smallint

Unique franchise identifier.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

tax_exception

int

Applies to Canadian provinces and territories. Does the political


unit represented by this franchise code participate in the two-outof-three rule determining the origin of toll calls for calculating GST
(Federal Goods and Services Tax) and PST (Provincial Sales
Tax)? ( 1 = yes) Null or 0 mean no.

Null

(D: 0)

Null

FRANCHISE_CODE_REF

Configurable. Describes franchise codes defined in FRANCHISE_CODE_REF. Admin table. Read-only copy exists on
Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


franchise_code exists in FRANCHISE_CODE_REF.
unique on franchise_code, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

franchise_code

smallint

Franchise code, from FRANCHISE_CODE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

261

Triggers:

FRANCHISE_CODE_VALUES

FRANCHISE_CODE_VALUES

G
262

GEOCODE_OVERRIDES
Configurable. Stores custom geocode or taxable location for specific charge types and/or regions. Admin table. Readonly copy exists on Customer server.
Triggers:

Indexes:
ABP-9.1-DR1-1999/09/30

Field Name

Ensure charge_elt_id, country_code and franchise_code exist in appropriate tables or are 0.


Ensure tax_location is appropriate for charge_elt_type.
franchise_code and state_code must be 0 when country_code is 0.
county_code must be 0 when state_code is 0.
city_code must be 0 when county_code is 0.
charge_elt_id must be 0 when charge_elt_type is 0.
Ensure one and only one of tax_location or override_geocode is set.
unique on charge_elt_type, charge_elt_id, country_code, franchise_code, state_code, county_code, city_
code

Data Type

Comments

Values

charge_elt_type smallint

Type of charge for which the geocode applies:


0 = all charges
1 = recurring charge
2 = non-recurring charge
3 = usage charge

charge_elt_id

smallint

From PRODUCT_ELEMENTS.element_id if charge_elt_type = 1. (D: 0)


From NRC_TRANS_DESCR.type_id_nrc if charge_elt_type = 2.
From USAGE_TYPES.type_id_usg if charge_elt_type = 3.
0 (all charge types) if charge_elt_type = 0.

country_code

smallint

Country component of original geocode (from COUNTRY_CODE_


REF), or 0 (all countries).

(D: 0)

franchise_code

smallint

Franchise component of original geocode (from FRANCHISE_


CODE_REF), or 0 (all franchises).

(D: 0)

Null

(D: 0) (R: 0, 1, 2,
3)

GEOCODE_OVERRIDES

Comments

Values

smallint

State component of original geocode without leading zeroes, or 0 (D: 0)


(all).

county_code

smallint

County component of original geocode without leading zeroes, or (D: 0)


0 (all).

city_code

smallint

City component of original geocode without leading zeroes, or 0


(all).

(D: 0)

priority

tinyint

Higher values indicate higher priorities.

(D: 0)

tax_location

tinyint

New taxable location for charge:


0 = non-taxable
1 = CMF.bill_geocode
2 = CMF.cust_geocode
3 = EMF.service_geocode
4 = CDR_DATA.point_tax_code_origin (usage only)
5 = CDR_DATA.point_tax_code_target (usage only)
7 = composite (2 out of 3 rule) from 1, 4, and 5 (usage only)
8 = composite (2 out of 3 rule) from 2, 4, and 5 (usage only)
9 = composite (2 out of 3 rule) from 3, 4, and 5 (usage only)
11 = 4-point rule involving service instance site, supported only by
certain Custom tax packages
13 = based on CMF.bill_geocode and the billing address,
supported only by certain Custom tax packages (usage only)
14 = EMF.b_service_geocode

override_
geocode

char

ABP-9.1-DR1-1999/09/30

state_code

15 Hardcoded geocode to use as taxable location.

Null

Null

Null

263

Data Type

GEOCODE_OVERRIDES

Field Name

G
264

GROUP_AMOUNT
Configurable. Defines the maximum currency amounts of an adjustment or refund that each user group is authorized to
make. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO
Triggers:
Indexes:

Field Name

group_name exists in SYBASE table, sysusers or Oracle table, DBA_ROLE_PRIVS.


currency_code exists in RATE_CURRENCY_REF.
unique on group_name, currency_code, module_name
Data Type

ABP-9.1-DR1-1999/09/30

group_name

char

currency_code

smallint

max_amount

numeric

module_name

smallint

Comments

Values

Null

30 User group name.


Currency code, from RATE_CURRENCY_REF.
18 Maximum amount of adjustment/refund members of the group can
make, or -1 (no limit).
Function this amount is associated with:
0 = adjustment
1 = refund

(R: 0, 1)

GROUP_AMOUNT

Configurable. Controls the Arbor/BP functions that each user group has permission to access. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: CUSTINFO, EFT, COL

Field Name

group_name exists in SYBASE table, sysusers or Oracle table, DBA_ROLE_PRIVS.


unique on group_name, module_name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

group_name

char

30 User group name.

module_name

char

30 Function that users within the Sybase group are allowed to access
through the Arbor/BP GUI. See the Arbor/BP System Administrator
Guide for more information.

Values

Null

265

Triggers:
Indexes:

GROUP_FUNCTION

GROUP_FUNCTION

G
266

GSM_ROAMING_AGREEMENT
Configurable. Stores contact information and roaming agreement details for mobile carriers. Maintained locally for
Admin and Customer servers.

operator_id, rate_key_id , country_code, ext_contact_id_in and ext_contact_id_out exist in their


corresponding tables (see below). currency_code exists in RATE_CURRENCY_REF if not NULL or 0.
currency_code cannot be NULL or 0 if plmn_type = 1.
Ensure only one operator_id exists for each ext_contact_id_in and each ext_contact_id_out value.
unique on operator_id
unique on plmn_name, active_dt

Triggers:

Indexes:

ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

operator_id

int

Roaming operator ID, from ROAMING_OPERATOR_REF.

rate_key_id

smallint

Roaming rate key ID, from ROAMING_RATE_KEYS.

plmn_name

char

Values

Null

Official PLMN name in file names, headers, trailers, and delivery


notes.
Mobile Country Code component of the IMSI.

Null

mobile_network_ smallint
code

Mobile Network Code component of the IMSI.

Null

national_
int
destination_code

National destination code of the MSISDN that belongs to the


PLMN.

version_in

char

TAP file version number for incoming files from this PLMN.

version_out

char

TAP file version number for outgoing files to this PLMN.

seq_num_in

int

Unique file transfer ID for incoming files from this PLMN.

seq_num_out

int

Unique file transfer ID for outgoing files to this PLMN.

GSM_ROAMING_AGREEMENT

mobile_country_ smallint
code

Data Type

Values

max_days_in

smallint

Number of days after call date by which call data must be received
from this PLMN. Two months (~60) is a typical value.

max_days_out

smallint

Number of days after call date by which call data must be sent to
this PLMN. Two months (~60) is typical.

plmn_tape_
volser_name

char

plmn_type

tinyint

plmn_address1

varchar

75 Contact information for PLMN.

Null

plmn_address2

varchar

75 Contact address for PLMN.

Null

plmn_address3

varchar

75 Contact address for PLMN.

Null

plmn_city

varchar

35 Contact city for PLMN.

Null

plmn_state

varchar

28 Contact state for PLMN.

Null

plmn_zip

varchar

16 Contact zip code for PLMN.

Null

plmn_contact_
name

varchar

60 Contact name for PLMN.

Null

plmn_contact_
phone

varchar

20 Contact phone number for PLMN.

Null

plmn_contact_
faxno

varchar

20 Contact fax number for PLMN.

Null

80 Description of PLMN.

Null

country_code

smallint

(R: Y,N,X)

Used on tape labels to identify the PLMN.


1: Home operator.

2: Other PLMN.

Null
3: Clearinghouse.

(R: 1, 2, 3)

PLMN country code, from COUNTRY_CODE_REF.

267

ABP-9.1-DR1-1999/09/30

char

Y: Tax included in the charge.


N: Tax not included.
X: Tax not applicable (also used for clearinghouses).

Null

tax_treatment

plmn_description varchar

Comments

GSM_ROAMING_AGREEMENT

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

currency_code

smallint

PLMN currency code, from RATE_CURRENCY_REF. Required if


plmn_type = 1.

Null

ext_contact_id_
in

smallint

External source ID for foreign roaming usage, from EXT_


CONTACTS.

Null

ext_contact_id_
out

smallint

External source ID for local roaming usage, from EXT_CONTACTS.

Null

active_dt

smalldt

Date on which this roaming agreement becomes active.

inactive_dt

smalldt

Date on which this agreement becomes inactive.

composite_file

tinyint

Flag. If set to yes (1), indicates that TOP is exchanging composite (D: 1)
TAP2 files with GSM roaming clearinghouses. TOP assembles
individual files that are destined for multiple VPLMNs into a single
composite file, and appends a superheader and supertrailer
record.
If set to no (0), indicates that TOP is exchanging a single TAP file
with GSM roaming partner.

notification_
interval

tinyint

Maximum number of days this contact can remain uncontacted.

newline_
terminate_
records

tinyint

Indicates whether TOP will end lines in the output file with newline (D: 0)
characters.
1 = TOP will add a newline character to the end of each output
record.
0 = TOP will not add a newline character to the end of each output
record.

268

Field Name

Null

Null

GSM_ROAMING_AGREEMENT

Configurable. Maps tables and fields in the databases to text elements and value ranges to be included in the user
interface. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
unique on table_name, field_name, integer_value

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

field_name

char

30 Sybase database table name.

table_name

char

30 Sybase database attribute name to be converted to a text value for


display by the GUI.

integer_value

smallint

Possible values of the field_name.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

269

Triggers:
Indexes:

GUI_INDICATOR_REF

GUI_INDICATOR_REF

G
270

GUI_INDICATOR_VALUES
Configurable. Describes entities defined in GUI_INDICATOR_REF. Admin table. Read-only copy exists on Customer
server.
Triggers:
Indexes:

Field Name
table_name

language_code exists in LANGUAGE_CODE_REF.


table_name, field_name, and integer_value exist in GUI_INDICATOR_REF.
clustered, unique on table_name, field_name, integer_value, language_code
unique on table_name, field_name, integer_value, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

char

30 Database attribute name, from GUI_INDICATOR_REF.

field_name

char

30 Sybase table name, from GUI_INDICATOR_REF.

integer_value

smallint

Value for field_name, from GUI_INDICATOR_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

GUI_INDICATOR_VALUES

Static. Holds messages that are included in the Windows NT user interface. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO (NT)

language_code exists in LANGUAGE_CODE_REF.


clustered, unique on msg_no, msg_type, language_code, msg_name

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

msg_no

int

Message number, must be greater than 20,000.

msg_type

tinyint

Message type.

language_code

smallint

msg_name

varchar

60

msg_text

varchar

255 Text of the message to be displayed.

Values

Null

(R: 1, 2, 3)

Language code, from LANGUAGE_CODE_REF.


A brief description or title for the message.

271

Triggers:
Indexes:

GUI_MESSAGES

GUI_MESSAGES

I
272

IGEN_ADDRESS_FORMATS
Configurable. For internal use only.
Describes the different formats for address types defined in IGEN_ADDRESS_FORMAT_REF. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: IGEN
Triggers:
Indexes:

county_code must exist in COUNTRY_CODE_REF.


unique on address_format_id, country_code, language_code

Foreign Keys:(language_code) must exist in LANGUAGE_CODE_REF(language_code)


(address_format_id) must exist in IGEN_ADDRESS_FORMAT_REF(address_format_id)
ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments
Address type ID.

country_code

smallint

Country code for this format, defined in COUNTRY_CODE_REF.


If zero, this is taken as the default format if exact format not found.

language_code

smallint

Language code for this format, defined in LANGUAGE_CODE_REF.

address_line

varchar

255 Format string for address. See Guide to Invoice Design for more
details.

Null

IGEN_ADDRESS_FORMATS

address_format_ smallint
id

Values

Configurable. For internal use only.


Defines available address types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: IGEN
Indexes: unique on tag
primary-key on address_format_id

Data Type

ABP-9.1-DR1-1999/09/30

address_format_ smallint
id

Comments

Values

Address type ID.

tag

varchar

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or


modify.

is_default

bit

Is this value default? (1 = yes). Only one row can be default.

Null

60 Unique name of address format type.

273

Field Name

IGEN_ADDRESS_FORMAT_REF

IGEN_ADDRESS_FORMAT_REF

I
274

IGEN_ADDRESS_FORMAT_VALUES
Configurable. For internal use only.
Contains descriptions of the address types in IGEN_ADDRESS_FORMAT_REF. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: IGEN
Indexes: unique on address_format_id, language_code
Foreign Keys:(language_code) must exist in LANGUAGE_CODE_REF(language_code)
(address_format_id) must exist in IGEN_ADDRESS_FORMAT_REF(address_format_id)

Field Name

Data Type

Values

Null

Address type ID.

IGEN_ADDRESS_FORMAT_VALUES

ABP-9.1-DR1-1999/09/30

address_format_ smallint
id

Comments

Comments

Values

ABP-9.1-DR1-1999/09/30

language_code

smallint

short_display

char

display_value

varchar

80 Abbreviated version of the display value:


%np = name prefix
%nf = first name
%nm = middle name
%nl = last name
%ng = name generation (suffix)
%nt = customer title
%co = company name
%a1 = address line 1
%a2 = address line 2
%a3 = address line 3
%ct = city
%cn = county
%st = state
%zp = zip
%cy = country
%ea = CUSTOMER_ID_ACCT_MAP.external_id
%ee = CUSTOMER_ID_EQUIP_MAP.external_id
%% = Percent sign (%)
%{ = }
%{ = }
\\ = \
If specifier is all caps (%NP), the output string will also be all caps.
Specifier may have pre- and post- text formatting, which is only
printed if the string specified by the specifier is non-null. Format is:
{pretext%specifierposttext}

Null

Language ID, from LANGUAGE_CODE_REF.


Text description to be displayed on screen.

Null

275

Data Type

IGEN_ADDRESS_FORMAT_VALUES

Field Name

I
276

INDUSTRY_TYPE_REF
Configurable. Defines valid industry types. Admin table. Read-only copy exists on Customer server.
Only one row can have is_default = 1.
primary-key on industry_type

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

industry_type

smallint

Unique identifier of an industry type.

use_address_
server

bit

Used by Arbor/OM.

is_e911_
required

bit

Should the e911 information screens be accessed? (1 = yes)

is_lidb_required bit

Should the input screens for the Line Information Database be


accessed? (1 = yes)

is_pic_required

bit

Should the input screens associated with Primary Interexchange


Carrier be accessed? (1 = yes)

is_dadl_used

bit

Should the input screens associated with Directory Assistance


Directory Listing be accessed? (1 = yes)

Values

Null

(R: != 0)

Should the input screens associated with a calling card be


accessed? (1 = yes)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, record is required by Arbor/BP modules; do not remove or


delete.

(D: 0)

INDUSTRY_TYPE_REF

is_calling_card_ bit
used

Configurable. Contains language-dependent description information for industry types. Admin table. Read-only copy
exists on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


industry_type_id exists in INDUSTRY_TYPE_REF.
unique on industry_type, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

industry_type

smallint

Industry type, from INDUSTRY_TYPE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

(D: 1)

Short text description.

Null

277

Triggers:

INDUSTRY_TYPE_VALUES

INDUSTRY_TYPE_VALUES

I
278

INSERT_FOREIGN_KEY_REF
Configurable. Defines valid client-specific key field values for BILL_INSERT_GROUPS table. Admin table. Read-only
copy exists on Customer server.
Only one row can have is_default = 1.
unique on insert_foreign_key

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

insert_foreign_
key

int

Unique client-specific key field value.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

INSERT_FOREIGN_KEY_REF

Configurable. Describes key fields defined in INSERT_FOREIGN_KEY_REF. Admin table. Read-only copy exists on
Customer server.

language_code exists in LANGUAGE_CODE_REF.


insert_foreign_key exists in INSERT_FOREIGN_KEY_REF.
unique on insert_foreign_key, language_code

Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

insert_foreign_
key

int

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

Key field value, from INSERT_FOREIGN_KEY_REF.


Language code, from LANGUAGE_CODE_REF.

(D: 1)

Short text description of the key field value.

Null

279

Triggers:

INSERT_FOREIGN_KEY_VALUES

INSERT_FOREIGN_KEY_VALUES

I
280

INSERT_GRP_ID_REF
Configurable. Defines customer groups used to control who receives specific bill inserts. The groups listed in this table
are included in a selection list of valid insert groups within the user interface. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO, BIF
Only one row may have is_default = 1.
clustered, unique on insert_grp_id

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

insert_grp_id

smallint

Unique internal ID of a specific insert group.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

INSERT_GRP_ID_REF

Configurable. Describes insert groups defined in INSERT_GRP_ID_REF. Admin table. Read-only copy exists on
Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


insert_grp_id exists in INSERT_GRP_ID_REF.
clustered, unique on insert_grp_id, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

insert_grp_id

smallint

Insert group ID, from INSERT_GRP_ID_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Abbreviated version of the display value.

Null

Null

281

Triggers:

INSERT_GRP_ID_VALUES

INSERT_GRP_ID_VALUES

I
282

IO_DEVICES
Configurable. Associates internal usage type identifiers (for example, print, tape output, and so on) with actual UNIX
devices, defined in DEVICES. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BID
Indexes: unique on usage_type, server_id

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

server_id

tinyint

usage_type

char

usage_desc

char

32 If usage_type = f, stores remote machine name.


If usage_type = P, stores device description.

device_id

char

32 If usage_type = f, stores remote username.


If usage_type = P, stores internal ID from DEVICES.

device_class

char

16 If usage_type = f, stores remote password.


If usage_type = P, not used.

device_options

char

80 If usage_type = f, stores destination directory name.


If usage_type = P, stores printer command-line options.

Values

Null

Server ID, to uniquely identify row.


Usage type code:
P = print
f = FTP

IO_DEVICES

Configurable. Associates journal codes with client-specific accounting codes. Not all fields are used by all deployments.
Admin table. Read-only copy exists on Customer server.
Indexes: clustered, unique on jnl_code_id

Data Type

Comments

Values

Unique journal code ID.

Null

ABP-9.1-DR1-1999/09/30

jnl_code_id

int

ps_code_db

varchar

10 Debit-side product/service code (see also fml_acct_db).

(R: > 0)
Null

csub_db

varchar

Debit-side common subaccount (see also fml_acct_db).

Null

csub_db_final

varchar

Debit-side common subaccount for final billing.

Null

fml_acct_db

varchar

10 Debit-side FML code. Journal transaction hierarchy defined by


FML, product/service, and common subaccount values.

Null

ps_code_cr

varchar

10 Credit-side product/service code (see also fml_acct_cr).

Null

csub_cr

varchar

Credit-side common subaccount (see also fml_acct_cr).

Null

csub_cr_final

varchar

Credit-side common subaccount for final billing.

Null

fml_acct_cr

varchar

10 Credit-side FML code. Journal transaction hierarchy defined by


FML, product/service, and common subaccount values.

Null

bu_ps_code_db varchar

10 Full PS code, internal to BU (debit side).

Null

bu_ps_code_cr

varchar

10 Full PS code, internal to BU (credit side).

Null

org_charged

char

Entity responsible for budgeting the financial transaction.

Null

org_originating

char

Entity responsible for originating the financial transaction.

Null

iet

varchar

10 Inter-entity transaction code.

Null

varchar

Managed Entity code (SOBP part 1).

Null

le

varchar

Legal Entity code (SOBP part 2).

Null

283

me

Field Name

JNL_CUSTOM

JNL_CUSTOM

Data Type

Comments

Values

Null

ae

varchar

Accounting Entity (SOBP part 3).

Null

journal_entry

varchar

Not used.

Null

location_code

varchar

15 Identifies the physical location of assets for financial and tax


analysis.

Null

je_category_
name

varchar

25 Used to generate the Oracle Financial feed file.

Null

display_value

varchar

80 Text description of this entry for display on screen.

Null

284

Field Name

ABP-9.1-DR1-1999/09/30

JNL_CUSTOM

Configurable. Defines start and end dates of journaling periods. Admin table. Read-only copy exists on Customer server.
Used by the following modules: JNL
Triggers:
Indexes:

Field Name

JNL_CYCLE

JNL_CYCLE

Ensure that periods are contiguous with no overlap, and that the end dates are later than the start dates.
unique on jnl_end_dt

Data Type

Comments

jnl_start_dt

smalldt

Start date of the journal cycle.

jnl_end_dt

smalldt

End date of the journal cycle

Values

Null

ABP-9.1-DR1-1999/09/30

285

J
286

JNL_EMF_BOOK_REF
Configurable. Contains definitions of relationships between service instance types and general ledger codes for financial
journaling. Admin table. Read-only copy exists on Customer server.
Used by the following modules: JNL
Only one row may have is_default = 1.
clustered, unique on emf_book_id

Triggers:
Indexes:

Field Name
emf_book_id

Data Type
smallint

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

Unique service instance type ID (as classified for journaling


purposes).

g_l_code

char

is_default

bit

15 Financial general ledger code.


Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or


modify.

JNL_EMF_BOOK_REF

Configurable. Describes service instance type and general ledger code associations defined in JNL_EMF_BOOK_REF.
Admin table. Read-only copy exists on Customer server.
Used by the following modules: JNL

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


emf_book_id exists in JNL_EMF_BOOK_REF.
clustered, unique on emf_book_id, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

emf_book_id

smallint

language_code

smallint

short_display

char

15 Abbreviated version of the display value.

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

Service instance booking id. From JNL_EMF_BOOK_REF.


Language code, from LANGUAGE_CODE_REF.
Null

287

Triggers:

JNL_EMF_BOOK_VALUES

JNL_EMF_BOOK_VALUES

J
288

JNL_FEED_HEADER
Configurable. Each row defines a field in a JNL feed file header record. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: JNL
Indexes: clustered, unique on hdr_type, hdr_position

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

hdr_type

tinyint

File header(0) or pack header (1).


Pack trailers group feed information by types for example, by
currency code.

hdr_position

tinyint

Field position (1 = first field, 2 = second field, 3 = third field, and so


on).

hdr_table

tinyint

See JNL_FEED_LAYOUT.jnl_table for other values. hdr_table


= 14 not used if this is pack header row.

Values

Null

(R: between 0
and 1)

JNL_FEED_HEADER

ABP-9.1-DR1-1999/09/30

hdr_field

tinyint

hdr_field_size

tinyint

hdr_hardcoded

varchar

Comments

Values

Null

If hdr table = 2 (JNL_CUSTOM), values may be changed for your


deployment, initial values are:
1 = jnl_code_id
2 = ps_code_db
3 = csub_db
4 = csub_db _inal
5 = fml_acct_db
6 = ps_code_cr
7 = csub_cr
8 = csub_cr_final
9 = fml_acct_cr
10 = bu_ps_code_db
11 = bu_ps_code_cr 12 = org_charged
13 = org_originating 14 = iet
16 = le
15 = me
17 = ae
18 = journal_entry
20 = je_category_name
19 = location_code
21 = display_value
See JNL_FEED_LAYOUT.jnl_field for description of other
values.
Field size. Source value is padded or trimmed to match this size.
32 Field value, used if hdr_table = 11 (hard-coded).

(R: > 0)
Null

hdr_field_format tinyint

See JNL_FEED_LAYOUT.jnl_field_format for a description.

hdr_field_trim

tinyint

See JNL_FEED_LAYOUT.jnl_field_trim for a description.

hdr_field_
description

varchar

in_feed_report

bit

Include field in JNL control report as well as JNL feed file? (1 = yes,
0 = no)

hdr_is_pack

bit

This field is used for a pack.

80 Description of field.

Null

289

Data Type

JNL_FEED_HEADER

Field Name

J
290

JNL_FEED_LAYOUT
Configurable. Each row defines a field in a JNL feed file detail record. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: JNL
Triggers:
Indexes:

Field Name

Cannot have any jnl_table = 3 (JNL_TRANS) rows and any jnl_table = 4 (JNL_DETAIL) rows in this table at
the same time.
clustered, unique on jnl_field_position, jnl_field_db_cr

Data Type

Comments

ABP-9.1-DR1-1999/09/30

Field position (1 = first field, 2 = second field, 3 = third field, and so on).

jnl_field_db_cr

tinyint

0 = Place value in both debit and credit rows.


1 = Place value in only debit row.
2 = Place value in only credit row.

jnl_table

tinyint

Indicates which table (if any) the field value is drawn from:
1 = (not used)
2 = JNL_CUSTOM
3 = JNL_TRANS
4 = JNL_DETAIL
5 = RATE_CURRENCY_REF/_VALUES
6 = JNL_RUNS_STATUS
7 = OWNING_COST_CTR_REF
8 = REV_RCV_COST_CENTER_REF
9 = No table; line counter for the current feed file, starting with 1.
10 = No table; current date in format specified by jnl_field_format.
11 = No table; value in jnl_hardcoded_value, format in jnl_field_trim.
12 = JNL_EMF_BOOK_REF
14 = No table; pack id specified by pack header rows in JNL_FEED_HEADER.

Null

JNL_FEED_LAYOUT

jnl_field_position tinyint

Values

tinyint

Comments

Values

ABP-9.1-DR1-1999/09/30

291

0, or a field in the table specified by jnl_table:


If jnl_table = 2 (JNL_CUSTOM), processing is site-specific.
If jnl_table = 3 (JNL_TRANS) or 4 (JNL_DETAIL):
2 = id_value
3 = id_type2
1 = id_type
4 = id_value2
5 = use_code
6 = provider_id
8 = jurisdiction
9 = invoice_currency_code
7 = account_category
10 = currency_code
11 = fraud_indicator 12 = adj_category
13 = mkt_code
14 = rev_rcv_cost_ctr 15 = owning_cost_ctr
17 = reported_amount 18 = usage_units
16 = invoice_amount
20 = jnl_code_id1
19 = usage_items
If jnl_table = 3 (JNL_TRANS):
23 = location_region 24 = element_id
22 = location_code
25 = jnl_subcycle_end_dt 26 = emf_book_id
27 = tax_type_code
28 = open_item_id
If jnl_table = 4 (JNL_DETAIL):
22 = location_region 23 = account_no
21 = location_code
24 = subscr_no
25 = subscr_no_resets 26 = bill_ref_no
28 = element_id
29 = tracking_id
27 = bill_ref_resets
31 = tracking_dt
32 = effective_dt
30 = tracking_id_serv
33 = billed_dt
34 = accrued_dt
35 = reference_code
36 = jnl_end_dt
37 = jnl_subcycle_end_dt 38 = emf_book_id
39 = tax_type_code
40 = open_item_id
If jnl_table = 5 (RATE_CURRENCY_REF/_VALUES):
2 = short_display
3 = implied_decimal
1 = display_value
If jnl_table = 6 (JNL_RUNS_STATUS):
1 = jnl_end_dt
2 = jnl_ref_no
3 = jnl_ref_no_serv
4 = jnl_subcycle_end_dt 5 = jnl_start_dt
If jnl_table = 7 (OWNING_COST_CTR_REF), 8 (REV_RCV_COST_CENTER_REF)
or 12 (JNL_EMF_BOOK_REF), 1 = g_l_code
If jnl_table = 14, 1 = Unique Pack Id

Null

jnl_field

Data Type

JNL_FEED_LAYOUT

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

tinyint

Size of field. Source value is padded or trimmed to match this size.

jnl_hardcoded_
value

varchar

jnl_field_format

tinyint

Field format, for date and currency values. 0 indicates no format.


Dates (given Dec 25 1997)
1 = 251297
2 = 25-12-97 3 = DEC97 4 = DEC-97 5 = 251297
6 = 25-12-97
7 = 9712
8 = 97-12
9 = 971225 10 = 97-12-25
11 = 122597
12 = 12-25-97
13 = 12251997
14 = 12-25-1997
15 = 1997
16 = 12
Currency (given US$123.45)
100 = Decimal (123.45)
101 = No decimal (12345)
102 = Decimal, forced negative (-123.45)
103 = Forced negative (-12345)
104 = Decimal, forced positive (123.45)
105 = Forced positive (12345)

jnl_field_trim

tinyint

Controls how values are padded/trimmed in detail field (examples assume jnl_
field_size is 5):
0 = no padding or trimming
1 = trim from the right (for example, 1234567 becomes 12345)
2 = trim from the left (for example, 1234567 becomes 34567)
3 = pad on right with spaces (for example, 1234 becomes 1234 )
4 = pad on left with spaces (for example, 1234 becomes 1234)
5 = pad on right with zeroes (for example, 1234 becomes 12340)
6 = pad on left with zeroes (for example, 1234 becomes 01234)
7 = center the field with spaces (for example, 123 becomes 123 )

jnl_field_
description

varchar

in_feed_report

bit

32 Field value, used if jnl_table = 11 (hard-coded).

80 Description of field.
Include field in JNL control report as well as JNL feed file? (1 = yes, 0 = no)

Null

(R: > 0)
Null

Null

JNL_FEED_LAYOUT

jnl_field_size

Values

292

Field Name

Configurable. Each row defines a field in a JNL feed file trailer record. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: JNL
Indexes: clustered, unique on trl_type, trl_position

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

trl_type

tinyint

File trailer (0) or pack trailer (1).


Pack trailers group feed information by types for example, by
currency code.

trl_position

tinyint

Field position (1 = first field, 2 = second field, 3 = third field, and so


on).

trl_table

tinyint

See JNL_FEED_LAYOUT.jnl_table for a description.


This field supports an additional value of 13 (Totals).

trl_field

tinyint

See JNL_FEED_LAYOUT.jnl_field for a description.


This field supports the following additional values if trl_table = 13:
1 = Number of detail debit records. 2 = Total debit amount.
3 = Number of detail credit records. 4 = Total credit amount.
5 = Number of detail records.
6 = Total amount.

trl_field_size

tinyint

Field size. Source value is padded or trimmed to match this size.

trl_hardcoded

varchar

trl_field_format

tinyint

32 Field value, used if trl_table = 11 (hard-coded).

Null

(R: between 0
and 1)

(R: > 0)
Null

See JNL_FEED_LAYOUT.jnl_field_format for a description.

293

Field Name

JNL_FEED_TRAILER

JNL_FEED_TRAILER

Data Type

trl_field_trim

tinyint

trl_field_
description

varchar

in_feed_report

bit

Comments

Values

Null

294

Field Name

See JNL_FEED_LAYOUT.jnl_field_trim for a description.


80 Description of field.

Null

Include field in JNL control report as well as JNL feed file? (1 = yes,
0 = no)

ABP-9.1-DR1-1999/09/30

JNL_FEED_TRAILER

Configurable. Associates accounting codes with transaction types. Admin table. Read-only copy exists on Customer
server.

ABP-9.1-DR1-1999/09/30

Indexes:

jnl_code_id exists in JNL_CUSTOM.


Two rows with the same keys cannot have overlapping active dates.
If one of the fields marked with an asterisk (*) below is set to NULL or 0, a corresponding row in JNL_KEYS_
MASK must exist and have the corresponding masking field set to 1.
Ensure that id_type, id_value, mkt_code, provider_id, jurisdiction, and account_category are properly
populated (see below).
Fraud indicator can be NULL or 0 only if id_type = 1.
Note: Triggers only apply if jnl_key_status = L.
unique on id_type, id_value, id_type2, id_value2, use_code, provider_id, account_category, jurisdiction, mkt_
code, currency_code, adj_category, fraud_indicator, active_date, tax_type_code, element_id, open_item_id

295

Triggers:

JNL_KEYS

JNL_KEYS

This page is intentionally left blank.

Comments

Values

ABP-9.1-DR1-1999/09/30

jnl_code_id

int

Journal code ID, from JNL_CUSTOM.

id_type

smallint

Transaction category:
1 = adjustments
2 = payments, refunds, deposits
3 = recurring charges
4 = usage charges
5 = discounts and unit credits
6 = non-recurring charges
7 = tax amounts
8 = write-offs
9 = unit credit totals
10 = written off/investigated usage
11 = interest
12 = billed and paid tax amount
13 = lockbox payment awaiting investigation
14 = currency conversion gain/loss
15 = payments in non-account currency
16 = fixed currency conversion gain/loss
17 = pre-payments
18 = free usage
99 do not use

(R: 1, 2, 3, 4, 5,
6, 7, 8, 9, 10, 11,
12, 13, 14, 15,
16, 17, 18, 99)

Null

297

Data Type

JNL_KEYS

Field Name

id_value*

Data Type
smallint

Comments

ABP-9.1-DR1-1999/09/30

Null
Null

JNL_KEYS

Transaction type code, based on transaction category.


If id_type = 1 and adj: ADJ_REASON_CODE_REF.adj_journal_code
If id_type = 1 and rounding booked as adjustment: -8
If id_type = 2 and payment or refund: BMF_TRANS_DESCR.bmf_trans_
type
If id_type = 2 and deposit: -5
If id_type = 2 and returned deposit: -6
If id_type = 3 recurring charges: PRODUCT_ELEMENTS.element_id
If id_type = 4 or 18 usage charges, free usage : USAGE_TYPES.type_
id_usage
If id_type = 5 and discounts identified at discount level:
DISCOUNT_DEFINITIONS.discount_id
If id_type = 6 non-recurring charges: NRC_TRANS_DESCR.type_id_nrc
If id_type = 7 taxes: -1 = federal taxes
-2 = state and local taxes; taxes on returned deposits
-3 = miscellaneous taxes not associated with a product
If id_type = 8 write-offs: 2 = written-off payments
3 = recovered written-off payments
4 = written-off payment recovery reversals
If id_type = 9 unit credits: UNIT_CR_DEFINITIONS.unit_credit_id
If id_type = 11 interest: -7
If id_type = 10 errored usage: 1 = written-off 2 = pending investigation
If id_type = 13 unguided lbx: LBX_PAYMENT_TYPES.bmf_trans_type
If id_type = 14, 15, 16 floating conversion gain/loss, payments in nonaccount currencies, fixed conversion gain/loss: BMF_TRANS_
DESCR.bmf_trans_type
Otherwise Null
If id_type = 17, 1= pre-payments rows, 2 = pre-payment distribution rows
If id_type = 18, USAGE_TYPES.type_id_usage

Values

298

Field Name

smallint

Comments

Values

ABP-9.1-DR1-1999/09/30

Transaction category, type 2.


If id_type = 1 and adjustment:
ADJ_TRANS_DESCR.trans_target_type
If id_type = 1 and rounding booked as adjustment:
-12 = debit
-13 = credit
If id_type = 2 and payment or refund:
1 = BMF record
2 = BMF_DISTRIBUTION record
If id_type = 2 and deposit:
DEPOSIT.pay method
If id_type = 5 and discounts identified at charge level:
3 = discount by recurring charge
4 = discount by usage
6 = discount by non-recurring charge
If id_type = 14, 15, 16 floating conversion gain/loss, payments in nonaccount currencies, fixed conversion gain/loss:
1 = BMF record
2 = BMF_DISTRIBUTION record
Otherwise Null
If id_type = 17 pre-payments:
1 = VAT amounts
2 = non VAT amounts

Null
Null

299

id_type2*

Data Type

JNL_KEYS

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

id_value2*

smallint

Transaction type 2 code for the id_type2 value.


If id_type = 1 and adjustment:
ADJ_TRANS_DESCR.trans_target_id
If id_type = 5 and booking discounts at charge level,
and id_type2 = 3, PRODUCT_ELEMENTS.element_id
and id_type2 = 4, USAGE_TYPES.type_id_usg
and id_type2 = 6, NRC_TRANS_DESCR.type_id_nrc
If id_type = 2 and deposit: DEPOST.refund_type
If id_type = 2 and refund: REFUND.refund_reason_code
2 = loss
If id_type = 16 fixed conv. gain/loss: 1 = gain
Otherwise Null.

(R: >= 0)

use_code

tinyint

Code describes how the transaction is to be journalized, generally:


1 = standard journal
2 = accrual
If id_type = 2 or 8, use_code can only be 1.

(R: 1, 2, 3)

provider_id*

smallint

Service provider identifier, from SERVICE_PROVIDERS_REF. If id_type =


1, 8, 10, or 11, must be Null.

account_
category*

tinyint

Account category identifier, from ACCOUNT_CATEGORY_REF.

jurisdiction*

smallint

From JURISDICTIONS.jurisdiction; use 255 to book unknown


jurisdiction, Null if not booking by jurisdiction.

Null

mkt_code*

smallint

Market code, from MKT_CODE_REF, associated with account.

Null

currency_code*

smallint

Currency code, from RATE_CURRENCY_REF.

Null

adj_category*

smallint

If id_type = 1 (adjustment):
ADJ_TRANS_DESCR.billing_category
otherwise, Null.

300

Field Name

Null

Null
(D: 0)

(R: 1, 2)

Null

Null

JNL_KEYS

Comments

Values

If id_type = 1 or 5, indicates fraud status for accrual reversal otherwise,


Null.

fraud_indicator* smallint
1

Status of the journal code record: L = live

H = hold

D = delete

Null
Null

ABP-9.1-DR1-1999/09/30

jnl_key_status

char

(R: L','H','D')'

active_date

smalldt

Date record becomes active.

inactive_date

smalldt

Date record becomes inactive. Null = indefinite

no_jnl_ind

bit

Should this transaction be journaled? (1 = no)

(D: 0)

arch_flag

bit

Has this record been archived? (1 = yes)

(D: 0)

tax_type_code

int

VAT tax type code, from TAX_RATES_VAT.

Null

open_item_id

int

Open item ID, from OPEN_ITEM_ID_REF.

Null

element_id

smallint

Product ID, from PRODUCT_ELEMENTS.

Null

Null

301

Data Type

JNL_KEYS

Field Name

J
302

JNL_KEYS_MASK
Configurable. Contains a series of mask fields that control which key fields in JNL_KEYS are active for each transaction
category. If a mask field is set to 1, the corresponding key field in JNL_KEYS can be left blank. Admin table. Read-only
copy exists on Customer server.
If id_type is not 1,2,5,15,16, or 17, id_type2, id_value2, adj_category and fraud_indicator_masks cannot be set
to 0.
unique on id_type

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

id_type

smallint

Transaction category ID, from JNL_KEYS.

(R: 1, 2, 3, 4, 5,
6, 7, 8, 9, 10, 11,
12, 13, 14, 15,
16, 17, 18, 99)

id_value_mask

bit

Ignore JNL_KEYS.id_value for id_type? (1 = yes, 0 = no)

(D: 0)

id_type2_mask

bit

(D: 1)

Ignore JNL_KEYS.id_value2 for id_type? (1 = yes, 0 = no)

(D: 1)

provider_id_
mask

bit

Ignore JNL_KEYS.provider_id for id_type? (1 = yes, 0 = no)

(D: 0)

account_
category_mask

bit

Ignore JNL_KEYS.account_category for id_type? (1 = yes,


0 = no)

(D: 0)

jurisdiction_
mask

bit

Ignore JNL_KEYS.jurisdiction for id_type? (1 = yes, 0 = no) (D: 0)

fraud_indicator_ bit
mask

Ignore JNL_KEYS.fraud_indicator for id_type? (1 = yes,


0 = no)

adj_category_
mask

Ignore JNL_KEYS.adj_category for id_type? (1 = yes, 0 = no) (D: 1)

bit

(D: 1)

JNL_KEYS_MASK

Ignore JNL_KEYS.id_type2 for id_type? (1 = yes, 0 = no)

id_value2_mask bit

Null

Data Type

Comments

Values

currency_code_ bit
mask

Ignore JNL_KEYS.currency_code for id_type? (1 = yes, 0 = no) (D: 0)

mkt_code_mask bit

Ignore JNL_KEYS.mkt_code for id_type? (1 = yes, 0 = no)

tax_type_code_ bit
mask

Ignore JNL_KEYS.tax_type_code for id_type? (1 = yes, 0 = no) (D: 1)

element_id_
mask

bit

Ignore JNL_KEYS.element_id for id_type? (1 = yes, 0 = no)

open_item_id_
mask

bit

Ignore JNL_KEYS.open_item_id for id_type? (1 = yes, 0 = no)

(D: 0)

Null

JNL_KEYS_MASK

Field Name

(D: 1)

ABP-9.1-DR1-1999/09/30

303

J
304

JNL_RUNS
Dynamic, configurable. Maintains local information pertaining to journal runs. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: JNL
Triggers:

Indexes:
ABP-9.1-DR1-1999/09/30

Field Name

jnl_end_dt corresponds to exactly one row in JNL_CYCLE and cannot be duplicated.


jnl_run_dt is later than jnl_end_dt.
jnl_run_dt check is performed only for type 2 runs.
jnl_run_dt must be unique for type 2 runs.
server_id exists in SERVER_DEFINITION.
unique on jnl_end_dt, jnl_type, jnl_run_dt, jnl_backout, jnl_subcycle_end_dt
non-unique on jnl_type

Data Type

Comments

smalldt

End date of the journal cycle as defined in JNL_CYCLE.

jnl_subcycle_
end_dt

smalldt

End date of the journal subcycle as defined in JNL_SUBCYCLE, if


running subcycles.

jnl_type

tinyint

Type of journal run:


1 = Bill Cycle End
2 = Journal Cycle End
3 = Summarization (write to JNL_TRANS)
4 = Create summarized journal feed

jnl_run_dt

smalldt

Date and time when journal run should be processed.

jnl_backout

tinyint

Is this run a backout of a prior run? (1 = yes)

server_id

tinyint

Server ID, from SERVER_DEFINITION.

Null

Null
(R: 1, 2, 3, 4)

(R: 0, 1)
Null

JNL_RUNS

jnl_end_dt

Values

Configurable. Specifies start and end dates for JNL subcycles for daily JNL feeds. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: JNL.

Indexes:

Field Name

jnl_subcycle_start_dt is prior to the jnl_subcycle_end_dt.


New JNL_SUBCYCLE dates do not overlap with existing records.
Records must be for contiguous date ranges.
clustered, unique on jnl_subcycle_end_dt

Data Type

Comments

ABP-9.1-DR1-1999/09/30

jnl_subcycle_
start_dt

smalldt

Start date for journal subcycle.

jnl_subcycle_
end_dt

smalldt

End date for journal subcycle.

Values

Null

305

Triggers:

JNL_SUBCYCLE

JNL_SUBCYCLE

J
306

JURISDICTIONS
Configurable. Defines valid jurisdictions for detail usage records. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CAP, RAP, MIU, JNL
Indexes: primary-key on jurisdiction

Field Name
jurisdiction

Data Type
smallint

Comments

Values

Null

Unique internal identifier of the territorial range of the transaction. (R: > 0 and <
The value 255 is used by JNL to represent unknown jurisdiction in 32767)
JNL_KEYS, and should not be used as a jurisdiction field value.

ABP-9.1-DR1-1999/09/30

description_code smallint

Description from DESCRIPTIONS table.

jurisdiction_class smallint

Class of jurisdiction, from JURISDICTION_CLASS_REF.

Null

JURISDICTIONS

Configurable. Defines valid jurisdiction classes for detail usage record.Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CAP, RAP, MIU, JNL
Only one row may have is_default = 1.
unique on jurisdiction_class

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

jurisdiction_class smallint

Unique internal identifier of a class of jurisdictions.

(R: != 0)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

307

Triggers:
Indexes:

JURISDICTION_CLASS_REF

JURISDICTION_CLASS_REF

J
308

JURISDICTION_CLASS_VALUES
Configurable. Describes classes defined in JURISDICTION_CLASS_REF. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CAP, RAP, MIU, JNL
Triggers:
Indexes:

Field Name

jurisdiction_class exists in JURISDICTION_CLASS_REF.


language_code exists in LANGUAGE_CODE_REF.
unique on jurisdiction_class, language_code
Data Type

ABP-9.1-DR1-1999/09/30

jurisdiction_class smallint

Comments

Values

Null

Jurisdiction class identifier, from JURISDICTION_CLASS_REF.

language_code

smallint

display_value

varchar

80 Description of this jurisdiction class.

Language code, from LANGUAGE_CODE_REF.

short_display

char

10 Abbreviated version of the display value.

Null

JURISDICTION_CLASS_VALUES

Configurable. Defines valid language codes, which are associated with text elements in other tables. Admin table. Readonly copy exists on Customer server.
Used by the following modules: all GUI modules
Only one row may have is_default = 1.
primary-key on language_code

Triggers:
Indexes:

LANGUAGE_CODE_REF

LANGUAGE_CODE_REF

Foreign Keys:(language_code) must exist in LANGUAGE_CODE_REF(language_code)

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

language_code

smallint

Unique Language code.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

309

Field Name

L
310

LANGUAGE_CODE_VALUES
Configurable. Describes language codes defined in LANGUAGE_CODE_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


clustered, unique on input_language, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

input_language

smallint

Language to be used for retrieving screen descriptions.


For U.S. deployments, 1 = English.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Description of language_code, in input_language.


For example, Ingles if language_code is English and input_
language is Spanish. This value is compared to $ARBOR_GUI_
LANGUAGE when a GUI is launched, and the corresponding input_
language value is subsequently used for language-code lookups.

Abbreviated version of the display value.

Values

Null

Null

LANGUAGE_CODE_VALUES

Configurable. For internal use only. Defines language formatting information for language codes. Admin table.
Used by the following modules: IGEN
Indexes: unique on language_code
Foreign Keys:(language_code) must exist in LANGUAGE_CODE_REF(language_code)

language_code

Data Type
smallint

negative_before char

Comments

Values

Null

Language code, from LANGUAGE_CODE_REF.


3

ABP-9.1-DR1-1999/09/30

String of characters you want to print before a negative in this


locale.

char

String of characters you want to print after a negative in this locale.

precedence

char

Reserved for future use.

date_format1

varchar

20 Format picture for canned date format #1 for this locale.

Null

date_format2

varchar

20 Format picture for canned date format #2 for this locale.

Null

date_format3

varchar

20 Format picture for canned date format #3 for this locale.

Null

date_format4

varchar

20 Format picture for canned date format #4 for this locale.

Null

date_format5

varchar

20 Format picture for canned date format #5 for this locale.

Null

short_month1

varchar

Short form of first month in this locale.

Null

short_month2

varchar

Short form of second month in this locale.

Null

short_month3

varchar

Short form of third month in this locale.

Null

short_month4

varchar

Short form of fourth month in this locale.

Null

short_month5

varchar

Short form of fifth month in this locale.

Null

short_month6

varchar

Short form of sixth month in this locale.

Null

311

negative_after

Field Name

LANGUAGE_LOCALE

LANGUAGE_LOCALE

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

varchar

Short form of seventh month in this locale.

Null

short_month8

varchar

Short form of eighth month in this locale.

Null

short_month9

varchar

Short form of ninth month in this locale.

Null

short_month10

varchar

Short form of tenth month in this locale.

Null

short_month11

varchar

Short form of eleventh month in this locale.

Null

short_month12

varchar

Short form of twelfth month in this locale.

Null

long_month1

varchar

20 Long form of first month in this locale.

Null

long_month2

varchar

20 Long form of second month in this locale.

Null

long_month3

varchar

20 Long form of third month in this locale.

Null

long_month4

varchar

20 Long form of fourth month in this locale.

Null

long_month5

varchar

20 Long form of fifth month in this locale.

Null

long_month6

varchar

20 Long form of sixth month in this locale.

Null

long_month7

varchar

20 Long form of seventh month in this locale.

Null

long_month8

varchar

20 Long form of eighth month in this locale.

Null

long_month9

varchar

20 Long form of ninth month in this locale.

Null

long_month10

varchar

20 Long form of tenth month in this locale.

Null

long_month11

varchar

20 Long form of eleventh month in this locale.

Null

long_month12

varchar

20 Long form of twelfth month in this locale.

Null

am_text

char

String to print for before-noon times in this locale.

Null

pm_text

char

String to print for afternoon times in this locale.

Null

zero_text

char

String to print for zero values in this locale.

Null

LANGUAGE_LOCALE

short_month7

312

Field Name

LBX_ERROR

LBX_ERROR
Dynamic. Holds payments found to be in error by LBX. Admin table.
Used by the following modules: LBX, LIU
Indexes: unique on lbx_payment_id, source_id

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

account_no

int

Arbor/BP account number, from CMF.

Null

account_
category

tinyint

Account category identifier, from ACCOUNT_CATEGORY_REF.

Null

bill_ref_no

int

Arbor/BP invoice identifier, from BILL_INVOICE.

Null

Reset counter value for bill_ref_no.

Null

bill_ref_resets

tinyint

check_amount

numeric

18

Amount of customers check.

pay_amount

numeric

18

Portion of check-amount to be applied for this payment.

currency_code

smallint

micr_bank_id

varchar

20

Bank ID of the payment.

Null

micr_dda_num

varchar

20

Routing number of payment.

Null

micr_check_num varchar

15

Check number of payment.

Null

lbx_account_id

varchar

15

Lockbox account ID.

Null

deposit_dt

smalldt

Date payment was deposited in bank.

Null

trans_date_time char

10

File transfer date and time.

file_name

char

13

Name of lockbox data file.

source_id

char

10

Source ID, from LBX_SOURCE_ID_REF.

batch_type

char

Payment batch type.

Valid currency, from RATE_CURRENCY_REF.

Null

313

Field Name

Data Type

Comments

payment_type

char

Type of the payment record, from LBX_PAYMENT_TYPES and:


= balance payment
1 = dishonored check

lbx_payment_id

char

15

Code created by LBX to uniquely identify payment record.

lbx_error_status tinyint

ABP-9.1-DR1-1999/09/30

varchar

chg_dt

smalldt

Date and time this record was last modified.

error_code

int

Error causing lockbox failure.

to_date

smalldt

End date for the payment period.

arch_flag

bit

Has this record been archived? (1 = yes)

char

mkt_code

smallint

30

48

external_id_type smallint
annotation

varchar

Null

Lockbox error status, from LBX_ERROR_STATUS_REF.

chg_who

external_id

Values

314

Field Name

The username or process ID (for example; bip01, cap01) of the


user/process that last modified this record.

Null
(D: 0)

External account ID.

Null

Market code, from MKT_CODE_REF.

Null

External ID source identifier, from EXTERNAL_ID_TYPE_REF.


255 Additional transaction information from bank.

Null

18

Amount of the payment, in the external_currency.

gl_amount

numeric

18

Amount of the payment, in GL currency. Should be the same as


external_amount.

open_item_id

int

A valid open item, from OPEN_ITEM_ID_REF, to which this


payment is to be applied.

Null

external_
currency

smallint

Currency in which the payment was made. Must be a valid


currency, from RATE_CURRENCY_REF.

Null

LBX_ERROR

external_amount numeric

Static. Describes the valid lockbox bank statuses, for use in the lockbox investigation user interface. Admin table.
Used by the following modules: LIU
Only one row may have is_default = 1.
unique on lbx_error_status

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

lbx_error_status tinyint

Lockbox bank status identifier. Values are:


0 = new
1 = in use
2 = posted
3 = audit record

(R: 0, 1, 2, 3)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

315

Triggers:
Indexes:

LBX_ERROR_STATUS_REF

LBX_ERROR_STATUS_REF

L
316

LBX_ERROR_STATUS_VALUES
Configurable. Describes lockbox statuses defined in LBX_ERROR_STATUS_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


lbx_error_status exists in LBX_ERROR_STATUS_REF.
unique on lbx_error_status, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

lbx_error_status tinyint

Lockbox status identifier, from LBX_ERROR_STATUS_REF.

language_code

Language code, from LANGUAGE_CODE_REF.

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

LBX_ERROR_STATUS_VALUES

LBX_FILE_STATUS

LBX_FILE_STATUS
Dynamic. Records the status of each lockbox file. Admin table. Read-only copy exists on Customer server.
Used by the following modules: LBX, LIU
Indexes: unique on file_name, source_id

Data Type

Comments

ABP-9.1-DR1-1999/09/30

file_name

char

13 Lockbox file name.

naming_
extension

char

source_id

char

10 Source ID, from LBX_SOURCE_ID_REF.

trans_date_time char

Values

Extension to be added to file name after transfer (to help identify


file).

Null

Null

10 File transfer date/time YYMMDDHHMM.

lbx_file_status

smallint

File status. Values are:


-1 = error
0 = ready to process 1 = being processed
2 = done

proc_time

datetime

Date and time that the file was processed.

error_code

int

File level error code, 1001 - 1008.

total_check

numeric

18 Total of payments by checks.

total_dis_check

numeric

18 Total of dishonored checks.

total_ach

numeric

18 Total ACH.

total_wire

numeric

18 Total WIRE transfers (not used).

total_amt

numeric

18 Total for the file.

(R: -1, 0, 1, 2)

317

Field Name

Data Type

Comments

total_valid

int

Total valid payment records.

payment_
counter

int

Counter of records processed. This is used if reprocessing the file


due to errors. Also indicates total number of records processed.

ext_file_id

varchar

16 Code or grouping ID used by the lockbox source to identify the file


(other than the file name).

Values

Null

318

Field Name

Null

ABP-9.1-DR1-1999/09/30

LBX_FILE_STATUS

Configurable. Defines payment types for transactions generated via LBX. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: LBX, ATM

Indexes:

Field Name

source_id exists in LBX_SOURCE_ID_REF.


bmf_trans_type exists in BMF_TRANS_DESCR.
unique on source_id, ext_category
Data Type

Comments

ABP-9.1-DR1-1999/09/30

source_id

char

10 Source ID, from LBX_SOURCE_ID_REF.

ext_category

char

bmf_trans_type

smallint

Values

Null

External category code. This is the payment type as defined in the


lockbox bank file format.
Transaction type, from BMF_TRANS_DESCR.

319

Triggers:

LBX_PAYMENT_TYPES

LBX_PAYMENT_TYPES

L
320

LBX_POST_DATED
Dynamic. Holds payments by post-dated checks until date is current. Admin table.
Used by the following modules: LBX, LIU
Indexes: unique on lbx_payment_id, source_id
non-unique on deposit_dt, lbx_error_status

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

account_no

int

Arbor/BP account number, from CMF.

Null

account_
category

tinyint

Account category identifier, from ACCOUNT_CATEGORY_REF.

Null

bill_ref_no

int

Arbor/BP invoice identifier, from BILL_INVOICE.

Null

bill_ref_resets

tinyint

Reset counter value for bill_ref_no.

Null

check_amount

numeric

18 Amount of customers check.

pay_amount

numeric

18 Portion of check-amount to be applied for this payment.

currency_code

smallint

micr_bank_id

varchar

20 Bank ID of the payment.

Null

micr_dda_num

varchar

20 Routing number of payment.

Null

micr_check_num varchar

15 Check number of payment.

Null

lbx_account_id

varchar

15 Lockbox account ID.

Null

deposit_dt

smalldt

Valid currency, from RATE_CURRENCY_REF.

trans_date_time char

10 File transfer date and time.

file_name

char

13 Name of lockbox data file.

source_id

char

10 Source ID, from LBX_SOURCE_ID_REF.

Null

LBX_POST_DATED

Date payment was deposited in bank.

Null

Data Type

Comments

batch_type

char

Payment batch type.

payment_type

char

Type of the payment record, from LBX_PAYMENT_TYPES.


= balance payment
1 = dishonored check

lbx_payment_id

char

15 Code created by LBX to uniquely identify payment record.

Null

Lockbox error status, from LBX_ERROR_STATUS_REF.

ABP-9.1-DR1-1999/09/30

chg_who

varchar

30 The username or process ID (for example; bip01, cap01) of the


user/process that last modified this record.

chg_dt

smalldt

Date and time this record was last modified.

error_code

int

Error causing lockbox failure.

to_date

smalldt

End date for the payment period.

arch_flag

bit

external_id

char

mkt_code

smallint

Has this record been archived? (1 = yes)


48 External account ID.

Null
(D: 0)
Null

Market code, from MKT_CODE_REF.

external_id_type smallint

External source ID, from EXTERNAL_ID_TYPE_REF.

open_item_id

int

A valid open item, from OPEN_ITEM_ID_REF, to which this


payment is to be applied.

annotation

varchar

25 Additional transaction information from bank.


5
18 Amount of the payment, in the external_currency.

numeric

18 Amount of the payment, in GL currency. Should be the same as


external_amount.

external_
currency

smallint

Currency in which the payment was made. Must be a valid


currency, from RATE_CURRENCY_REF.

Null
Null

Null

321

external_amount numeric
gl_amount

Null

lbx_error_status tinyint

Values

LBX_POST_DATED

Field Name

L
322

LBX_SOURCE_ID_REF
Configurable. Lists and defines sources of the lockbox transaction files. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: LBX, LIU
Triggers:
Indexes:

Field Name
ABP-9.1-DR1-1999/09/30

source_id

Only one row may have is_default = 1.


currency_code exists in RATE_CURRENCY_REF.
unique on source_id

Data Type
char

Comments

How file should be acquired:


1 = modem

tinyint

cycle_expected

char

Null

10 LBX file source ID (for example; 0071000288, 0071000289).


Each of these sources should appear in TRANS_SOURCE_REF, as
well.

lbx_source_type tinyint
lbx_cycle_type

Values

(R: 1, 2)

2 = UNIX file

Indicates when files are expected (daily, and so on).


Cycle-type:
1 = daily (M-F,S,S)
2 = business daily (M-F)
2

(R: 1, 2)

path_name

varchar

80 Directory path where files may be found (if UNIX file).

naming_pattern

varchar

20 File naming pattern (if UNIX file).

naming_
extension

char

Extension to be added to file name after transfer (to help identify


file).

Null
Null

LBX_SOURCE_ID_REF

Indicates number of files expected per cycle (day, week). Values


can be any 2-digit number, or any 1-digit number followed by +.
Examples: 15 indicates 1 to 5 files per cycle, inclusive; 7+
indicates 7 or more files per cycle.

Data Type

Comments

Values

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

(R: > 0)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

LBX_SOURCE_ID_REF

Field Name

ABP-9.1-DR1-1999/09/30

323

L
324

LBX_SOURCE_ID_VALUES
Configurable. Describes lockbox transaction file sources defined in LBX_SOURCE_ID_REF. Admin table. Read-only copy
exists on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


source_id exists in LBX_SOURCE_ID_REF.
unique on source_id, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

source_id

char

language_code

smallint

short_display

char

display_value

varchar

80 Description of the source identifier (for example; LBX-LBB


288,LBX-CRP 289).

Values

Null

10 Source ID, from LBX_SOURCE_ID_REF.


Language code, from LANGUAGE_CODE_REF.
Abbreviated version of the display value.

Null

LBX_SOURCE_ID_VALUES

Configurable. Defines valid market codes, which appear in selection lists within the user interface. Admin table. Readonly copy exists on Customer server.
Used by the following modules: CUSTINFO, BIF

Field Name

Only one row may have is_default = 1.


unique on mkt_code

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

mkt_code

smallint

Identifies a specific market segment (must be > 0).

(R: > 0)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

325

Triggers:
Indexes:

MKT_CODE_REF

MKT_CODE_REF

M
326

MKT_CODE_VALUES
Configurable. Describes market codes defined in MKT_CODE_REF. Admin table. Read-only copy exists on Customer
server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


mkt_code exists in MKT_CODE_REF.
clustered, unique on mkt_code, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

mkt_code

smallint

Market segment identifier, from MKT_CODE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

MKT_CODE_VALUES

Configurable. Defines valid message groups, which appear in selection lists within the user interface. Admin table.
Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, BIF

Field Name
msg_grp_id

Only one row may have is_default = 1.


unique on msg_grp_id

Data Type
smallint

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

Unique internal ID of a customer group, used to control who


receives a given bill message.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

(D: 0)

327

Triggers:
Indexes:

MSG_GRP_ID_REF

MSG_GRP_ID_REF

M
328

MSG_GRP_ID_VALUES
Configurable. Describes customer message groups defined in MSG_GRP_ID_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


msg_grp_id exists in MSG_GRP_ID_REF.
clustered, unique on msg_grp_id, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

msg_grp_id

smallint

Customer message group ID, from MSG_GRP_ID_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

MSG_GRP_ID_VALUES

Configurable. Defines all valid network actions for the iCARE network provisioning interface. Admin table. Read-only
copy exists on Customer server.

net_action_id cannot be zero.


Only one row may have is_default = 1.
primary-key on net_action_id
unique on net_action_name

Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

net_action_id

smallint

Unique internal ID of a network action.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or


modify.

net_action_
name

char

Values

Null

16 Action name, used in HTTP commands.

329

Triggers:

NET_ACTION_REF

NET_ACTION_REF

N
330

NET_ACTION_VALUES
Configurable. Describes network actions defined in NET_ACTION_REF. Admin table. Read-only copy exists on
Customer server.
Indexes: clustered, unique on net_action_id, language_code
Foreign Keys:(net_action_id) must exist in NET_ACTION_REF(net_action_id)

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

net_action_id

smallint

Network action ID, from NET_ACTION_REF.

language_code

smallint

Language ID, from LANGUAGE_CODE_REF

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

NET_ACTION_VALUES

Configurable. Associates network actions with network interfaces. Admin table. Read-only copy exists on Customer
server.
Indexes: clustered, unique on net_interface_id, net_action_id

Data Type

Comments

ABP-9.1-DR1-1999/09/30

net_interface_id smallint

Network interface ID, from NET_INTERFACE_REF.

net_action_id

smallint

Network action ID, from NET_ACTION_REF.

is_immediate

bit

Reserved for future use.

cgi_url

varchar

Values

Null

25 Uniform Resource Locator (URL) of Common Gateway Interface


5 (CGI) application which is responsible for performing the network
action specified in net_action_id.

331

Field Name

NET_INTERFACE_ACTIONS

NET_INTERFACE_ACTIONS

N
332

NET_INTERFACE_ELIGIBILITY
Configurable. Specifies a net interface to use based on a set of of service-instance-level keys. Admin table. Read-only
copy exists on Customer server.
Indexes: clustered, unique on net_interface_id, mkt_code, rate_class, emf_config_id

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

mkt_code

smallint

Market code, from MKT_CODE_REF. Specifies for which mkt_code


this network interface is eligible, or Null to indicate any market
code.

Null

rate_class

smallint

Service-instance-level rate class, from RATE_CLASS_DESCR.


Specifies for which rate_class this network interface is eligible, or
Null to indicate any rate class.

Null

emf_config_id

smallint

Service instance configuration, from EMF_CONFIG_ID_REF.


Specifies for which emf_config_id this network interface is eligible,
or Null to indicate any emf_config_id.

Null

net_interface_id smallint

Network interface ID, from NET_INTERFACE_REF.

NET_INTERFACE_ELIGIBILITY

Configurable. Defines all valid network interfaces for the iCARE network provisioning interface. Admin table. Readonly copy exists on Customer server.

net_interface_id cannot be zero.


Only one row may have is_default = 1.
clustered, unique on net_interface_id

Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

net_interface_id smallint

Unique internal ID of a network interface.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or


modify.

net_interface_
name

char

Values

Null

16 Interface name, used in calling application.

333

Triggers:

NET_INTERFACE_REF

NET_INTERFACE_REF

N
334

NET_INTERFACE_VALUES
Configurable. Describes network interfaces defined in NET_INTERFACE_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_VALUES.


net_interface_id exists in NET_INTERFACE_REF.
clustered, unique on net_interface_id, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

net_interface_id smallint

Network interface ID, from NET_INTERFACE_REF.

language_code

smallint

Language ID, from LANGUAGE_CODE_REF

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

NET_INTERFACE_VALUES

Configurable. Defines valid note codes, which appear in selection lists within the user interface. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: CUSTINFO
Indexes: clustered, unique on note_code

Field Name

Data Type

note_code

char

language_code

smallint

Comments

Values

NOTE_CODES

NOTE_CODES

Null

Unique identifier of a note.


Language code, from LANGUAGE_CODE_REF.

ABP-9.1-DR1-1999/09/30

335

N
336

NOTE_TEXT
Configurable. Contains boilerplate text for notes in NOTE_CODES. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CUSTINFO
Triggers:
Indexes:

Field Name

note_code exists in NOTE_CODES.


clustered, unique on note_code, note_text

Data Type

Comments

ABP-9.1-DR1-1999/09/30

note_code

char

note_text

varchar

80 Pre-defined note text entry.

Values

Null

Note code identifier, from NOTE_CODES.

NOTE_TEXT

Configurable. Defines all valid non-recurring charge (NRC) types. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CUSTINFO, BIP, BIF, JNL
Triggers:

Foreign Keys:(currency_code) must exist in RATE_CURRENCY_REF(currency_code)

Field Name

Data Type

Comments

Values

Null

type_id_nrc

smallint

NRC type ID.

trigger_status

smallint

Reserved for future use.

(R: = 0)

trigger_level

smallint

Level at which to check status:


0 = Account level
1 = Service Instance level

(R: 0, 1)

provider_id

smallint

Service provider identifier, from SERVICE_PROVIDERS_REF.

Null

element_id

smallint

Product identifier, from PRODUCT_ELEMENTS.

Null

product_line_id

smallint

Product line the NRC type is restricted to, from PRODUCT_LINES.

Null

trans_sign

smallint

Indicates if charge is a debit:


1 = debit
-1 = credit
Description code from DESCRIPTIONS table.

337

description_code smallint

(R: -1, 1)

ABP-9.1-DR1-1999/09/30

Indexes:

type_id_nrc is unique and cannot be updated.


description_code, provider_id, and product_line_id exist in the appropriate tables (see below).
element_id exists in PRODUCT_ELEMENTS, and only one element_id exists for each type group.
If tax_location_nrc = 3, 12, 14 or rate_currency_location = 4, 5, or 6, trigger_level must be 1.
currency_group exists in RATE_CURRENCY_GROUP_REF or is null.
When currency_location is 9, currency_code must exist.
max_installments must be 0, if nrc_category = 1.
primary-key on type_id_nrc

NRC_TRANS_DESCR

NRC_TRANS_DESCR

N
tax_class

Data Type
smallint

Comments

Values

Null

338

Field Name

Only for deployments with VAT taxation. Tax class, from TAX_
RATES_VAT, or:
-1 = exempt
-2 = outside scope of tax law.

is_viewable

bit

Is the charge type viewable through the GUI? (1 = yes)

(D: 1)

is_modifiable

bit

Is the NRC type modifiable through the GUI? (1 = yes)

(D: 1)

is_enterable

bit

Is the NRC enterable through the GUI? (1 = yes)

(D: 1)

is_adjustable

bit

May the NRC type be adjusted? (1 = yes)

(D: 1)

is_journalable

bit

Should the NRC type be journaled? (1 = yes)

(D: 1)

is_displayed_
onbill

bit

Should this NRC type be displayed on the bill? (1 = yes)

(D: 1)

NRC_TRANS_DESCR

Indicator of taxable location for charge:


(R: 0, 1, 2, 3, 11,
0 = non-taxable
12, 14, 17, 18)
1 = CMF.bill_geocode
2 = CMF.cust_geocode
3 = EMF.service_geocode
11 = 4-point rule, supported only by certain Custom tax packages
12 = charge split between EMF.service_geocode + EMF.b_
service_geocode
14 = EMF.b_service_geocode (for subscription level
only)
17 = 2 out of 3 rule applied to CMF.cust_geocode,
EMF.service_geocode, and EMF.b_service_geocode
18 = 2 out of 3 rule applied to CMF.bill_geocode,
EMF.service_gecode, and EMF.b_service_geocode
Note: A geocode is made up of a number of different sub-codes.
For the 2 out of 3 rule, when there is a match of at least 2 of 3 for
any sub-code, this sub-code is used. When there is no match, the
sub-code and all subsequent ones are filled with zeros.

ABP-9.1-DR1-1999/09/30

tax_location_nrc tinyint

Data Type

Comments

Values

Null

Is this NRC enterable by a CSR? (1 = yes)

is_pretaxed

bit

Taxes may be entered for NRC in GUI when used for external
billing.

(D: 0)

split_booking

tinyint

Should journals split booking for this NRC type? (1 = yes, half of
revenue is booked to the rev_rcv_cost_ctr and half to the b_rev_
rcv_cost_ctr)

(D: 0) (R: 0, 1)

journal_delay

tinyint

Number of days to delay journalizing of charges of this type.

(D: 0)

installment_
type_id_nrc

int

Installment type ID of the non-recurring charge.

max_
installments

tinyint

Maximum number of installments:


If nrc_category = 1, this field should be 0.
If nrc_category = 2, 3, this field is the maximum number of
installments.

(D: 0)

nrc_category

tinyint

Category of the NRC:


1=normal
2=installment
3=refinance

(D: 1) (R: 1, 2, 3)

currency_group

smallint

Currency code group from RATE_CURRENCY_GROUP for currency_


code validation, or 0 for no restriction.

Null

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

Null

Null

339

ABP-9.1-DR1-1999/09/30

is_csr_enterable bit

NRC_TRANS_DESCR

Field Name

N
Data Type

Comments

ABP-9.1-DR1-1999/09/30

rate_currency_
location

smallint

Determines currency in which charges of this type are stored:


1 = CMF.currency_code for customer.
2 = COUNTRY_CODE_REF.default_currency_code for
CMF.cust_country_code for customer.
3 = Like 2, but for CMF.bill_country_code.
4 = EMF.currency_code for service instance.
5 = Like 2, but for EMF.service_country_code.
6 = Like 2, but for EMF.b_service_country_code.
7, 8 Do not use.
9 = currency_code.
10 = Specified by CSR or automatic feed.

component_id

int

Component ID associated with this NRC, from COMPONENT_


DEFINITIONS_REF.

rate_
component_id

bit

Use the component ID code for rating? (1 = yes)

equip_type_
code

smallint

Equipment type code associated with this NRC, from EQUIP_


TYPE_CODE_REF.

rate_equip_type bit

Use the equipment type for rating? (1 = yes)

equip_class_
code

Equipment class code associated with thei NRC, from EQUIP_


CLASS_CODE_REF.

smallint

Use the equipment class for rating? (1 = yes)

class_of_
service_code

smallint

Class of service code associated with this NRC, from CLASS_OF_


SERVICE_CODE_REF.

rate_class_of_
service

bit

Use the class of service for rating? (1 = yes)

open_item_id

int

Open item ID, from OPEN_ITEM_ID_REF.

Null

(D: 1) (R: 1, 2, 3,
4, 5, 6, 7, 8, 9,
10)

(D: 1)

NRC_TRANS_DESCR

rate_equip_class bit

Values

340

Field Name

Configurable. Associates individual non-recurring charges with non-recurring charge groups for a particular product.
Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, BIP, BIF, JNL

Field Name

description_code and type_id_nrc exist in appropriate tables.


unique on type_group_nrc, type_id_nrc

Data Type

Comments

ABP-9.1-DR1-1999/09/30

type_group_nrc

smallint

Non-recurring charge group ID.

type_id_nrc

smallint

Non-recurring charge type ID, from NRC_TRANS_DESCR.

description_code smallint

Values

Null

Description from DESCRIPTIONS table.

341

Triggers:
Indexes:

NRC_TYPE_GROUPS

NRC_TYPE_GROUPS

O
342

OPEN_ITEM_ID_REF
Configurable. Defines open items. Admin table. Read-only copy exists on Customer server.
Indexes: primary-key on open_item_id

Field Name

Data Type

Comments

open_item_id

int

Unique ID for the open item.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or


modify.

Values

Null

(R: != 0)

ABP-9.1-DR1-1999/09/30

OPEN_ITEM_ID_REF

Configurable. Describes open items defined in OPEN_ITEM_ID_REF. Admin table. Read-only copy exists on Customer
server.
Indexes: clustered, unique on open_item_id, language_code
Foreign Keys:(open_item_id) must exist in OPEN_ITEM_ID_REF(open_item_id)

Data Type

Comments

ABP-9.1-DR1-1999/09/30

open_item_id

int

Open item ID, from OPEN_ITEM_ID_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

343

Field Name

OPEN_ITEM_ID_VALUES

OPEN_ITEM_ID_VALUES

O
344

OPEN_ITEM_PRIORITY
Configurable. Defines the ordering of payment application to open item balances. Admin table. Read-only copy exists on
Customer server.
Indexes: unique on priority, regulatory_id
unique on open_item_id, regulatory_id
Foreign Keys:(open_item_id) must exist in OPEN_ITEM_ID_REF(open_item_id)
(regulatory_id) must exist in REGULATORY_ID_REF(regulatory_id)

Field Name
open_item_id

Data Type
int

Comments

Values

Null

Open item ID, from OPEN_ITEM_ID_REF.

ABP-9.1-DR1-1999/09/30

regulatory_id

smallint

Regulatory jurisdiction ID, from REGULATORY_ID_REF.

priority

smallint

Priority of the open item, applied in descending order (e.g., if


priorities 1 through 10 exist, 10 is the highest, or first priority, and 1
is the lowest, or last priority.

OPEN_ITEM_PRIORITY

Configurable. Defines owning cost centers for journaling purposes. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CUSTINFO
Only one owning_cost_ctr exists.
Only one row may have is_default = 1.
unique on owning_cost_ctr

Indexes:

Field Name

Data Type

ABP-9.1-DR1-1999/09/30

owning_cost_ctr smallint

Comments
Identifier for owning cost center.

Values

Null

(R: >= 1)

g_l_code

char

is_default

bit

19 General Ledger code for this owning cost center.


Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

(D: 0)

345

Triggers:

OWNING_COST_CTR_REF

OWNING_COST_CTR_REF

O
346

OWNING_COST_CTR_VALUES
Configurable. Describes cost centers defined in OWNING_COST_CTR_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


owning_cost_ctr exists in OWNING_COST_CTR_REF.
unique on owning_cost_ctr, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

owning_cost_ctr smallint

Owning cost center identifier, from OWNING_COST_CTR_REF.

language_code

Language code, from LANGUAGE_CODE_REF.

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

OWNING_COST_CTR_VALUES

Configurable. Associates each product package with several rating keys that are used to determine whether a particular
account is eligible to be provisioned with that package. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO

package_id exists in PACKAGE_DEFINITION_REF.


mkt_code exists in MKT_CODE_REF.
rate_class exists in RATE_CLASS_DESCR.
account_category exists in ACCOUNT_CATEGORY_REF or NULL.
Ensure that rate_class cannot be both NULL and not NULL for same unique index.
Ensure the active range of this table is within the active range of PACKAGE_DEFINITION_REF.
unique on package_id, mkt_code, rate_class, account_category, active_dt

Indexes:
ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

package_id

int

Package ID, from PACKAGE_DEFINITION_REF.

Values

Null

mkt_code

smallint

Value to be matched against CMF.mkt_code, or Null.

Null

rate_class

smallint

Value to be matched against CMF.rate_class, or Null.

Null

account_
category

tinyint

Value to be matched against CMF.account_category, or Null.

Null

active_dt

smalldt

Date eligibility requirement for this configuration becomes active.

inactive_dt

smalldt

Date eligibility requirement for this configuration becomes inactive.

Null

347

Triggers:

PACKAGE_CMF_ELIGIBILITY

PACKAGE_CMF_ELIGIBILITY

P
348

PACKAGE_COMPONENTS
Configurable. Defines the set of package components which comprise each product package. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: CUSTINFO

package_id and component_id exist in the appropriate tables (see below).


Active date range is within active date ranges for package_id and component_id.
minimum_required is less than or equal to maximum_allowed.
unique on package_id, component_id, active_dt

Triggers:

Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

int

Package ID, from PACKAGE_DEFINITION_REF.

component_id

int

Component ID, from COMPONENT_DEFINITION_REF.

minimum_
required

int

Minimum number of instances of this component which may be


provisioned.

maximum_
allowed

int

Maximum number of components that can be provisioned under


this package. The value in this field must be greater than the value
for minimum required. If you enter 0, Customer Care displays no
components for that package.

active_dt

smalldt

Date component becomes part of the package.

inactive_dt

smalldt

Date component is no longer part of the package.

Null

Null

PACKAGE_COMPONENTS

package_id

Values

Configurable. Defines the set of product elements and contract types associated with a package component. Admin
table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO

member_id and billing_frequency exist in appropriate tables.


No account-level products associated with service-instance-level components, or vice-versa.
unique on component_id, member_type, member_id
non-unique on component_id

Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

component_id

int

Component ID, from COMPONENT_DEFINITION_REF.

member_type

tinyint

Identifies the type of member (1 = product, 2 = contract).

member_id

int

PRODUCT_ELEMENTS.element_id or CONTRACT_
TYPES.contract_type.

member_
required

tinyint

Reserved for future use.

(R: 1)

offset_units

smallint

Units for start_dt_offset and duration.


140 = days, 150 = weeks, 160 = months, 170 = quarters, 180 =
years

(R: 140, 150,


160, 170, 180)

start_dt_offset

int

Number of offset_units after package provisioning date to begin


(R: >= 0)
billing component (date_rc_begin for product elements, start_dt for
contracts).

duration

int

Number of offset_units after initial billing to cease component, or 0 (R: >= 0)


(dont cease).

billing_frequency tinyint

Null

(R: 1, 2)

349

Billing frequency for product element. From BILLING_


FREQUENCY_REF or 0 (CMF.billing_frequency for account).

Triggers:

PACKAGE_COMPONENT_MEMBERS

PACKAGE_COMPONENT_MEMBERS

Data Type

Comments

Values

cycle_type

tinyint

What date should this product or contracts bill cycle


(R: 1, 2, 3)
be synchronized with?
1 = synchronize product bill cycle with CMF.bill_period.
2 = synchronize product bill cycle with product start date.
3 = synchronize the product/contract bill cycle to align with January
1st following the start date.

active_dt

smalldt

Date member becomes part of the component.

inactive_dt

smalldt

Date member is no longer part of the component.

Null

350

Field Name

Null

PACKAGE_COMPONENT_MEMBERS

ABP-9.1-DR1-1999/09/30

Configurable. Defines the set of available product packages. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
unique on package_id

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

package_id

int

Unique package ID.

package_group

smallint

Package group ID, from PACKAGE_GROUP_REF.

active_dt

smalldt

Date package becomes available for provisioning.

inactive_dt

smalldt

Date package becomes unavailable for provisioning.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 1)
Null
(D: 0)

351

Triggers:
Indexes:

PACKAGE_DEFINITION_REF

PACKAGE_DEFINITION_REF

P
352

PACKAGE_DEFINITION_VALUES
Configurable. Describes product packages defined in PACKAGE_DEFINITION_REF. Admin table. Read-only copy exists
on Customer server.

language_code exists in LANGUAGE_CODE_REF.


package_id exists in PACKAGE_DEFINITION_REF.
unique on package_id, language_code

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

package_id

int

Package ID, from PACKAGE_DEFINITION_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

PACKAGE_DEFINITION_VALUES

Configurable. Defines the set of available product package groups. Admin table. Read-only copy exists on Customer
server.
Only one row may have is_default = 1.
unique on package_group

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

package_group

smallint

Unique package group ID.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

353

Triggers:
Indexes:

PACKAGE_GROUP_REF

PACKAGE_GROUP_REF

P
354

PACKAGE_GROUP_VALUES
Configurable. Describes package groups defined in PACKAGE_GROUP_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


package_group exists in PACKAGE_GROUP_REF.
unique on package_group, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

package_group

smallint

Package group ID, from PACKAGE_GROUP_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

PACKAGE_GROUP_VALUES

PACKAGE_NRCS

PACKAGE_NRCS
This table is not currently supported. Admin table. Read-only copy exists on Customer server.

Indexes:

Field Name

package_id exists in PACKAGE_DEFINITION_REF.


type_id_nrc exists in NRC_TRANS_DESCR where level_code = 1.
unique on package_id, action_code, type_id_nrc, active_dt

Data Type

Comments

ABP-9.1-DR1-1999/09/30

package_id

int

Package ID, from PACKAGE_DEFINITION_REF.

action_code

smallint

Defines type of action performed on product package:


0 = Connect
1 = Disconnect
2 = Transfer

type_id_nrc

smallint

Type of NRC to be generated for action code, from NRC_TRANS_


DESCR.

active_dt

smalldt

Date NRC becomes member of package.

inactive_dt

smalldt

Date NRC terminates membership in package.

Values

Null

(R: 0, 1, 2)

Null

355

Triggers:

P
356

PAYMENT_FILE_DETAIL
Reserved for future use. Allows table-driven EFT output to a formatted file. Admin table. Read-only copy exists on
Customer server.
Indexes: unique on clearing_house_id, field_rec_pos

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

clearing_house_ char
id

field_id

char

30 Reserved for future use.

src_table

tinyint

Reserved for future use.

src_field

tinyint

Reserved for future use.

field_rec_pos

int

Reserved for future use.

field_length

int

Reserved for future use.

field_type

int

Reserved for future use.

field_format

int

Reserved for future use.

Values

Null

Reserved for future use.

PAYMENT_FILE_DETAIL

Reserved for future use. Admin table. Read-only copy exists on Customer server.
Indexes: unique on clearing_house_id, field_rec_pos

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

clearing_house_ char
id

Reserved for future use.

field_id

char

30 Reserved for future use.

src_table

tinyint

Reserved for future use.

Null

src_field

tinyint

Reserved for future use.

Null

field_rec_pos

int

Reserved for future use.

field_length

int

Reserved for future use.

field_type

int

Reserved for future use.

field_format

int

Reserved for future use.

357

Field Name

PAYMENT_FILE_HEADER

PAYMENT_FILE_HEADER

P
358

PAYMENT_FILE_TRAILER
Reserved for future use. Admin table. Read-only copy exists on Customer server.
Indexes: unique on clearing_house_id, field_rec_pos

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

clearing_house_ char
id

Reserved for future use.

field_id

char

30 Reserved for future use.

src_table

tinyint

Reserved for future use.

Null

src_field

tinyint

Reserved for future use.

Null

field_rec_pos

int

Reserved for future use.

field_length

int

Reserved for future use.

field_type

int

Reserved for future use.

field_format

int

Reserved for future use.

PAYMENT_FILE_TRAILER

PLAN_ID_CREDIT_REF

PLAN_ID_CREDIT_REF
Configurable. Defines valid unit credit plans. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, BIP, BIF, JNL
Only one row may have is_default = 1.
unique on plan_id_credit

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

plan_id_credit

smallint

Unique internal ID of a specific unit credit plan.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

359

Triggers:
Indexes:

P
360

PLAN_ID_CREDIT_VALUES
Configurable. Describes unit credit plans defined in PLAN_ID_CREDIT_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


plan_id_credit exists in PLAN_ID_CREDIT_REF.
clustered, unique on plan_id_credit, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

plan_id_credit

smallint

Unit credit plan ID, from PLAN_ID_CREDIT_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

PLAN_ID_CREDIT_VALUES

Configurable. Defines valid discount plans, included in the user interface. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO, BIP, BIF, JNL
Only one row may have is_default = 1.
clustered, unique on plan_id_discount

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

plan_id_discount smallint

Unique internal ID of a specific discount plan.

is_exclusive

bit

1 = Once applied to a charge, another exclusive discount cannot be (D: 0)


applied?

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

361

Triggers:
Indexes:

PLAN_ID_DISCOUNT_REF

PLAN_ID_DISCOUNT_REF

P
362

PLAN_ID_DISCOUNT_VALUES
Configurable. Describes discount plans defined in PLAN_ID_DISCOUNT_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


plan_id_discount exists in PLAN_ID_DISCOUNT_REF.
clustered, unique on plan_id_discount, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

plan_id_discount smallint

Discount plan ID, from PLAN_ID_DISCOUNT_REF.

language_code

Language code, from LANGUAGE_CODE_REF.

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

PLAN_ID_DISCOUNT_VALUES

Configurable. Lists and describes valid usage point categories, used in USAGE_POINTS and USAGE_TYPES. Common
categories include phone numbers, billing zones (phone number prefixes), email/network addresses, and
document/object identifiers. Usage point categories may overlap. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CAP, RAP, MIU
Only one row may have is_default = 1.
primary-key on point_category

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

point_category

smallint

Unique internal identifier of a usage point category.

(D: 0)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

363

Triggers:
Indexes:

POINT_CATEGORY_REF

POINT_CATEGORY_REF

P
364

POINT_CATEGORY_VALUES
Configurable. Describes point categories defined in POINT_CATEGORY_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


point_category exists in POINT_CATEGORY_REF.
clustered, unique on point_category, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

point_category

smallint

Point category, from POINT_CATEGORY_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

POINT_CATEGORY_VALUES

Configurable. Lists and describes valid usage point classes, which are used to categorize usage events for later rating and
guiding (see USAGE_POINTS, RATE_PERIODS and RATE_USAGE tables). Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CAP, RAP, MIU

Field Name

Only one row may have is_default = 1.


clustered, unique on point_class

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

point_class

int

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

Unique internal identifier of a usage point class.


(D: 0)

365

Triggers:
Indexes:

POINT_CLASS_REF

POINT_CLASS_REF

P
366

POINT_CLASS_VALUES
Configurable. Describes usage point classes defined in POINT_CLASS_REF. Admin table. Read-only copy exists on
Customer server.

language_code exists in LANGUAGE_CODE_REF.


point_class exists in POINT_CLASS_REF.
clustered, unique on point_class, language_code

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

point_class

int

Point class, from POINT_CLASS_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

POINT_CLASS_VALUES

Configurable. Defines valid point regions for derivation of jurisdiction of usage events. For North American telephony
deployments, for example, point_regions would be NPA values. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU
Only one row may have is_default = 1.
unique on point_region

Field Name

Data Type
8

Comments

Values

ABP-9.1-DR1-1999/09/30

point_region

char

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

Unique internal identifier of a usage point region.


(D: 0)

367

Triggers:
Indexes:

POINT_REGION_REF

POINT_REGION_REF

P
368

POINT_REGION_VALUES
Configurable. Describes point regions defined in POINT_REGION_REF. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CAP, RAP, MIU
Triggers:
Indexes:

Field Name

point_region exists in POINT_REGION_REF.


language_code exists in LANGUAGE_CODE_REF.
unique on point_region, language_code
Data Type

ABP-9.1-DR1-1999/09/30

Comments

point_region

char

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

Point region, from POINT_REGION_REF.


Language code, from LANGUAGE_CODE_REF.
Abbreviated version of the display value.

Null

POINT_REGION_VALUES

Configurable. Holds valid privacy levels for B-number masking in the Customer Care interface and on invoices. Admin
table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, BIF
Only one row may have is_default = 1.
unique on privacy_level

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

privacy_level

smallint

Unique identifier for this privacy level; also specifies the number of (R: >= -1)
digits to truncate from the B-number:
0 = no truncation
-1 = total truncation
>=1 = partial truncation; indicates the number of digits to be
deleted, starting with the rightmost digit.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

369

Triggers:
Indexes:

PRIVACY_LEVEL_REF

PRIVACY_LEVEL_REF

P
370

PRIVACY_LEVEL_VALUES
Configurable. Describes privacy levels defined in PRIVACY_LEVEL_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


privacy_level exists in PRIVACY_LEVEL_REF.
clustered, unique on privacy_level, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

privacy_level

smallint

Privacy level identifier, from PRIVACY_LEVEL_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

PRIVACY_LEVEL_VALUES

Dynamic. Coordinates queue names between processes, instances, and machines to prevent conflicts. Admin table.
Read-only copy exists on Customer server.
Indexes: unique on instance_name, queue_name
unique on hostname, instance_name, queue_name
non-unique on category

Data Type

Comments

ABP-9.1-DR1-1999/09/30

category

tinyint

hostname

char

32 Name of the machine hosting the process.

instance_name

char

32 Name of the instance. The instance will reflect what multiple


processes have in common. For example, BIF and BIP could be an
instance called hotinvoicing.

queue_name

char

32 The queue name.

process_name

char

Values

Null

Category of queue, for example, hot invoicing.

Name of the process that started the queue and reads from it, for
example, bip01.

371

Field Name

PROCESS_QUEUE

PROCESS_QUEUE

P
372

PROCESS_SCHED
Dynamic. Associates tasks with each instance of an Arbor/BP process. Maintained locally for Admin and Customer
servers.
Used by the following modules: All batch processes
Indexes: clustered, unique on process_name, task_name

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

char

Name of Arbor/BP process instance (for example; cap01, cap02).

task_name

char

Task ID for the process to execute.

task_cycle

char

(R)ecurring or (N)on-recurring indicator.

task_mode

int

Mode of operation:
0 = production
1 = test (not used for all process types)
2 = flash (not currently used) 3 = pro-forma (BIP)
4 = redo (not currently used) 5 = disconnect credits only (BIP)
6 = backout (BIP)
7 = HQ discount (BIP)
For ARCH tasks:
0 = delete only
1 = count only
3 = archive and delete
4 = restore an invoice
6 = restore entire archive

sched_start

datetime

Date/time for process to start this task.

task_intrvl

int

Interval (in seconds) between task executions (for example


86400 = every 24 hours).

task_status

int

Current status of the task.

task_priority

int

Priority of the task.

slide_time

int

Not currently used.

Null

Null
(R: R,N,r,n)

(R: > 0)

PROCESS_SCHED

process_name

Values

Data Type

Comments

db_name

char

30 Not currently used.

sql_query

char

80 Appended to the processs standard SQL query to further define


data to be worked on; usually it is in the form of a where clause
phrase.

debug_level

int

plat_id

char

usg_crt_hour

int

usg_plat_id

char

usg_version

int

Not currently used.


8
8

Values

Null

Null

(R: 0, 1, 2, 3)

Not currently used.

Null

Not currently used.

Null

Not currently used.

Null

Not currently used.

Null

PROCESS_SCHED

Field Name

ABP-9.1-DR1-1999/09/30

373

P
374

PROCESS_STATUS
Dynamic. Holds status information for each task in PROCESS_SCHED. Do not modify this table except during error
recovery. Maintained locally for Admin and Customer servers.
Used by the following modules: All batch processes
Indexes: unique on process_name

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

hostname

char

32 Name of host running process.

process_name

char

process_pid

int

Values

Null
Null

Name of Arbor/BP process instance (for example; cap01, cap02).


UNIX process ID.

char

process_status

int

1 = INIT (initializing process)


4 = POSTPROC (completing task)
5 = PREPROC (initializing task)
6 = IDLE (process is waiting for next tasks start time)
7 = LOGOUT (process has been stopped)
8 = ABORT (process has been aborted; system failure)
9 = Rating (RAP only)
10 = Processing messages (BEM only)
12 = ERROR (process in an error condition)
20 = TASK_INIT (initializing task)
21 = PROC (processing task)
31 = COLLECT (BIP only)
33 = COMMIT (BIP only)

Task on which process is currently working, or last worked.

chg_date

datetime

Date and time this record was last modified.

comments

char

80 Additional information on status of the process.

Null

Null

PROCESS_STATUS

task_name

Configurable. Defines valid product elements and associates each with information from other tables (for example,
service provider, recurring charge, usage and/or non-recurring charge, tax class, and so on). Admin table. Read-only
copy exists on Customer server.
Used by the following modules: BIP, CAP, RAP, MIU, CUSTINFO
Triggers:

ABP-9.1-DR1-1999/09/30

Indexes:

type_group_nrc exists in NRC_TYPE_GROUPS, compatible with product definition in NRC_TRANS_DESCR.


type_group_usg is compatible with product definition in USAGE_TYPES.
description_code, product_line_id, and provider_id exist in appropriate tables (see below).
class_of_service_code , equip_type_code , external_id_type , equip_class_code and type_group_usg exist in
appropriate tables (see below) or are 0.
currency_group exists in RATE_CURRENCY_GROUP_REF or is NULL.
currency_code must be defined if rate_currency_location is 9.
rate_currency_location can be 4, 5, or 6 only for subscription-level products.
advance_periods can be updated only if alternate_frequencies_allowed = 1.
If tax_location_rc = 12, level_code must be 2. If tax_location_rc = 3 or 14, level_code cannot be 1.
level_code and element_id cant be updated.
auto_activation must be 0 for account level products.
If not NULL, date_inactive cannot be earlier than date_active.
primary-key on element_id
non-unique on equip_type_code, equip_class_code, class_of_service_code

PRODUCT_ELEMENTS

PRODUCT_ELEMENTS

Foreign Keys:(open_item_id) must exist in OPEN_ITEM_ID_REF(open_item_id)


(currency_code) must exist in RATE_CURRENCY_REF(currency_code)

element_id

Data Type
smallint

Comments

Null

Unique product ID.


Description, from DESCRIPTIONS.

product_line_id

Product line ID, from PRODUCT_LINES.

Null

375

description_code smallint
smallint

Values

Field Name

Data Type

Comments

provider_id

smallint

Service provider ID, from SERVICE_PROVIDERS_REF.

equip_type_
code

smallint

Service instance type, from EQUIP_TYPE_CODE_REF, or 0 (all).

rate_equip_type bit

Use EMF.equip_type_code as rate key? (1 = yes) If not, 0 is


used.

equip_class_
code

Service instance class from EQUIP_CLASS_CODE_REF, or 0 (all).

smallint

ABP-9.1-DR1-1999/09/30

rate_equip_class bit

Use EMF.equip_class_code as rate key? (1 = yes) If not, 0 is


used.

class_of_
service_code

smallint

Class of service from CLASS_OF_SERVICE_CODE_REF, or 0 (all).

rate_class_of_
service

bit

Use EMF.class_of_service_code as rate key? (1 = yes) If


not, 0 is used.

Values

Usage type group supported by the product (from USAGE_TYPE_


GROUPS), or 0.

type_group_nrc

smallint

NRC type group supported by the product (from NRC_TYPE_


GROUPS), or 0.

type_id_rc

smallint

Determines if recurring charge should be calculated based on units (R: 1, 2)


(the pop_units field in the EMF table):
1 = not distance sensitive 2 = distance sensitive

tax_class

smallint

Tax class of product, from TAX_RATES_VAT, or:


-1 = exempt
-2 = outside scope of tax law
Only used for deployments with VAT taxation.

PRODUCT_ELEMENTS

type_group_usg smallint

Null

376

Field Name

Comments

Values

tinyint

Indicator of taxable location for recurring charge:


(R: 0, 1, 2, 3, 11,
0 = non-taxable
12, 14, 17, 18)
1 = CMF.bill_geocode
2 = CMF.cust_geocode
3 = EMF.service_geocode
11 = 4-point rule, supported only by certain Custom tax packages
12 = charge split bewteen EMF.service_geocode + EMF.b_
service_geocode
14 = EMF.b_service_geocode (for subscription level
only)
17 = 2 out of 3 rule applied to CMF.cust_geocode,
EMF.service_geocode, and EMF.b_service_geocode
18 = 2 out of 3 rule applied to CMF.bill_geocode,
EMF.service_gecode, and EMF.b_service_geocode
Note: A geocode is made up of a number of different sub-codes.
For the 2 out of 3 rule, when there is a match of at least 2 of 3 for
any sub-code, this sub-code is used. When there is no match, the
sub-code and all subsequent ones are filled with zeros.

date_active

smalldt

Date the product element becomes available for provisioning.

ABP-9.1-DR1-1999/09/30

tax_location_rc

date_inactive

smalldt

Date the product element is no longer available for provisioning.

date_created

smalldt

Date product element was created.

foreign_product_ char
code

Null

Reserved for future use. Use 0.

bit

Bill this product in arrears? (1 = yes)

level_code

tinyint

1 = account level

contract_use_
code

tinyint

0 = provision directly or through contract


1 = provision only through contract
2 = cannot provision through contract

2 = service instance level 0 = either

Null

(D: 0) (R: 0, 1, 2)
(D: 0) (R: 0, 1, 2)

377

bill_in_arrears

Null

Data Type

PRODUCT_ELEMENTS

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

activation_code

tinyint

1 = prorate charge for incomplete activation cycle


2 = charge full amount for incomplete activation cycle
3 = charge nothing at all for incomplete activation cycle

termination_
code

tinyint

1 = prorate charge for disconnect credit when product is terminated (D: 1) (R: 1, 2, 3)
2 = use full amount for disconnect credit when product is
terminated
3 = use no amount for disconnect credit when product is terminated

auto_credit_
code

tinyint

1,2 = Generate normal disconnect credits


3 = Generate disconnect credits with an amount of 0.

rate_
component_id

bit

Use component_id as rate key? (1 = yes) If not, 0 is used.

(D: 1) (R: 1, 2, 3)

(D: 1) (R: 1, 2, 3)

rate_rate_class

bit

Use rate_class as rate key? (1 = yes) If not, 0 is used.

allow_
alternative_bill_
period

bit

Can alternate billing periods be defined for this product in EMF_


PRODUCTS and/or CMF_PRODUCTS? (1 = yes)

split_booking

tinyint

Should journals split booking for this product? (1 = yes, half


of revenue is booked to the rev_rcv_cost_ctr and half to the
b_rev_rcv_cost_ctr)

(D: 0) (R: 0, 1)

rate_zone

bit

Use inzone/outzone as usage rate key? (1 = yes, 0 = no)

(D: 0)

External ID type, from EXTERNAL_ID_TYPE_REF, to use when


(D: 0)
interpreting external IDs for this product. 0 implies no external IDs.

advance_
periods

Number of billing periods to bill for when the product is billed in


advance. Has no effect when products is billed in arrears.

(D: 1) (R: >= 1)

PRODUCT_ELEMENTS

external_id_type smallint
tinyint

Null

378

Field Name

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

auto_activation

tinyint

Determines when recurring charges are first calculated:


(D: 0) (R: 0, 1, 2)
0 = First cycle, independent of usage.
1 = First cycle in which usage for the product occurs.
2 = Like 1, but start charging all products of this type provisioned to
a single service instance as soon as a single provisioned product
incurs usage.

currency_group

smallint

Currency code group from RATE_CURRENCY_GROUP for currency_


code validation, or 0 for no restriction.

Null

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

Null

rate_currency_
location

smallint

Determines currency in which charges of this type are stored:


1 = CMF.currency_code for customer.
2 = COUNTRY_CODE_REF.default_currency_code for
CMF.cust_country_code for customer.
3 = Like 2, but for CMF.bill_country_code.
4 = EMF.currency_code for service instance.
5 = Like 2, but for EMF.service_country_code.
6 = Like 2, but for EMF.b_service_country_code.
7, 8 Do not use.
9 = currency_code.
10 Do not use.

(D: 1) (R: 1, 2, 3,
4, 5, 6, 7, 8, 9,
10)

open_item_id

int

Open item ID, from OPEN_ITEM_ID_REF.

(D: 1)

379

Data Type

PRODUCT_ELEMENTS

Field Name

P
380

PRODUCT_ELEMENT_RELATIONS
This table is not currently supported. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

element_id and related_element_id exist in PRODUCT_ELEMENTS.


unique on element_id, related_element_id

Data Type

Comments

smallint

The base element_id for the relationship, from PRODUCT_


ELEMENTS.

related_
element_id

smallint

The element_id which is the object of the relationship, from


PRODUCT_ELEMENTS.

relationship_type tinyint

Defines the type of relationship:


0 = base depends on object
1 = base and object are incompatible

Null

(R: 0, 1)

PRODUCT_ELEMENT_RELATIONS

ABP-9.1-DR1-1999/09/30

element_id

Values

Configurable. Describes valid product groups, with which product lines can be associated. Admin table. Read-only copy
exists on Customer server.
Used by the following modules: BIP, BIF, JNL
Indexes: unique on product_group_id

Data Type

Comments

ABP-9.1-DR1-1999/09/30

product_group_ smallint
id

Product group ID.

description_code smallint

Description from DESCRIPTIONS table.

Values

Null

381

Field Name

PRODUCT_GROUPS

PRODUCT_GROUPS

P
382

PRODUCT_LINES
Configurable. Defines valid product lines, with which product elements can be associated. Admin table. Read-only copy
exists on Customer server.
Used by the following modules: BIP, BIF, JNL
Triggers:

Indexes:

Field Name
ABP-9.1-DR1-1999/09/30

product_line_id

usage_data_table, usage_audit_table, usage_free_table, usage_audit_view, and usage_bad_table must be


NULL.
product_group_id and description_code exist in the appropriate tables (see below).
primary-key on product_line_id

Data Type
smallint

char

description_code smallint

Values

Null

Unique internal ID of a product line with which product elements


may be associated.

product_group_ smallint
id
foreign_group_
code

Comments

Product group ID, from PRODUCT_GROUPS.


4

Code by which the external accounting system recognizes the


product line; reserved for future use.

Null

Description from DESCRIPTIONS table.

char

32 Table containing usage data; reserved for future use.

Null

usage_audit_
table

char

32 Table containing audit information; reserved for future use.

Null

PRODUCT_LINES

usage_data_
table

Data Type

Comments

Values

Null

usage_free_
table

char

32 View for audit information; reserved for future use.

Null

usage_audit_
view

char

32 View for audit information; reserved for future use.

Null

usage_bad_
table

char

32 Table for bad CDR image; reserved for future use.

Null

PRODUCT_LINES

Field Name

ABP-9.1-DR1-1999/09/30

383

P
384

PROVIDER_ADDRESS
Configurable. Contains the address of each service provider in SERVICE_PROVIDERS_REF. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: BIP, BIF, JNL
Triggers:
Indexes:

Field Name

provider_id and provider_country_code exist in the appropriate tables (see below).


clustered, unique on provider_id

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

smallint

Service provider identifier, from SERVICE_PROVIDERS_REF.

provider_name

varchar

56 Service provider name.

provider_
address1

varchar

75 Service provider address, line 1.

provider_
address2

varchar

75 Service provider address, line 2.

Null

provider_
address3

varchar

75 Service provider address, line 3.

Null

provider_city

varchar

35 Service provider city.

provider_state

varchar

28 Service provider state.

provider_zip

varchar

16 Service provider ZIP code.

provider_
country_code

smallint

Service provider country, from COUNTRY_CODE_REF.

(D: 840)

PROVIDER_ADDRESS

provider_id

Configurable. Describes valid classes of service providers. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU
Only one row may have is_default = 1.
clustered, unique on provider_class

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

provider_class

smallint

Provider class identifier.

(R: > 0)

rate_class

smallint

Service instance level rate class, from RATE_CLASS_


DESCR.rate_class.

Null

equip_type_
code

smallint

Service instance type.

Null

equip_class_
code

smallint

Service instance class.

Null

class_of_
service_code

smallint

Class of service code, from CLASS_OF_SERVICE_CODE_REF, or


0 (all).

Null

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

Null

element_id

smallint

Unique product ID.

Null

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

(D: 0)

385

Triggers:
Indexes:

PROVIDER_CLASS_REF

PROVIDER_CLASS_REF

P
386

PROVIDER_CLASS_VALUES
Configurable. Describes provider classes defined in PROVIDER_CLASS_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


provider_class exists in PROVIDER_CLASS_REF.
clustered, unique on provider_class, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

provider_class

smallint

Provider class, from PROVIDER_CLASS_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

PROVIDER_CLASS_VALUES

Configurable. Defines usage unit types (for example, KB for kilobytes), which are used in bill formatting and
adjustments. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, BIP, BIF, JNL
Only one row may have is_default = 1.
unique on ratable_unit_class

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

ratable_unit_
class

smallint

Ratable units type.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

387

Triggers:
Indexes:

RATABLE_UNIT_CLASS_REF

RATABLE_UNIT_CLASS_REF

R
388

RATABLE_UNIT_CLASS_VALUES
Configurable. Describes units types defined in RATABLE_UNIT_CLASS_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


ratable_unit_class exists in RATABLE_UNIT_CLASS_REF.
clustered, unique on ratable_unit_class, language_code
Data Type

Comments

smallint

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

format_display

char

10 Text description for bill format display.

Null

Ratable units type, from RATABLE_UNIT_CLASS_REF.


Language code, from LANGUAGE_CODE_REF.
Abbreviated version of the display value.

(D: 1)
Null

RATABLE_UNIT_CLASS_VALUES

ABP-9.1-DR1-1999/09/30

ratable_unit_
class

Values

Configurable. Defines aggregate usage rate profiles. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIP

ABP-9.1-DR1-1999/09/30

Indexes:

Field Name

active_dt must be earlier than or equal to inactive_dt and cannot be modified.


If inactive_dt for a record is modified, all records with the same key field values are modified as well.
Active date range cannot overlap an existing active date range with the same key field values.
upper_limit must be greater than lower_limit, unless upper_limit is zero.
upper_limit and lower_limit must be contiguous for all the records with a given set of key field values.
aggr_usage_id, rate_class, billing_frequency, jurisdiction, provider_id, element_id, currency_code, equip_
type_code, equip_class_code, and class_of_service_code exist in the appropriate tables (see below).
All rows with the same currency_code must have the same rate_implied_decimal.
unique on aggr_usage_id, rate_class, billing_frequency, jurisdiction, provider_id, element_id, equip_type_
code, equip_class_code, class_of_service_code, currency_code, upper_limit
Data Type

Comments

Values

aggr_usage_id

smallint

Aggregate rate ID, from AGGR_USAGE_DEFINITIONS_REF.

rate_class

smallint

Rate key from RATE_CLASS_DESCR or 0 (all).

billing_frequency smallint

Billing frequency, from BILLING_FREQUENCY_REF.

jurisdiction

smallint

Territorial range of usage, from JURISDICTIONS or 0 (all).

provider_id

smallint

Service provider, from SERVICE_PROVIDERS_REF.

element_id

smallint

Product identifier, from PRODUCT_ELEMENTS.

equip_type_
code

smallint

Service instance type, from EQUIP_TYPE_CODE_REF.

equip_class_
code

smallint

Rating zone, from EQUIP_CLASS_CODE_REF.

Null

389

Triggers:

RATE_AGGR_USAGE

RATE_AGGR_USAGE

Data Type

Comments

class_of_
service_code

smallint

Equipment service class, from CLASS_OF_SERVICE_CODE_REF.

lower_limit

int

Minimum amount of usage for rate to apply.

ABP-9.1-DR1-1999/09/30

upper_limit

int

Maximum amount of usage for rate to apply (0 if unbounded).

currency_code

smallint

Currency code for the rating currency, from RATE_CURRENCY_


REF.

fixed_amount

numeric

active_dt

smalldt

Earliest date at which this rate can be used.

inactive_dt

smalldt

Date the rate can no longer be applied.

create_dt

smalldt

Date the rate was created.

change_dt

smalldt

change_who

char

rate_implied_
decimal

smallint

Values

Null

390

Field Name

Null

18 Rate, with the normal number of implied decimal points for


currency type (for example, 2500 for US$25.00).
Null

Date the rate was last changed.


30 ID of user who last changed the rate.
Reserved for future use.

(D: 3)

RATE_AGGR_USAGE

Configurable. Defines and describes valid rate classes, which are used in rating and discounting. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: CUSTINFO, BIP, BIF

description_code exists in DESCRIPTIONS.


primary-key on rate_class

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

rate_class

smallint

Unique internal identifier of rating component.

is_default

bit

Use this record as the default value? (1 = yes)

description_code smallint

Description from DESCRIPTIONS table.

level_code

1 = account level
2 = service instance level
0 = either

tinyint

Values

Null

(D: 0) (R: 0, 1, 2)

391

Triggers:
Indexes:

RATE_CLASS_DESCR

RATE_CLASS_DESCR

R
392

RATE_CURRENCY
Configurable. Defines exchange rates between each currency and the operating currency. Admin table. Read-only copy
exists on Customer server.

exrate_class exists in EXRATE_CLASS_REF.


currency_code exists in RATE_CURRENCY_REF.
active_dt is earlier than or equal to inactive_dt unless inactive_dt is NULL.
If currency_code is operating (default) currency, exchange_rate must be 1, inactive_dt must be NULL, and
implied_decimal must be 0.
Active date bands cannot overlap for a single currency.
unique on rate_currency_id
unique on exrate_class, currency_code, charge_type, active_dt

Triggers:

Indexes:
ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

Values

rate_currency_id int

Unique exchange rate ID.

exrate_class

smallint

Exchange rate class, from EXRATE_CLASS_REF.

currency_code

smallint

Currency to exchange from, from RATE_CURRENCY_REF.

charge_type

tinyint

Type of charge: long-term (1) or short term (2).


Use 1 for recurring charges and 2 for all other charge types.

exchange_rate

int

Stores either the multiplier from amounts in this currency to


(R: != 0)
amounts in the operating currency, or the multiplier from amounts
in the operating currency to amounts in this currency, depending on
the CONVERT_CURRENCY_DIRECTION system parameter.
Implied decimal points for exchange_rate.

smalldt

Date on which this exchange rate becomes active.

inactive_dt

smalldt

Date on which this exchange rate becomes inactive.

(R: 1, 2)

Null

RATE_CURRENCY

implied_decimal smallint
active_dt

Null

Data Type

create_dt

smalldt

chg_who

char

base_currency

smallint

Comments

Values

Date on which this record was created.


30 User or process ID that most recently changed this record.
Alternate currency for which this currency may be considered a
denomination.

Null

RATE_CURRENCY

Field Name

ABP-9.1-DR1-1999/09/30

393

R
394

RATE_CURRENCY_GROUP
Configurable. Maps currency code groups to currency codes. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

currency_group exists in RATE_CURRENCY_GROUP_REF.


currency_code exists in RATE_CURRENCY_REF.
unique on currency_group, currency_code

Data Type

Comments

currency_group

smallint

Currency group ID, from RATE_CURRENCY_GROUP_REF.

currency_code

smallint

Currency code in this group, from RATE_CURRENCY_REF.

Values

Null

ABP-9.1-DR1-1999/09/30

RATE_CURRENCY_GROUP

Configurable. Defines valid currency code groups. Admin table. Read-only copy exists on Customer server.
Only one row can have is_default = 1.
unique on currency_group

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

currency_group

smallint

Unique valid currency code group ID.

(R: > 0)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

395

Triggers:
Indexes:

RATE_CURRENCY_GROUP_REF

RATE_CURRENCY_GROUP_REF

R
396

RATE_CURRENCY_GROUP_VALUES
Configurable. Describes currency code groups. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


currency_group exists in RATE_CURRENCY_GROUP_REF.
unique on currency_group, language_code

Data Type

Comments

smallint

Currency code group ID, from RATE_CURRENCY_GROUP_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Short text description of the currency code group.

Null

Null

RATE_CURRENCY_GROUP_VALUES

ABP-9.1-DR1-1999/09/30

currency_group

Values

RATE_CURRENCY_REF

RATE_CURRENCY_REF
Configurable. Defines all supported currencies. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIP, CUSTINFO, CAP, RAP, MIU, JNL

Indexes:

Field Name

currency_type exists in CURRENCY_TYPE_REF


Only one row may have is_default = 1
Only one row may have is_coversion_default = 1
primary-key on currency_code
Data Type

ABP-9.1-DR1-1999/09/30

currency_code

smallint

currency_type

char

implied_decimal smallint

Comments

Values

Unique internal currency ID.


1

Null

(R: > 0)

Type of currency, from CURRENCY_TYPE_REF.


Number of implied decimal places in whole integer amounts (for
example, 2 for U.S. dollars, since .01 dollars is smallest billable
unit).

active_date

datetime

Date when currency becomes effective.

inactive_date

datetime

Reserved for future use.

format_code

smallint

Currency formatting code. Not currently used.

rounding_factor

smallint

Controls currency rounding; see rounding_method. For example, if (D: 1) (R: >= 1)
rounding_factor = 1 and implied_decimal = 2, amounts are
rounded to the nearest hundredth for billing.

rounding_
method

tinyint

0 = no rounding (in other words, truncate)


1 = always round to the next lower multiple of rounding_factor
2 = round to next higher multiple
3 = round to nearest multiple (round up if exactly half)
4 = round to nearest multiple (round down if exactly half)

(R: = NULL)

Null
Null

(D: 0) (R: 0, 1, 2,
3, 4)

397

Triggers:

Data Type

Comments

Values

is_conversion_
default

bit

Currency used for currency conversion? (1=yes).

is_symbol_first

bit

Does the currency symbol appear before the number? (1 = yes)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

398

Field Name

(D: 0)

(D: 0)

ABP-9.1-DR1-1999/09/30

RATE_CURRENCY_REF

Configurable. Describes currencies defined in RATE_CURRENCY_REF. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CUSTINFO, BIF

Indexes:

Field Name
ABP-9.1-DR1-1999/09/30

currency_code

language_code exists in LANGUAGE_CODE_REF.


currency_code exists in RATE_CURRENCY_REF.
clustered, unique on currency_code, language_code
Data Type

smallint

Comments

Values

Null

Currency code, from RATE_CURRENCY_REF.

language_code

smallint

display_value

varchar

80 Text description to be displayed on screen.

Language code, from LANGUAGE_CODE_REF.

short_display

char

Abbreviated version of the display value.

Null

399

Triggers:

RATE_CURRENCY_VALUES

RATE_CURRENCY_VALUES

R
400

RATE_DISCOUNT
Configurable. Defines discount percentages or rebate rates for all valid discounts. The values of range_origin, range_
terminus, and discount_amount should be consistent with the implied decimal for currency_code for example, use
2500 for $25.00 (U.S.). Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIP
Triggers:

Indexes:
ABP-9.1-DR1-1999/09/30

Field Name

billing_frequency, currency_code, discount_id, and rate_class exist in the appropriate tables (see below).
range_terminus and range_origin describe a continuous range band.
range_origin > 0 if discount_type = 2 (in DISCOUNT_DEFINITIONS) for given discount_id.
date_created and date_active cannot be modified.
If discount_amount exists, currency_code must exist.
clustered, unique on discount_id, rate_class, billing_frequency, currency_code, range_origin, date_active,
range_terminus

Data Type

Comments

Values

Null

discount_id

smallint

Discount ID, from DISCOUNT_DEFINITIONS.

rate_class

smallint

Account level rating component, from RATE_CLASS_DESCR, or 0


(any).

range_origin

numeric

18 Lower limit for incremental discount band. Must be positive.

Null

range_terminus

numeric

18 Upper limit for incremental band, or threshold for bulk discount.

Null

Billing frequency code, from BILLING_FREQUENCY_REF.

currency_code

Currency code from RATE_CURRENCY_REF, or 0 if percent.

smallint

Null

RATE_DISCOUNT

billing_frequency tinyint

Null

Comments

Values

ABP-9.1-DR1-1999/09/30

discount_
percent

int

You must enter a value in whole numbers in this field is this is a


percentage discount.
Percentages with no decimal fraction, that is, whole number
percentages, are entered exactly. For example, for a five percent
discount, enter 5. For a 12% discount, enter 12.
Percentages that include a decimal fraction are entered differently.
You must also set the implied_decimals field. For a 12 1/4%
discount, convert to the equivalent value in decimals: 0.1225. Enter
1225 in this field and set implied_decimals = 2.
If this is a rebate expressed as an amount of money, leave this field
blank and use the field discount_amount.

implied_
decimals

smallint

This field contains the number of decimal places greater than two
used to calculate the discount_percent. For example, a discount of
5%, or 0.05, required no extra decimal places, so enter 0 in this
field. A 12 1/4% discount, or 0.1225, requires 2 extra decimal
places, so enter 2 in this field.

discount_
amount

numeric

date_active

smalldt

18 Amount of rebate: populate only if not a percent discount.

Null
Null

Null

Date discount rate became active.

date_inactive

smalldt

Date discount rate became inactive.

date_created

smalldt

Date discount rate was created.

Null

401

Data Type

RATE_DISCOUNT

Field Name

R
402

RATE_LATE_FEE
Configurable. Defines parameters for late-fee charging. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIP

franchise_tax_code, billing_frequency, and currency_code exist in the appropriate tables (see below).
type_id_nrc exists in NRC_TRANS_DESCR with trigger_level 0.
date_inactive >= date_active.
maximum_amount >= minimum_amount.
date_created and date_active cannot be modified.
Only one of fee_percent and fee_amount may contain a value for a given row.
Active date ranges cannot overlap for rows with the same franchise_tax_code, billing_frequency, and
currency_code.
unique on franchise_tax_code, billing_frequency, currency_code, date_active

Triggers:

ABP-9.1-DR1-1999/09/30

Indexes:

Foreign Keys:(billing_frequency) must exist in BILLING_FREQUENCY_REF(billing_frequency)

Field Name

Data Type

Comments

franchise_tax_
code

smallint

Franchise tax code, from FRANCHISE_CODE_REF.

grace_period

tinyint

Number of days after due date to begin charging late fees.

fee_class

smallint

Can a late charge be subject to a late fee? (1 = yes, 2 = no)


Billing frequency, from BILLING_FREQUENCY_REF.

type_id_nrc

smallint

Non-recurring charge, from NRC_TRANS_DESCR.

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

fee_percent

int

Percentage of charge to use for fee, if fee is percentage-based.

Null

(R: 1, 2)

Null

RATE_LATE_FEE

billing_frequency tinyint

Values

Data Type

Comments

Values

smallint

fee_amount

numeric

18 Percentage to charge, in whole numbers, for the fee, if this late fee
is calculated on a percentage basis. For example, if the late fee is
5%, enter 5.
Set the field to Null if it is a flat fee, and use fee_amount.

minimum_
amount

numeric

18 Minimum amount charged if any late fee is charged at all.

maximum_
amount

numeric

18 Maximum amount a late fee can be.

date_active

smalldt

Date when the fee becomes active.

date_inactive

smalldt

Date the late fee becomes inactive.

date_created

smalldt

min_bal_
threshold

numeric

This field contains the number of decimal places greater than two (D: 1)
used to calculate the fee_amount. For example, a discount of 5%,
or 0.05, required no extra decimal places, so enter 0 in this field. A
12 1/4% discount, or 0.1225, requires 2 extra decimal places, so
enter 2 in this field.
Null

Null

Date the late fee was created.


18 Minimum balance threshold for late fees. If total charges eligible for
late fee are lower than this amount, late fee is not calculated.

Null

403

ABP-9.1-DR1-1999/09/30

implied_
decimals

Null

RATE_LATE_FEE

Field Name

R
404

RATE_NRC
Configurable. Defines rates for non-recurring charges that are rated during bill preparation. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: CUSTINFO, BIP

rate_class, type_id_nrc and currency_code exist in the appropriate tables (see below).
active_date is earlier than inactive_date, and date bands do not overlap.
Cannot modify active_date or date_created.
unique on rate_class, type_id_nrc, currency_code, active_date, element_id, component_id, equip_type_code,
equip_class_code, class_of_service_code

Triggers:

Indexes:

ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

rate_class

smallint

type_id_nrc

smallint

rate

numeric

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

active_date

smalldt

Date rate became active.

inactive_date

smalldt

Date rate becomes inactive.

date_created

smalldt

Date rate was created.

element_id

smallint

Element ID, from ELEMENT_ID_REF.

component_id

int

Component ID, from COMPONENT_DEFINITION_REF.

Values

Null

Subscription-level rating component identifier for subscription-level


products, otherwise account level rating component identifier, from
RATE_CLASS_DESCR.
Non-recurring charge type ID, from NRC_TRANS_DESCR.
18 Rate of non-recurring charge.

Null

RATE_NRC

Data Type

Comments

Values

equip_type_
code

smallint

Service instance class, from EQUIP_TYPE_CODE_REF.

equip_class_
code

smallint

Service instance class, from EQUIP_CLASS_CODE_REF.

class_of_
service_code

smallint

Equipment service class identifier, from CLASS_OF_SERVICE_


CODE_REF.

Null

RATE_NRC

Field Name

ABP-9.1-DR1-1999/09/30

405

R
406

RATE_PERIODS
Configurable. Defines rate periods based on time of day, day of week, day of month, and so on. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU

starthhmm is earlier than or equal to endhhmm.


bill_class, jurisdiction, point_class_origin, point_class_target , equip_type_code , equip_class_code , class_
of_service_code , provider_class , type_id_usg , and rate_period exists in appropriate tables (see below),
unless NULL or blank.
seqnum and create_dt cannot be modified.
inactive_dt >= active_dt, and active_dt/inactive_dt date bands cannot overlap for a given set of values for
starthhmm, endhhmm, dayofweek, dayofmonth, month, year, point_class_origin, point_class_target,
jurisdiction, bill_class, provider_class, type_id_usg, equip_type, equip_class, and equip_class_of_service.
chg_dt and chg_who are automatically populated.
Ensures that rows are unique on combination of active_dt, starthhmm, endhhmm, dayofweek, dayofmonth,
month, year, point_class_origin, point_class_target, jurisdiction, bill_class, provider_class, type_id_usg, type_
id_usg, equip_type_code, equip_class_code, class_of_service_code, and rate_class.
clustered on seqnum (allow duplicate row)

Triggers:

ABP-9.1-DR1-1999/09/30

Indexes:

Field Name

Data Type

Comments

Values

Null

int

Internally generated unique identifier.

point_class_
target

int

Target point_class from POINT_CLASS_REF, or Null (all).

Null

point_class_
origin

int

Origin point_class from POINT_CLASS_REF, or Null (all).

Null

jurisdiction

smallint

Territorial range of usage from JURISDICTIONS, or Null (all).

bill_class

smallint

Bill class from BILL_CLASS_REF, or Null (all).

(R: > 0 and <


32767)

Null
Null

RATE_PERIODS

seqnum

Comments

Values
(R: > 0)

Null

ABP-9.1-DR1-1999/09/30

provider_class

smallint

Provider class from PROVIDER_CLASS_REF, or Null (all).

type_id_usg

smallint

Usage type ID, from USAGE_TYPES, or Null (all).

Null

rate_class

smallint

Rate class identifier, from RATE_CLASS_DESCR, or Null (all).

Null

equip_type_
code

smallint

Service instance type, from EQUIP_TYPE_CODE_REF, or Null


(all).

Null

equip_class_
code

smallint

Service instance class, from EQUIP_CLASS_CODE_REF, or Null


(all).

Null

class_of_
service_code

smallint

Class of service, from CLASS_OF_SERVICE_CODE_REF, or Null


(all).

Null

year

smallint

4-digit year or Null (all).

(R: >= 1990 and Null


< 2025)

month

tinyint

Month (1-12) or Null (all).

(R: >= 1 and <= Null


12)

dayofmonth

tinyint

Day of month (1-31) or Null (all).

(R: >= 1 and <= Null


31)

dayofweek

tinyint

1 (Sunday) - 7 (Saturday) or Null (all).

(R: >= 1 and <= Null


7)

starthhmm

char

Start of period in hhmm format (use 0000 for midnight).

endhhmm

char

End of period in hhmm format (use 2400 for midnight).

char

Rate period identifier, from RATE_PERIOD_REF.

(R: != "+")

int

Discount factor with 5 implied decimals (for example, 25000 =


25%).

(R: >= 0 and <=


100000)

priority

tinyint

For multiple matching rows, the one with largest priority is used.

active_dt

smalldt

Date rate period becomes active.

407

rate_period
discount_factor

Null

Data Type

RATE_PERIODS

Field Name

Data Type

Comments

inactive_dt

smalldt

Date rate period expires.

create_dt

smalldt

Date and time this record was created.

chg_dt

smalldt

Date and time this record was last modified.

chg_who

char

element_id

smallint

Product ID from PRODUCT_ELEMENTS, or Null (all).

component_id

int

Component ID, from COMPONENT_DEFINITION_REF.

Values

Null

408

Field Name

Null

30 Username or process ID (for example, bip01, cap01) that last


modified record.
Null
(D: 0)

ABP-9.1-DR1-1999/09/30

RATE_PERIODS

RATE_PERIOD_REF

RATE_PERIOD_REF
Configurable. Defines valid rate periods. Admin table. Read-only copy exists on Customer server.
Used by the following modules: ATM

Field Name

Only one row may have is_default = 1


unique on rate_period

Data Type
1

Comments

Values

ABP-9.1-DR1-1999/09/30

rate_period

char

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

Unique rate period identifier.


(D: 0)

409

Triggers:
Indexes:

R
410

RATE_PERIOD_VALUES
Configurable. Describes rate periods defined in RATE_PERIOD_REF. Admin table. Read-only copy exists on Customer
server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


rate_period exists in RATE_PERIOD_REF.
unique on rate_period, language_code
Data Type

ABP-9.1-DR1-1999/09/30

rate_period

char

language_code

smallint

Comments

Values

Null

Identifier of this rate period, from RATE_PERIOD_REF.


Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

RATE_PERIOD_VALUES

Configurable. Contains rates for recurring charge calculation. Admin table. Read-only copy exists on Customer server.

RATE_RC

RATE_RC
Used by the following modules: BIP

component_id, currency_code, element_id, and rate_class exist in the appropriate tables (see below).
active_date is earlier than or equal to inactive_date and date bands do not overlap.
billing_frequency exists in BILL_CYCLE and BILLING_FREQUENCY_REF.
equip_type_code exists in EQUIP_TYPE_CODE_REF, unless 0.
equip_class_code exists in EQUIP_CLASS_CODE_REF, unless 0.
class_of_service_code exists in CLASS_OF_SERVICE_CODE_REF, unless 0.
Ensures record validity based on type_id_rc value.
If type_id_rc = 2, distance_increment cannot be 0.
upper_limit and lower_limit of different records for a single rate form a contiguous range band.
lower_limit cannot be greater than upper_limit.
clustered, unique on rate_class, element_id, equip_type_code, equip_class_code, class_of_service_code,
component_id, type_id_rc, billing_frequency, currency_code, lower_limit, active_date

ABP-9.1-DR1-1999/09/30

Indexes:

Field Name

Data Type

Comments

Values

rate_class

smallint

Rate key from RATE_CLASS_DESCR if PRODUCT_


ELEMENTS.rate_rate_class = 1, or 0 (all) otherwise.

element_id

smallint

Product identifier, from PRODUCT_ELEMENTS.

component_id

int

Rate key from COMPONENT_DEFINITION_REF if PRODUCT_


ELEMENTS.rate_component_id = 1, or 0 (all) otherwise.

equip_type_
code

smallint

Rate key from EQUIP_TYPE_CODE_REF if PRODUCT_


ELEMENTS.rate_equip_type_code = 1, or 0 (all) otherwise.

equip_class_
code

smallint

Rate key from EQUIP_CLASS_CODE_REF if PRODUCT_


ELEMENTS.rate_equip_class_code = 1, or 0 (all) otherwise.

Null

411

Triggers:

Data Type

Comments

class_of_
service_code

smallint

Rate key from CLASS_OF_SERVICE_CODE_REF if PRODUCT_


ELEMENTS.rate_class_of_service_code = 1, or 0 (all)
other-wise.

type_id_rc

smallint

Is this rate based on EMF.pop_units (2) or not (1)?

ABP-9.1-DR1-1999/09/30

billing_frequency tinyint

Billing frequency, from BILLING_FREQUENCY_REF.

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

rate

numeric

distance_
increment

int

Unit increment within this rate band. 0 if type_id_rc = 1.

lower_limit

int

Lower limit of rate band. 0 if type_id_rc = 1.

upper_limit

int

Upper limit of rate band.

18 Base rate.

distance_rate

int

Rate per unit of distance. Enter the value in whole numbers.

implied_
decimals

smallint

Number of decimal places greater than the number of decimal


places in the specified currency unit.

date_created

smalldt

Date rate was created.

active_date

smalldt

Date rate became active.

inactive_date

smalldt

Date rate became inactive.

test_flag

bit

Reserved for future use; use 0.

foreign_code

varchar

10 Reserved for future use; use 0.

Values

Null

412

Field Name

(R: 1, 2)

(R: >= 0)

Null

Null
Null

RATE_RC

Configurable. Contains rebate rates or number of free units or for all valid unit credit definitions. Admin table. Readonly copy exists on Customer server.
Used by the following modules: BIP, CUSTINFO

RATE_UNIT_CR

RATE_UNIT_CR

billing_frequency, rate_class, and unit_cr_id exist in the appropriate tables (see below).
currency_code exists in RATE_CURRENCY_REF or is 0.
date_active is earlier than or equal to date_inactive and date bands dont overlap.
Ensure currency_code is set if UNIT_CR_DEFINITIONS.unit_cr_quantum for the unit_cr_id = 1 or NULL.
If currency_code = 0, one and only one of amount_free and units_free is 0.
range_terminus must be greater than range_origin or be NULL, and the rate bands defined by range_origin
and range_terminus for a given unit_cr_id must be contiguous starting at 0.
unique on unit_cr_id, rate_class, currency_code, billing_frequency, date_active, range_origin

Triggers:

Foreign Keys:(unit_cr_id) must exist in UNIT_CR_DEFINITIONS(unit_cr_id)

Field Name

Data Type

Comments

Values

unit_cr_id

smallint

Unit credit ID, from UNIT_CR_DEFINITIONS.

rate_class

smallint

Account level rating component identifier, from RATE_CLASS_


DESCR.

units_free

int

For unit credits this is the whole number of free units of the billing
units type.

billing_frequency tinyint

Billing frequency code, from BILLING_FREQUENCY_REF.

currency_code

smallint

Currency code for currency being credited, from RATE_


CURRENCY_REF, or 0 (crediting units).

amount_free

numeric

date_active

datetime

Null

18 For rebates, the amount of money to credit.


Date/time unit credit became active.

413

ABP-9.1-DR1-1999/09/30

Indexes:

Data Type

Comments

date_inactive

datetime

Date/time unit credit became inactive.

range_origin

numeric

18 Lower limit for incremental discount band.

range_terminus

numeric

18 Upper limit for incremental discount band.

Values

Null

414

Field Name

Null
(D: 0)
Null

ABP-9.1-DR1-1999/09/30

RATE_UNIT_CR

Configurable. Contains usage-based rates. Different usage types may use different key fields (see USAGE_TYPES).
Admin table. Read-only copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU

active_dt is earlier than or equal to inactive_dt and date bands dont overlap.
bill_class, currency_code, element_id, and rate_units_type exist in the appropriate tables (see below). equip_
type_code , equip_class_code , class_of_service_code , jurisdiction , point_class_target , point_class_origin ,
provider_class , rate_class and distance_band_id exist in the appropriate tables (see below) or are 0. rate_
period exists in RATE_PERIODS_REF unless blank.
type_id_usg/units_indicator combination exists in USAGE_TYPES, and units_indicator may not be 0.
active_dt, create_dt, and seqnum cannot be modified.
All rows with the same currency_code must have the same rate_implied_decimal.
clustered on rate_class (allow dup. row)
unique on seqnum
unique on active_dt, type_id_usg, seqnum

ABP-9.1-DR1-1999/09/30

Indexes:

seqnum

Data Type
int

Comments

Values

Null

Unique identifier of a usage rate.

rate_class

smallint

Rate key from RATE_CLASS_DESCR or 0 (all).

type_id_usg

smallint

Usage type ID, from USAGE_TYPES.

bill_class

smallint

Bill class, priority, or grade of service identifier, from BILL_CLASS_


REF.

jurisdiction

smallint

Territorial range of usage, from JURISDICTIONS.

point_class_
target

int

Target usage point class, from POINT_CLASS_REF.

415

Triggers:

Field Name

RATE_USAGE

RATE_USAGE

Data Type

Comments

ABP-9.1-DR1-1999/09/30

point_class_
origin

int

Origin usage point class, from POINT_CLASS_REF.

units_indicator

tinyint

Units field (see USAGE_TYPES_UNITS) the rate applies to:


1 = primary_units
2 = second_units
3 = third_units

provider_class

smallint

Service provider class, from PROVIDER_CLASS_REF or 0 (all).

rate_period

char

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

element_id

smallint

Product identifier, from PRODUCT_ELEMENTS.

equip_type_
code

smallint

Service instance type, from EQUIP_TYPE_CODE_REF or 0 (all).

equip_class_
code

smallint

Rating zone, from EQUIP_CLASS_CODE_REF or 0 (all zones).

class_of_
service_code

smallint

Equipment service class identifier, from


CLASS_OF_SERVICE_CODE_REF or 0 (all classes).

fixed_charge_
amt

numeric

add_fixed_amt

int

Amount added to fixed_charge_amt (see add_implied_decimal).

add_unit_rate

int

Per-unit rate for additional units (see add_implied_decimal).

active_dt

smalldt

Date rate became active.

inactive_dt

smalldt

Date rate becomes inactive.

Rate period identifier, from RATE_PERIOD_REF, for time of


day/day of week/holiday component.

Values

Null

416

Field Name

(R: 0, 1, 2, 3)

(R: != "+")

18 Fixed charge for transaction, with the same number of implied


decimal places to the right of the decimal point as the
corresponding currency, defined in RATE_CURRENCY_REF (in US
dollars, a fixed charge of $1.04 would be defined as 104).

Null

RATE_USAGE

(D: 0)

Comments

Values

create_dt

smalldt

Date and time this record was created.

change_dt

smalldt

Date and time that this entry was last modified.

change_who

char

incremental_
bands

bit

Always set to 1. Reserved for future use.

rate_units_type

smallint

Type of units the rate is defined in, from USAGE_UNITS_TYPE_


REF.

30 The username or process ID (for example, bip01, cap01) of the


user/process that last modified this record.

Null

(D: 1) (R: = 1)

ABP-9.1-DR1-1999/09/30

distance_band_ tinyint
id

Distance band ID, from DISTANCE_BANDS_ID_REF.

zone_class

tinyint

0 indicates no zone rating; 1 indicates calls out of zone plans.


(D: 0)
Values greater than 1 indicate calls originating from zones defined
in ZONE_CLASS_REF.

add_implied_
decimal

smallint

Implied decimal places for add_fixed_amt and add_unit_rate. This (D: 3) (R: <= 6)
is in addition to the implied decimal places for the currency.

is_default_rate

bit

Is this the default rate? (1 = yes)

(D: 0)

component_id

int

Component ID, from COMPONENT_DEFINITION_REF.

(D: 0)

417

Data Type

RATE_USAGE

Field Name

R
418

RATE_USAGE_BANDS
Configurable. Defines additional bands of usage rates in conjunction with the RATE_USAGE table. Admin table. Readonly copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU
Triggers:

Indexes:

Field Name

rateband values are contiguous (for example, next lower value exists on insert, no higher value exists on
delete).
seqnum exists in RATE_USAGE.
unique on seqnum, rateband

Data Type

Comments

ABP-9.1-DR1-1999/09/30

seqnum

int

Usage rate identifier, from RATE_USAGE.

rateband

tinyint

Number of the particular rate band.

unit_rate

int

Rate per unit, defined with three implied decimal places in addition
to the number of implied decimal places defined for the
corresponding currency (in US dollars, a unit rate of $0.25 would
be defined as 25000).

num_units

int

Number of billing units in this rate band.

Values

Null

(R: 1, 2, 3, 4, 5,
6)

(R: > 0)

RATE_USAGE_BANDS

Configurable. Defines bands of usage rates for corridor-based usage. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CAP, RAP, MIU

Indexes:

Field Name

rateband values are contiguous (for example, next lower value exists on insert, no higher value exists on
delete).
seqnum exists in RATE_USAGE_OVERRIDES.
unique on seqnum, rateband

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

seqnum

int

Usage rate being overridden, from RATE_USAGE_OVERRIDES.

rateband

tinyint

Number of the particular rate band.

unit_rate

int

Rate per unit, defined with three implied decimal places in addition
to the number of implied decimal places defined for the
corresponding currency (in US dol-lars, a unit rate of $0.25 would
be defined as 25000).

num_units

int

Number of billing units in this rate band.

Null

(R: 1, 2, 3, 4, 5,
6)

(R: > 0)

419

Triggers:

RATE_USAGE_BANDS_OVERRIDES

RATE_USAGE_BANDS_OVERRIDES

R
420

RATE_USAGE_OVERRIDES
Configurable. Used to guide and rate corridor-based usage. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU

active_dt is earlier than or equal to inactive_dt and date bands dont overlap.
currency_code, corridor_plan_id, and rate_units_type exist in the appropriate tables (see below). equip_type_
code, equip_class_code , class_of_service_code , jurisdiction , point_class_target , point_class_origin,
provider_class , rate_class, element_id, bill_class and distance_band_id exist in the appropriate tables (see
below) or are 0. rate_period exists in RATE_PERIODS_REF unless blank.
type_id_usg/units_indicator combination exists in USAGE_TYPES, and units_indicator may not be 0.
active_dt, create_dt, and seqnum cannot be modified.
All rows with the same currency_code must have the same rate_implied_decimal.
unique on seqnum
unique on active_dt, type_id_usg, seqnum
clustered, unique on corridor_plan_id, type_id_usg, units_indicator, element_id, rate_class, equip_type_code,
equip_class_code, class_of_service_code, provider_class, bill_class, jurisdiction, currency_code, rate_period,
active_dt, distance_band_id, component_id

Triggers:

ABP-9.1-DR1-1999/09/30

Indexes:

Field Name

int

Comments

Values

Usage rate identifier.

corridor_plan_id int

Corridor plan ID, from CORRIDOR_PLAN_ID_REF.

type_id_usg

smallint

Usage type ID, from USAGE_TYPES.

units_indicator

tinyint

Indicates which units field in CDR_DATA contains the number of


units:
2 = second_units
3 = third_units
1 = primary_units

element_id

smallint

Product identifier, from PRODUCT_ELEMENTS.

rate_class

smallint

Rate key from RATE_CLASS_DESCR or 0 (all).

(R: 0, 1, 2, 3)

Null

RATE_USAGE_OVERRIDES

seqnum

Data Type

Data Type

Comments

Values

smallint

Equipment type, from EQUIP_TYPE_CODE_REF or 0 (all).

equip_class_
code

smallint

Rating zone, from EQUIP_CLASS_CODE_REF or 0 (all).

class_of_
service_code

smallint

Equipment class identifier, from CLASS_OF_SERVICE_CODE_REF


or 0 (all).

provider_class

smallint

Class of service provider, from PROVIDER_CLASS_REF.

bill_class

smallint

Bill class, priority, or grade of service identifier, from BILL_CLASS_


REF.

jurisdiction

smallint

Territorial range of usage, from JURISDICTIONS.

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

rate_period

char

incremental_
bands

bit

Rate period identifier, from RATE_PERIOD_REF.

(R: != "+")

Always 1. Reserved for future use.

(D: 1) (R: = 1)

fixed_charge_
amt

numeric

add_fixed_amt

int

Amount added to fixed_charge_amt (see add_implied_decimal).

18 Fixed charge for transaction, with the same number of implied


decimal places as the corresponding currency, defined in RATE_
CURRENCY_REF (in US dollars, a fixed charge of $1.04 is defined
as 104).

add_unit_rate

int

Per-unit rate for additional units (see add_implied_decimal).

active_dt

smalldt

Date rate became active.

inactive_dt

smalldt

Date rate becomes inactive.

create_dt

smalldt

Date and time this record was created.

chg_dt

smalldt

Date and time that this entry was last modified.

(D: 0)

Null

421

ABP-9.1-DR1-1999/09/30

equip_type_
code

Null

RATE_USAGE_OVERRIDES

Field Name

Data Type

chg_who

char

rate_units_type

smallint

Comments

Values

Null

422

Field Name

30 The username or process ID (for example, bip01, cap01) of the


user/process that last modified this record.
Type of units the rate is defined in, from USAGE_UNITS_TYPE_
REF.

distance_band_ tinyint
id

Distance band ID, from DISTANCE_BANDS_ID_REF.

add_implied_
decimal

smallint

Implied decimal places for add_fixed_amt and add_unit_rate. This (D: 3) (R: <= 6)
is in addition to the implied decimal places for the currency.

component_id

int

Component ID, from COMPONENT_DEFINITION_REF.

(D: 0)

ABP-9.1-DR1-1999/09/30

RATE_USAGE_OVERRIDES

Configurable. Maps fields from usage records to fields in CDR_DATA or CDR_DATA_WORK, so CAP can process usage
records. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CAP

Indexes:

Field Name
ABP-9.1-DR1-1999/09/30

record_type

Ensures field_from_pos is sequential (for example, 1 for first record, increments by 1 thereafter, cant delete
from middle of sequence) and consistent with field_from_size.
unique on record_type, field_to_name

Data Type
char

field_from_pos smallint
field_from_
name

Comments

Values

Identifier for the type of record (e.g,. A01, TE1, and so


on).
Position of the field in the record.

varchar 80 Client-specific name for the field.

field_from_size smallint

Null

Field size. For unsigned integer fields, the size is 2 for 1byte ints, 5 for 2-byte ints, and 10 for 4-byte ints. Signed
integers add 1 byte to the un-signed field size. For other
types, size is number of bytes.

field_from_type tinyint

Field type: 1 = integer; 3 = char; 4 = binary; 5 = date

is_required

Is this field required to process the record? (1 = yes)

bit

Null

(R: 1, 3, 4, 5)

423

Triggers:

RAW_USAGE_FIELD_MAPPING

RAW_USAGE_FIELD_MAPPING

Data Type

is_ignored

bit

date_format

char

Comments

Values

Null

424

Field Name

Is this field ignored in processing the record? (1 = yes)


20 For date fields, YYYYMMDD HH:MM:SS or
YYYYMMDDHHMMSS; otherwise Null.

(R: NULL, "YYYYMMDD


HH:MM:SS",
"YYYYMMDDHHMMSS")

Null

ABP-9.1-DR1-1999/09/30

RAW_USAGE_FIELD_MAPPING

char

Comments

Values

ABP-9.1-DR1-1999/09/30

30 CDR_DATA/_WORK field this field is written to. One of:


account_no, amount, annotation, base_amt, bill_class,
bill_ref_no, call_direction, ccard_account, ccard_carrier,
ccard_expire, ccard_ownr_name, ccountry_dial_code_
origin, cdr_status, cell_name_origin, city_tax, comp_
status, county_tax, customer_tag, date_dt, element_id,
ext_tracking_id, external_id, external_id_type, federal_
tax, foreign_amount, home_carrier_sid_bid, jurisdiction,
no_bill, open_item_id, other_tax, point_class_origin,
point_class_target, point_origin, point_target, point_tax_
code_origin, point_tax_code_target, point_tax_code_
type_origin, point_tax_code_type_target, primary_units,
provider_class, provider_id, rate_class, rate_currency_
code, rate_period, rated_units, record_type, second_dt,
second_units, special_features, state_tax, term_status,
third_units, timezone, trans_dt, trans_id, type_id_usg,
units_currency_code, unrounded_amount.

Null

425

(R: ,record_type,ext_tracking_
Null
id,trans_id,element_id,type_id_
usg,rate_class,bill_
class,provider_id,provider_
class,jurisdiction,rate_currency_
code,point_origin,point_class_
origin,point_tax_code_
origin,point_tax_code_type_
origin,point_target,point_class_
target,point_tax_code_
target,point_tax_code_type_
target,trans_dt,second_
dt,timezone,primary_
units,second_units,third_
units,federal_tax,state_
tax,county_tax,city_tax,other_
tax,units_currency_
code,annotation,customer_
tag,base_amt,rate_period,rate_
dt,no_bill,comp_status,cdr_
status,bill_ref_no,external_
id,external_id_type,ccard_
account,ccard_ownr_name,ccard_
expire,ccard_carrier,account_
no,country_dial_code_
origin,home_carrier_sid_bid,term_
status,special_features,call_
direction,amount,unrounded_
amount,cell_name_origin,rated_
units,open_item_id,foreign_
amount)

field_to_name

Data Type

RAW_USAGE_FIELD_MAPPING

Field Name

R
426

RECORD_FIELD_DEF
Configurable. Defines all fields associated with the corresponding record type. Admin table.
Used by the following modules: TIP
If is_variable_size is set to 1, field_size can either be 0 or NULL
unique on record_id, field_name, field_pos

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

record_id

smallint

Name of the record type. Can be a database table name.

field_pos

smallint

Field position within the record type.

field_name

varchar

field_size

smallint

field_type

Values

Null

(R: >= 0)

Null

Byte size of field. Can be Null if record type is a database table.

(R: >= 0)

Null

tinyint

Field type (can be Null if record type is a database table):


1 = numeric
3 = alphanumeric
4 = binary
5 = date
6 = bit
10 = alphabetic
11 = time
12 = BCD / Packed Decimal

(R: 1, 3, 4, 5, 6,
10, 11, 12)

Null

field_category

tinyint

1 = total amount
2 = total number of records
3 = contributes to a total amount
4 = record type for subsequent records (use only in header
records)
5 = primary units field, will increment total units
6 = switch ID field
7 = date field is an end date field

(R: 1, 2, 3, 4, 5,
6, 7)

Null

is_ebcdic

bit

Is this field in EBCDIC? (1 = yes)

40 Field name associated with the record type. If the record type is a
database table, should be a valid field name from that table.

RECORD_FIELD_DEF

Comments

Values

Null

tinyint

For field_type = 6, the beginning bit position within a byte.

(R: 1, 2, 3, 4, 5,
6, 7, 8)

Null

bit_end

tinyint

For field_type = 6, the ending bit position within a byte.

(R: 1, 2, 3, 4, 5,
6, 7, 8)

Null

is_required

bit

Is this field required? (1 = yes)

is_index_key

tinyint

(For database tables only) Is this field part of a unique index?


(1 = yes)

(R: 0, 1)

Null

data_format

varchar

(R:
"YYYYMMDDH
HMMSS",
"YYMMDD",
"YYYYMMDD
HH:MM:SS",
"YYYYMMDD",
"MM/DD/YY
HH:MM:SS",
"HHMMSS",
"HH:MM:SS",
"MM/DD/YYYY
HH:MM:SS" )

Null

edit_type

tinyint

edit_table
edit_table_field

ABP-9.1-DR1-1999/09/30

bit_start

20 Specifies the format for certain field types.


If field_type = 5, one of:
YYYYMMDDHHMMSS
YYMMDD
YYYYMMDD HH:MM:SS
YYYYMMDD
MM/DD/YY HH:MM:SS
If field_type = 11, one of:
HHMMSS
HH:MM:SS

Reserved for future use.

Null

varchar

30 Reserved for future use.

Null

varchar

30 Reserved for future use.

Null

Reserved for future use.

Null

edit_table_field_ tinyint
type
char

30 Reserved for future use.

Null

translate_field

varchar

30 Reserved for future use.

Null

427

translate_table

Data Type

RECORD_FIELD_DEF

Field Name

Data Type

Comments

Values

Null

translate_field_
type

varchar

30 Reserved for future use.

Null

fill_char

char

Null

justify_type

tinyint

default_value

varchar

default_type

tinyint

ABP-9.1-DR1-1999/09/30

is_variable_size bit

Character used to fill in blank spaces.


1 = left justify

2 = right justify

(R: 1, 2)

30 If default_type = 0, a default value to be used for this field name.

428

Field Name

Null
Null

Specifies how to arrive at a default value for a field.


0 = use value specified by default_value
1 = current date/time
2 = users name
3 = total record count
4 = total amount
5 = sequence number of the file

(R: 0, 1, 2, 3, 4,
5)

If is_variable_size is set to 1, field_size can be 0.

(D: 0)

Null

RECORD_FIELD_DEF

RECORD_FIELD_MAP

RECORD_FIELD_MAP
Configurable. Defines mapping between record type/field name pairs. Admin table.
Used by the following modules: TIP

record_id_from exists in RECORD_TYPE_REF (with io_type = 1).


record_id_to exists in RECORD_TYPE_REF (for io_type = 2).
record_id_from and field_name_from exist in RECORD_FIELD_REF.
record_id_to, field_name_to exist in RECORD_FIELD_REF.
unique on record_id_from, field_name_from, task_name, record_id_to, field_name_to

Indexes:

Field Name
ABP-9.1-DR1-1999/09/30

record_id_from

Data Type
smallint

field_name_from varchar
record_id_to

smallint

field_name_to

varchar

mapping_type

tinyint

task_name

varchar

scale

int

Comments

Values

Null

Input record type.


40 Input field name.
Output record type.
40 Output field name.
1 = input field specifies size of output field
2 = concatenate input field onto output field
3 = apply scale and scale_type to input field and derive output field
4 = TIP performs a database lookup for input field
6-15 = These values are primarily used for Arbor/OM.

40 Name of the TIP task this record is used in.

(R: 1, 2, 3, 4, 5, Null
6, 7, 8, 9, 10, 11,
12, 13, 14, 15,
16, 17, 18, 19,
20, 21, 22, 23,
24, 25, 26, 27,
28, 29)
(R: "in", "out")

Value to use when mapping_type = 3.

Null

429

Triggers:

Data Type

Comments

ABP-9.1-DR1-1999/09/30

scale_type

tinyint

The operation TIP must perform to calculate the output field:


1 = multiply
2 = divide
3 = mod

mapping_order

tinyint

Order used when concatenating field values (mapping_type = 2).

lookup_table_
name

varchar

compare_type

tinyint

Reserved for future use.

server_type

tinyint

1 = Catalog
2 = Admin (default)
3 = Customer

cat_char

char

Values
(R: 1, 2, 3)

Character used to separate concatenated fields.

Null

Null

30 Table containing the mapping needed to translate the input field


name to the output field name.

Null

430

Field Name

Null
Null
(R: 1, 2, 3)

Null

Null

30 Name of the field in lookup_table_name containing the value from


which to translate the input field name. If multiple fields need to be
searched in order to translate the input field name, multiple rows
with the same field_db_name_to must be present in lookup_table_
name.

Null

field_db_name_ varchar
to

30 Name of the field in lookup_table_name containing the value to


which to translate the input field name. If multiple fields need to be
searched in order to translate the input field name, multiple rows
with the same field_db_name_to must be present in lookup_table_
name.

Null

RECORD_FIELD_MAP

field_db_name_ varchar
from

tinyint

conditional_type tinyint

ABP-9.1-DR1-1999/09/30

conditional_
value

char

Comments

Values

Null

This record will be mapped if it has a nonzero value and is_


conditional = 1. Additionally, RECORD_TYPE_MAP.is_
conditional_map = 1.

Null

Depending upon the conditional_value, how should


the output record be mapped?
0 or Null = map an output record
1 = if the conditional input field value is not 0 or blank, map an
output record
2 = if the conditional input field value is equal to the conditional
value, map an output record
3 = if the conditional input field value does not equal the conditional
value, map an output record

Null

10 Value that indicates how the output record will be mapped; see
conditional_type.

Null

431

is_conditional_
map

Data Type

RECORD_FIELD_MAP

Field Name

R
432

RECORD_TYPE_MAP
Configurable. Defines mapping between record types. Admin table.
Used by the following modules: TIP
Triggers:
Indexes:

Field Name

record_id_from and record_id_to exist in RECORD_TYPE_REF.record_id.


unique on record_id_from, record_id_to, task_name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

task_name

varchar

40 Name of the TIP task this record is used in.

record_id_from

smallint

Input record type.

record_id_to

smallint

Output record type.

is_conditional_
map

tinyint

Record will be mapped if it has a nonzero value and is_conditional


= 1. Additionally, RECORD_FIELD_MAP.is_conditional_map
= 1.

Values

Null

(R: "in", "out")

Null

RECORD_TYPE_MAP

RECORD_TYPE_REF

RECORD_TYPE_REF
Configurable. Defines valid record types. Admin table.
Used by the following modules: TIP

Field Name

server_type cannot be 1.
unique on record_id
unique on record_type, task_name, io_type, switch_id, active_dt

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

record_id

smallint

record_type

char

30

switch_id

char

30

active_dt

smalldt

Date the record type definition becomes active.

inactive_dt

smalldt

Date the record type definition becomes inactive.

task_name

char

source_type

Null

Internal record ID.

Name of the record type. Can be a database name.


Switch ID.

Null
Null

Name of the TIP task this record is used in.

(R: "in", "out")

smallint

Source of the record type:


0 = from database
1 = usage type
7 or 8 = TIP processing

(R: 0, 1, 7, 8)

server_type

smallint

If source_type is 0, can be 2 (Admin) or 3 (Customer). Otherwise


Null.

(R: 1, 2, 3)

Null

record_size

smallint

Size of the record. Must be non-Null if this record is ignored.

(R: >= -1)

Null

is_ignored

bit

Ignore this record type? (1 = yes)

io_type

tinyint

1 = record has from fields, read by TIP.


2 = record has to fields, written by TIP.

(R: 1, 2)

433

Triggers:
Indexes:

Data Type

record_category tinyint

Comments
1 = header
2 = data

30

3 = trailer
5 = batch trailer
4 = batch header 6 = module

Values

Null

(R: 1, 2, 3, 4, 5,
6)

ABP-9.1-DR1-1999/09/30

output_by

char

(Used by task OUT only.) Field name that the output files are
separated on. A separate output file is generated for each value of
the field specified.

null_terminated

tinyint

where_clause

varchar

255

(Used by task OUT only.) Contains a SQL WHERE clause to select


data from a table. If this field is Null, all data in the specified
database table is selected.

Null

order_clause

varchar

255

Reserved for future use.

Null

set_query

varchar

255

Used to update database table after processing.

Null

process_status

tinyint

process_name

varchar

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or


modify.

is_variable_
length

bit

Is the field of variable length? (1 = yes)

field_delimiter_
char

char

field_delimiter_
code

tinyint

Is the record terminated with a newline character? (1 = yes)

0 = ready
1 = processed
30

6 = error

Null

(R: 0, 1)

Null

(R: 0, 1, 2, 4, 6)

Used to lock a record type to prevent another process from


accessing the same record type.

Null

(D: 0)

Printable character of the field delimiter.

Null

ASCII code for the non-printable character for the delimiter.

Null

RECORD_TYPE_REF

2 = in lock
4 = done

434

Field Name

Data Type

record_
delimiter_char

char

record_
delimiter_code
record_
delimiter_count

Comments

Values

Null

Record delimiter character.

Null

tinyint

ASCII code for the record delimiter.

Null

tinyint

Number of delimiters used; for example, two carriage returns could


be a record delimiter.

Null

RECORD_TYPE_REF

Field Name

ABP-9.1-DR1-1999/09/30

435

R
436

RECORD_TYPE_SEQ_NUM
Dynamic (maintained by TIP). Defines a unique identifier (seq_num) for each TIP output file. This table should contain
at least one record for every field name specified in RECORD_TYPE_REF.output_by. Admin table.
Used by the following modules: TIP
Triggers:
Indexes:

Field Name

record_id/task_name pair exists in RECORD_TYPE_REF.


unique on task_name, record_type, field_name, field_value, seq_num

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

record_type

char

30 Name of the record type. Can be a database table name.

task_name

char

30 Name of the TIP task this record is used in.

field_name

char

30 (Used by task "out" only.) Field name that the output files are
separated on. Values in this field will match those from RECORD_
TYPE_DEF.output_by.

Null

field_value

char

30 A value of field_name. A separate output file is generated for each


value of the field specified.

Null

seq_num

int

(R: "in", "out")

Unique key number.

RECORD_TYPE_SEQ_NUM

Configurable. This table contains language-dependent descriptions for record types defined in RECORD_TYPE_REF.
Admin table.
Indexes: unique on record_id, language_code

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

record_id

smallint

Record type definition ID, from RECORD_TYPE_REF.

language_code

smallint

Text description to be displayed on screen.

short_display

char

display_value

varchar

80 Abbreviated version of the display value.

Language code, from LANGUAGE_CODE_REF.

Null

Null

437

Field Name

RECORD_TYPE_VALUES

RECORD_TYPE_VALUES

R
438

REFUND_REASON_CODE_REF
Configurable. Defines valid reasons for refunds that can be selected by CSRs. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO.
Only one row can have is_default = 1.
clustered, unique on refund_reason_code

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

refund_reason_
code

smallint

Unique ID for a refund reason.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, record is required by Arbor/BP modules; do not delete or


modify.

(D: 0)

Null

REFUND_REASON_CODE_REF

Configurable. Contains language-dependent description information for refund reason codes. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: CUSTINFO

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


refund_reason_code exists in REFUND_REASON_CODE_REF.
clustered, unique on refund_reason_code, language_code
Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

refund_reason_
code

smallint

Unique ID for a refund reason, from REFUND_REASON_CODE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Short text description.

Null

Null

439

Triggers:

REFUND_REASON_CODE_VALUES

REFUND_REASON_CODE_VALUES

R
440

REGULATORY_ID_REF
Configurable. Defines regulatory jurisdictions. Admin table. Read-only copy exists on Customer server.
Indexes: primary-key on regulatory_id

Field Name

Data Type

Comments

regulatory_id

smallint

Unique regulatory jurisdiction ID.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or


modify.

Values

Null

(R: != 0)

ABP-9.1-DR1-1999/09/30

REGULATORY_ID_REF

Configurable. Describes regulatory jurisdictions defined in REGULATORY_ID_VALUES. Admin table. Read-only copy
exists on Customer server.
Indexes: clustered, unique on regulatory_id, language_code
Foreign Keys:(regulatory_id) must exist in REGULATORY_ID_REF(regulatory_id)

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

regulatory_id

smallint

Regulatory jurisdiction ID, from REGULATORY_ID_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

Null

441

Field Name

REGULATORY_ID_VALUES

REGULATORY_ID_VALUES

R
442

REPLICATION_TABLES
Configurable. Contains replication schedules for one or more tables. Used in conjunction with the Manual Replication
Utility. Admin table.
Indexes: unique on table_name, from_server, to_server

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

table_name

varchar

30 Name of the table to be replicated.

table_key

varchar

30 Not used.

from_server

tinyint

Server that the table resides on:


1 = Catalog
2 = Admin

(R: 1, 2)

to_server

tinyint

Server that the table is replicated to:


1 = Catalog
2 = Admin
3 = Customer

(R: 1, 2, 3)

dt_chg_field

varchar

update_
frequency

int

Not used.

date_last_
updated

datetime

Last date/time that table_name was replicated.

active_dt

smalldt

Date and time this replication specification becomes active.

inactive_dt

smalldt

Date and time this replication specification becomes inactive.

Null

30 Field name of a date field in table_name. The date field specified is


read to choose rows from the table for incremental update. Ignored
for complete updates.

Null

REPLICATION_TABLES

Null

Configurable. Defines revenue receiving cost centers for journaling purposes. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO, JNL
Only one row may have is_default = 1.
primary-key on rev_rcv_cost_ctr

Field Name

Data Type

rev_rcv_cost_ctr smallint

Comments

Values

Unique identifier for a revenue receiving cost center.

(R: >= 1)

ABP-9.1-DR1-1999/09/30

g_l_code

char

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

19 General Ledger code for this revenue receiving cost center.


(D: 0)

443

Triggers:
Indexes:

REV_RCV_COST_CENTER_REF

REV_RCV_COST_CENTER_REF

R
444

REV_RCV_COST_CENTER_VALUES
Configurable. Describes revenue-receiving cost centers defined in REV_RCV_COST_CENTER_REF. Admin table. Readonly copy exists on Customer server.
Used by the following modules: CUSTINFO, JNL
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


rev_rcv_cost_ctr exists in REV_RCV_COST_CENTER_REF.
unique on rev_rcv_cost_ctr, language_code
Data Type

Comments
Revenue receiving cost center ID, from REV_RCV_COST_CENTER_
REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF .

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

Null

REV_RCV_COST_CENTER_VALUES

ABP-9.1-DR1-1999/09/30

rev_rcv_cost_ctr smallint

Values

Configurable. Associates PLMNs with roaming clearinghouses. Maintained locally on Customer servers. Admin table.

clearing_house_operator_id and operator_id exist in GSM_ROAMING_AGREEMENT or CIBER_ROAMING_


AGREEMENT.
unique on clearing_house_operator_id, operator_id, active_dt

Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

clearing_house_ int
operator_id

Intercarrier ID for clearinghouse, from GSM_ROAMING_


AGREEMENT.

operator_id

int

Intercarrier ID for PLMN, from GSM_ROAMING_AGREEMENT.

active_dt

smalldt

First date on which records should be provided to this


clearinghouse.

inactive_dt

smalldt

Date on which records should no longer be provided to this


clearinghouse.

Null

Null

445

Triggers:

ROAMING_CLEARING_HOUSE_MEMBERS

ROAMING_CLEARING_HOUSE_MEMBERS

R
446

ROAMING_INVOICE_SUMMARY
Reserved for future use. Stores summary information from ROAMING_TRANSFER_DETAIL for regular reports.
Maintained locally on Admin and Customer servers.
Indexes: unique on roaming_invoice_no
non-unique on operator_id, roaming_invoice_no

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

operator_id

int

Roaming operator ID, from ROAMING_OPERATOR_REF.

roaming_
invoice_no

int

Unique identifier of summary report.

roaming_
invoice_dt

smalldt

Date on which summary report is generated.

total_amt

numeric

total_amt_home numeric

total_amt_
foreign

numeric

currency_code_ smallint
foreign

18 Total amount on report, in SDR (for GSM)


or home carrier currency (otherwise).
18 Total amount on report, in home carrier currency.
Currency code for home carrier charges, from RATE_CURRENCY_
REF.
18 Total amount on report, in visited carrier currency.
Currency code for foreign charges, from RATE_CURRENCY_REF.

total_tax

numeric

18 Total tax amount on report, in SDR (for GSM)


or home carrier currency (otherwise).

total_tax_home

numeric

18 Total tax amount on report, in home carrier currency.

total_tax_foreign numeric

Null

18 Total tax amount on report, in visited carrier currency.

ROAMING_INVOICE_SUMMARY

currency_code_ smallint
home

Values

Configurable. Defines valid roaming operator IDs. Admin table. Read-only copy exists on Customer server.
Only one row may have is_default = 1.
unique on operator_id

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

operator_id

int

Unique internal intercarrier ID.

operator_type

tinyint

1 = GSM operator; 2 = CIBER operator.

(D: 1) (R: 1, 2)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

447

Triggers:
Indexes:

ROAMING_OPERATOR_REF

ROAMING_OPERATOR_REF

R
448

ROAMING_OPERATOR_VALUES
Configurable. Describes roaming operator IDs. Admin table. Read-only copy exists on Customer server.

language_code exists in LANGUAGE_CODE_REF.


operator_id exists in ROAMING_OPERATOR_REF.
unique on operator_id, language_code

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

operator_id

int

Intercarrier ID, from ROAMING_OPERATOR_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Short text description of the roaming operator IDs.

Values

Null

Null

ROAMING_OPERATOR_VALUES

Configurable. Associates rate key IDs with values of rate key fields. Admin table. Read-only copy exists on Customer
server.
Indexes: unique on rate_key_id
Foreign Keys:(equip_class_code) must exist in EQUIP_CLASS_CODE_REF(equip_class_code)
(class_of_service_code) must exist in CLASS_OF_SERVICE_CODE_REF(class_of_service_code)
(element_id) must exist in PRODUCT_ELEMENTS(element_id)
(currency_code) must exist in RATE_CURRENCY_REF(currency_code)
(rate_class) must exist in RATE_CLASS_DESCR(rate_class)

Data Type

Comments

Values

Null

rate_key_id

smallint

Unique internal identifier of a set of roaming charge rate keys.

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

element_id

smallint

Unique identifier of a product element, from PRODUCT_ELEMENTS.

equip_type_
code

smallint

Equipment type, from EQUIP_TYPE_CODE_REF.

Null

rate_class

smallint

Rate class, from RATE_CLASS_DESCR.

Null

equip_class_
code

smallint

Service instance class, from EQUIP_CLASS_CODE_REF.

Null

class_of_
service_code

smallint

Class of service, from CLASS_OF_SERVICE_CODE_REF.

Null

449

ABP-9.1-DR1-1999/09/30

Field Name

ROAMING_RATE_KEYS

ROAMING_RATE_KEYS

R
450

ROAMING_TRANSFER_DETAIL
Dynamic. Stores statistics about a roaming usage file. Maintained locally on Admin and Customer servers.
Indexes: unique on operator_id, operator_id_recipient, batch_seq_num, file_creation_dt

Field Name

Data Type

Comments

operator_id

int

Roaming operator ID, from ROAMING_OPERATOR_REF.

file_id

int

Roaming file ID, from FILE_STATUS.

Values

Null

Null

ABP-9.1-DR1-1999/09/30

batch_seq_num int

Join to ROAMING_TRANSFER_TAX_DETAIL.

file_creation_dt

smalldt

Date on which file was created.

Null

cutoff_dt

smalldt

Cutoff date for call inclusion in file.

Null

smalldt

Transaction date for first call in file.

Null

last_call_dt

smalldt

Transaction date for last call in file.

Null

process_dt

smalldt

Date on which file was processed.

Null

roaming_
invoice_no

int

Join to ROAMING_INVOICE_SUMMARY.

Null

roaming_
invoice_dt

smalldt

Date on which the roaming invoice was generated.

Null

tax_treatment

char

Tax treatment code for carrier.

Null

tax_rate

smallint

Tax rate, with four implied decimal points (for example, 5% = 5000). (R: >= 0 and <= Null
9999)

multi_tax_rate

bit

Are multiple tax rates in use for this file? (0 = no, 1 = yes)

currency_code_ smallint
home

Currency code for home carrier charges, from RATE_CURRENCY_


REF.

ROAMING_TRANSFER_DETAIL

first_call_dt

Data Type

total_amt

numeric

total_amt_home numeric
total_amt_
foreign

numeric

Values

Currency code for foreign charges, from RATE_CURRENCY_REF.


18 Total charge, in SDR (for GSM) or home carrier currency
(otherwise).
18 Total charge, in home carrier currency.
18 Total charge, in visited carrier currency.

total_tax

numeric

18 Total tax charge amount, in home carrier currency.

total_tax_home

numeric

18 Total tax charge amount, in visited carrier currency.

ABP-9.1-DR1-1999/09/30

total_tax_foreign numeric

18 Total amount of tax charges in error, in SDR (for GSM)


or home carrier currency (otherwise).

total_amt_error

numeric

18 Total amount of charges in error, in SDR (for GSM)


or home carrier currency (otherwise).

total_amt_
home_error

numeric

18 Total amount of charges in error, in home carrier currency.

total_amt_
foreign_error

numeric

18 Total amount of charges in error, in visited carrier currency.

total_tax_error

numeric

18 Total amount of tax charges in error, in SDR (for GSM)


or home carrier currency (otherwise).

total_tax_home_ numeric
error
total_tax_
foreign_error

numeric

total_records

int

Null
Null

18 Total amount of tax charges in error, in home carrier currency.


18 Total amount of tax charges in error, in visited carrier currency.
Total number of records.

451

currency_code_ smallint
foreign

Comments

ROAMING_TRANSFER_DETAIL

Field Name

Data Type

Comments

total_records_
error

int

Total number of records in error.

total_MOC

int

Total number of MOC records.

total_MOC_error int

Total number of MOC records in error.

total_MTC

Total number of MTC records.

int

total_MTC_error int

Total number of MTC records in error.

total_SSC

Total number of supplementary service records.

int

total_SSC_error int

Total number of supplementary service records in error.

total_VAS

Total number of VAS records.

int

ABP-9.1-DR1-1999/09/30

total_VAS_error int

Total number of VAS records in error.

total_exchange_ tinyint
rate

Total number of exchange rate records.

total_utc_offset

tinyint

Total number of UTC time offset records.

total_units

int

Total units in file.


Total units in error in file.

operator_id_
recipient

Roaming operator ID, from ROAMING_OPERATOR_REF.

int

in_out_indicator bit
sid_bid

Null

0 = Local roaming file.


1 = Foreign roaming file.

varchar

For CIBER, the SID or BID for this batch of records. Not applicable
to TAP.

Null

sid_bid_recipient varchar

CIBER, the SID or BID of the recipient.

Null

total_type_10

int

For CIBER, the total number of type 10 records. Not used for TAP.

Null

total_type_11

int

For CIBER, the total number of type 11 records. Not used for TAP.

Null

ROAMING_TRANSFER_DETAIL

total_units_error int

Values

452

Field Name

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

total_type_20

int

For CIBER, the total number of type 20 records. Not used for TAP.

Null

total_type_30

int

For CIBER, the total number of type 30 records. Not used for TAP.

Null

total_type_50

int

For CIBER, the total number of type 50 records. Not used for TAP.

Null

total_type_70

int

For CIBER, the total number of type 70 records. Not used for TAP.

Null

total_type_10_
error

int

For CIBER, the total number of type 10 records in error. Not used
for TAP.

Null

total_type_11_
error

int

For CIBER, the total number of type 11 records in error. Not used
for TAP.

Null

total_type_20_
error

int

For CIBER, the total number of type 20 records in error. Not used
for TAP.

Null

total_type_30_
error

int

For CIBER, the total number of type 30 records in error. Not used
for TAP.

Null

total_type_50_
error

int

For CIBER, the total number of type 50 records in error. Not used
for TAP.

Null

total_type_70_
error

int

For CIBER, the total number of type 70 records in error. Not used
for TAP.

Null

return_reason_id int

CIBER code indicating why the record was returned to the


originating carrier.

status

Reserved for future use. The current status of the CIBER batch;
used for return processing.

int

453

Data Type

ROAMING_TRANSFER_DETAIL

Field Name

R
454

ROAMING_TRANSFER_TAX_DETAIL
Configurable. Stores per-tax-rate statistics about a roaming usage file. Maintained locally on Admin and Customer
servers.

operator_id exists in ROAMING_OPERATOR_REF.


unique on operator_id, batch_seq_num, tax_rate

Triggers:
Indexes:

Field Name
operator_id

Data Type
int

Comments

Values

Null

Intercarrier ID, from ROAMING_OPERATOR_REF.


Join to ROAMING_TRANSFER_DETAIL.

tax_rate

smallint

Tax rate, with four implied decimal points (for example, 5% = 5000). (R: >= 0 and <=
9999)

total_amt

numeric

18 Total charge, in SDR (for GSM) or home carrier currency


(otherwise).

total_amt_home numeric

18 Total charge, in home carrier currency.

total_amt_
foreign

numeric

18 Total charge, in visited carrier currency.

total_tax

numeric

18 Total tax, in SDR (for GSM) or home carrier currency (otherwise).

total_tax_home

numeric

18 Total tax, in home carrier currency.

total_tax_foreign numeric

18 Total tax, in visited carrier currency.

total_amt_error

numeric

18 Total errored charge, in SDR (for GSM) or home carrier currency


(otherwise).

total_amt_
home_error

numeric

18 Total errored charge, in home carrier currency.

total_amt_
foreign_error

numeric

18 Total errored charge, in visited carrier currency.

ROAMING_TRANSFER_TAX_DETAIL

ABP-9.1-DR1-1999/09/30

batch_seq_num int

numeric

Comments

18 Total errored tax, in SDR (for GSM) or home carrier currency


(otherwise).

total_tax_home_ numeric
error

18 Total errored tax, in home carrier currency.

total_tax_
foreign_error

18 Total errored tax, in visited carrier currency.

numeric

in_out_indicator bit

Values

0 = Local roaming usage.

1 = Foreign roaming usage.

Null

ABP-9.1-DR1-1999/09/30

455

total_tax_error

Data Type

ROAMING_TRANSFER_TAX_DETAIL

Field Name

S
456

SALES_CHANNEL_REF
Configurable. Defines valid sales channels for commissioning. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

Only one row can have is_default = 1.


primary-key on sales_channel_id

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

sales_channel_
id

smallint

Unique ID for a sales channel (such as a dealer or a salesperson).

sc_name

char

32 Name for the sales channel.

sc_number

char

32 Number for the sales channel.

Null

sc_contact_
name_pre

char

Null

sc_contact_
fname

char

28 Sales channel contact first name.

Prefix for the sales channels name. For example, Dr. or Mrs.

Null

30 Sales channel contact middle initial.

Null

sc_contact_
lname

char

56 Sales channel contact last name.

Null

sc_contact_
name_gen

char

Null

sc_address1

char

75 Sales channel address.

Null

sc_address2

char

75 Sales channel address.

Null

sc_address3

char

75 Sales channel address.

Null

sc_city

char

35 Sales channel city.

Null

sc_state

char

28 Sales channel state.

Null

Generation of the sales channel contact. For example, Jr., Sr., or


III.

SALES_CHANNEL_REF

sc_contact_minit char

char

sc_country_code smallint

Comments

Values

16 Sales channel zip code.

Null
Null

Sales channel country code.

Null

ABP-9.1-DR1-1999/09/30

sc_phone

char

20 Sales channel phone.

Null

parent_sales_
channel_id

smallint

ID for the parent sales channel for sales channel hierarchies.

Null

commission_id

smallint

Unique ID for the commission.

Null

dealer_pin

char

20 PIN number for the dealer.

Null

security_word

char

20 Security word related to the sales channel.

Null

status

smallint

Status of the sales channel. For example, active, retired, or new


store.

date_active

smalldt

Date the sales channel became active.

date_inactive

smalldt

Date the sales channel became inactive.

num_threshold

smallint

Reserved for future use.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, record is required by Arbor/BP modules; do not delete or


modify.

(D: 0)

Null

457

sc_zip_code

Data Type

SALES_CHANNEL_REF

Field Name

S
458

SALES_CHANNEL_VALUES
Configurable. Contains language-dependent description information for sales channel IDs. Admin table. Read-only copy
exists on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


sales_channel_id exists in SALES_CHANNEL_REF.
unique on sales_channel_id, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

sales_channel_
id

smallint

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

Unique ID for a sales channel, from SALES_CHANNEL_REF.


Language code, from LANGUAGE_CODE_REF.
Short text description.

(D: 1)
Null

SALES_CHANNEL_VALUES

Configurable. Stores conversion rates between Standard Drawing Rights (SDRs) and Arbor/BP currencies. Admin table.
Read-only copy exists on Customer server.
Active date ranges for a given currency_code cannot overlap, and active_dt must be earlier than inactive_dt.
unique on currency_code, active_dt

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

preradix_exch_
rate_mant

int

Integer component of exchange rate mantissa.

(R: >= 0 and <=


99999)

postradix_exch_ int
rate_mant

Decimal component of mantissa (five implied decimal places).

(R: >= 0 and <=


99999)

exch_rate_exp

Exponent component of exchange rate.

(R: >= 0 and <=


9)

tinyint

active_dt

datetime

Date the exchange rate becomes active.

inactive_dt

datetime

Date the exchange rate becomes inactive.

create_dt

smalldt

Date this record was created.

change_dt

smalldt

Date this record was last modified.

change_who

char

Null

Null

30 Username or process ID that last modified the record.

459

Triggers:
Indexes:

SDR_EXCHANGE_RATES

SDR_EXCHANGE_RATES

S
460

SEQ_NUM
Dynamic; also contains static entries. Used to generate unique key numbers for various tables. Maintained locally for
Admin and Customer servers.
Indexes: unique on table_name

Field Name

Data Type

table_name

char

seq_num

int

Comments

Values

Null

30 Table name or key for seq_num. e.g. LBX


Next unique key number for table/key.

ABP-9.1-DR1-1999/09/30

SEQ_NUM

Dynamic; also contains static entries. Defines valid server categories. Admin table. Read-only copy exists on Catalog
server.
Used by the following modules: CUSTINFO, API
Only one row may have is_default = 1.
unique on server_category

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

server_category tinyint

Server category ID.

(R: > 0)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

461

Triggers:
Indexes:

SERVER_CATEGORY_REF

SERVER_CATEGORY_REF

S
462

SERVER_CATEGORY_VALUES
Dynamic; also contains static entries. Describes server categories defined in SERVER_CATEGORY_REF. Admin table.
Read-only copy exists on Catalog server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


server_category exists in SERVER_CATEGORY_REF.
unique on server_category, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

server_category tinyint

Server category ID, from SERVER_CATEGORY_REF.

language_code

Language code, from LANGUAGE_CODE_REF.

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

(D: 1)
Null

SERVER_CATEGORY_VALUES

Configurable. Defines service centers which handle customer inquiries. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CUSTINFO, BIF, COL

Indexes:

Field Name

sc_country_code exists in COUNTRY_CODE_REF.


printer_device_id exists in DEVICES.device_id, or is NULL.
clustered, unique on service_center_id
Data Type

ABP-9.1-DR1-1999/09/30

service_center_ smallint
id

Comments

Values

Null

Unique internal service center ID.

sc_name

varchar

40

Service center name.

sc_contact_
fname

varchar

19

First name of contact at service center.

Null

sc_contact_minit varchar

30

Middle initial of contact at service center.

Null

sc_contact_
lname

varchar

20

Last name of contact at service center.

Null

sc_address1

varchar

75

First line of address at service center.

Null

sc_address2

varchar

75

Second line of address at service center.

Null

sc_address3

varchar

75

Third line of address at service center.

Null

sc_city

varchar

35

City of service center.

Null

sc_state

varchar

28

State of service center.

Null

sc_zip

varchar

16

Zip code of service center.

Null

Country of service center, from COUNTRY_CODE_REF.

(D: 840)

Null

463

sc_country_code smallint

Triggers:

SERVICE_CENTERS

SERVICE_CENTERS

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

sc_county

varchar

28

County of service center.

Null

sc_phone

varchar

20

Phone number for service center.

Null

tele_msg

varchar

120 Telephone message for service center.

Null

fax_msg

varchar

40

Fax message for service center.

Null

email_msg

varchar

40

E-mail message for service center.

Null

chg_date

smalldt

chg_who

char

30

The username or process ID (for example, bip01, cap01) of the


user/process that last modified this record.

printer_device_
id

char

32

Device ID of printer for this service center, if any, from DEVICES


table.

464

Field Name

Date and time this record was last modified.

Null

SERVICE_CENTERS

Configurable. Lists valid types of service centers. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO

Indexes:

Field Name

service_center_type exists in SERVICE_CENTER_TYPE_REF.


service_center_id exists in SERVICE_CENTERS.
clustered, unique on service_center_type, service_center_id

Data Type

Comments

ABP-9.1-DR1-1999/09/30

service_center_ tinyint
type

Identifies the type or role of a service center.

service_center_ smallint
id

Service center ID.

Values

Null

465

Triggers:

SERVICE_CENTER_TYPES

SERVICE_CENTER_TYPES

S
466

SERVICE_CENTER_TYPE_REF
Configurable. Defines service center types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO
Only one row may have is_default = 1.
clustered, unique on service_center_type

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

service_center_ tinyint
type

Unique identifier of service center type:


1 = Billing Service Center
2 = Remittance Center
3 = Service Inquiry Center
4 = Collections Center
6 = Printing Center

(R: 1, 2, 3, 4, 5,
6)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

SERVICE_CENTER_TYPE_REF

Configurable. Describes types defined in SERVICE_CENTER_TYPE_REF. Admin table. Read-only copy exists on
Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


service_center_type exists in SERVICE_CENTER_TYPE_REF.
clustered, unique on service_center_type, language_code
Data Type

service_center_ tinyint
type

Comments

Values

Null

Identifier of service center type, from SERVICE_CENTER_TYPE_


REF.

ABP-9.1-DR1-1999/09/30

language_code

smallint

short_display

char

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Null

467

Triggers:

SERVICE_CENTER_TYPE_VALUES

SERVICE_CENTER_TYPE_VALUES

S
468

SERVICE_PROVIDERS_REF
Configurable. Defines valid service (or information) providers and associates them with provider classes. Admin table.
Read-only copy exists on Customer server.
Used by the following modules: BIP, BIF, CPM, JNL, CAP, RAP
Only one row may have is_default = 1.
provider_class and source_id exist in the appropriate tables (see below).
ext_contact_id exists in EXT_CONTACTS or is NULL.
Different service providers may not share the same ext_contact_id.
provider_service_type must have GUI_INDICATOR_REF entries for validation.
primary-key on provider_id

Triggers:

Indexes:
ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

Values

Null

provider_id

smallint

Unique internal identifier of a service provider.

provider_class

smallint

Class of service provider, from PROVIDER_CLASS_REF.

merchant_
account_no

char

main_provider_
flag

bit

merchant_id

char

Merchant ID.

Null

merchant_
category_code

char

Merchant account category code.

Null

security_code

char

Security code.

Null

merchant_name char

19

Name of merchant.

Null

merchant_city

13

City of merchant.

Null

Merchant account identifier.

Null

Is the merchant a main service provider? (1 = yes)

SERVICE_PROVIDERS_REF

char

12

(R: > 0)

Comments

Values

Null

merchant_state_ char
prov

State or province of merchant.

Null

merchant_zip

ZIP or postal code of merchant.

Null

Phone number for this service provider.

Null

char

merchant_phone varchar
amex_flag

20

bit

Does the merchant accept AMEX credit cards? (1 = yes) If so, then
an R (AMEX Descriptor) record is needed.

ABP-9.1-DR1-1999/09/30

amex_descriptor char

23

Text tag that appears on a customers credit card bill. Charges


billed to different providers can be distinguished on credit card bills.

Null

clearing_house_ char
id

Clearinghouse ID, from CLEARING_HOUSE_ID_REF.

Null

Billing source ID, from EXT_SOURCE_ID_REF.

Null

source_id

int

home_provider_ bit
flag

Is this service provider your organization? (1 = yes) Wireless


usage processing requires that one entry in this table represent
your organization.

batch_seq_
num_out

smallint

Next unique key number for outgoing files to this service provider. (D: 0)

batch_seq_
num_in

smallint

Next unique key number for ingoing files to this service provider.

ext_contact_id

smallint

External data source ID, from EXT_CONTACTS.

Null

country_code

smallint

Country code corresponding to this service providers country.

Null

operating_
company_
number

char

Used by Arbor/OM to support CARE processing.

Null

(D: 0)

(D: 0)

469

Data Type

SERVICE_PROVIDERS_REF

Field Name

Data Type

Comments

Values

Null

customer_
carrier_name_
abbr

char

Used by Arbor/OM to support CARE processing.

Null

carrier_id_code

ABP-9.1-DR1-1999/09/30

char

Used by Arbor/OM to support CARE processing.

Null

access_carrier_ char
name_abbr

Used by Arbor/OM to support CARE processing.

Null

revenue_
accounting_
office

char

Used by Arbor/OM to support CARE processing.

Null

provider_
service_type

smallint

Used by Arbor/OM to support CARE processing.

Null

switchless_
reseller

bit

Used by Arbor/OM to support CARE processing.

open_item_id

int

Open item ID, from OPEN_ITEM_ID_REF.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

registration

varchar

(D: 0)
Null
(D: 0)

Null

SERVICE_PROVIDERS_REF

128 Alphanumeric identifier associated with this service provider of up


to 128 characters, such as 5AE10J6RO92. For telecom providers,
you can enter the alphanumeric tax registration number for this
service provider.

470

Field Name

Configurable. Describes service providers defined in SERVICE_PROVIDERS_REF. Admin table. Read-only copy exists
on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


provider_id exists in SERVICE_PROVIDERS_REF.
clustered, unique on provider_id, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

provider_id

smallint

Service provider identifier, from SERVICE_PROVIDERS_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

471

Triggers:

SERVICE_PROVIDERS_VALUES

SERVICE_PROVIDERS_VALUES

S
472

STATE_REF
Configurable. Associates state geocodes used on charges with state information which is displayed on the bill. Admin
table. Read-only copy exists on Customer server.
Used by the following modules: GUIs
Only one row may have is_default = 1.
country_code exists in COUNTRY_CODE_REF.
unique on country_code, state_abbr
clustered, unique on country_code, state_geocode

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

country_code

smallint

state_geocode

char

Official code used by the Vertex and custom geocoders.

state_abbr

char

2-character state abbreviation (for example, MA).

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or


modify.

Values

Null

Country code, from COUNTRY_CODE_REF.

STATE_REF

Configurable. Describes state geocode information found in STATE_REF. Admin table. Read-only copy exists on
Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


country_code, state_geocode, and state_abbr exist in STATE_REF.
unique on country_code, state_abbr, language_code
unique on country_code, state_geocode, state_abbr, language_code
clustered, unique on country_code, state_geocode, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

country_code

smallint

state_geocode

char

State geocode, from STATE_REF.

state_abbr

char

2-character state abbreviation, from STATE_REF.

language_code

smallint

display_value

varchar

80 Text description to be displayed on screen.

short_display

char

Values

Null

Country code, from COUNTRY_CODE_REF.

Language code, from LANGUAGE_CODE_REF.


Abbreviated version of the display value.

Null

473

Triggers:

STATE_VALUES

STATE_VALUES

S
474

SUSPENDED_REASON_REF
Configurable. Defines valid reasons for suspending collections events in a customers event queue. Suspension is carried
out by CSRs through collections GUI. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, COL
Only one row can have is_default = 1.
clustered, unique on suspended_code

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

suspended_
code

smallint

Unique suspension reason ID.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

SUSPENDED_REASON_REF

Configurable. Describes suspension reason IDs. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, COL

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


suspended_code exists in SUSPENDED_REASON_REF.
clustered, unique on suspended_code, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

suspended_
code

smallint

Suspension reason ID, from SUSPENDED_REASON_REF.

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

Language code, from LANGUAGE_CODE_REF.


Short text description of the suspension reason.

475

Triggers:

SUSPENDED_REASON_VALUES

SUSPENDED_REASON_VALUES

S
476

SYSTEM_MESSAGES
Static. Defines all valid messages that can appear in batch process activity log files. Admin table. Read-only copy exists
on Customer server.
Triggers:

Indexes:

Field Name
ABP-9.1-DR1-1999/09/30

message_
language

Ensures message_severity is a valid value if the language is English.


module_name exists in SYSTEM_MODULES, unless NULL.
Only one record at a time can be inserted.
unique on message_number, message_language
unique on message_name, message_language

Data Type

Comments

varchar

20

Language the error message is in (for example, English).

message_name varchar

20

Error message identifier (name).

Values

Null

int

Error message number.

message_
severity

char

10

Severity of message. In English, one of the following:


DEBUG, INFORM, WARN, ERROR, ALARM, FATAL.

message_text

varchar

50

Error message text.

module_name

char

10

Module which can invoke the error, from SYSTEM_MODULES or Null


(any module).

Null

category

int

Reserved for future use.

Null

action

int

Reserved for future use.

Null

description

varchar

Long description of error.

Null

255

SYSTEM_MESSAGES

message_
number

Static, internal use only. Stores a list of all system modules recognized by the Arbor/BP error messaging system. Admin
table. Read-only copy exists on Customer server.
Indexes: unique on module_name

Field Name
module_name

Data Type
varchar

Comments

10 Name of the module. Do not modify the values in this table.

Values

Null

SYSTEM_MODULES

SYSTEM_MODULES

Null

ABP-9.1-DR1-1999/09/30

477

S
478

SYSTEM_PARAMETERS
Configurable. Defines system parameters. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

parameter_name and module may not be modified or updated.


parent_sales_channel_id must already exist in this table.
unique on module, parameter_name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

module

char

parameter_name

varchar

32 Name of system parameter.

int_value

int

char_value

varchar

Values

Null

Module for which this parameter is used.


Integer value for this system parameter.

32 Character value of this system parameter.

Null
Null

SYSTEM_PARAMETERS

Configurable. Contains mapping information about usage types. Admin table.


Used by the following modules: TIP

ABP-9.1-DR1-1999/09/30

Indexes:

Field Name

If record_type = 20 or record_type = 30, there can be only one row for a given combination of sender, service_
type, and service_code.
If record_type = 40, there can be only one row for a given combination of sender, service_type, service_code,
ss_code, and ss_action_code.
For any given value of subscr_id_type, there can be only one row with record_type = 50 or record_type = 60.
If record_type = 50, there can be only one row for a given combination of sender and charged_party_status.
If record_type = 60, there can be only one row for a given combination of sender and vas_code.
For any given value of sender, there can be only one row with record_type = 70.
If record_type = 71, there can be only one row for a given combination of sender and service_key.
This table has no indexes.

Data Type

record_type

tinyint

sender

char

service_type

tinyint

Comments

Values

Null

TAP2 record type (in other words 20, 30, 40, 50, 60, 70, 71)
5

TAP2 identifier of the PLMN which is sending the file. This field
should be the same as GSM_ROAMING_AGREEMENT.plmn_name
where GSM_ROAMING_AGREEMENT.plmn_type = 2.

Null

TAP2 code which uniquely defines the type of basic service, either
a Teleservice Code (0) or a Bearer Service Code (1).

Null

479

Triggers:

TAP_MAPPING

TAP_MAPPING

T
Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

Null

TAP2 Supplementary Service Code:


00 = all supplementary services
10 = all line identification services
9B = barring of all IC calls when outside HPLMN

Null

TAP2 qualifier for the way in which the supplementary service is


used:
0 = registration
1 = erasure
2 = activation
3 = deactivation
4 = interrogation
5 = invocation
6 = registration of password

Null

A single character used to denote whether the number used to


identify the subscriber is an IMSI or an MSISDN.
I = IMSI
M = MSISDN

Null

Indicates whether the chargeable subscriber is the originating (0)


or terminating (1) party.

Null

tinyint

A classification of Value Added Services.

Null

service_key

int

Identification of the CAMEL service logic to be applied to the IN


subscriber.

Null

type_id_usg

smallint

Usage type, from USAGE_TYPES, or 0 (all).

Null

ext_id_type

smallint

External ID source type, from EXTERNAL_ID_TYPE_REF.

Null

tinyint

ss_code

char

ss_action_code

tinyint

subscr_id_type

char

charged_party_
status

char

vas_code

TAP_MAPPING

If service_type = 0,
11 = telephony
12 = emergency calls
63 = automatic facsimile group 4
If service_type = 1,
21 = Duplex Asynch. 300bps data circuit
96 = Speech then Synch. 9600bps unrestricted digital.

service_code

480

Field Name

Configurable. Contains information required to perform a lookup of a tax package instance. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: BIP, CUSTINFO

ABP-9.1-DR1-1999/09/30

Indexes:

Field Name

provider_id, country_code, franchise_code, and account_category exist in the appropriate tables (see below),
or are NULL.
tax_pkg_inst_id is greater than 0, and exists in TAX_PKG_INST_ID_REF.
Validate charge_elt_id against the following tables, depending on the value of charge_elt_type: 1
PRODUCT_ELEMENTS, 2 NRC_TRANS_DESCR, 3 USAGE_TYPES, 4 ADJ_TRANS_DESCR, 5 TAX_
PKG_INST_ID_REF.
Tax package may not tax itself.
unique on account_category, brand_id, country_code, state_code, county_code, city_code, franchise_code,
charge_elt_type, charge_elt_id, tax_pkg_inst_id
Data Type

Comments

Values

Null

account_
category

tinyint

Account category identifier, from ACCOUNT_CATEGORY_REF.

Null

brand_id

smallint

From CMF; reserved for future use.

Null

country_code

smallint

Country portion of geocode, from COUNTRY_CODE_REF.

Null

state_code

smallint

State portion of geocode.

Null

county_code

smallint

County portion of geocode.

Null

city_code

smallint

City portion of geocode.

Null

franchise_code

smallint

Franchise portion of geocode, from FRANCHISE_CODE_REF.

Null

481

Triggers:

TAX_ASSIGNMENTS

TAX_ASSIGNMENTS

T
Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

charge_elt_type smallint

Identifies the kind of charge:


(R: 1, 2, 3, 4, 5) Null
1 = recurring charge
2 = non-recurring charge
3 = usage charge
4 = adjustment
5 = tax charges, or potentially tax charges plus the orginal charges
they were based on

charge_elt_id

smallint

ID of charge
Type 1: PRODUCT_ELEMENTS.element_id
Type 2: NRC_TRANS_DESCR.type_id_nrc
Type 3: USAGE_TYPES.type_id_usg

Null

provider_id

smallint

Service provider identifier, from SERVICE_PROVIDERS_REF.

Null

tax_pkg_inst_id

smallint

Tax package instance ID, from TAX_PKG_INST_ID_REF.

482

Field Name

TAX_ASSIGNMENTS

Configurable. Contains taxation information for every charge (RC, NRC, Usage) billable by Arbor/BP, and taxed
through a custom tax package. This table is used only for Custom tax packages. Admin table. Read-only copy exists on
Customer server.

ABP-9.1-DR1-1999/09/30

Indexes:

Field Name

charge_elt_id exists in appropriate table (see below).


If compliance_trans_code is 1, 2, 3, 4 or Z, taxable_bus_ind must be P.
If taxable_bus_ind = T, the following fields must be NULL; otherwise, they must be non-NULL: type_of_
charge, service_group, teletax_calc_ind, frequency, division, product_code, product_group, terms_code,
usage_of_product.
If teletax_calc_ind is RB, compliance_trans_code must be D.
If frequency is R, type_of_charge must be US, MI, BD, EL, DA, or OT.
If frequency is N, type_of_charge must be FC, LP, IN, TR, RP, CN, CA, JK or OT.
If frequency is O, type_of_charge must be OT.
unique on charge_elt_type, charge_elt_id

Data Type

Comments

charge_elt_type smallint

Identifies the kind of charge:


1 = recurring charge
2 = non-recurring charge
3 = usage charge
4 = adjustment

charge_elt_id

ID of charge:
Type 1: PRODUCT_ELEMENTS.element_id
Type 2: NRC_TRANS_DESCR.type_id_nrc
Type 3: USAGE_TYPES.type_id_usage
Type 4: ADJ_TRANS_DESCR.adj_trans_code

smallint

taxable_bus_ind char

Is charge telecommunications? (T = yes, P = no)

Values

Null

(R: 1, 2, 3, 4, 5)

(R: "P", "T")

483

Triggers:

TAX_CHARGE_ELEMENTS

TAX_CHARGE_ELEMENTS

T
Data Type

Comments

Values

Null

compliance_
trans_code

char

Custom tax package compliance transaction code.


(R: "A", "B", "D",
One of the following: A, B, D, F, I, J, L, R, S, U, W, X, Z, 1, 2, 3, 4, . "F", "I", "J", "L",
"R", "S", "U",
"W", "X", "Z", "1",
"2", "3", "4", " ")

service_group

char

Custom tax package service group.

(R: "M", "P", "W", Null


"8", "C", "S", "A")
(R: "R", "N", "O") Null

ABP-9.1-DR1-1999/09/30

char

Custom tax package billing frequency.

type_of_charge

char

Custom tax package type of charge. One of the following: US,


(R: "US", "MI",
Null
MI, DA, BD, EL, FC, LP, IN, TR, RP, CN, CA, JK, "DA", "BD", "EL",
OT, RF, NF
"FC", "LP", "IN",
"TR", "RP",
"CN", "CA", "JK",
"OT", "RF",
"NF")

teletax_calc_ind char

Custom tax package teletax indicator.


One of: RB, TF, space, or two spaces.

(R: "RB", "TF", " Null


", " ")

division

char

Custom tax package product division.

(R: "A", "C", "T") Null

product_code

char

10 Custom tax package product code.

Null

TAX_CHARGE_ELEMENTS

frequency

484

Field Name

Data Type

Comments

Values

Null

char

Custom tax package product group.

Null

terms_code

char

Custom tax package product terms code. One of the following:


(R: "999N",
Null
999N, 999R, 999S, 999Z, 999M, WWWW, 001 , A000- "999R", "999S",
L999, N000-Z999, M000-M999, 000 -0009.
"999Z", "999M",
"WWWW", "001
") or (between
"A000" and
"L999") or
(between "N000"
and "Z999") or
(between
"M000" and
"M999") or
(between "000 "
and "0009")

usage_of_
product

char

Custom tax package product usage code. One of PL, space, or


two spaces.

(R: "PL", " ", " ") Null

485

ABP-9.1-DR1-1999/09/30

product_group

TAX_CHARGE_ELEMENTS

Field Name

T
486

TAX_CODES_COMM
Configurable. Assigns a CommTax category and code to every charge type and charge ID. For every charge type in
PRODUCT_ELEMENTS, NRC_TRANS_DESCR, and USAGE_TYPES, there must be a row in this table, otherwise CommTax
can only calculate Federal Excise Tax on the charge. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIP
Triggers:

Indexes:
ABP-9.1-DR1-1999/09/30

Field Name

If charge_elt_type = 1, charge_elt_id exists in PRODUCT_ELEMENTS.element_id or is NULL.


If charge_elt_type = 2, charge_elt_id exists in NRC_TRANS_DESCR.type_id_nrc or is NULL.
If charge_elt_type = 3, charge_elt_id exists in USAGE_TYPES.type_id_usg or is NULL.
charge_elt_type cannot be 4.
jurisdiction exists in JURISDICTIONS or is NULL.
unique on charge_elt_type, charge_elt_id, jurisdiction

Data Type

Comments

Values

Null

Identifies the kind of charge:


1 = recurring charge
2 = non-recurring charge
3 = usage charge
4 = adjustment
5=

(R: 1, 2, 3, 4, 5)

charge_elt_id

smallint

Charge ID, depends on charge_elt_type:


charge_elt_type = 1, PRODUCT_ELEMENTS.element_id
charge_elt_type = 2, NRC_TRANS_DESCR.type_id_nrc
charge_elt_type = 3, USAGE_TYPES.type_id_usg

Null

jurisdiction

smallint

Territorial range of usage, from JURISDICTIONS or Null (match all


jurisdictions).

Null

TAX_CODES_COMM

charge_elt_type smallint

tinyint

Comments

ABP-9.1-DR1-1999/09/30

CommTax parameter which helps identify the type of charge:


1 = intrastate service
2 = other charge type
3 = reserved by Vertex
4 = interstate service
For CommTax21 only:
5 = calling features
6 = reserved by Vertex
7-9 = Flexible Categories
10 = Wireless Network
11-12 = reserved by Vertex
13-15 = Flexible Categories
See your CommTax documentation for more information about
category codes.

Values
(R: > 0)

Null

487

tax_category

Data Type

TAX_CODES_COMM

Field Name

T
Data Type

Comments

Values

Service code for the given tax_category, used by CommTax to


identify the type of charge.
For tax_category = 1:
1 = dial tone line
2 = toll
3 = private line
4 = outbound calling plan 5 = 800
6 = access
charge
For tax_category = 2:
1 = installation
2 = repair
For tax_category = 4:
1 = toll
2 = private line
3 = outbound
calling plan
4 = 800
5 = access
charge
For tax_category = 5 CommTax 21 only:
1 = Feature Activation/Deactivation
2 = Call Waiting
3 = Call Forwarding
4 = Voice Mail
5 = Caller ID
6 = Debit Calling Card
For tax_category = 7-9 or 13-15 CommTax 21 only:
1-10 = Flexible services for each category
For tax_category = 10 CommTax21 only:
1 = Network Access
2 = Usage/Airtime-Intrastate
3 = Usage/Airtime-Interstate
4 = Service Activation/Deactivation
5 = Landline Fees
6 = Messaging
See your CommTax documentation for more information about
service codes.

(R: > 0)

utility_code

tinyint

0 = unregulated, 1 = regulated

(R: 0, 1)

resale_flag

tinyint

0 = sale, 1 = resale

(R: 0, 1)

TAX_CODES_COMM

tinyint

ABP-9.1-DR1-1999/09/30

tax_code

Null

488

Field Name

Configurable. Defines default geocodes to be used for taxation when an optional geocode is missing. Admin table. Readonly copy exists on Customer server.
Used by the following modules: BIP, CAP, RAP, MIU, CUSTINFO

Indexes:

ABP-9.1-DR1-1999/09/30

Field Name
tax_pkg_inst_id

charge_elt_id and tax_pkg_inst_id_ref exist in appropriate tables.


pt_default_geocode must exist if pt_location_code = 0.
pt_location_code cannot be 4 if charge_elt_type = 3 and point_number = 1.
pt_location_code cannot be 5 if charge_elt_type = 3 and point_number = 2.
unique on charge_elt_type, charge_elt_id, point_number
non-unique on tax_pkg_inst_id
Data Type

smallint

Comments

Null

Tax package instance ID, from TAX_PKG_INST_ID_REF, or 0 (all).

charge_elt_type smallint

Identifies the kind of charge:


1 = recurring charge
2 = non-recurring charge
3 = usage charge
4 = adjustment

charge_elt_id

ID of charge; depends on charge type:


Type 1: PRODUCT_ELEMENTS.element_id
Type 2: NRC_TRANS_DESCR.type_id_nrc
Type 3: USAGE_TYPES.type_id_usg
Type 4: ADJ_TRANS_DESCR.adj_trans_code

smallint

Values

(R: 1, 2, 3, 4, 5)

489

Triggers:

TAX_ELEM_DEFAULT_LOC

TAX_ELEM_DEFAULT_LOC

point_number

Data Type
tinyint

pt_location_code smallint

ABP-9.1-DR1-1999/09/30

pt_default_
geocode

varchar

Comments
Location point number; depends on charge type:
Type 1 = Origin of usage event
Type 2 = Destination of usage event
Type 3 = Reserved for future use
Type 4 = Reserved for future use

Values

Null

490

Field Name

(R: 1, 2, 3, 4)

Tax location code for default geocode:


(R: 0, 1, 2, 3, 4,
0 = use value from pt_default_geocode
5, 6)
1 = CMF.bill_geocode
2 = CMF.cust_geocode
3 = EMF.service_geocode
4 = use CDR_DATA.point_tax_code_origin (origin geocode)
5 = use CDR_DATA.point_tax_code_target (destination
geocode)
6 = reserved for future use.
15 Geocode to use if pt_location_code is zero.

Null

TAX_ELEM_DEFAULT_LOC

Configurable. Stores custom tax rates. Admin table. Read-only copy exists on Customer server.

charge_elt_id, country_code, tax_pkg_inst_id, and franchise_code exist in appropriate tables or are 0.


franchise_code and state_code must be 0 when country_code is 0.
county_code must be 0 when state_code is 0.
city_code must be 0 when county_code is 0.
charge_elt_id must be 0 when charge_elt_type is 0.
tax_type_code must be 0 if tax_pkg_inst_id is 0.
unique on charge_elt_type, charge_elt_id, tax_pkg_inst_id, tax_type_code, country_code, franchise_code,
state_code, county_code, city_code

Indexes:

ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

Values

charge_elt_type smallint

Type of charge for which the geocode applies:


0 = all charges
1 = recurring charge
2 = non-recurring charge
3 = usage charge

charge_elt_id

smallint

From PRODUCT_ELEMENTS.element_id if charge_elt_type = 1. (D: 0)


From NRC_TRANS_DESCR.type_id_nrc if charge_elt_type = 2.
From USAGE_TYPES.type_id_usg if charge_elt_type = 3.
0 (all charge types) if charge_elt_type = 0.

tax_pkg_inst_id

smallint

Positive tax package instance ID from TAX_PKG_INST_ID_REF, (D: 0)


or 0 (all, use if tax_type_code is 0).

tax_type_code

int

Tax type code, from TAX_RATES_VAT or TAX_TYPE_COMM_REF, (D: 0)


or 0 (all).

country_code

smallint

Country component of original geocode (from COUNTRY_CODE_


REF), or 0 (all countries).

Null

(D: 0) (R: 0, 1, 2,
3)

(D: 0)

491

Triggers:

TAX_OVERRIDES

TAX_OVERRIDES

T
Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

franchise_code

smallint

Franchise component of original geocode (from FRANCHISE_


CODE_REF), or 0 (all franchises).

state_code

smallint

State component of original geocode without leading zeroes, or 0 (D: 0)


(all).

county_code

smallint

County component of original geocode without leading zeroes, or (D: 0)


0 (all).

city_code

smallint

City component of original geocode without leading zeroes, or 0


(all).

(D: 0)

priority

tinyint

Higher values indicate higher priorities.

(D: 0)

federal_rate

int

Override federal tax rate.

Null

state_rate

int

Override state tax rate.

Null

county_rate

int

Override county tax rate.

Null

city_rate

int

Override city tax rate.

Null

other_rate

int

Override other tax rate.

Null

492

Field Name

(D: 0)

TAX_OVERRIDES

Configurable. Contains information used to look up tax packages, including basic type and order of tax-package instance
application. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIP, CUSTINFO
Only one row may have is_default = 1.
tax_pkg_inst_id must be sequential.
Only one row at a time can be inserted.
tax_pkg_inst_id must be sequential only if greater than 0.
primary-key on tax_pkg_inst_id

Triggers:

Indexes:

TAX_PKG_INST_ID_REF

TAX_PKG_INST_ID_REF

Check Constraints:is_binned != 0 or is_distributed != 0


Data Type

Comments

Values

tax_pkg_inst_id

smallint

Unique internal ID for tax package instance.

(R: >= -2)

tax_pkg_type

smallint

1=Sales, 2=CommTax, 3=Universal, 4=Custom

(R: 1, 2, 3, 4)

pkg_order

smallint

Order in which to apply this package; used when multiple tax


packages apply to a charge or when taxes themselves are taxed.
Lower values apply before higher values.

basic_days

smallint

Number of days used for UK-style VAT taxing, or zero.

is_binned

bit

Is the tax calculated on a bin, or collection, of charges? (1 = yes) (D: 0)


Charges are binned according to the value of tax_pkg_inst_id, tax_
class (ignore if Null in TAX_RATES_VAT), tax_rate, billing_
category, provider_id, and geo-code.

is_distributed

bit

Are the taxes distributed back to the bins charges? (1 = yes)

Null

(D: 0) (R: >= 0)

(D: 1)

is_franchise

bit

Is this a franchise tax (for Universal Tax Package only)? (1 = yes) (D: 0)

is_gui_pretax

bit

Can be used with external bills? (1 = yes)

(D: 0)

493

ABP-9.1-DR1-1999/09/30

Field Name

T
Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

exclude_charge bit

Exclude charge amount and only calculate tax on the charges tax (D: 0)
amount? (1 = yes)

rounding_
method

tinyint

0 = no rounding method (in other words truncate)


1 = always round to the next lowest value
2 = round to next highest value
3 = round to nearest value (round up if exactly half)
4 = round to nearest value (round down if exactly half)

(D: 3) (R: 0, 1, 2,
3, 4)

tax_type

smallint

Tax type.
1 = point-of-invoice
2 = point-of-sale

(D: 0)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

is_graduated

bit

Allow graduated (tiered) taxes? (1 = yes).


If tax_pkg_type not equal to 3, the value of this field is ignored by
Arbor/BP.

Null

494

Field Name

TAX_PKG_INST_ID_REF

Configurable. Describes tax package instances defined in TAX_PKG_INST_ID_REF. Admin table. Read-only copy exists
on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


tax_pkg_inst_id exists in TAX_PKG_INST_ID_REF.
unique on tax_pkg_inst_id, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

tax_pkg_inst_id

smallint

Tax package instance ID, from TAX_PKG_INST_ID_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

495

Triggers:

TAX_PKG_INST_ID_VALUES

TAX_PKG_INST_ID_VALUES

T
496

TAX_RATES_VAT
Configurable. Contains information required to look up universal tax rates. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: BIP, CUSTINFO

active_date earlier than or equal to inactive_date and date bands do not overlap.
For a given tax_pkg_inst_id there may be one row with tax_class = 0 or multiple rows with non-zero tax_
class values.
currency_code can be NULL only if fixed_amt is 0 or NULL.
tax_pkg_inst_id exists in TAX_PKG_INST_ID_REF.
Cant update tax_type_code.
If fixed_amt is not 0 or NULL, billing_frequency cannot be NULL.
Only one of rate and fixed_amt may be non-zero or non-NULL.
If currency_code is NULL, range_terminus must also be NULL.
unique on tax_pkg_inst_id, tax_class, billing_frequency, currency_code, active_date, range_terminus
non-unique on tax_type_code, currency_code

Triggers:

ABP-9.1-DR1-1999/09/30

Indexes:

Foreign Keys:(currency_code) must exist in RATE_CURRENCY_REF(currency_code)


Check Constraints:currency_code is not null or (currency_code is null and range_terminus is null)
Field Name

Data Type

Comments

smallint

Tax package instance ID, from TAX_PKG_INST_ID_REF.

currency_code

smallint

Currency code, from RATE_CURRENCY_REF.

fixed_amt

numeric

tax_class

smallint

Unique identifier of the tax class, use 0 if only a a single tax rate
applies for each tax package.

rate

int

Percentage rate for the tax class. This field has 4 implied decimal
places, for example: 1% would be 10000 in this field.

active_date

datetime

Date this rate becomes active.

18 Fixed amount of tax, if any.

Null

Null
Null

TAX_RATES_VAT

tax_pkg_inst_id

Values

Data Type

Comments

inactive_date

datetime

Date this rate expires.

tax_type_code

int

VAT tax type code.

billing_frequency tinyint
range_terminus

numeric

Billing frequency associated with tax rate, from BILLING_


FREQUENCY_REF.
18 Ceiling of range to which tax can be applied. Upper limit is one less
than the value of this field. Lower limit is defined by presence of
another row in this table with the closest lower range_terminus
value. Null means infinity. To use this field, currency_code must
contain a valid value.

Values

Null
Null

(R: > 0)
Null

TAX_RATES_VAT

Field Name

Null

ABP-9.1-DR1-1999/09/30

497

T
498

TAX_STATUS_REF
Configurable. Defines valid tax statuses, used to identify particular types of tax exemptions. Admin table. Read-only
copy exists on Customer server.
Used by the following modules: CUSTINFO
Triggers:
Indexes:

Field Name

Only one row may have is_default = 1.


unique on tax_status

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

tax_status

smallint

Unique internal identifier of the tax status of an account.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

TAX_STATUS_REF

Configurable. Describes tax statuses defined in TAX_STATUS_REF. Admin table. Read-only copy exists on Customer
server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


tax_status exists in TAX_STATUS_REF.
clustered, unique on tax_status, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

tax_status

smallint

Tax status identifier, from TAX_STATUS_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

499

Triggers:

TAX_STATUS_VALUES

TAX_STATUS_VALUES

T
500

TAX_TYPE_COMM_REF
Configurable. Defines each of the possible CommTax tax types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIF
Triggers:
Indexes:

Field Name

Only one row may have is_default = 1.


unique on tax_type

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

tax_type

tinyint

CommTax parameter (0 to 99).

(R: >= 0 and <=


99)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

(D: 0)

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

TAX_TYPE_COMM_REF

Configurable. Describes CommTax types defined in TAX_TYPE_COMM_REF. Admin table. Read-only copy exists on
Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


tax_type exists in TAX_TYPE_COMM_REF.
unique on tax_type, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

tax_type

tinyint

CommTax parameter, from TAX_TYPE_COMM_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

80 Text description to be displayed on screen.

short_display

char

Abbreviated description of tax type.

Values

Null

Null

501

Triggers:

TAX_TYPE_COMM_VALUES

TAX_TYPE_COMM_VALUES

T
502

TICKLER
Dynamic. Holds the memos for the Tickler Memo System (tms). Admin table.
Used by the following modules: CUSTINFO, tms
Triggers:
Indexes:

Field Name

subject_line and memo_text cannot both be NULL.


clustered on to_user (allow duplicate row)
unique on from_user, to_user, create_dt

Data Type

Comments

ABP-9.1-DR1-1999/09/30

from_user

char

30

Sybase From user.

to_user

char

30

Sybase To user.

Values

Null

datetime

acct_level_
external_id

char

48

External ID used to identify account.

Date and time this record was created.


Null

subscr_level_
external_id

char

48

External ID used to identify service instance.

Null

memo_type

char

A = Action
I = Informational
P = Personal

(R: "A", "I", "P")

memo_status

char

O = Open
C = Complete
R = Reassigned

(R: "O", "C", "R")

due_dt

smalldt

reminder_dt

smalldt

subject_line

varchar

60

memo_text

varchar

255 Note.

Date action is due.

Null

Date reminder should pop up.

Null

Subject of the memo.

Null
Null

TICKLER

create_dt

Data Type

was_
acknowledged

bit

chg_who

char

chg_dt

smalldt

Comments
Did the CSR acknowledge a reminder? (1 = yes)

30

Values

Null

TICKLER

Field Name

The username or process ID (for example, bip01, cap01) of the


user/process that last modified this record.
Date and time this record was last modified.

ABP-9.1-DR1-1999/09/30

503

T
504

TIMEZONE_REF
Configurable. Holds valid timezone codes. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, CAP, RAP, MIU
Triggers:
Indexes:

Field Name

Only one row may have is_default = 1.


primary-key on timezone

Data Type

Comments
Unique internal timezone code.

Values

ABP-9.1-DR1-1999/09/30

timezone

tinyint

unix_tz

char

isdst

bit

Is there is a summer timezone adjustment (for example daylight


savings)? (1 = yes)

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(R: < 255)

14 UNIX timezone designator (for example, "MST7MDT" for USA


Mountain timezone).

(D: 0)

TIMEZONE_REF

Configurable. Describes timezone codes defined in TIMEZONE_REF. Admin table. Read-only copy exists on Customer
server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


timezone exists in TIMEZONE_REF.
unique on timezone, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

timezone

tinyint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

language_code

smallint

Values

Null

Timezone code, from TIMEZONE_REF.


Abbreviated version of the display value.
Language code, from LANGUAGE_CODE_REF.

Null
(D: 1)

505

Triggers:

TIMEZONE_VALUES

TIMEZONE_VALUES

T
506

TRANSLATION
For internal use only. Used at initialization time for translating a system for non-english users. Read-only copies exist on
Catalog and Customer servers. Admin table.
Indexes: unique on table_name, language_code, origin_value

Field Name

Data Type
80

Comments

ABP-9.1-DR1-1999/09/30

table_name

varchar

language_code

smallint

origin_value

varchar

240 English text.

target_value

varchar

240 Translated text for language_code.

Values

Null

Table name.
Language code, from LANGUAGE_CODE_REF.
Null

TRANSLATION

Configurable. Defines valid transaction sources. Admin table. Read-only copy exists on Customer server.
Only one row may have is_default = 1.
unique on trans_source

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

trans_source

tinyint

source_id

char

10 Transaction source ID.

module

char

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

Source by which the transaction entered the database.


Null

Transaction source category identifier, such as PYMT", "CPM",


"EFT", "LBX", "DEPT", "RFND", and "API".
(D: 0)

507

Triggers:
Indexes:

TRANS_SOURCE_REF

TRANS_SOURCE_REF

T
508

TRANS_SOURCE_VALUES
Configurable. Describes transaction sources defined in TRANS_SOURCE_REF. Admin table. Read-only copy exists on
Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


trans_source exists in TRANS_SOURCE_REF.
clustered, unique on trans_source, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

trans_source

tinyint

Transaction source, from TRANS_SOURCE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

80 Text description to be displayed on screen.

short_display

char

Abbreviated version of the display value.

Values

Null

Null

TRANS_SOURCE_VALUES

Configurable. For each unit credit, defines which usage charges it applies to and how it reduces them. Admin table.
Read-only copy exists on Customer server.
Used by the following modules: CUSTINFO, BIP, BIF

ABP-9.1-DR1-1999/09/30

Indexes:

Field Name

description_code, product_line_id, provider_id, ratable_unit_class, and type_id_usg exist in the appropriate


tables (see below).
element_id exists in PRODUCT_ELEMENTS if unit_cr_level = 2, and does not exist in PRODUCT_ELEMENTS if
unit_cr_level = 1.
If unit_cr_distrib = 2, then unit_cr_level = 2.
If unit_cr_domain <> 3, then unit_cr_quantum cannot be 3.
Ensure domain_id and unit_cr_domain are consistent.
element_id can be NULL if unit_cr_level = 2.
type_id_usg is no longer validated against USAGE_TYPES.
primary-key on unit_cr_id

Data Type

Comments

Values

Null

unit_cr_id

smallint

Unique internal ID of a specific unit credit definition.

(R: > 0)

unit_cr_level

smallint

Level that the unit credit may be active:


1 = account level
2 = service instance level

(R: 1, 2)

unit_cr_distrib

smallint

Method by which the credit is distributed:


1 = account distribution
2 = service instance distribution

(R: 1, 2)

element_id

smallint

Product identifier from PRODUCT_ELEMENTS, if credit is active at


service instance level (unit_cr_level = 2).

Null

provider_id

smallint

Service provider identifier, from SERVICE_PROVIDERS_REF.

Null

509

Triggers:

UNIT_CR_DEFINITIONS

UNIT_CR_DEFINITIONS

U
Data Type

Comments

Values

Null

product_line_id

smallint

ID of the product line to whose associated charges the unit credit is


restricted, from PRODUCT_LINES.

Null

format_code

tinyint

Contains deployment-specific values.

Null

date_active

smalldt

Date the credit becomes active.

date_inactive

smalldt

Date the credit becomes inactive.

date_created

smalldt

Date the record was entered.

Null

ABP-9.1-DR1-1999/09/30

description_code smallint

Description from DESCRIPTIONS table.

ratable_unit_
class

smallint

From RATABLE_UNIT_CLASS_REF.ratable_unit_class.
Determines the units (for example, minutes, seconds, and so on)
for the credit.

unit_cr_domain

smallint

Category of charges for credit:


1 = recurring charges
2 = non-recurring charges
3 = usage charges
4 = all charges

(R: NULL, 1, 2,
3, 4)

unit_cr_quantum smallint

1 if monetary, 3 if units-based.

(R: NULL, 1, 3)

domain_id

element_id , type_id_nrc, or type_id_usg to which credit applies.

smallint

510

Field Name

Null

Null
Null

UNIT_CR_DEFINITIONS

Configurable. Describes unit credit plans that are available to customers. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CUSTINFO, BIP

Indexes:

Field Name

plan_id_credit exists in PLAN_ID_CREDIT_REF, and cannot be updated.


unit_cr_id exists in UNIT_CR_DEFINITIONS and in RATE_UNIT_CR.
clustered, unique on plan_id_credit, unit_cr_id
Data Type

Comments

ABP-9.1-DR1-1999/09/30

plan_id_credit

smallint

Plan ID from account/equipment, from PLAN_ID_CREDIT_REF.

unit_cr_id

smallint

Unit credit ID, from UNIT_CR_DEFINITIONS.

Values

Null

511

Triggers:

UNIT_CR_PLANS

UNIT_CR_PLANS

U
512

UNIT_CR_RESTRICTIONS
Configurable. Each record contains an exclusion or a restriction of a particular type which applies to a specific unit credit
applied to a particular entity. Admin table. Read-only copy exists on Customer server.
Used by the following modules: BIP
Triggers:

Indexes:

Ensure that UNIT_CR_DEFINITIONS entry for this unit_cr_id is consistent with the restriction_type.
Ensure that restricted_domain exists for restriction_types 1 and 5 and is NULL otherwise.
A given unit_cr_id cannot have both restriction_type 2 and restriction_type 3.
Ensure that restricted_id exists in the appropriate table for the given restriction_type.
is_exclusion must be consistent for all rows with a given unit_cr_id.
Cannot update unit_cr_id, restriction_type, or is_exclusion.
clustered, unique on unit_cr_id, restriction_type, restricted_id, restricted_domain

ABP-9.1-DR1-1999/09/30

UNIT_CR_RESTRICTIONS

Data Type

Comments

smallint

Unit credit ID, from UNIT_CR_DEFINITIONS.

restriction_type

tinyint

Identifies the restriction parameter type:


1 do not use
2 = product
5 = charge type
3 = product line
6 = jurisdiction
4 = service provider 7 = rate period

restricted_id

smallint

Identifies the restriction entity, based on restriction_type:


If 2, PRODUCT_ELEMENTS.element_id.
If 3, PRODUCT_LINES.product_line_id.
If 4, SERVICE_PROVIDERS_REF.provider_id.
If 5, depends on restricted_domain:
1: PRODUCT_ELEMENTS.element_id.
2: NRC_TRANS_DESCR.type_id_nrc.
3: USAGE_TYPES.type_id_usg.
If 6, JURISDICTIONS.jurisdiction.
If 7, ASCII equivalent of RATE_PERIOD_REF.rate_period. The
type_id_usg associated with this restriction must have USAGE_
TYPES.bill_aggr_level = 255.

is_exclusion

bit

If 0, unit_cr_id is applied only to the restriction entity.


If 1, unit_cr_id is applied to everything but the restriction entity.

restricted_
domain

tinyint

Restriction charge domain if restriction_type = 5:


1 = recurring charges
2 = non-recurring charges
3 = usage charges

Null

(R: 1, 2, 3, 4, 5,
6, 7)

Null

(R: NULL, 1, 2,
3)

Null

513

ABP-9.1-DR1-1999/09/30

unit_cr_id

Values

UNIT_CR_RESTRICTIONS

Field Name

U
514

USAGE_ALARM_REF
Configurable. Describes types of alarms. Admin table. Read-only copy exists on Customer server.
Indexes: unique on alarm_id

Field Name

Data Type

Comments

alarm_id

tinyint

Usage alarm ID.

alarm_type

tinyint

Type of alarm:
1 = usage amount alarm

Values

Null

2 = usage units alarm

ABP-9.1-DR1-1999/09/30

tinyint

Level of alarm:
1 = CMF level alarm
2 = EMF level alarm
3 = EMF_PRODUCTS level alarm

lower_limit_
percent

int

Lower percent limit of usage limits to emit an alarm. A value of 80


means that an alarm will be triggered when the usage amount is
80% of the usage limit.

upper_limit_
percent

int

Upper percent limit of usage limits to emit an alarm.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or


modify.

Null

USAGE_ALARM_REF

alarm_level

Configurable. Lists alarm values for alarms in USAGE_ALARM_REF. Admin table. Read-only copy exists on Customer
server.
Indexes: unique on alarm_id, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

alarm_id

tinyint

Alarm ID.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Abbreviated version of the display value.

Values

Null

Null

515

Field Name

USAGE_ALARM_VALUES

USAGE_ALARM_VALUES

U
516

USAGE_JURISDICTION
Configurable. Defines jurisdictions for a given pair of origin and target points. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CAP

jurisdiction, country_code_origin, country_code_target, element_id, point_region_origin, point_region_target,


state_origin, state_target, access_region_origin, access_region_target, type_id_usg, rate_class, equip_type_
code, equip_class_code, class_of_sevice_code, point_class_origin, point_class_target exist in the
appropriate tables or are 0/NULL.
Ensure that active/inactive dates are valid.
Ensure that active/inactive dates do not overlap.
non-unique on state_origin
non-unique on point_origin, point_class_origin, point_region_origin, state_origin, access_region_origin,
country_code_origin
non-unique on point_origin
unique on seqnum
non-unique on access_region_origin
non-unique on point_region_origin
non-unique on exclude_group
non-unique on point_class_origin

Triggers:

Indexes:
ABP-9.1-DR1-1999/09/30

Data Type

Comments

seqnum

int

Manually entered unique identifier.

jurisdiction

smallint

Territorial region for usage, from JURISDICTIONS.

element_id

smallint

Product element ID from PRODUCT_ELEMENTS, or 0 (all).

type_id_usg

smallint

Usage type, from USAGE_TYPES, or 0 (all).

rate_class

smallint

Rate class, from RATE_CLASS_DESCR, or 0 (all).

Values

Null

USAGE_JURISDICTION

Field Name

Data Type

Comments

smallint

Service instance type code, from EQUIP_TYPE_CODE_REF, or 0


(all).

equip_class_
code

smallint

Service instance class code, from EQUIP_CLASS_CODE_REF, or 0


(all).

class_of_
service_code

smallint

Service instance class code, from CLASS_OF_SERVICE_CODE_


REF, or 0 (all).

point_origin

char

24 Origin usage point, from USAGE_POINTS. matches all points.

point_target

char

24 Target usage point, from USAGE_POINTS. matches all targets.

point_class_
origin

int

Origin usage point class, from POINT_CLASS_REF.

point_class_
target

int

Target usage point class, from POINT_CLASS_REF.

point_region_
origin

char

Origin usage point region, from POINT_REGION_REF. matches


all points.

point_region_
target

char

Target usage point region, from POINT_REGION_REF. matches


all targets.

state_origin

char

State of origin for this usage jurisdiction. matches all points.

state_origin_
exclude

bit

Null

Use this origin state specification as an exclusion, relative to the


specified exclude_group? (1 = yes).

char

state_target_
exclude

bit

Use this target state specification as an exclusion, relative to the


specified exclude_group? (1 = yes).

Target state for this usage jurisdiction. matches all targets.

exclude_group

smallint

Rows with the same nonzero exclude_group are considered as


one comparison. All rows with the same exclude_group must have
the same priority and the same jurisdiction .

Null

517

state_target

ABP-9.1-DR1-1999/09/30

equip_type_
code

Values

USAGE_JURISDICTION

Field Name

U
Data Type

Comments

ABP-9.1-DR1-1999/09/30

access_region_
origin

char

Origin access region, from ACCESS_REGION_REF. matches all


points.

access_region_
target

char

Target access region, from ACCESS_REGION_REF. matches all


targets.

priority

int

Priority of this record, to break ties in wildcard matches. Higher


values indicate higher priorities.

country_code_
origin

smallint

Identifier of usage origin point, from COUNTRY_CODE_REF.

country_code_
target

smallint

Identifier of usage target point, from COUNTRY_CODE_REF.

active_dt

smalldt

Date jurisdiction mapping becomes active.

inactive_dt

smalldt

Date jurisdiction mapping becomes inactive.

Values

Null

518

Field Name

Null

USAGE_JURISDICTION

Configurable. Defines all valid origin and target usage points. Usage points can be phone numbers, email/network
addresses, document/object identifiers, and so on. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU

active_dt/inactive_dt date range is valid.


point_class, point_id, point_category, point_region and country_code exist in the appropriate tables (see
below).
provider_id exists in the appropriate table (see below) or is NULL.
clustered, unique on point_id
unique on country_code, point, is_a_prefix, point_category, active_dt

Indexes:

ABP-9.1-DR1-1999/09/30

Field Name

Data Type

Comments

point_id

int

Usage point ID, from USAGE_POINTS_TEXT.

point_type

tinyint

0 = origin or target

1 = target only

Values

Null

(R: > 0)
2 = origin only

Usage point category ID, from POINT_CATEGORY.

(R: 0, 1, 2)

point_category

smallint

point

char

24 Usage point or prefix (country code, NPA/NXX, document ID prefix,


and so on).

(D: 0)

point_region

char

is_a_prefix

tinyint

Is the point a prefix? (1 = yes). If not, exact match required.

(R: 0, 1)

point_status

tinyint

0 = Normal; guide and rate corresponding usage normally


1 = Free usage point; store usage in CDR_FREE
2 = Errored usage; store in CDR_WORK for review by MIU

(R: 0, 1, 2)

Usage point region, from POINT_REGION_REF.

int
varchar

15 Not used in all deployments.

Optional key into usage rate tables, from POINT_CLASS_REF.


Null

point_city

varchar

35 Location of this usage point. Used to look up geocode.

Null

519

point_class
point_tax_code

Triggers:

USAGE_POINTS

USAGE_POINTS

U
Data Type

Comments

point_state_abbr char

point_zip

varchar

16 Location of this usage point.

country_code

smallint

Values

Location of this usage point. Used to look up geocode.

Null
Null
Null

Location of usage point. Only used if is_international = 1.

Null

ABP-9.1-DR1-1999/09/30

point_county

varchar

point_
coordinate_x

int

28 Location of this usage point. Used to lookup geocode.


Major horizontal coordinate for V&H rating on this usage point.

Null

point_
coordinate_y

int

Major vertical coordinate for V&H rating on this usage point.

Null

provider_id

smallint

Service provider identifier, from SERVICE_PROVIDERS_REF.

Null

active_dt

smalldt

Date and time this usage point becomes active.

inactive_dt

smalldt

Date and time this usage point becomes inactive.

bit

Is this usage point international? (1 = yes)

arch_flag

bit

Has this record been archived? (1 = yes)

access_region

char

point_
coordinate_x_
min
point_
coordinate_y_
min

Null
(D: 0)

Identifier of an access region (LATA), from ACCESS_REGION_REF.

Null

int

Minor horizontal coordinate for V&H rating on this usage point.

Null

int

Minor vertical coordinate for V&H rating on this usage point.

Null

point_
tinyint
coordinate_type

Null

1 = V&H rating; 2 = Longitude and Latitude rating.

(R: 1, 2)

Null

USAGE_POINTS

is_international

520

Field Name

Configurable. Describes specific usage points in human-readable form. Admin table. Read-only copy exists on Customer
server.

Field Name

Ensure that language_code exists in LANGUAGE_CODE_REF or is 0.


clustered, unique on point_id, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

point_id

int

Usage point ID.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

Values

Null

(R: > 0)

80 Text description to be displayed on screen.

521

Triggers:
Indexes:

USAGE_POINTS_TEXT

USAGE_POINTS_TEXT

U
522

USAGE_TYPES
Configurable. Defines all valid usage types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: RAP, CAP, MIU, BIP, BIF, CUSTINFO
Triggers:

ABP-9.1-DR1-1999/09/30

Indexes:

If element_id and product_line_id are both set, element_id exists in product_line_id in PRODUCT_ELEMENTS.
If element_id or product_line_id is set, only the identified product(s) can have type_group_usg including this
usage type.
tax_class exists in TAX_RATES_VAT or is -1, -2, or NULL.
description_code, raw_units_type, ratable_unit_class, andpoint_category, exist in the appropriate tables (see
below). rate_currency_code and product_line_id exist in the appropriate tables (see below) or are NULL, and
rate_currency_code cannot be NULL if rate_currency_location is 9.
tax_code_origin_req and tax_code_target_req must be 0 unless tax_location_usg is 0,4,5,7,8 or 9.
rounding_method cannot be zero.
If use_jurisdiction = 0, derive_jurisdiction cannot be 1, 2, or 3. If derive_jurisdiction = 3, use_point_class_target
and use_point_class_origin cannot be zero. If derive_jurisdiction = 4, use_distance_band_id must be either 1
or 2.
unique on type_id_usg

Foreign Keys:(product_line_id) must exist in PRODUCT_LINES(product_line_id)

Field Name

Data Type

Comments

Values

smallint

Unique internal ID of a usage type.

(R: > 0)

guide_to

tinyint

Determines which field from the usage record is used to guide:


1 = A-number (point_origin)
2 = B-number (point_target)
3 = C-number (external_id)

(D: 3) (R: 1, 2, 3)

point_category

smallint

Category (from POINT_CATEGORY) of usage points associated


with usage of this type.

(D: 0)

USAGE_TYPES

type_id_usg

Null

Data Type

Comments

Values

origin_country_
dial_code_req

tinyint

Is an origin country code necessary (1) or ignored (0) for usage of (D: 0) (R: 0, 1)
this type?

tax_code_
origin_req

tinyint

Is the origin tax code required?


0 = Not required 1 = Required
3 = Calculate/look up

2 = Use Default

(D: 0) (R: 0, 1, 2,
3)

tax_code_
target_req

tinyint

Is the target tax code required?


0 = Not required 1 = Required
3 = Calculate/look up

2 = Use Default

(D: 0) (R: 0, 1, 2,
3)

Null

Description from DESCRIPTIONS table.

Null

tax_class

Tax class of product, from TAX_RATES_VAT, or:


-1 = exempt; -2 = outside scope of tax law.
Only used for deployments with VAT taxation.

Null

smallint

523

ABP-9.1-DR1-1999/09/30

description_code smallint

USAGE_TYPES

Field Name

U
Data Type

Comments

Values

usg_class

Broad usage category the usage type belongs in:


0 = domestic to domestic
1 = domestic to international
2 = international to international
3 = international to domestic

smallint

Null

USAGE_TYPES

Indicator of the taxable location for the specific usage type:


(R: 0, 1, 2, 3, 4,
0 = non-taxable
5, 7, 8, 9, 11, 13,
1 = CMF.bill_geocode
14, 15, 16)
2 = CMF.cust_geocode
3 = EMF.service_geocode
4 = CDR_DATA.point_tax_code_origin
5 = CDR_DATA.point_tax_code_target
7 = composite (2 out of 3 rule) from 1, 4, and 5
8 = composite (2 out of 3 rule) from 2, 4, and 5
9 = composite (2 out of 3 rule) from 3, 4, and 5
11 = service_geocode /b_service_geocode from EMF (half each)
13 = based on CMF.bill_geocode and the billing address,
supported only by certain Custom tax packages
14 = EMF.b_service_geocode
15 = composite (2 out of 3 rule) from 1,4, and 5; if no match and the
franchise code has a tax_exception value 1, use franchise code of
the origin geocode
16 = composite (2 out of 3 rule) from 3, 4, and 5; if no match and
the franchise code has a tax_exception value 1, use franchise code
of the origin geocode
Note: A geocode is made up of a number of different sub-codes.
For the 2 out of 3 rule, when there is a match of at least 2 of 3 for
any sub-code, this sub-code is used. When there is no match, the
sub-code and all subsequent ones are filled with zeros.

ABP-9.1-DR1-1999/09/30

tax_location_usg tinyint

Null

524

Field Name

Data Type

Comments

Values

Null

bit

Is usage of this type charged normally (0) or free (1)? Free usage
is stored in CDR_FREE, is not rated and doesnt appear on any
invoice.

element_id

smallint

Product, from PRODUCT_ELEMENTS, the usage is restricted to.

Null

product_line_id

smallint

Product line, from PRODUCT_LINES, the usage is restricted to.

Null

bill_aggr_level

int

Specify the aggregation level when BIP is processing CDR_DATA


records:
Null = default aggregation
127 = aggregate to current level, without rate_period or
geographical
zone
255 = aggregate to current level, keeping rate_period (allows
discounting by rate period)
383 = aggregate ignoring rate_period, using geographical zone
511 = aggregate using rate_period and geographical zone
639 = aggregated as for 127 but also by amount_reduction_id
767 = aggregated as for 255 but also by amount_reduction_id
895 = aggregated as for 383 but also by amount_reduction_id
1023 = aggregated as for 511 but also by amount_reduction_id
Note: these fields are found in CDR_DATA.

(R: 127, 255,


Null
383, 511, 639,
767, 895, 1023)

525

ABP-9.1-DR1-1999/09/30

free_usg

USAGE_TYPES

Field Name

U
Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

derive_
jurisdiction

tinyint

Controls how jurisdiction is derived:


(R: 0, 1, 2, 3, 4,
0 = not derived
5)
1 = supplied on input usage record
2 = derived by lookup into USAGE_JURISDICTION
3 = if point_class_origin = point_class_target, jurisdiction = 2, else
jurisdiction = 3
4 = look up jurisdiction based on distance_band_id, which requires
that jurisdiction be based on distance,
5 = derive based on distance band if lookup into USAGE_
JURISDICTION fails

units_indicator

tinyint

Indicates which units field in CDR_DATA contains the number of


units:
1 = primary units 2 = secondary units 3 = third_units

ratable_unit_
class

smallint

From RATABLE_UNIT_CLASS_REF.

duration_flag

bit

Are these duration-based units? (1 = yes). If not, then user rate_


period is an effective transaction date/time for usage.

Null
Null

(R: 0, 1, 2, 3)

Defines how the distance is calculated in V&H rating:


(R: 0, 1, 2, 3, 4, Null
0 = not calculated
5, 6)
1 = read from the CDR_DATA field indicated by distance_units_
indicator
2 = derived from V&H major coordinates
3 = derived from V&H minor coordinates
4 = derived from Great Circle major/minor coordinates (kilometers)
5 = derived from Great Circle major/minor coordinates (miles)
6 = derived from V&H coordinates using modified Stentor algorithm

vh_minor_
threshold

Distance below which minor coordinates are used for V&H rating.

USAGE_TYPES

derive_distance_ tinyint
units

smallint

526

Field Name

Data Type

Comments

Values

tinyint

Indicates which units field in CDR_DATA contains the number of


units used for rating based on distance:
1 = primary units 2 = second units
3 = third units

(R: 0, 1, 2, 3)

guide_to_
provider

tinyint

0 = Normal guiding to EMF


1 = Guide to CIBER operator (by SID or BID)
2 = Guide to GSM operator (by MCC/MNC)
3 = Normal guiding to EMF; then CIBER operator
4 = Normal guiding to EMF; then GSM operator
5 = Normal guiding to EMF; then CIBER, then GSM
6 = Use target provider record from USAGE_POINTS.

(D: 0) (R: 0, 1, 2,
3, 4, 5, 6)

is_prerated

bit

Is this usage type pre-rated? (1 = yes)

(D: 0)

is_prepaid

bit

Reserved for future use.

(D: 0)

keep_running_
total

bit

Does CAP keep a running total? (1 = yes)

(D: 0)

rounding_
method

tinyint

Indicates rounding behavior:


1 = round down
2 = round up
3 = round nearest (exactly .5 rounds down)
4 = round nearest (exactly .5 rounds up)

(R: 0, 1, 2, 3, 4)

raw_units_type

smallint

Type of units in field indicated by units_indicator (primary_units,


and so on). Values are listed in USAGE_UNITS_TYPE_REF.

use_rate_class

tinyint

0 = field is not used 1 = field is used for guiding only


2 = field is used in both guiding and rating

(D: 2) (R: 0, 1, 2)

use_bill_class

tinyint

0 = field is not used 1 = field is used for guiding only


2 = field is used in both guiding and rating

(D: 0) (R: 0, 1, 2)

use_jurisdiction

tinyint

0 = field is not used 1 = field is used for guiding only


2 = field is used in both guiding and rating

(D: 2) (R: 0, 1, 2)

527

ABP-9.1-DR1-1999/09/30

distance_units_
indicator

Null

USAGE_TYPES

Field Name

U
Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

use_point_
class_origin

tinyint

0 = field is not used 1 = field is used for guiding only


2 = field is used in both guiding and rating

(D: 1) (R: 0, 1, 2)

use_point_
class_target

tinyint

0 = field is not used 1 = field is used for guiding only


2 = field is used in both guiding and rating

(D: 1) (R: 0, 1, 2)

use_provider_
class

tinyint

0 = field is not used 1 = field is used for guiding only


2 = field is used in both guiding and rating

(D: 0) (R: 0, 1, 2)

use_rate_period tinyint

0 = field is not used 1 = field is used for guiding only


2 = field is used in both guiding and rating

(D: 2) (R: 0, 1, 2)

use_element_id tinyint

0 = field is not used 1 = field is used for guiding only


2 = field is used in both guiding and rating

(D: 0) (R: 0, 1, 2)

use_equip_
type_code

tinyint

0 = not a rating key


2 = rating key

1 = field is used for guiding only

(D: 0) (R: 0, 1, 2)

use_equip_
class_code

tinyint

0 = not a rating key


2 = rating key

1 = field is used for guiding only

(D: 0) (R: 0, 1, 2)

use_class_of_
service_code

tinyint

0 = field is not used 1 = field is used for guiding only


2 = field is used in both guiding and rating

(D: 0) (R: 0, 1, 2)

use_distance_
band_id

tinyint

0 = field is not used 1 = field is used for guiding only


2 = field is used in both guiding and rating

(D: 0) (R: 0, 1, 2)

Null

528

Field Name

USAGE_TYPES

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

use_default_
rate_type

tinyint

0 = do not use default rate.


1 = apply default rate to free records. If no default rate, error
records.
2 = apply default rate to error records only. If no default rate, dont
calculate amounts.
3 = apply default rate to free and error records. If no default rate for
free records, error records.
4 = apply default rate to records with missing rates. If no default
rate, dont send records to CDR_DATA.
5 = apply default rate to records with missing rates, free, and
errored records. If no default rate, error.

Null

rate_currency_
code

smallint

Currency code, from RATE_CURRENCY_REF.

Null

rate_currency_
location

smallint

Determines currency in which charges of this type are stored.


1 = CMF.currency_code for customer.
2 = COUNTRY_CODE_REF.default_currency_code for
CMF.cust_country_code for customer.
3 = Like 2, but for CMF.bill_country_code.
4 = EMF.currency_code for service instance.
5 = Like 2, but for EMF.service_country_code.
6 = Like 2, but for EMF.b_service_country_code.
7 = Like 2, but for country_code_target from usage record.
8 = Like 2, but for country_code_origin from usage record.
9 = rate_currency_code.
10 = Specified by incoming usage record.

rate_period_
rounding

bit

Indicates whether to adjust rounding for the last segment of a


(D: 0)
usage event crossing more than one rate period so that total usage
for each segment equals total duration for the usage event. A value
of 1 will adjust the rounding.

(D: 1) (R: 1, 2, 3,
4, 5, 6, 7, 8, 9,
10)

529

Data Type

USAGE_TYPES

Field Name

U
Data Type

Comments

Values

use_
component_id

tinyint

Which component_id, if any, should be used for


rating?
0 or 1 = use RATE_USAGE.component_id and
RATE_USAGE_OVERRIDES.component_id for rating
2 = use EMF_PRODUCTS.component_id for rating

(D: 0) (R: 0, 1, 2)

open_item_id

int

Open item ID, from OPEN_ITEM_ID_REF.

(D: 1)

min_billing_units int

Minimum number of billing units used before BIP rates a usage


event using different rate periods for each segment.

consolidate_
usage

Does the account category allows CAP to summarize usage?


(1 = yes)

bit

Null

530

Field Name

Null
Null

(D: 0)

ABP-9.1-DR1-1999/09/30

USAGE_TYPES

Configurable. Associates a number of output usage types with an input usage type. Admin table. Read-only copy
exists on Customer server.

Indexes:

Field Name
ABP-9.1-DR1-1999/09/30

type_id_usg_in

type_id_usg_in and type_id_usg_out must exist in USAGE_TYPES.


type_id_usg_in and type_id_usg_out must both have the same point_category.
units_indicator for type_id_usg_in must be 0.
units_indicator for type_id_usg_out must not be 0.
unique on type_id_usg_in, type_id_usg_out

Data Type
smallint

type_id_usg_out smallint

Comments

Values

Null

Unique input usage ID.


Associated output usage ID.

531

Triggers:

USAGE_TYPES_SPLIT

USAGE_TYPES_SPLIT

U
532

USAGE_TYPES_UNITS
Configurable. Defines how individual usage types are to be processed. Admin table. Read-only copy exists on Customer
server.
Used by the following modules: CAP, RAP, MIU

billing_units_type and type_id_usg exist in the appropriate tables (see below).


unique on type_id_usg, jurisdiction, rate_class, equip_type_code, equip_class_code, class_of_service_code

Triggers:
Indexes:

Field Name

Data Type

Comments

Values

Null

ABP-9.1-DR1-1999/09/30

type_id_usg

smallint

Usage type ID, from USAGE_TYPES.

jurisdiction

smallint

Territorial range for usage, from JURISDICTIONS.

rate_class

smallint

Rate class, from RATE_CLASS_DESCR.

Null

equip_type_
code

smallint

Service instance type code, from EQUIP_TYPE_CODE_REF.

Null

equip_class_
code

smallint

Service instance class code, from EQUIP_CLASS_CODE_REF.

Null

class_of_
service_code

smallint

Service instance class of service code, from CLASS_OF_


SERVICE_CODE_REF.

Null

billing_units_
type

smallint

Type of units used for billing. Values are listed under USAGE_
UNITS_TYPE_REF. Must match the ratable unit class set in
USAGE_TYPES.

no_bill

bit

Suppress billing for this type of usage? (1 = yes)

priority

int

Breaks ties in case of multiple matching records. Higher values


indicate higher priority.

Null

USAGE_TYPES_UNITS

Configurable. Defines the valid usage types for a given usage group, which are used to control guiding of usage to
products. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU

Indexes:

Field Name

description_code and type_id_usg exist in the appropriate tables (see below).


type_group_usg is compatible with USAGE_TYPES and PRODUCT_ELEMENTS.
unique on type_group_usg, type_id_usg
Data Type

Comments

ABP-9.1-DR1-1999/09/30

type_group_usg smallint

Identifier for a usage type group. Defines set of usage types that
are valid for a given product. See PRODUCT_ELEMENTS.

type_id_usg

Usage type ID, from USAGE_TYPES.

smallint

description_code smallint

Values

Null

Description from DESCRIPTIONS table.

533

Triggers:

USAGE_TYPE_GROUPS

USAGE_TYPE_GROUPS

U
534

USAGE_UNITS_CONVERT
Configurable. Contains conversion values between various usage units types. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: CAP, RAP, MIU, BIF

in_units_type and out_units_type exist in the appropriate tables (see below).


unique on in_units_type, out_units_type

Triggers:
Indexes:

Field Name

Data Type

Comments

ABP-9.1-DR1-1999/09/30

in_units_type

smallint

Units type to convert from, from USAGE_UNITS_TYPE_REF.

out_units_type

smallint

Units type to convert to, from USAGE_UNITS_TYPE_REF.

convert_factor

int

Factor used to convert in_units_type to out_units_type.

operator

tinyint

Operator used to convert in_units_type to out_units_type:


1 = divide
2 = multiply

Values

Null

(R: 1, 2)

USAGE_UNITS_CONVERT

Configurable. Defines the valid usage units types. Admin table. Read-only copy exists on Customer server.
Used by the following modules: CAP, RAP, MIU

Field Name

Only one row may have is_default = 1.


unique on units_type

Data Type

Comments

Values

smallint

Unique identifier of a units type:


0 = pre-rated (The corresponding units field will contain money
units.)
100 = seconds
200 = bytes
101 = 1/10ths of a second
201 = kilobytes
102 = 1/100ths of a second
202 = megabytes
103 = 1/1000ths of a second 203 = gigabytes
120 = minutes
205 = 64 bytes
121 = 1/10ths of a minute
300 = meters
130 = hours
301 = kilometers
140 = days
320 = feet
321 = miles
You can define additional values as well.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

ABP-9.1-DR1-1999/09/30

units_type

Null

(D: 0)

535

Triggers:
Indexes:

USAGE_UNITS_TYPE_REF

USAGE_UNITS_TYPE_REF

U
536

USAGE_UNITS_TYPE_VALUES
Configurable. Describes usage units types defined in USAGE_UNITS_TYPE_REF. Admin table. Read-only copy exists on
Customer server.
Used by the following modules: ATM, CUSTINFO
Triggers:
Indexes:

Field Name
ABP-9.1-DR1-1999/09/30

units_type

language_code exists in LANGUAGE_CODE_REF.


units_type exists in USAGE_UNITS_TYPE_REF.
unique on units_type, language_code
Data Type

smallint

Comments

Values

Null

Usage units type, from USAGE_UNITS_TYPE_REF.

language_code

smallint

display_value

varchar

80 Text description to be displayed.

Language code, from LANGUAGE_CODE_REF.

short_display

char

Abbreviated version of the display value.

Null

USAGE_UNITS_TYPE_VALUES

VIP_CODE_REF

VIP_CODE_REF
Configurable. Defines valid VIP codes. Admin table. Read-only copy exists on Customer server.
Only one row may have is_default = 1.
clustered, unique on vip_code

Field Name

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

vip_code

tinyint

Unique VIP code ID.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

is_latefee_
exempt

bit

Reserved for future use.

Null

(D: 0)

(D: 0)

537

Triggers:
Indexes:

V
538

VIP_CODE_VALUES
Configurable. Describes VIP codes. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


vip_code exists in VIP_CODE_REF.
clustered, unique on vip_code, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

vip_code

tinyint

VIP code ID, from VIP_CODE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

display_value

varchar

80 Short text description of the VIP code.

short_display

char

Text description to be displayed on screen.

Values

Null

Null

VIP_CODE_VALUES

Dynamic. This table allows geocoding to take place down to the city level when the Vertex geocoder is not installed, or
when geocoding is taking place in a country in which the Vertex geocoder does not apply. Admin table. Read-only copy
exists on Customer server.

ZIPCODE

ZIPCODE

This table maps the alphanumeric postal code (such as a ZIP code) to the state, county, and city portions of the geocode
to be populated in CMF.cust_geocode, CMF.bill_geocode, EMF.service_geocode, or EMF.b_service_geocode. If the TAX
system parameter IGNORE_ZIPCODE is set to a nonzero value, this table is ignored, tha is, no mapping takes place.
Maps zipcodes to city, county and state codes.
Used by the following modules: BIP
Indexes: unique on zip

Data Type

Comments

Values

Null

zip

char

state_code

smallint

16 Zipcode.
State Code, defined in STATE_REF.

Null

county_code

smallint

County code.

Null

city_code

smallint

City code.

Null

539

ABP-9.1-DR1-1999/09/30

Field Name

Z
540

ZONE_CLASS_REF
Configurable. Defines valid zone classes such as business or home. Admin table. Read-only copy exists on Customer
server.
Triggers:
Indexes:

Field Name

Only one row may have is_default = 1.


unique on zone_class

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

zone_class

tinyint

Unique zone class ID.

priority

tinyint

Used when multiple zone classes are selected. Higher values


indicate higher priorities.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(R: > 1)

(D: 0)

ZONE_CLASS_REF

Configurable. Describes zone classes defined in ZONE_CLASS_REF. Admin table. Read-only copy exists on Customer
server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


zone_class exists in ZONE_CLASS_REF.
unique on zone_class, priority, language_code
Data Type

Comments

ABP-9.1-DR1-1999/09/30

zone_class

tinyint

Zone class ID, from ZONE_CLASS_REF.

priority

tinyint

Higher values indicate higher priorities.

language_code

smallint

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Null

(R: > 1)

Language code, from LANGUAGE_CODE_REF.


Abbreviated version of the display value.

Null

541

Triggers:

ZONE_CLASS_VALUES

ZONE_CLASS_VALUES

Z
542

ZONE_REF
Configurable. Defines cell zones. Admin table. Read-only copy exists on Customer server.
Triggers:
Indexes:

Field Name

Only one row may have is_default = 1.


unique on zone_id

Data Type

Comments

Values

ABP-9.1-DR1-1999/09/30

zone_id

smallint

Unique zone ID.

is_default

bit

Is this value default? (1 = yes) Only one row can be default.

is_internal

bit

If 1, this record is required by Arbor/BP modules; do not delete or (D: 0)


modify.

Null

(D: 0)

ZONE_REF

Configurable. Describes zones defined in ZONE_REF. Admin table. Read-only copy exists on Customer server.

Indexes:

Field Name

language_code exists in LANGUAGE_CODE_REF.


zone_id exists in ZONE_REF.
unique on zone_id, language_code

Data Type

Comments

ABP-9.1-DR1-1999/09/30

zone_id

smallint

Zone ID, from ZONE_REF.

language_code

smallint

Language code, from LANGUAGE_CODE_REF.

short_display

char

display_value

varchar

80 Text description to be displayed on screen.

Values

Abbreviated version of the display value.

Null

Null

543

Triggers:

ZONE_VALUES

ZONE_VALUES

Fields
[I] = in Vol. 1; [II] = in Vol. 2

A
abi_effective_date 19[II]
abi_level_code 24[II]
abi_line_num 19[II], 23[II]
abi_record_id 22[II]
abi_record_type 23[II]
abi_source_record_type 9[I]
abi_tracking_id 19[II], 23[II]
abi_tracking_id_serv 19[II], 23[II]
access_carrier_name_abbr 470[I]
access_method 239[I], 240[I], 242[I]
access_region 12[I], 13[I], 520[I]
access_region_origin 112[I], 183[I], 216[I],
518[I], 44[II], 88[II], 93[II], 120[II]
access_region_target 112[I], 183[I], 518[I],
44[II], 88[II], 93[II], 120[II]
account_category 14[I], 15[I], 108[I],
172[I], 174[I], 313[I], 320[I],
347[I], 481[I], 13[II], 99[II], 184[II],
190[II], 193[II]
account_category* 300[I]
account_category_mask 302[I]
account_code 108[II]
account_code_group 109[II]
account_no 313[I], 320[I], 8[II], 9[II], 10[II],
13[II], 19[II], 26[II], 33[II], 48[II],
50[II], 70[II], 72[II], 77[II], 79[II],
80[II], 94[II], 97[II], 99[II], 107[II],
109[II], 111[II], 113[II], 119[II],
122[II], 124[II], 126[II], 127[II],
130[II], 134[II], 135[II], 137[II],
139[II], 141[II], 144[II], 150[II],
155[II], 157[II], 159[II], 163[II],
167[II], 173[II], 175[II], 176[II],
182[II], 183[II], 193[II], 195[II],
200[II], 204[II], 209[II], 211[II],
218[II], 220[II]
account_no * 107[I], 115[I], 42[II], 84[II],
89[II]
account_no_bill_nrc 167[II]

account_no_bill_rc 130[II], 167[II]


account_no_bill_usg 167[II]
account_status 52[II], 103[II]
account_status_dt 104[II]
account_type 99[II]
accrued_dt 184[II]
acct_level_external_id 502[I]
acct_seg_id 17[I], 18[I], 19[I], 191[I], 14[II],
105[II]
acg_tracking_id 108[II], 109[II], 171[II]
acg_tracking_id_serv 108[II], 109[II],
171[II]
act_nrc_tracking_id 153[II]
act_nrc_tracking_id_serv 153[II]
action 476[I]
action_code 178[I], 355[I], 74[II]
action_type 168[I]
activation_code 378[I]
activation_type_id_nrc 180[I]
active_date 180[I], 301[I], 397[I], 404[I],
412[I], 496[I], 9[II], 10[II], 155[II],
156[II]
active_dt 25[I], 77[I], 82[I], 138[I], 140[I],
142[I], 175[I], 178[I], 223[I],
243[I], 268[I], 347[I], 348[I],
350[I], 351[I], 355[I], 390[I],
392[I], 407[I], 416[I], 421[I],
433[I], 442[I], 445[I], 459[I],
518[I], 520[I], 107[II], 118[II],
120[II], 127[II], 129[II], 134[II],
143[II], 180[II], 181[II]
active_flag 163[I], 11[II]
active_modified_date 135[II]
add_fixed_amt 416[I], 421[I]
add_implied_decimal 417[I], 422[I]
add_unit_rate 416[I], 421[I]
address_field 45[I]
address_format_id 272[I], 273[I], 274[I]
address_line 45[I], 272[I]
address_line_order 46[I]
address1 163[I]

ABP-9.1-DR1-1999/09/30

F
546

Fields

address2 163[I]
address3 163[I]
adj_category 184[II], 191[II]
adj_category* 300[I]
adj_category_mask 302[I]
adj_reason_code 20[I], 21[I], 29[II]
adj_tracking_id 209[II]
adj_tracking_id_serv 209[II]
adj_trans_category 23[I]
adj_trans_code 23[I], 26[II]
advance_periods 378[I]
ae 284[I]
affected 116[II]
afp_char_set 66[I]
afp_code_page 66[I]
afp_line_name 78[I]
afp_line_width 78[I]
afp_pitch 65[I]
afp_trcref 65[I]
aggr_usage_id 25[I], 26[I], 27[I], 389[I],
42[II], 65[II]
aggr_usage_quantum 25[I]
aggr_usage_type 25[I]
alarm_id 514[I], 515[I], 97[II]
alarm_id_by_cmf_amt 95[II]
alarm_id_by_cmf_units 95[II]
alarm_id_by_emf_amt 95[II]
alarm_id_by_emf_products_amt 95[II]
alarm_id_by_emf_products_units 95[II]
alarm_id_by_emf_units 95[II]
alarm_level 514[I]
alarm_status 97[II]
alarm_type 514[I]
allocated_tax 205[II]
allocated_undesignated 205[II]
allow_alternative_bill_period 378[I]
allow_auto_post 149[I]
allow_autotransfer 96[I]
allow_manual_entry 96[I]
allow_suspense_acnt 96[I]
alt_bank_acc_num 102[II]
alt_printer_text 72[I]
am_text 312[I]
amex_descriptor 469[I]
amex_flag 469[I]
amex_total 103[I]
amount 130[I], 135[I], 41[II], 60[II], 77[II],
80[II], 163[II], 195[II], 207[II],

209[II], 211[II], 214[II], 216[II]


amount * 110[I], 117[I], 87[II], 91[II]
amount_credited 41[II]
amount_free 413[I]
amount_reduction 112[I], 45[II], 65[II],
88[II], 93[II]
amount_reduction_id 113[I], 45[II], 65[II],
88[II], 93[II]
annotation 314[I], 321[I], 26[II], 42[II],
64[II], 76[II], 200[II]
annotation * 110[I], 117[I], 86[II], 91[II]
annotation2 200[II]
arbor_char_value 124[I]
arbor_detail 244[I]
arbor_done 242[I]
arbor_error 242[I]
arbor_field_description 124[I]
arbor_int_value 124[I]
arbor_int_value2 124[I]
arbor_ready 242[I]
arbor_tbl_name 124[I]
arbor_work 242[I]
arbordata 11[II]
arch_action 29[I], 30[I], 32[I]
arch_archived 35[II]
arch_date 31[I]
arch_deleted 35[II]
arch_dest_file_directory 37[II]
arch_dt 35[II]
arch_end_dt 36[II]
arch_field_seperator 37[II]
arch_file_id 34[II]
arch_file_nm 34[II]
arch_first_seq 34[II]
arch_flag 31[I], 111[I], 117[I], 132[I], 137[I],
301[I], 314[I], 321[I], 520[I], 27[II],
31[II], 39[II], 42[II], 47[II], 49[II],
54[II], 65[II], 67[II], 74[II], 87[II],
92[II], 131[II], 147[II], 153[II],
177[II], 185[II], 188[II], 191[II],
201[II]
arch_from 32[I]
arch_granularity 36[II]
arch_key 35[II]
arch_key_fld_nm 36[I]
arch_key_resets 35[II]
arch_key_resets_fld_nm 36[I]
arch_keys_archived 36[II]

ABP-9.1-DR1-1999/09/30

Fields

547

arch_keys_counted 36[II]
arch_keys_deleted 36[II]
arch_keys_restored 36[II]
arch_last_seq 34[II]
arch_lock 35[II]
arch_mode_id 34[I], 35[I], 36[II]
arch_output_mode 37[II]
arch_owner 35[II]
arch_restored 35[II]
arch_rows_archived 38[II]
arch_rows_counted 38[II]
arch_rows_deleted 38[II]
arch_rows_restored 38[II]
arch_run_criteria 37[II]
arch_run_id 34[II], 35[II], 36[II], 38[II]
arch_run_id_serv 34[II], 35[II], 36[II], 38[II]
arch_seq 35[II]
arch_start_dt 36[II]
arch_status 37[II]
arch_table_id 36[I], 34[II], 38[II]
arch_table_nm 36[I]
arch_tag 31[I]
arch_to 32[I]
arch_type_id 36[I], 37[I], 38[I], 36[II]
arp 138[I]
assignment_id 143[II]
association_id 117[II]
association_id_serv 117[II]
association_type 117[II]
att_expected_date 19[II]
auto_activation 379[I], 178[II]
auto_credit_code 378[I]
auto_post_delay 149[I]
aux_tax_info 29[II], 32[II], 41[II], 64[II],
68[II]
avail_amount 147[II]
avail_periods 153[II]
avail_units 146[II]
avs_address_id 79[II]
avs_response_code 97[I], 79[II]

B
b_rev_rcv_cost_ctr 30[II], 65[II], 171[II]
b_service_address1 169[II]
b_service_address2 169[II]
b_service_address3 169[II]
b_service_city 169[II]
b_service_company 169[II]
b_service_country_code 170[II]

b_service_county 169[II]
b_service_fname 169[II]
b_service_franchise_tax_code 170[II]
b_service_geocode 170[II]
b_service_lname 169[II]
b_service_minit 169[II]
b_service_phone 170[II]
b_service_phone2 170[II]
b_service_state 170[II]
b_service_zip 170[II]
backout_status 53[II]
bad_recs 83[II]
balance_120_day 33[II]
balance_30_day 33[II]
balance_60_day 33[II]
balance_90_day 33[II]
balance_chg_date 30[II]
balance_due 112[II], 114[II]
band 143[I]
bank_agency_code 105[II], 165[II]
bank_agency_name 105[II], 164[II]
base_amt 130[I], 135[I], 41[II]
base_amt * 109[I], 116[I], 86[II], 90[II]
base_currency 393[I]
basic_days 493[I]
batch_balance 76[II]
batch_id 39[II], 46[II], 70[II], 73[II], 76[II]
batch_id_serv 73[II], 76[II]
batch_seq_num 450[I], 454[I]
batch_seq_num_in 469[I]
batch_seq_num_out 469[I]
batch_status 76[II]
batch_total 103[I]
batch_type 313[I], 321[I]
bi_currency_code 214[II]
bill_address1 13[II], 101[II]
bill_address2 101[II]
bill_address3 101[II]
bill_aggr_level 525[I]
bill_category_type 23[II]
bill_city 13[II], 101[II]
bill_class 47[I], 48[I], 131[I], 136[I], 406[I],
415[I], 421[I], 40[II]
bill_class * 107[I], 114[I], 84[II], 89[II]
bill_class_type 47[I]
bill_company 13[II], 48[II], 100[II]
bill_company_find 13[II]
bill_country_code 101[II]

ABP-9.1-DR1-1999/09/30

F
548

Fields

bill_county 101[II]
bill_date 48[II]
bill_disp_meth 50[I], 51[I], 52[II], 103[II]
bill_fmt_opt 45[I], 57[I], 58[I], 87[I], 88[I],
103[II]
bill_fname 13[II], 48[II], 100[II]
bill_fname_find 13[II]
bill_franchise_tax_code 101[II]
bill_geocode 101[II]
bill_hold_code 53[II], 103[II]
bill_image 48[II]
bill_in_arrears 377[I]
bill_invoice_row 44[II], 56[II], 66[II], 67[II],
216[II]
bill_lname 13[II], 48[II], 100[II]
bill_lname_find 13[II]
bill_minit 100[II]
bill_name_generation 100[II]
bill_name_pre 100[II]
bill_order_number 55[II], 75[II], 124[II],
201[II]
bill_period 49[I], 84[I], 85[I], 51[II], 95[II],
103[II], 131[II], 177[II]
bill_ref_no 86[I], 313[I], 320[I], 19[II], 28[II],
48[II], 50[II], 69[II], 70[II], 72[II],
77[II], 80[II], 111[II], 113[II],
116[II], 135[II], 137[II], 139[II],
146[II], 163[II], 182[II], 183[II],
188[II], 193[II], 195[II], 201[II],
205[II], 209[II], 215[II]
bill_ref_no * 111[I], 117[I], 87[II], 92[II]
bill_ref_no_resets 139[II]
bill_ref_resets 86[I], 111[I], 117[I], 313[I],
320[I], 19[II], 28[II], 48[II], 50[II],
69[II], 70[II], 72[II], 77[II], 80[II],
87[II], 92[II], 111[II], 113[II],
116[II], 135[II], 137[II], 146[II],
163[II], 182[II], 183[II], 188[II],
193[II], 195[II], 201[II], 205[II],
209[II], 215[II]
bill_sequence_num 50[II], 99[II]
bill_state 13[II], 101[II]
bill_subcategory_id 23[II]
bill_title 100[II]
bill_zip 13[II], 101[II]
billable_amount 24[II]
billable_line_ind 23[II]
billed_dt 184[II]

billing_category 23[I], 71[I], 96[I], 60[II]


billing_frequency 43[I], 44[I], 49[I], 349[I],
389[I], 400[I], 402[I], 412[I],
413[I], 497[I], 96[II], 103[II]
billing_level 23[I], 71[I], 59[II]
billing_no 20[II]
billing_service_center 17[I]
billing_units_type 109[I], 116[I], 532[I],
43[II], 86[II], 91[II]
bit_end 427[I]
bit_start 427[I]
bmf_tracking_id 77[II], 81[II], 164[II],
207[II]
bmf_tracking_id_serv 77[II], 81[II], 164[II],
207[II]
bmf_trans_category 95[I]
bmf_trans_type 95[I], 319[I], 72[II], 78[II],
81[II], 163[II]
booked 116[II]
booked_current 116[II]
brand_id 481[I]
bu_ps_code_cr 283[I]
bu_ps_code_db 283[I]
bytes_appended_last 218[II]
bytes_appended_total 218[II]

C
call_direction 129[I], 134[I]
called_place 131[I], 135[I]
called_state_prov 131[I], 136[I]
carrier 143[I]
carrier_code 138[I]
carrier_id_code 470[I]
cat_char 430[I]
category 371[I], 476[I]
cb_currency_code 214[II]
cc_trans_status 81[II]
cc_trans_type 80[II]
ccard_account 79[II]
ccard_carrier 97[I], 101[I], 79[II]
ccard_expire 79[II]
ccard_id 109[I], 116[I], 29[II], 41[II], 64[II],
74[II], 79[II], 81[II], 86[II], 91[II],
202[II], 212[II]
ccard_id_serv 109[I], 116[I], 29[II], 41[II],
64[II], 74[II], 79[II], 82[II], 86[II],
91[II], 202[II], 213[II]
ccard_ownr_name 79[II]
ccard_type_code 100[I], 101[I], 102[I]

ABP-9.1-DR1-1999/09/30

Fields

549

ccauth_code 82[II]
ccauth_date 82[II]
cdr_status 44[II]
cdr_status * 111[I], 117[I], 87[II], 92[II]
cell_id 121[I], 122[I], 123[I]
cell_id_origin 44[II]
cell_id_origin * 112[I], 118[I], 88[II], 93[II]
cell_name 121[I]
cell_name_origin 112[I]
certificate 122[II]
cgi_url 331[I]
ch_format_type 148[I]
change_dt 243[I], 257[I], 390[I], 417[I],
459[I], 8[II], 149[II], 162[II], 219[II]
change_who 243[I], 257[I], 390[I], 417[I],
459[I]
char_code 68[I]
char_value 41[I], 42[I], 478[I]
charge_date 195[II]
charge_elt_id 262[I], 482[I], 483[I], 486[I],
489[I], 491[I]
charge_elt_type 262[I], 482[I], 483[I],
486[I], 489[I], 491[I]
charge_threshold 106[II]
charge_type 392[I], 23[II], 216[II]
charged_party_status 480[I]
check_amount 313[I], 320[I]
check_digit_alg 101[I]
check_num 212[II]
check_sum 94[II], 97[II]
checksum1 256[I]
checksum2 256[I]
checksum3 257[I]
chg_date 374[I], 464[I], 30[II], 73[II], 76[II],
78[II], 81[II], 105[II], 112[II],
114[II], 126[II], 138[II], 142[II],
157[II], 159[II], 164[II], 171[II],
202[II], 205[II], 208[II], 210[II]
chg_dt 132[I], 137[I], 314[I], 321[I], 408[I],
421[I], 503[I], 96[II], 97[II], 120[II],
134[II], 180[II]
chg_order 131[II], 178[II]
chg_who 132[I], 137[I], 314[I], 321[I],
393[I], 408[I], 422[I], 464[I],
503[I], 30[II], 76[II], 78[II], 96[II],
97[II], 105[II], 112[II], 114[II],
120[II], 126[II], 134[II], 138[II],
157[II], 159[II], 171[II], 180[II],

202[II], 205[II], 208[II], 210[II]


chgb_resubmit_delay 149[I]
child_cols 28[I]
child_count 99[II]
child_nm 28[I]
ciber_call_direction 125[I]
ciber_char_value 124[I]
ciber_description 124[I]
ciber_int_value 124[I]
ciber_int_value2 124[I]
ciber_operator_type 141[I]
ciber_rec_type 125[I]
ciber_sid_bid 121[I]
ciber_tbl_name 124[I]
ciber_tbl_no 124[I]
cir_nrr_rate 201[II]
cir_nrr_rate_type 201[II]
city 163[I], 123[II], 217[II]
city_code 263[I], 481[I], 492[I], 539[I],
122[II], 217[II]
city_rate 492[I]
city_tax 128[I], 133[I], 29[II], 31[II], 65[II],
67[II], 203[II]
city_tax * 110[I], 116[I], 43[II], 86[II], 91[II]
ckf_client_id 153[I]
ckf_var_descriptor 153[I]
class_of_service_code 74[I], 146[I], 147[I],
177[I], 222[I], 340[I], 376[I],
385[I], 390[I], 405[I], 407[I],
412[I], 416[I], 421[I], 449[I],
517[I], 532[I], 170[II]
class_of_service_value 146[I]
clearing_house 103[I]
clearing_house_id 97[I], 98[I], 99[I], 103[I],
148[I], 150[I], 151[I], 152[I],
153[I], 220[I], 221[I], 356[I],
357[I], 358[I], 469[I], 79[II], 81[II],
105[II], 148[II], 161[II], 164[II]
clearing_house_operator_id 445[I]
closed_date 111[II], 113[II]
cmf_status 159[I], 160[I], 134[II]
cmf_status_chg_reason 157[I], 158[I],
134[II]
cmf_status_type 134[II]
code 234[I]
code_type 69[I], 70[I], 73[I]
code_value 74[I]
codeword 14[II], 104[II], 171[II]

ABP-9.1-DR1-1999/09/30

F
550

Fields

col_active_flag 135[II], 138[II]


col_balance_due 135[II]
col_enter_date 135[II]
col_exit_date 135[II]
col_order_type_id 167[I], 168[I], 169[I],
142[II]
collection_delay 149[I]
collection_history 54[II], 104[II]
collection_indicator 104[II], 112[II], 114[II]
collection_status 161[I], 162[I], 170[I],
104[II], 136[II]
collections_center 17[I]
collector_id 163[I], 136[II], 138[II]
com_ref_level 152[II]
com_ref_tracking_id 152[II]
com_ref_tracking_id_serv 153[II]
comb_tax_rate 29[II]
comments 374[I], 126[II], 173[II], 175[II]
commission_id 457[I]
commitment_amount 154[II]
commitment_currency_code 154[II]
commitment_reference 179[I], 152[II]
commitment_type_id_nrc 181[I]
comp_status 104[I], 105[I], 129[I], 134[I]
comp_status * 110[I], 117[I], 44[II], 87[II],
92[II]
comp_status_type 104[I]
company 163[I]
compare_type 430[I]
complete_dt 149[II], 162[II]
compliance_trans_code 484[I]
component_id 174[I], 175[I], 176[I], 177[I],
178[I], 340[I], 348[I], 349[I],
404[I], 408[I], 411[I], 417[I],
422[I], 56[II], 117[II], 128[II],
132[II], 178[II]
component_instance_id 117[II], 128[II]
component_instance_id_serv 117[II],
128[II]
component_level 175[I]
composite_file 268[I]
compressed_size 49[II]
compression_type 49[II]
conditional_type 431[I]
conditional_value 431[I]
consolidate_usage 14[I], 530[I]
contact1_name 48[II], 101[II]
contact1_phone 101[II]

contact2_name 48[II], 101[II]


contact2_phone 101[II]
contract_category 179[I]
contract_id 152[II]
contract_level 152[II]
contract_tracking_id 131[II], 177[II]
contract_tracking_id_serv 131[II], 177[II]
contract_type 179[I], 152[II]
contract_use_code 377[I]
control_file_expected 243[I]
conversion_date 235[I]
convert_factor 534[I]
converted 55[II], 105[II], 112[II], 115[II],
132[II], 171[II], 178[II]
copy_type 54[II]
corrected_records 257[I]
corridor_plan_id 112[I], 117[I], 182[I],
184[I], 186[I], 210[I], 420[I], 44[II],
88[II], 92[II], 120[II]
counter 81[II], 164[II], 191[II]
country_code 45[I], 142[I], 187[I], 188[I],
189[I], 262[I], 267[I], 272[I],
469[I], 472[I], 473[I], 481[I],
491[I], 520[I], 122[II], 216[II]
country_code_origin 108[I], 115[I], 131[I],
136[I], 182[I], 190[I], 518[I], 85[II],
90[II], 119[II]
country_code_origin * 42[II]
country_code_target 108[I], 115[I], 132[I],
136[I], 183[I], 190[I], 518[I], 85[II],
90[II], 120[II]
country_code_target * 43[II]
country_dial_code 189[I]
country_dial_code_origin 132[I], 136[I]
country_dial_code_origin * 108[I], 115[I],
42[II], 85[II], 90[II]
country_dial_code_target 109[I]
county 122[II], 217[II]
county_code 263[I], 481[I], 492[I], 539[I],
122[II], 217[II]
county_rate 492[I]
county_tax 128[I], 133[I], 29[II], 31[II],
64[II], 67[II], 203[II]
county_tax * 110[I], 116[I], 43[II], 86[II],
91[II]
cr_note_bill_ref_no 72[II]
cr_note_bill_ref_resets 72[II]
create_date 76[II]

ABP-9.1-DR1-1999/09/30

Fields

551

create_dt 25[I], 390[I], 393[I], 408[I],


417[I], 421[I], 459[I], 502[I], 8[II],
96[II], 97[II], 120[II], 146[II],
148[II], 153[II], 161[II], 173[II],
175[II], 219[II], 220[II]
create_who 76[II]
created_dt 184[II], 190[II]
creation_date 46[II]
cred_status 102[II]
credit_rating 102[II], 135[II]
credit_thresh 102[II]
credit_trans_type 148[I]
cross_field_name 40[I]
cross_table_name 40[I]
csr_action 150[II]
csr_address1 192[I]
csr_address2 192[I]
csr_address3 192[I]
csr_city 192[I]
csr_country_code 193[I]
csr_county 193[I]
csr_email 192[I]
csr_fname 192[I]
csr_id 150[II]
csr_lname 192[I]
csr_minit 192[I]
csr_name 191[I]
csr_phone 192[I]
csr_state 192[I]
csr_title 192[I]
csr_zip 192[I]
csub_cr 283[I]
csub_cr_final 283[I]
csub_db 283[I]
csub_db_final 283[I]
ctrl_file_name 255[I]
currency_code 142[I], 150[I], 171[I], 173[I],
195[I], 264[I], 268[I], 313[I],
320[I], 323[I], 339[I], 379[I],
385[I], 390[I], 392[I], 394[I],
397[I], 399[I], 400[I], 402[I],
404[I], 412[I], 413[I], 416[I],
421[I], 449[I], 459[I], 496[I], 27[II],
52[II], 72[II], 76[II], 78[II], 80[II],
99[II], 111[II], 113[II], 133[II],
136[II], 159[II], 163[II], 172[II],
179[II], 185[II], 191[II], 193[II],
195[II], 201[II], 206[II], 213[II]

currency_code* 300[I]
currency_code_foreign 446[I], 451[I]
currency_code_home 446[I], 450[I]
currency_code_mask 303[I]
currency_gain_loss 78[II]
currency_group 339[I], 379[I], 394[I],
395[I], 396[I]
currency_type 196[I], 197[I], 397[I]
current_balance 33[II]
current_flag 27[II]
current_installment 202[II]
current_rec_no 256[I]
cust_address1 100[II]
cust_address2 100[II]
cust_address3 100[II]
cust_bank_acc_name 102[II], 165[II]
cust_bank_acc_num 102[II], 165[II]
cust_bank_sort_code 102[II], 165[II]
cust_city 100[II]
cust_country_code 100[II]
cust_county 101[II]
cust_email 104[II]
cust_faxno 101[II]
cust_franchise_tax_code 100[II]
cust_geocode 101[II], 194[II]
cust_order_number 201[II]
cust_phone1 14[II], 101[II]
cust_phone2 14[II], 101[II]
cust_state 100[II]
cust_zip 100[II]
customer_carrier_name_abbr 470[I]
customer_tag 42[II]
customer_tag * 110[I], 117[I], 86[II], 91[II]
cutoff_date 49[I]
cutoff_dt 450[I]
cutoff_end_dt 95[II], 218[II], 220[II]
cutoff_start_dt 95[II], 97[II], 218[II], 220[II]
cycle_expected 322[I]
cycle_from_date 214[II]
cycle_id 148[II], 161[II]
cycle_id_serv 148[II], 161[II]
cycle_status 148[II], 161[II]
cycle_type 350[I]
cyclical_threshold 106[II], 172[II]

D
data_format 427[I]
date_active 193[I], 209[I], 377[I], 401[I],
403[I], 413[I], 457[I], 510[I],

ABP-9.1-DR1-1999/09/30

F
552

Fields

105[II], 122[II]
date_created 210[I], 377[I], 401[I], 403[I],
404[I], 412[I], 510[I], 105[II],
131[II], 177[II]
date_expiration 122[II]
date_format 424[I]
date_format1 311[I]
date_format2 311[I]
date_format3 311[I]
date_format4 311[I]
date_format5 311[I]
date_inactive 193[I], 210[I], 377[I], 401[I],
403[I], 414[I], 457[I], 510[I],
105[II]
date_last_updated 442[I]
date_nrc_journalable 202[II]
date_rc_begin 130[II], 177[II]
date_rc_billed_through 131[II], 177[II]
date_received 159[II]
date_returned 159[II]
daylight_savings 129[I], 134[I]
dayofmonth 407[I]
dayofweek 407[I]
days_from_prev_event 170[I]
db_criteria1 32[I]
db_criteria2 32[I]
db_name 31[I], 373[I]
dealer_pin 457[I]
debit_trans_type 149[I]
debug_level 373[I]
decimal_count 195[I]
decimal_string 195[I]
declines_amt 148[II], 161[II]
def_order 211[I]
default_ccard_id 102[II]
default_ccard_id_serv 102[II]
default_currency_code 187[I]
default_external_id_type 224[I]
default_type 428[I]
default_value 428[I]
denial_reason 200[I], 201[I]
depend_id 28[I]
deposit_amount 159[II]
deposit_dt 313[I], 320[I]
deposit_type 202[I], 203[I], 159[II]
derive_distance_units 526[I]
derive_jurisdiction 526[I]
description 75[I], 476[I]

description_code 23[I], 96[I], 180[I], 204[I],


210[I], 241[I], 306[I], 337[I],
341[I], 375[I], 381[I], 382[I],
391[I], 510[I], 523[I], 533[I], 63[II]
description_group 204[I]
description_text 204[I]
designated_tax_amount 204[II]
device_class 205[I], 282[I]
device_id 205[I], 282[I], 39[II], 47[II]
device_id_serv 39[II], 47[II]
device_label 39[II], 47[II]
device_name 205[I]
device_options 282[I]
device_type 205[I]
direction 141[II]
disc_rcv_opt 102[II]
disc_total 103[I]
disconnect_reason 206[I], 207[I], 102[II],
131[II], 171[II], 177[II]
discount 61[II], 214[II]
discount_activation_code 181[I]
discount_amount 401[I], 66[II]
discount_amt 29[II]
discount_base_period 181[I]
discount_domain 208[I]
discount_factor 407[I]
discount_id 185[I], 208[I], 211[I], 212[I],
214[I], 400[I], 61[II], 66[II]
discount_level 208[I]
discount_percent 401[I]
discount_quantum 209[I]
discount_termination_code 181[I]
discount_type 209[I]
disp_code 137[I]
disp_status 137[I]
dispatch_count 47[II], 53[II], 70[II]
dispatch_date 47[II], 53[II]
dispatch_device 47[II]
dispatch_status 47[II]
dispatch_task 47[II]
dispatch_type 39[II]
display_external_id_type 172[II]
display_type 71[I]
display_value 11[I], 13[I], 15[I], 19[I], 21[I],
26[I], 30[I], 35[I], 38[I], 42[I], 44[I],
48[I], 51[I], 54[I], 56[I], 58[I], 60[I],
62[I], 64[I], 67[I], 70[I], 80[I], 85[I],
91[I], 93[I], 99[I], 102[I], 105[I],

ABP-9.1-DR1-1999/09/30

Fields

553

122[I], 147[I], 152[I], 158[I],


160[I], 162[I], 169[I], 176[I],
186[I], 188[I], 197[I], 201[I],
203[I], 207[I], 218[I], 221[I],
225[I], 227[I], 229[I], 231[I],
233[I], 236[I], 238[I], 240[I],
251[I], 253[I], 259[I], 261[I],
270[I], 275[I], 277[I], 279[I],
281[I], 284[I], 287[I], 308[I],
310[I], 316[I], 324[I], 326[I],
328[I], 330[I], 334[I], 343[I],
346[I], 352[I], 354[I], 360[I],
362[I], 364[I], 366[I], 368[I],
370[I], 386[I], 388[I], 396[I],
399[I], 410[I], 437[I], 439[I],
441[I], 444[I], 448[I], 458[I],
462[I], 467[I], 471[I], 473[I],
475[I], 495[I], 499[I], 501[I],
505[I], 508[I], 515[I], 521[I],
536[I], 538[I], 541[I], 543[I],
108[II], 109[II]
dispute_amt 112[II], 114[II]
distance_band_id 216[I], 217[I], 218[I],
417[I], 422[I]
distance_increment 412[I]
distance_rate 412[I]
distance_units_indicator 527[I]
distr_chan 104[II]
distrib_order 77[II], 207[II]
distributed_amount 74[II]
distributed_gl_amount 74[II]
division 484[I]
division_number 150[I]
do_not_arch 33[I]
dom_amex_format_code 155[I]
dom_amex_merchant 156[I]
dom_amex_process_id 155[I]
dom_amex_receiver_id 155[I]
dom_batch_limit 155[I]
dom_currency_ind 155[I]
dom_fund_acct_num 155[I]
dom_fund_dest 155[I]
dom_fund_inst_id 155[I]
dom_fund_orig 155[I]
dom_mailbox_id 155[I]
dom_msc_dest 155[I]
dom_msc_merchant 156[I]
dom_msc_orig 155[I]

dom_phone_dest 155[I]
dom_rcon_number 154[I]
dom_visa_dest 155[I]
dom_visa_merchant 156[I]
dom_visa_orig 155[I]
domain_id 209[I], 510[I]
down_reason_code 12[II]
down_set_by 12[II]
down_since_dt 11[II]
ds_database 11[II], 198[II]
dsquery 11[II], 198[II]
dt_chg_field 442[I]
due_date 48[II]
due_dt 502[I]
duration 180[I], 349[I]
duration_flag 526[I]
duration_units 180[I]

E
earliest 31[I]
edit_table 427[I]
edit_table_field 427[I]
edit_table_field_type 427[I]
edit_type 427[I]
effective_date 26[II], 200[II]
effective_dt 184[II]
eft_trans_status 164[II]
eft_trans_type 163[II]
element_id 74[I], 179[I], 209[I], 216[I],
301[I], 337[I], 375[I], 380[I],
385[I], 389[I], 404[I], 408[I],
411[I], 416[I], 420[I], 449[I],
509[I], 516[I], 525[I], 40[II], 62[II],
94[II], 97[II], 130[II], 152[II],
176[II], 181[II], 183[II], 192[II],
200[II]
element_id * 107[I], 114[I], 84[II], 89[II]
element_id_mask 120[I], 303[I]
element_level 152[II]
element_tracking_id 152[II]
element_tracking_id_serv 152[II]
email_msg 464[I]
emf_book_id 223[I], 286[I], 287[I], 185[II],
191[II]
emf_config_id 167[I], 222[I], 224[I], 225[I],
332[I], 142[II], 170[II]
emf_status 228[I], 229[I], 180[II]
emf_status_chg_reason 226[I], 227[I],
180[II]

ABP-9.1-DR1-1999/09/30

F
554

Fields

emf_status_type 180[II]
emf_type 222[I]
end_date 26[II], 209[II]
end_dt 133[II], 145[II], 153[II], 179[II]
end_offset 53[II]
end_time 205[I]
endhhmm 407[I]
enter_thresh 173[I]
entry_create_dt 256[I]
entry_date 150[II]
eof_data 249[I]
equip_class_code 74[I], 177[I], 222[I],
230[I], 231[I], 340[I], 376[I],
385[I], 389[I], 405[I], 407[I],
411[I], 416[I], 421[I], 449[I],
517[I], 532[I], 170[II]
equip_external_id 126[II]
equip_group_id 167[II]
equip_status 63[II], 168[II]
equip_status_dt 168[II]
equip_type_code 74[I], 177[I], 222[I],
232[I], 233[I], 340[I], 376[I],
385[I], 389[I], 405[I], 407[I],
411[I], 416[I], 421[I], 449[I],
517[I], 532[I], 170[II]
error_code 126[I], 245[I], 255[I], 314[I],
317[I], 321[I]
error_code1 137[I]
error_code2 137[I]
error_code3 137[I]
error_desc 182[II], 187[II]
event 165[I], 167[I], 170[I], 137[II]
event_category 165[I], 170[I], 137[II]
event_no 170[I], 137[II], 139[II], 141[II]
event_process 165[I]
exceptions_amt 149[II], 161[II]
exch_rate_exp 459[I]
exchange_rate 392[I]
exclude 145[II]
exclude_charge 494[I]
exclude_group 517[I]
exempt_city 122[II]
exempt_county 122[II]
exempt_federal 122[II]
exempt_other 122[II]
exempt_state 122[II]
exit_thresh 173[I]
expiration_date 219[I]

expression_group_id 52[I], 53[I], 54[I]


expression_id 52[I], 55[I], 56[I]
expression_type 55[I]
exrate_class 235[I], 236[I], 392[I], 103[II],
171[II]
ext_category 319[I]
ext_client_id 241[I]
ext_contact_id 148[I], 241[I], 245[I], 246[I],
247[I], 248[I], 249[I], 255[I], 469[I]
ext_contact_id_in 139[I], 142[I], 268[I]
ext_contact_id_out 140[I], 142[I], 268[I]
ext_ebcdic 242[I]
ext_file_id 255[I], 318[I]
ext_id_type 480[I]
ext_tracking_id 128[I], 133[I]
ext_tracking_id * 107[I], 114[I], 42[II],
84[II], 89[II]
external_amount 314[I], 321[I], 75[II]
external_currency 314[I], 321[I], 75[II]
external_id 314[I], 321[I], 9[II], 10[II],
115[II], 155[II], 156[II]
external_id * 108[I], 115[I], 42[II], 85[II],
90[II]
external_id_type 237[I], 238[I], 314[I],
321[I], 378[I], 9[II], 10[II], 155[II],
156[II]
external_id_type * 108[I], 115[I], 42[II],
85[II], 90[II]

F
fax_msg 464[I]
fdm_avs_type 154[I]
fdm_merchant_name 154[I]
fdm_merchant_number 154[I]
federal_rate 492[I]
federal_tax 128[I], 133[I], 29[II], 31[II],
64[II], 67[II], 202[II]
federal_tax * 110[I], 116[I], 43[II], 86[II],
91[II]
fee_amount 403[I]
fee_class 402[I]
fee_percent 402[I]
field_category 426[I]
field_db_name_from 430[I]
field_db_name_to 430[I]
field_delimiter_char 434[I]
field_delimiter_code 434[I]
field_format 356[I], 357[I], 358[I]
field_from_name 423[I]

ABP-9.1-DR1-1999/09/30

Fields

555

field_from_pos 423[I]
field_from_size 423[I]
field_from_type 423[I]
field_id 356[I], 357[I], 358[I]
field_length 356[I], 357[I], 358[I]
field_name 40[I], 41[I], 42[I], 106[I], 126[I],
269[I], 270[I], 426[I], 436[I]
field_name_from 429[I]
field_name_to 429[I]
field_pos 426[I]
field_rec_pos 356[I], 357[I], 358[I]
field_size 426[I]
field_status 46[I]
field_to_name 425[I]
field_type 40[I], 356[I], 357[I], 358[I], 426[I]
field_value 436[I]
file_age 32[I]
file_byte_count 256[I]
file_creation_dt 450[I]
file_group_id 254[I]
file_id 111[I], 117[I], 254[I], 450[I], 19[II],
22[II], 23[II], 74[II], 81[II], 83[II],
87[II], 92[II], 164[II], 218[II],
220[II]
file_id * 44[II]
file_id_in 132[I], 137[I]
file_id_out 132[I], 137[I]
file_id_serv 111[I], 117[I], 254[I], 19[II],
22[II], 23[II], 83[II], 87[II], 92[II],
218[II], 220[II]
file_id_serv * 44[II]
file_id_serv_in 132[I], 137[I]
file_id_serv_out 132[I], 137[I]
file_name 103[I], 254[I], 313[I], 317[I],
320[I], 53[II]
file_name_alter_type 244[I]
file_no 31[I]
file_pattern 32[I]
file_process_dt 256[I]
file_size 218[II], 220[II]
file_status 255[I], 218[II], 220[II]
file_type 243[I], 255[I], 258[I], 259[I]
filename 46[II]
fill_char 428[I]
first_call_dt 450[I]
first_invoice 46[II]
first_name 163[I]
first_scanline 46[II]

first_use_dt 153[II]
fixed_amount 390[I]
fixed_amt 496[I]
fixed_charge_amt 416[I], 421[I]
fixed_end_date 180[I]
fixed_mile_rate 179[II]
fixed_start_date 180[I]
fml_acct_cr 283[I]
fml_acct_db 283[I]
font_id 65[I], 67[I], 68[I]
foreign_amount 110[I], 41[II], 87[II], 92[II]
foreign_code 146[I], 180[I], 232[I], 412[I]
foreign_group_code 382[I]
foreign_product_code 377[I]
format_code 57[I], 71[I], 72[I], 73[I], 209[I],
397[I], 510[I]
format_comp_date 39[II]
format_display 74[I], 225[I], 388[I]
format_error_code 53[II]
format_status 39[II], 46[II], 53[II], 124[II]
format_task 39[II], 46[II]
franchise_code 17[I], 260[I], 261[I], 262[I],
481[I], 492[I], 122[II], 217[II]
franchise_tax_code 402[I]
fraud_ind 130[I], 135[I]
fraud_indicator 29[II], 185[II], 191[II]
fraud_indicator* 301[I]
fraud_indicator_mask 302[I]
fraud_sub_ind 131[I], 135[I]
free_usg 525[I]
frequency 484[I]
frn_account_num 154[I]
frn_agency_code 154[I]
frn_bank_code 154[I]
frn_company_name 154[I]
frn_fast_mode 154[I]
frn_fast_op_id 154[I]
frn_fast_post_delay 154[I]
frn_national_num 154[I]
frn_norm_op_id 154[I]
frn_norm_post_delay 154[I]
frn_unique_dates 154[I]
from_date 48[II], 51[II], 63[II]
from_server 442[I]
from_tables 16[I]
from_user 502[I]
fus_avs_type 153[I]
fus_pres_id 153[I]

ABP-9.1-DR1-1999/09/30

F
556

Fields

fus_pres_pass 153[I]
fus_sub_id 153[I]
fus_sub_pass 153[I]

html_start_tag 66[I]

g_l_code 286[I], 345[I], 443[I]


geo_key 76[I], 82[I]
geocode 29[II], 32[II], 41[II], 64[II], 68[II]
gl_amount 314[I], 321[I], 72[II], 77[II],
112[II], 114[II]
grace_period 402[I], 152[II]
group_id 163[I], 164[I]
group_name 264[I], 265[I]
group_type 53[I]
guide_flag 104[I]
guide_to 522[I]
guide_to_provider 527[I]

H
hdr_field 289[I]
hdr_field_description 289[I]
hdr_field_format 289[I]
hdr_field_size 289[I]
hdr_field_trim 289[I]
hdr_hardcoded 289[I]
hdr_is_pack 289[I]
hdr_position 288[I]
hdr_table 288[I]
hdr_type 288[I]
hierarchy_acg_tracking_id 110[II]
hierarchy_acg_tracking_id_serv 110[II]
hierarchy_id 8[II], 99[II]
home_carrier_sid_bid 128[I], 133[I]
home_provider_flag 469[I]
home_sid_bid 118[I]
hostname 371[I], 374[I], 11[II], 198[II]
hp_direction 65[I]
hp_height 65[I]
hp_line_type 78[I]
hp_outline 65[I]
hp_pen_width 78[I]
hp_pitch 65[I]
hp_spacing 65[I]
hp_stroke_weight 65[I]
hp_style 65[I]
hp_symbol_set 65[I]
hp_typeface 65[I]
hp_underline 65[I]
html_end_tag 66[I]

ic_account_no 19[II]
ic_extract_date 19[II]
id_type 297[I], 302[I], 128[II], 183[II],
190[II]
id_type2 183[II], 190[II]
id_type2* 299[I]
id_type2_mask 302[I]
id_value 128[II], 183[II], 190[II]
id_value* 298[I]
id_value_mask 302[I]
id_value2 183[II], 190[II]
id_value2* 300[I]
id_value2_mask 302[I]
iet 283[I]
image_done 52[II]
image_req 52[II]
image_size 48[II]
image_type 49[II]
implied_decimal 392[I], 397[I], 206[II]
implied_decimals 401[I], 403[I], 412[I]
in_arrears_override 131[II], 177[II]
in_feed_report 289[I], 292[I], 294[I]
in_out_indicator 452[I], 455[I]
in_units_type 534[I]
in_use 104[II], 145[II]
in_use_by 32[I]
inactive_date 180[I], 301[I], 397[I], 404[I],
412[I], 497[I], 9[II], 10[II], 155[II],
156[II]
inactive_dt 25[I], 77[I], 83[I], 138[I], 140[I],
142[I], 175[I], 178[I], 223[I],
243[I], 268[I], 347[I], 348[I],
350[I], 351[I], 355[I], 390[I],
392[I], 408[I], 416[I], 421[I],
433[I], 442[I], 445[I], 459[I],
518[I], 520[I], 107[II], 118[II],
120[II], 127[II], 129[II], 134[II],
143[II], 147[II], 180[II], 181[II]
include_adj 54[II], 124[II]
include_bmf 54[II], 124[II]
include_nrc 54[II], 124[II]
include_rc 54[II], 124[II]
include_usage 54[II], 124[II]
income_tax_amount 159[II]
incremental_bands 417[I], 421[I]
index_bill_ref 40[II], 50[II], 56[II], 66[II],

ABP-9.1-DR1-1999/09/30

Fields

557

67[II], 193[II], 216[II]


index_bill_ref_resets 40[II], 50[II], 56[II],
66[II], 67[II], 193[II], 216[II]
industry_type 223[I], 276[I], 277[I]
initial_cell_site 129[I], 134[I]
input_language 310[I]
insert_bin_num 76[I]
insert_date 83[II]
insert_foreign_key 77[I], 278[I], 279[I]
insert_grp_id 17[I], 76[I], 280[I], 281[I],
103[II]
insert_id 75[I], 76[I]
insert_pages 75[I]
insert_trigger_id 76[I]
installment_type_id_nrc 339[I]
instance_name 371[I]
int_value 41[I], 42[I], 478[I]
integer_value 269[I], 270[I]
interest_amount 159[II]
interim_bill_date 124[II]
interim_bill_flag 54[II]
interim_due_days 14[I]
intl_dial_access 189[I]
intl_dial_code 189[I]
investigator 137[I]
invoice_amount 184[II], 190[II]
invoice_billing_type 20[II]
invoice_currency_code 185[II], 191[II]
io_type 433[I]
ip_address 249[I], 11[II]
is_a_prefix 519[I]
is_adjustable 24[I], 338[I]
is_binned 493[I]
is_business 14[I]
is_calling_card_used 276[I]
is_conditional_map 431[I], 432[I]
is_consolidation_key 106[I]
is_conversion_default 398[I]
is_csr_default 191[I]
is_csr_enterable 339[I]
is_current 155[II], 156[II]
is_dadl_used 276[I]
is_default 7[I], 10[I], 12[I], 14[I], 18[I], 20[I],
25[I], 29[I], 34[I], 37[I], 41[I], 43[I],
46[I], 47[I], 50[I], 57[I], 59[I], 61[I],
63[I], 69[I], 84[I], 88[I], 98[I],
101[I], 104[I], 121[I], 146[I],
151[I], 157[I], 159[I], 161[I],

168[I], 175[I], 185[I], 187[I],


196[I], 200[I], 202[I], 206[I],
217[I], 220[I], 224[I], 226[I],
228[I], 230[I], 232[I], 235[I],
237[I], 239[I], 250[I], 252[I],
258[I], 260[I], 269[I], 273[I],
276[I], 278[I], 280[I], 286[I],
307[I], 309[I], 315[I], 323[I],
325[I], 327[I], 329[I], 333[I],
342[I], 345[I], 351[I], 353[I],
359[I], 361[I], 363[I], 365[I],
367[I], 369[I], 385[I], 387[I],
391[I], 395[I], 398[I], 409[I],
434[I], 438[I], 440[I], 443[I],
447[I], 457[I], 461[I], 466[I],
470[I], 472[I], 474[I], 494[I],
498[I], 500[I], 504[I], 507[I],
514[I], 535[I], 537[I], 540[I], 542[I]
is_default_rate 417[I]
is_deletable 36[I]
is_disconnect_credit 24[I]
is_displayed_onbill 24[I], 96[I], 338[I]
is_distributed 493[I]
is_e911_required 276[I]
is_ebcdic 426[I]
is_empty 106[I]
is_enterable 338[I]
is_exclusion 27[I], 213[I], 215[I], 513[I]
is_exclusive 210[I], 361[I]
is_franchise 493[I]
is_graduated 494[I]
is_gross 210[I]
is_gui_pretax 493[I]
is_hidden 52[I], 53[I], 55[I], 89[I], 90[I],
92[I]
is_icb_corridor 184[I]
is_ignored 424[I], 433[I]
is_immediate 331[I]
is_index_key 427[I]
is_internal 10[I], 12[I], 14[I], 18[I], 20[I],
25[I], 29[I], 34[I], 37[I], 41[I], 43[I],
47[I], 50[I], 52[I], 53[I], 55[I], 57[I],
59[I], 61[I], 63[I], 69[I], 84[I], 89[I],
90[I], 92[I], 98[I], 101[I], 104[I],
121[I], 146[I], 151[I], 157[I],
159[I], 161[I], 168[I], 175[I],
185[I], 187[I], 196[I], 200[I],
202[I], 206[I], 217[I], 220[I],

ABP-9.1-DR1-1999/09/30

F
558

Fields

224[I], 226[I], 228[I], 230[I],


232[I], 235[I], 237[I], 239[I],
250[I], 252[I], 258[I], 260[I],
269[I], 273[I], 276[I], 278[I],
280[I], 286[I], 307[I], 309[I],
315[I], 323[I], 325[I], 327[I],
329[I], 333[I], 342[I], 345[I],
351[I], 353[I], 359[I], 361[I],
363[I], 365[I], 367[I], 369[I],
385[I], 387[I], 395[I], 398[I],
409[I], 434[I], 438[I], 440[I],
443[I], 447[I], 457[I], 461[I],
466[I], 470[I], 472[I], 474[I],
494[I], 498[I], 500[I], 504[I],
507[I], 514[I], 535[I], 537[I],
540[I], 542[I]
is_international 520[I]
is_journalable 24[I], 96[I], 338[I]
is_latefee_exempt 537[I]
is_lidb_required 276[I]
is_master 36[I]
is_modifiable 24[I], 338[I]
is_pic_required 276[I]
is_prepaid 223[I], 527[I], 96[II], 172[II]
is_prerated 527[I]
is_pretaxed 339[I]
is_promotion 180[I]
is_refinance 24[I]
is_required 423[I], 427[I]
is_reseller 14[I]
is_rfr_required 243[I]
is_send 148[I], 241[I], 255[I]
is_start_bounded 147[II]
is_symbol_first 398[I]
is_system_complete 165[I]
is_tax 208[II]
is_variable_length 434[I]
is_variable_size 428[I]
is_viewable 24[I], 338[I]
isdst 504[I]
item_id 142[II]
item_id_resets 142[II]
item_number 24[II]
ixc_provider_id 171[II]

J
je_category_name 284[I]
jnl_backout 304[I], 189[II]
jnl_code_id 283[I], 297[I], 184[II], 191[II]

jnl_completion_dt 189[II]
jnl_earned_thru_dt 54[II], 188[II], 193[II]
jnl_end_dt 285[I], 304[I], 185[II], 189[II],
190[II], 216[II]
jnl_feed_status 186[II], 192[II]
jnl_field 291[I]
jnl_field_db_cr 290[I]
jnl_field_description 292[I]
jnl_field_format 292[I]
jnl_field_position 290[I]
jnl_field_size 292[I]
jnl_field_trim 292[I]
jnl_hardcoded_value 292[I]
jnl_key_status 301[I]
jnl_ref_no 183[II], 187[II], 188[II], 189[II],
190[II]
jnl_ref_no_serv 183[II], 187[II], 188[II],
189[II], 190[II]
jnl_run_dt 304[I], 189[II]
jnl_start_dt 285[I]
jnl_status 54[II], 188[II], 193[II]
jnl_subcycle_end_dt 304[I], 305[I], 185[II],
189[II], 191[II]
jnl_subcycle_start_dt 305[I]
jnl_table 290[I]
jnl_type 304[I], 189[II]
journal_code 20[I]
journal_delay 339[I]
journal_entry 284[I]
jurisdiction 74[I], 131[I], 136[I], 190[I],
210[I], 216[I], 306[I], 389[I],
406[I], 415[I], 421[I], 486[I],
516[I], 532[I], 30[II], 40[II], 94[II],
184[II], 190[II]
jurisdiction * 107[I], 114[I], 84[II], 89[II]
jurisdiction* 300[I]
jurisdiction_class 306[I], 307[I], 308[I]
jurisdiction_mask 120[I], 302[I]
justify_type 428[I]

K
keep_running_total 527[I]
key_nm 28[I]
knn_merchant_acct 153[I]
knn_merchant_id 153[I]

L
language_code 11[I], 13[I], 15[I], 19[I],
21[I], 26[I], 30[I], 35[I], 38[I], 42[I],

ABP-9.1-DR1-1999/09/30

Fields

559

44[I], 48[I], 51[I], 54[I], 56[I], 58[I],


60[I], 62[I], 64[I], 67[I], 70[I], 75[I],
80[I], 81[I], 85[I], 91[I], 93[I], 99[I],
102[I], 105[I], 122[I], 147[I],
152[I], 158[I], 160[I], 162[I],
166[I], 169[I], 176[I], 186[I],
188[I], 197[I], 199[I], 201[I],
203[I], 204[I], 207[I], 218[I],
221[I], 225[I], 227[I], 229[I],
231[I], 233[I], 236[I], 238[I],
240[I], 251[I], 253[I], 259[I],
261[I], 270[I], 271[I], 272[I],
275[I], 277[I], 279[I], 281[I],
287[I], 308[I], 309[I], 310[I],
311[I], 316[I], 324[I], 326[I],
328[I], 330[I], 334[I], 335[I],
343[I], 346[I], 352[I], 354[I],
360[I], 362[I], 364[I], 366[I],
368[I], 370[I], 386[I], 388[I],
396[I], 399[I], 410[I], 437[I],
439[I], 441[I], 444[I], 448[I],
458[I], 462[I], 467[I], 471[I],
473[I], 475[I], 495[I], 499[I],
501[I], 505[I], 506[I], 508[I],
515[I], 521[I], 536[I], 538[I],
541[I], 543[I], 54[II], 99[II]
last_access_dt 245[I]
last_arch 33[I]
last_call_dt 450[I]
last_event_no 136[II]
last_file_in 139[I]
last_file_in_dt 145[I]
last_file_out 139[I]
last_file_out_dt 145[I]
last_name 163[I]
last_reviewed_name 30[II], 213[II]
last_scanline 46[II]
last_use_dt 153[II]
late_exempt_charges 112[II], 114[II]
latest 31[I]
lbx_account_id 313[I], 320[I]
lbx_cycle_type 322[I]
lbx_error_status 314[I], 315[I], 316[I],
321[I]
lbx_file_status 317[I]
lbx_payment_id 314[I], 321[I]
lbx_source_type 322[I]
le 283[I]

lec_provider_id 171[II]
level_code 377[I], 391[I]
level_identifier 152[II]
line_id 78[I], 80[I]
line_num 81[I]
line_range_high 138[I]
line_range_low 138[I]
local_loginfile_path 247[I]
local_modem 247[I]
local_port_path 247[I]
local_speed 247[I]
local_work_dir 247[I]
location_code 284[I], 184[II], 191[II]
location_region 184[II], 191[II]
long_month1 312[I]
long_month10 312[I]
long_month11 312[I]
long_month12 312[I]
long_month2 312[I]
long_month3 312[I]
long_month4 312[I]
long_month5 312[I]
long_month6 312[I]
long_month7 312[I]
long_month8 312[I]
long_month9 312[I]
lookup_table_name 430[I]
lower_balance_due 171[I]
lower_credit_rating 171[I]
lower_limit 390[I], 412[I]
lower_limit_percent 514[I]

M
main_provider_flag 468[I]
manual_ccauth_code 74[II], 160[II]
manual_ccauth_date 74[II], 160[II]
manual_code 182[II], 187[II]
mapping_direction 124[I], 125[I]
mapping_order 430[I]
mapping_type 429[I]
market_city 144[I]
market_country_code 144[I]
market_name 138[I]
market_state_abbr 144[I]
marketing_bill_ic1 20[II]
marketing_bill_ic2 20[II]
marketing_bill_ic3 20[II]
marketing_bill_ic4 20[II]
marketing_bill_ic5 21[II]

ABP-9.1-DR1-1999/09/30

F
560

Fields

marketing_bill_ic6 21[II]
master_file_name 218[II]
max_amount 264[I]
max_days_in 139[I], 267[I]
max_days_out 139[I], 267[I]
max_distance 216[I]
max_installments 339[I]
max_ref_no 69[II]
max_scenario_id 164[I]
max_size_reached 219[II]
max_time_gap 242[I]
maximum_allowed 348[I]
maximum_amount 403[I]
maximum_range_value 100[I]
me 283[I]
member_id 168[I], 349[I]
member_inst_id 142[II]
member_inst_id2 142[II]
member_required 349[I]
member_type 349[I], 142[II]
memo_status 502[I]
memo_text 502[I]
memo_type 502[I]
merchant_account_no 468[I]
merchant_category_code 468[I]
merchant_city 468[I]
merchant_id 468[I]
merchant_name 468[I]
merchant_phone 469[I]
merchant_state_prov 469[I]
merchant_zip 469[I]
message_id 81[I], 82[I], 166[I]
message_language 234[I], 476[I]
message_name 476[I]
message_number 476[I]
message_severity 234[I], 476[I]
message_text 81[I], 166[I], 476[I]
micr_bank_id 313[I], 320[I], 74[II], 205[II]
micr_check_num 313[I], 320[I], 74[II],
205[II]
micr_dda_num 313[I], 320[I], 74[II], 205[II]
min_bal_threshold 403[I]
min_billing_units 530[I]
min_distance 216[I]
min_scenario_id 164[I]
minimum_amount 403[I]
minimum_range_value 100[I]
minimum_required 348[I]

misc_surcharge 130[I], 135[I]


misc_surcharge_desc 130[I], 135[I]
missed_bill_code 10[I]
miu_ccard_account 109[I]
miu_ccard_carrier_code 110[I]
miu_ccard_expire 110[I]
miu_ccard_ownr_name 110[I]
miu_disp_code 112[I]
miu_disp_status 111[I]
miu_error_code1 111[I]
miu_error_code2 111[I]
miu_error_code3 111[I]
miu_investigator 111[I]
miu_locked_by 112[I]
miu_notes 112[I]
miu_queue 111[I]
mkt_code 17[I], 76[I], 82[I], 108[I], 174[I],
314[I], 321[I], 325[I], 326[I],
332[I], 347[I], 104[II], 185[II],
191[II], 193[II], 216[II]
mkt_code* 300[I]
mkt_code_mask 303[I]
mobile_country_code 266[I]
mobile_network_code 266[I]
module 148[I], 153[I], 478[I], 507[I]
module_name 264[I], 265[I], 476[I], 477[I]
month 407[I]
move_dt 8[II]
mps_miu_dt 111[I]
msc_total 103[I]
msg 199[I]
msg_acct_digits 129[I], 134[I]
msg_foreign_key 83[I]
msg_grp_id 17[I], 82[I], 327[I], 328[I],
103[II]
msg_id 107[I], 114[I], 119[I], 128[I], 133[I],
40[II], 84[II], 89[II]
msg_id_serv 107[I], 114[I], 119[I], 128[I],
133[I], 40[II], 84[II], 89[II]
msg_id2 107[I], 114[I], 119[I], 128[I],
133[I], 40[II], 84[II], 89[II]
msg_name 271[I]
msg_no 271[I]
msg_sequence_num 82[I]
msg_text 271[I]
msg_trigger_id 72[I], 82[I]
msg_type 271[I]
msgno 199[I]

ABP-9.1-DR1-1999/09/30

Fields

561

multi_tax_rate 450[I]

N
naming_extension 317[I], 322[I]
naming_pattern 322[I]
national_destination_code 266[I]
ndevice_id 205[I]
negative_after 311[I]
negative_before 311[I]
net_action_id 329[I], 330[I], 331[I]
net_action_name 329[I]
net_interface_id 331[I], 332[I], 333[I],
334[I]
net_interface_name 333[I]
net_new_charges 111[II], 114[II]
new_charges 111[II], 113[II]
new_cust_bank_sort_code 105[II]
new_jnl_earned_thru_dt 188[II]
new_jnl_status 188[II]
newline_terminate_records 268[I]
next_account_no 7[II]
next_bill_date 99[II]
next_event_no 136[II]
next_ppdd_date 49[I]
next_subscr_no 15[II]
next_to_date 51[II]
no_bill 532[I], 27[II], 31[II], 73[II], 104[II],
131[II], 147[II], 165[II], 168[II],
178[II], 201[II], 205[II]
no_bill * 110[I], 117[I], 87[II], 92[II]
no_bytes 46[II]
no_invoices 46[II]
no_jnl_ind 301[I]
no_pages 46[II]
nonpub_nonlist 172[II]
note_code 335[I], 336[I], 126[II]
note_text 336[I], 126[II]
notes 137[I]
notification_interval 268[I]
npa 127[I], 138[I]
nrc_category 339[I], 200[II]
null_terminated 434[I]
num_accts 11[II]
num_approved 148[II], 161[II]
num_declines 148[II], 161[II]
num_discarded 256[I]
num_exceptions 148[II], 161[II]
num_failed_attempts 256[I]
num_good 256[I]

num_hard_errors 256[I]
num_pass_thru 256[I]
num_payments 76[II]
num_records 45[II], 88[II]
num_rows 31[I]
num_soft_errors 256[I]
num_threshold 457[I]
num_trans_audit 149[II], 162[II]
num_trans_sent 148[II], 161[II]
num_units 418[I], 419[I]
nxx 127[I], 138[I]

O
obligation_id 20[II]
offset_units 349[I]
open_item_id 113[I], 172[I], 301[I], 314[I],
321[I], 340[I], 342[I], 343[I],
344[I], 379[I], 470[I], 530[I], 30[II],
45[II], 65[II], 75[II], 78[II], 82[II],
88[II], 115[II], 116[II], 132[II],
136[II], 138[II], 139[II], 160[II],
172[II], 178[II], 186[II], 192[II],
196[II], 197[II], 203[II], 205[II],
209[II], 213[II]
open_item_id_mask 303[I]
oper_assist 205[I]
operating_company_number 469[I]
operator 534[I]
operator_address_1 141[I]
operator_address_2 141[I]
operator_address_3 141[I]
operator_city 141[I]
operator_contact_faxno 142[I]
operator_contact_name 141[I]
operator_contact_phone 142[I]
operator_county 141[I]
operator_description 142[I]
operator_id 118[I], 139[I], 141[I], 266[I],
445[I], 446[I], 447[I], 448[I],
450[I], 454[I]
operator_id_recipient 452[I]
operator_state 141[I]
operator_type 447[I]
operator_zip 141[I]
order_clause 434[I]
order_id 142[II]
order_id_resets 142[II]
order_number 132[II], 178[II], 201[II]
org_charged 283[I]

ABP-9.1-DR1-1999/09/30

F
562

Fields

org_originating 283[I]
orig_bill_invoice_row 27[II]
orig_bill_ref_no 27[II], 72[II], 77[II]
orig_bill_ref_resets 27[II], 54[II], 72[II],
77[II]
orig_bill_refno 54[II]
orig_bmf_tracking_id 207[II]
orig_bmf_tracking_id_serv 207[II]
orig_cell_id 125[I]
orig_msg_id 28[II]
orig_msg_id_serv 28[II]
orig_msg_id2 28[II]
orig_ppdd_date 111[II], 113[II]
orig_provider_id 27[II]
orig_rc_from_date 28[II]
orig_split_row_num 30[II]
orig_submitter_name 30[II], 211[II]
orig_subtype 28[II]
orig_tracking_dt 28[II]
orig_tracking_id 28[II], 73[II], 164[II]
orig_tracking_id_serv 28[II], 73[II], 164[II]
orig_trans_code 26[II]
orig_type 28[II]
orig_type_id_usg 112[I], 114[I], 44[II],
88[II], 93[II]
origin_country_dial_code_req 523[I]
origin_is_xact 182[I], 119[II]
origin_restriction 184[I]
origin_value 506[I]
other_rate 492[I]
other_tax 128[I], 133[I], 29[II], 31[II], 65[II],
67[II], 203[II]
other_tax * 110[I], 116[I], 44[II], 86[II],
91[II]
out_units_type 534[I]
output_by 434[I]
override_dates 125[II]
override_geocode 263[I]
override_rate 133[II], 179[II]
owning_account_no 120[II], 153[II]
owning_cost_ctr 345[I], 346[I], 105[II],
185[II], 191[II], 194[II]

P
package_group 351[I], 353[I], 354[I]
package_id 347[I], 348[I], 351[I], 352[I],
355[I], 56[II], 117[II], 127[II],
128[II]
package_instance_id 127[II], 128[II]

package_instance_id_serv 127[II], 128[II]


package_status 118[II], 127[II], 129[II]
page_count 53[II]
page_no 49[II]
paper_size 88[I]
parameter_name 478[I]
parent_acg_tracking_id 109[II]
parent_acg_tracking_id_serv 110[II]
parent_cols 28[I]
parent_group_id 53[I], 90[I]
parent_id 99[II]
parent_nm 28[I]
parent_sales_channel_id 457[I]
parent_tracking_id 201[II]
parent_tracking_id_serv 201[II]
partial_period 181[I]
path_name 322[I]
pay_amount 313[I], 320[I]
pay_method 172[I], 52[II], 103[II], 160[II]
payee_address1 212[II]
payee_address2 212[II]
payee_address3 212[II]
payee_city 212[II]
payee_company 212[II]
payee_country_code 212[II]
payee_county 212[II]
payee_first 212[II]
payee_geocode 212[II]
payee_last 212[II]
payee_state 212[II]
payee_zip 212[II]
payment_counter 318[I]
payment_due_date 51[II], 80[II], 125[II],
163[II]
payment_type 314[I], 321[I]
pending_flag 27[II]
permanent_flag 126[II]
phone 163[I]
phrase_text 23[II]
phrase_type_ind 23[II]
pic_date_active 171[II]
pkg_order 493[I]
plan_id_credit 180[I], 222[I], 359[I], 360[I],
511[I], 103[II], 171[II]
plan_id_discount 180[I], 211[I], 222[I],
361[I], 362[I], 103[II], 171[II]
plan_level 184[I]
plan_order 211[I]

ABP-9.1-DR1-1999/09/30

Fields

563

plan_type 184[I]
plat_id 373[I]
plmn_address1 267[I]
plmn_address2 267[I]
plmn_address3 267[I]
plmn_city 267[I]
plmn_contact_faxno 267[I]
plmn_contact_name 267[I]
plmn_contact_phone 267[I]
plmn_description 267[I]
plmn_name 266[I]
plmn_state 267[I]
plmn_tape_volser_name 267[I]
plmn_type 267[I]
plmn_zip 267[I]
pm_text 312[I]
pmt_req_sent_counter 82[II], 165[II]
point 519[I]
point_category 182[I], 363[I], 364[I], 519[I],
522[I], 120[II]
point_city 519[I]
point_class 127[I], 365[I], 366[I], 519[I]
point_class_origin 406[I], 416[I], 517[I]
point_class_target 406[I], 415[I], 517[I]
point_coordinate_type 520[I]
point_coordinate_x 520[I]
point_coordinate_x_min 520[I]
point_coordinate_y 520[I]
point_coordinate_y_min 520[I]
point_county 520[I]
point_id 519[I], 521[I]
point_id_origin 108[I], 115[I], 132[I], 136[I],
41[II], 85[II], 90[II]
point_id_target 109[I], 115[I], 132[I], 136[I],
41[II], 85[II], 90[II]
point_number 490[I]
point_origin 128[I], 133[I], 182[I], 517[I],
41[II], 119[II]
point_origin * 108[I], 115[I], 85[II], 90[II]
point_origin_len 128[I], 133[I]
point_region 367[I], 368[I], 519[I]
point_region_origin 517[I]
point_region_target 517[I]
point_state_abbr 520[I]
point_status 519[I]
point_target 129[I], 134[I], 182[I], 517[I],
41[II], 119[II]
point_target * 108[I], 115[I], 85[II], 90[II]

point_target_len 129[I], 134[I]


point_tax_code 519[I]
point_tax_code_origin * 108[I], 115[I],
42[II], 85[II], 90[II]
point_tax_code_target * 109[I], 116[I],
43[II], 85[II], 90[II]
point_tax_code_type_origin * 108[I], 115[I],
43[II], 85[II], 90[II]
point_tax_code_type_target * 109[I],
116[I], 43[II], 86[II], 90[II]
point_type 519[I]
point_zip 520[I]
pop_units 167[II]
poplist_type 40[I]
port 249[I]
position 195[I]
post_date 72[II], 76[II]
post_who 76[II]
posted_dt 184[II], 190[II]
postfix_match 242[I]
postradix_exch_rate_mant 459[I]
ppdd_date 49[I], 111[II], 113[II]
precedence 311[I]
prefix_match 242[I]
prep_date 49[I], 51[II]
prep_delay 49[I]
prep_error_code 53[II]
prep_sequence 59[II]
prep_status 52[II]
prep_task 52[II]
prepayment_tracking_id 207[II]
prepayment_tracking_id_serv 207[II]
preradix_exch_rate_mant 459[I]
prev_balance_ref_resets 51[II], 100[II]
prev_balance_refno 51[II], 100[II]
prev_bill_date 99[II]
prev_bill_ref_resets 51[II], 100[II]
prev_bill_refno 50[II], 99[II]
prev_cutoff_date 51[II], 99[II]
prev_ppdd 51[II]
primary_units 132[I], 136[I], 26[II]
primary_units * 109[I], 116[I], 43[II], 86[II],
91[II]
primary_units_type 26[II]
printed_call 130[I], 135[I]
printer_device_id 464[I]
printer_text 72[I]
priority 125[I], 263[I], 344[I], 407[I], 492[I],

ABP-9.1-DR1-1999/09/30

F
564

Fields

518[I], 532[I], 540[I], 541[I]


privacy_level 369[I], 370[I], 171[II]
proc_time 317[I]
process_dt 450[I], 221[II]
process_file_name 218[II], 220[II]
process_if_disc 165[I]
process_name 245[I], 257[I], 371[I], 372[I],
374[I], 434[I], 219[II], 220[II]
process_num 40[II], 50[II], 56[II], 67[II]
process_pid 374[I]
process_status 132[I], 137[I], 374[I], 434[I]
processed_date 137[II]
product_code 484[I]
product_group 485[I]
product_group_id 381[I], 382[I]
product_line_id 72[I], 209[I], 337[I], 375[I],
382[I], 510[I], 525[I], 63[II]
product_start 131[II], 177[II]
product_status 131[II], 177[II]
product_stop 131[II], 177[II]
proforma_bill_flag 124[II]
project_bill_ic1 20[II]
project_bill_ic2 20[II]
project_bill_ic3 20[II]
project_bill_ic4 20[II]
project_bill_ic5 21[II]
project_bill_ic6 21[II]
promo_bill_ic1 20[II]
promo_bill_ic2 20[II]
promo_bill_ic3 20[II]
promo_bill_ic4 20[II]
promo_bill_ic5 21[II]
promo_bill_ic6 21[II]
proportion 145[II]
prorate_code 59[II], 214[II]
provider_address1 384[I]
provider_address2 384[I]
provider_address3 384[I]
provider_city 384[I]
provider_class 385[I], 386[I], 407[I], 416[I],
421[I], 468[I]
provider_country_code 384[I]
provider_id 74[I], 131[I], 136[I], 209[I],
337[I], 376[I], 384[I], 389[I],
468[I], 471[I], 482[I], 509[I],
520[I], 40[II], 62[II], 81[II], 184[II],
190[II]
provider_id * 107[I], 114[I], 84[II], 89[II]

provider_id* 300[I]
provider_id_mask 302[I]
provider_name 384[I]
provider_service_type 470[I]
provider_state 384[I]
provider_zip 384[I]
ps_code_cr 283[I]
ps_code_db 283[I]
pt_default_geocode 490[I]
pt_location_code 490[I]
purchase_order 104[II]

Q
queue_name 371[I]
queue_status 138[II]

R
range_origin 400[I], 414[I]
range_terminus 400[I], 414[I], 497[I]
ratable_unit_class 387[I], 388[I], 510[I],
526[I]
rate 142[I], 404[I], 412[I], 496[I], 201[II]
rate_class 17[I], 131[I], 136[I], 174[I],
177[I], 222[I], 332[I], 347[I],
385[I], 389[I], 391[I], 400[I],
404[I], 407[I], 411[I], 413[I],
415[I], 420[I], 449[I], 516[I], 532[I]
rate_class * 107[I], 114[I], 42[II], 84[II],
89[II]
rate_class_default 103[II], 170[II]
rate_class_of_service 340[I], 376[I]
rate_class_special 103[II], 170[II]
rate_component_id 340[I], 378[I]
rate_currency_code 129[I], 134[I], 529[I],
60[II]
rate_currency_code * 107[I], 115[I], 42[II],
84[II], 89[II]
rate_currency_id 392[I]
rate_currency_location 340[I], 379[I],
529[I]
rate_dt 132[I], 137[I]
rate_dt * 109[I], 116[I], 43[II], 86[II], 91[II]
rate_equip_class 340[I], 376[I]
rate_equip_type 340[I], 376[I]
rate_implied_decimal 390[I]
rate_key_id 141[I], 266[I], 449[I]
rate_period 130[I], 135[I], 210[I], 407[I],
409[I], 410[I], 416[I], 421[I], 42[II],
63[II], 94[II]

ABP-9.1-DR1-1999/09/30

Fields

565

rate_period * 110[I], 117[I], 87[II], 92[II]


rate_period_mask 120[I]
rate_period_rounding 529[I]
rate_rate_class 378[I]
rate_service_type 179[II]
rate_time 201[II]
rate_type 63[II]
rate_units_type 417[I], 422[I]
rate_zone 378[I]
rateband 418[I], 419[I]
rated_amount 41[II], 60[II]
rated_amount_reduction 45[II]
rated_flag 27[II]
rated_units 110[I], 117[I], 130[I], 135[I],
87[II], 91[II]
raw_rec 119[I]
raw_rec_id 113[I], 118[I]
raw_rec_size 113[I], 118[I]
raw_units_type 527[I]
rc_charge_type 142[I]
reactivation_date 140[II]
reason_code 126[I], 160[II]
receivables_amt 148[II], 161[II]
receiving_sid_bid 145[I]
record_category 434[I]
record_delimiter_char 435[I]
record_delimiter_code 435[I]
record_delimiter_count 435[I]
record_id 426[I], 433[I], 437[I]
record_id_from 429[I], 432[I]
record_id_to 429[I], 432[I]
record_size 433[I]
record_type 423[I], 433[I], 436[I], 479[I]
records_appended_last 218[II]
reference_code 184[II]
refinance_plan_id 209[II]
refinance_plan_id_serv 209[II]
refinance_status 210[II]
refinance_tracking_id 114[II]
refinance_tracking_id_serv 115[II]
refund_reason_code 438[I], 439[I], 211[II]
refund_status 211[II]
refund_type 160[II], 212[II]
registration 470[I]
regulatory_id 344[I], 440[I], 441[I], 106[II]
related_element_id 380[I]
relationship_type 380[I]
remark 104[II]

reminder_dt 502[I]
remit_service_center 17[I]
remote_done 246[I], 248[I]
remote_host 246[I], 249[I]
remote_login 246[I]
remote_password 246[I]
remote_phone_num 247[I]
remote_ready 246[I], 248[I]
remote_work 246[I], 248[I]
report_name 166[I]
reported_amount 185[II], 190[II]
request_date 211[II]
request_status 27[II]
resale_flag 488[I]
reschedule_delay 165[I]
resend_delay 98[I]
respond_to_id 242[I]
response_category 98[I], 220[I]
response_code 98[I], 99[I], 220[I], 221[I],
75[II], 81[II], 164[II]
response_code_descr 97[I]
restricted_domain 27[I], 213[I], 513[I]
restricted_id 27[I], 213[I], 513[I]
restricted_pic 172[II]
restriction_type 27[I], 212[I], 513[I]
retry_count 245[I]
retry_delay 243[I]
retry_limit 243[I]
return_reason_id 453[I]
return_type 55[I]
rev_rcv_cost_ctr 17[I], 111[I], 117[I],
150[I], 443[I], 444[I], 29[II], 65[II],
87[II], 92[II], 105[II], 171[II],
185[II], 191[II], 194[II]
rev_rcv_cost_ctr * 44[II]
revenue_accounting_office 470[I]
revenue_owner 10[I]
reversal_action_type 168[I]
reversal_member_id 168[I]
reversal_trans_type 220[I]
review_date 27[II], 212[II]
rfr_delay 243[I]
rfr_filename 243[I]
rfr_path 243[I]
roaming_invoice_dt 446[I], 450[I]
roaming_invoice_no 446[I], 450[I]
rounding_factor 397[I]
rounding_method 397[I], 494[I], 527[I]

ABP-9.1-DR1-1999/09/30

F
566

Fields

row_count 119[I]
run_order 16[I]
run_status 189[II]
run_success 185[II], 191[II]

sales_channel_id 456[I], 458[I], 132[II],


154[II], 172[II], 178[II], 202[II]
sales_code 104[II]
sales_id 202[II]
sample_bill_flag 20[II]
save_detail 210[I]
sc_address1 456[I], 463[I]
sc_address2 456[I], 463[I]
sc_address3 456[I], 463[I]
sc_city 456[I], 463[I]
sc_contact_fname 456[I], 463[I]
sc_contact_lname 456[I], 463[I]
sc_contact_minit 456[I], 463[I]
sc_contact_name_gen 456[I]
sc_contact_name_pre 456[I]
sc_country_code 457[I], 463[I]
sc_county 464[I]
sc_name 456[I], 463[I]
sc_number 456[I]
sc_phone 457[I], 464[I]
sc_state 456[I], 463[I]
sc_zip 463[I]
sc_zip_code 457[I]
scale 429[I]
scale_type 430[I]
scenario_id 170[I], 171[I], 135[II]
scenario_modified_date 135[II]
sched_start 372[I]
scheduled_date 137[II]
screen_id 150[II]
screen_version 78[I]
second_dt * 109[I], 116[I], 43[II], 86[II],
91[II]
second_units 132[I], 136[I]
second_units * 109[I], 116[I], 43[II], 86[II],
91[II]
secondary_amount 60[II]
section_exclude 59[I], 60[I], 87[I]
section_type 61[I], 62[I], 73[I]
security_code 468[I]
security_word 457[I]
sender 479[I]
sent_receive 103[I]

separator_count 195[I]
separator_string 195[I]
seq_num 118[I], 436[I], 460[I]
seq_num_in 139[I], 145[I], 266[I]
seq_num_out 139[I], 145[I], 266[I]
seqnum 406[I], 415[I], 418[I], 419[I], 420[I],
516[I]
sequence_no 139[II]
serial_number 130[II], 177[II]
serv_tape_id 31[I]
server_capacity 11[II]
server_category 461[I], 462[I], 12[II]
server_from 8[II]
server_id 205[I], 282[I], 304[I], 9[II], 10[II],
11[II], 14[II], 189[II], 198[II]
server_to 8[II]
server_type 39[I], 430[I], 433[I], 11[II]
service_address1 168[II]
service_address2 168[II]
service_address3 168[II]
service_center_id 83[I], 463[I], 465[I],
47[II], 157[II]
service_center_type 465[I], 466[I], 467[I],
157[II]
service_city 168[II]
service_code 480[I]
service_company 168[II]
service_country_code 169[II]
service_county 168[II]
service_end 167[II]
service_fname 168[II]
service_franchise_tax_code 169[II]
service_geocode 169[II]
service_group 146[I], 484[I]
service_inquiry_center 17[I]
service_key 480[I]
service_lname 168[II]
service_minit 168[II]
service_name_generation 168[II]
service_name_pre 168[II]
service_phone 169[II]
service_phone2 169[II]
service_start 167[II]
service_state 169[II]
service_type 479[I]
service_zip 169[II]
serving_place 131[I], 136[I]
serving_sid_bid 118[I], 125[I], 145[I]

ABP-9.1-DR1-1999/09/30

Fields

567

serving_state_prov 131[I], 136[I]


set_query 434[I]
ship_from_geocode 202[II]
ship_to_geocode 202[II]
short_description 169[I]
short_description_text 204[I]
short_display 11[I], 13[I], 15[I], 19[I], 21[I],
26[I], 30[I], 35[I], 38[I], 42[I], 44[I],
48[I], 51[I], 54[I], 56[I], 58[I], 60[I],
62[I], 64[I], 67[I], 70[I], 80[I], 85[I],
91[I], 93[I], 99[I], 102[I], 105[I],
122[I], 147[I], 152[I], 158[I],
160[I], 162[I], 176[I], 186[I],
188[I], 197[I], 201[I], 203[I],
207[I], 218[I], 221[I], 225[I],
227[I], 229[I], 231[I], 233[I],
236[I], 238[I], 240[I], 251[I],
253[I], 259[I], 261[I], 270[I],
275[I], 277[I], 279[I], 281[I],
287[I], 308[I], 310[I], 316[I],
324[I], 326[I], 328[I], 343[I],
346[I], 352[I], 354[I], 360[I],
362[I], 364[I], 366[I], 368[I],
370[I], 386[I], 388[I], 396[I],
399[I], 410[I], 437[I], 439[I],
441[I], 444[I], 448[I], 458[I],
462[I], 467[I], 471[I], 473[I],
475[I], 495[I], 499[I], 501[I],
505[I], 508[I], 515[I], 536[I],
538[I], 541[I], 543[I]
short_month1 311[I]
short_month10 312[I]
short_month11 312[I]
short_month12 312[I]
short_month2 311[I]
short_month3 311[I]
short_month4 311[I]
short_month5 311[I]
short_month6 311[I]
short_month7 312[I]
short_month8 312[I]
short_month9 312[I]
sic_code 104[II]
sid_bid 138[I], 139[I], 143[I], 144[I], 452[I]
sid_bid_recipient 452[I]
sim_serial_number 172[II]
slide_time 372[I]
sort_priority 72[I], 74[I]

source_id 9[I], 10[I], 11[I], 241[I], 250[I],


251[I], 313[I], 317[I], 319[I],
320[I], 322[I], 324[I], 469[I],
507[I], 73[II], 107[II]
source_id_serv 73[II]
source_type 250[I], 252[I], 253[I], 433[I],
73[II]
special_code 52[II]
special_features 131[I], 135[I]
special_ins_code 20[II]
split_booking 339[I], 378[I]
split_row_num 112[I], 114[I], 44[II], 88[II],
93[II]
sql_query 373[I]
src_field 356[I], 357[I], 358[I]
src_table 356[I], 357[I], 358[I]
ss_action_code 480[I]
ss_code 480[I]
ssn 101[II]
start_by 180[I]
start_by_dt 153[II]
start_by_units 180[I]
start_dt 133[II], 145[II], 153[II], 179[II]
start_dt_offset 349[I]
start_offset 53[II]
start_time 205[I]
starthhmm 407[I]
state 138[I], 163[I], 122[II], 217[II]
state_abbr 472[I], 473[I]
state_code 263[I], 481[I], 492[I], 539[I],
122[II], 217[II]
state_geocode 472[I], 473[I]
state_origin 517[I]
state_origin_exclude 517[I]
state_rate 492[I]
state_target 517[I]
state_target_exclude 517[I]
state_tax 128[I], 133[I], 29[II], 31[II], 64[II],
67[II], 202[II]
state_tax * 110[I], 116[I], 43[II], 86[II], 91[II]
statement_date 49[I], 51[II], 80[II], 125[II],
163[II], 193[II]
statement_to_email 104[II]
statement_to_faxno 102[II]
status 453[I], 457[I], 8[II], 78[II], 141[II],
206[II], 208[II], 221[II]
subject_line 502[I]
subscr_group_no 173[II], 174[II]

ABP-9.1-DR1-1999/09/30

F
568

Fields

subscr_id_type 480[I]
subscr_level_external_id 502[I]
subscr_master_group_no 173[II], 175[II]
subscr_no 108[I], 115[I], 10[II], 26[II],
40[II], 63[II], 85[II], 89[II], 94[II],
97[II], 142[II], 150[II], 156[II],
167[II], 174[II], 176[II], 180[II],
181[II], 182[II], 183[II], 200[II],
214[II]
subscr_no_mask 120[I]
subscr_no_resets 108[I], 115[I], 10[II],
15[II], 26[II], 40[II], 63[II], 85[II],
90[II], 94[II], 97[II], 129[II], 142[II],
143[II], 152[II], 156[II], 167[II],
174[II], 176[II], 180[II], 181[II],
182[II], 183[II], 200[II], 214[II]
subtype_code 71[I], 57[II], 214[II]
supervisor_name 192[I], 194[I], 27[II],
212[II]
suppress_prenotes 149[I]
suspended_code 474[I], 475[I], 138[II],
140[II]
suspended_date 137[II], 140[II]
switch_id 433[I], 167[II]
switchless_reseller 470[I]
symbol 195[I]

T
table_alias 16[I]
table_key 442[I]
table_name 16[I], 31[I], 39[I], 40[I], 41[I],
42[I], 269[I], 270[I], 442[I], 460[I],
506[I]
table_order 74[I]
tables_used 55[I]
tag 55[I], 65[I], 78[I], 92[I], 273[I]
tape_file_name 70[II]
tape_id 31[I]
target_domain 215[I]
target_id 215[I]
target_is_xact 182[I], 120[II]
target_restriction 185[I]
target_table 9[I], 22[II]
target_type 9[I], 214[I]
target_value 506[I]
task_cycle 372[I]
task_id 205[I], 182[II]
task_intrvl 372[I]
task_mode 372[I]

task_name 32[I], 372[I], 374[I], 429[I],


432[I], 433[I], 436[I], 221[II]
task_priority 372[I]
task_status 372[I]
tax 61[II], 116[II], 197[II], 216[II]
tax_category 487[I]
tax_class 24[I], 338[I], 376[I], 496[I],
523[I], 28[II], 195[II]
tax_code 488[I]
tax_code_origin_req 523[I]
tax_code_target_req 523[I]
tax_date 51[II], 195[II]
tax_description 217[II]
tax_exception 260[I]
tax_identifier 187[I]
tax_journal_status 29[II], 52[II]
tax_level 216[II]
tax_location 263[I]
tax_location_nrc 338[I]
tax_location_rc 377[I]
tax_location_usg 524[I]
tax_pkg_inst_id 482[I], 489[I], 491[I],
493[I], 495[I], 496[I], 28[II], 31[II],
61[II], 67[II], 122[II], 202[II],
205[II]
tax_pkg_instance_id 216[II]
tax_pkg_type 493[I], 216[II]
tax_point 204[II]
tax_rate 450[I], 454[I], 31[II], 61[II], 67[II],
204[II]
tax_status 498[I], 499[I], 122[II]
tax_treatment 267[I], 450[I]
tax_type 494[I], 500[I], 501[I], 116[II]
tax_type_code 301[I], 491[I], 497[I], 30[II],
32[II], 65[II], 68[II], 122[II], 186[II],
192[II], 197[II], 202[II], 205[II],
217[II]
tax_type_code_mask 303[I]
taxable_amount 216[II]
taxable_bus_ind 483[I]
tele_msg 464[I]
teletax_calc_ind 484[I]
temp_local_dir_num 129[I], 134[I]
template_code 63[I], 64[I], 74[I]
term_nrc_tracking_id 153[II]
term_nrc_tracking_id_serv 154[II]
term_status 129[I], 134[I]
termination_code 378[I]

ABP-9.1-DR1-1999/09/30

Fields

569

termination_type_id_nrc 180[I]
terms_code 485[I]
test_flag 33[I], 65[I], 67[I], 68[I], 78[I], 80[I],
92[I], 93[I], 412[I], 54[II], 65[II]
text_group_id 89[I], 90[I], 91[I]
text_id 89[I], 92[I], 93[I]
third_units 132[I], 136[I]
third_units * 109[I], 116[I], 43[II], 86[II],
91[II]
thresh_ref 102[II]
threshold 106[II], 172[II]
tie_code 99[II]
timeout 249[I]
timezone 129[I], 134[I], 504[I], 505[I],
170[II]
timezone * 109[I], 116[I], 43[II], 86[II], 91[II]
to_date 314[I], 321[I], 48[II], 51[II], 63[II],
193[II], 214[II]
to_server 442[I]
to_user 502[I]
total 33[II]
total_ach 317[I]
total_adj 112[II], 114[II]
total_amount 147[II]
total_amt 317[I], 446[I], 451[I], 454[I],
27[II], 94[II]
total_amt_error 451[I], 454[I]
total_amt_foreign 446[I], 451[I], 454[I]
total_amt_foreign_error 451[I], 454[I]
total_amt_home 446[I], 451[I], 454[I]
total_amt_home_error 451[I], 454[I]
total_check 317[I]
total_dis_check 317[I]
total_due 112[II], 114[II]
total_element_amount 154[II]
total_exchange_rate 452[I]
total_installments 202[II]
total_MOC 452[I]
total_MOC_error 452[I]
total_MTC 452[I]
total_MTC_error 452[I]
total_paid 112[II], 114[II]
total_periods 153[II]
total_records 256[I], 451[I], 219[II], 220[II]
total_records_error 452[I]
total_savings_amount 154[II]
total_SSC 452[I]
total_SSC_error 452[I]

total_tax 446[I], 451[I], 454[I]


total_tax_error 451[I], 455[I]
total_tax_foreign 446[I], 451[I], 454[I]
total_tax_foreign_error 451[I], 455[I]
total_tax_home 446[I], 451[I], 454[I]
total_tax_home_error 451[I], 455[I]
total_type_10 452[I]
total_type_10_error 453[I]
total_type_11 452[I]
total_type_11_error 453[I]
total_type_20 453[I]
total_type_20_error 453[I]
total_type_30 453[I]
total_type_30_error 453[I]
total_type_50 453[I]
total_type_50_error 453[I]
total_type_70 453[I]
total_type_70_error 453[I]
total_units 452[I], 94[II], 146[II]
total_units_error 452[I]
total_utc_offset 452[I]
total_valid 318[I]
total_VAS 452[I]
total_VAS_error 452[I]
total_wire 317[I]
tracking_date 58[II]
tracking_dt 184[II]
tracking_id 22[II], 26[II], 31[II], 58[II], 72[II],
81[II], 119[II], 123[II], 124[II],
130[II], 133[II], 136[II], 138[II],
139[II], 141[II], 143[II], 144[II],
146[II], 152[II], 159[II], 164[II],
176[II], 179[II], 181[II], 184[II],
196[II], 197[II], 200[II], 204[II],
212[II], 214[II]
tracking_id_counter 26[II], 31[II]
tracking_id_serv 22[II], 26[II], 31[II], 58[II],
72[II], 81[II], 119[II], 123[II],
125[II], 130[II], 133[II], 136[II],
138[II], 139[II], 141[II], 143[II],
144[II], 146[II], 152[II], 159[II],
164[II], 176[II], 179[II], 181[II],
184[II], 196[II], 197[II], 200[II],
204[II], 212[II], 215[II]
trans_amount 72[II]
trans_audit_amt 149[II], 162[II]
trans_date 61[II], 72[II], 78[II], 208[II],
209[II], 214[II]

ABP-9.1-DR1-1999/09/30

F
570

Fields

trans_date_time 313[I], 317[I], 320[I]


trans_dt 128[I], 133[I], 41[II], 205[II]
trans_dt * 109[I], 116[I], 86[II], 91[II]
trans_id * 107[I], 114[I], 42[II], 84[II], 89[II]
trans_sent_amt 148[II], 161[II]
trans_sign 23[I], 95[I], 337[I]
trans_source 507[I], 508[I], 73[II]
trans_submitter 73[II]
trans_target_id 23[I]
trans_target_type 23[I]
transact_date 26[II], 200[II]
transact_status 200[II]
transaction_date 103[I]
translate_field 427[I]
translate_field_type 428[I]
translate_table 427[I]
treasury_date 212[II]
treatment_ind 98[I], 220[I]
trigger_level 337[I]
trigger_status 337[I]
trl_field 293[I]
trl_field_description 294[I]
trl_field_format 293[I]
trl_field_size 293[I]
trl_field_trim 294[I]
trl_hardcoded 293[I]
trl_position 293[I]
trl_table 293[I]
trl_type 293[I]
type_code 71[I], 56[II], 214[II], 216[II]
type_group_nrc 341[I], 376[I]
type_group_usg 376[I], 533[I]
type_id_nrc 178[I], 337[I], 341[I], 355[I],
402[I], 404[I], 200[II]
type_id_rc 376[I], 412[I]
type_id_usg 125[I], 131[I], 136[I], 216[I],
407[I], 415[I], 420[I], 480[I],
516[I], 522[I], 532[I], 533[I], 40[II],
94[II]
type_id_usg * 107[I], 114[I], 84[II], 89[II]
type_id_usg_in 531[I]
type_id_usg_mask 120[I]
type_id_usg_out 531[I]
type_of_charge 484[I]

U
undesignated_amount 204[II]
unique_ext_name 242[I]
uniqueness_type 237[I]

unit_cr_distrib 509[I]
unit_cr_domain 510[I]
unit_cr_id 413[I], 509[I], 511[I], 513[I],
44[II], 146[II]
unit_cr_level 509[I]
unit_cr_quantum 510[I]
unit_rate 418[I], 419[I]
units 41[II], 61[II]
units_credited 41[II]
units_currency_code * 109[I], 116[I], 43[II],
86[II], 91[II]
units_free 413[I]
units_indicator 416[I], 420[I], 526[I]
units_type 535[I], 536[I]
unix_file 83[II]
unix_tz 504[I]
unrounded_amount * 112[I], 117[I], 42[II],
88[II], 92[II]
up_since_dt 11[II]
update_frequency 442[I]
upper_balance_due 171[I]
upper_credit_rating 171[I]
upper_limit 390[I], 412[I]
upper_limit_percent 514[I]
usage_audit_table 382[I]
usage_audit_view 383[I]
usage_bad_table 383[I]
usage_data_table 382[I]
usage_desc 282[I]
usage_free_table 383[I]
usage_items 184[II], 191[II]
usage_of_product 485[I]
usage_type 205[I], 282[I]
usage_units 184[II], 191[II]
use_address_server 276[I]
use_bill_class 527[I]
use_class_of_service_code 528[I]
use_code 300[I], 183[II], 190[II]
use_component_id 530[I]
use_default_rate_type 529[I]
use_distance_band_id 528[I]
use_element_id 528[I]
use_equip_class_code 528[I]
use_equip_type_code 528[I]
use_jurisdiction 527[I]
use_point_class_origin 528[I]
use_point_class_target 528[I]
use_provider_class 528[I]

ABP-9.1-DR1-1999/09/30

Fields

571

use_rate_class 527[I]
use_rate_period 528[I]
use_raw_usage 244[I]
user_name 192[I], 194[I]
usg_amt_limit 106[II], 172[II], 178[II]
usg_amt_limit_cmf 94[II]
usg_amt_limit_emf 95[II]
usg_amt_limit_emf_products 95[II]
usg_class 524[I]
usg_crt_hour 373[I]
usg_plat_id 373[I]
usg_units_limit 106[II], 172[II], 178[II]
usg_units_limit_cmf 94[II]
usg_units_limit_emf 95[II]
usg_units_limit_emf_products 95[II]
usg_version 373[I]
utility_code 488[I]
utl_name 221[II]

V
variable_1 24[II]
variable_2 24[II]
variable_3 24[II]
variable_id 23[II]
variable_mile_rate 179[II]
vas_code 480[I]
version_in 139[I], 266[I]
version_out 139[I], 266[I]
vh_minor_threshold 526[I]
vip_code 17[I], 171[I], 537[I], 538[I],
104[II], 135[II]
visa_total 103[I]

win_underline 66[I]
win_weight 66[I]
writeoff_trans_date 195[II]
writeoff_type_code 195[II]
written_off_records 257[I]

X
xfer_acnt_id 219[I]
xfer_acnt_limit 219[I]
xfer_acnt_limit_cycle 219[I]
xfer_acnt_name 219[I]
xfer_acnt_type 219[I]
xfer_prenote_status_delay 219[I]
xfer_sort_code 219[I]
xfer_transact_delay 219[I]
xfer_transact_limit 219[I]
xfer_user_id 219[I]

Y
year 407[I]

Z
zero_mile_rate 179[II]
zero_text 312[I]
zip 163[I], 539[I], 51[II]
zone_class 123[I], 417[I], 540[I], 541[I]
zone_id 123[I], 542[I], 543[I], 181[II]

W
warm_bill_flag 55[II], 124[II]
was_acknowledged 503[I]
where_clause 16[I], 434[I]
width 68[I]
win_color 66[I]
win_direction 66[I]
win_facename 66[I]
win_height 66[I]
win_italic 66[I]
win_outline 66[I]
win_pen_color 79[I]
win_pen_style 79[I]
win_pen_width 79[I]
win_pointsize 66[I]
win_strikeout 66[I]

ABP-9.1-DR1-1999/09/30

Das könnte Ihnen auch gefallen