Arbor BP 9-1 Database Reference Volume 1

8/21/2019 Arbor BP 9-1 Database Reference Volume 1

1/583

DATABASEREFERENCE

VOL. 1 (ADMIN)

ABP-9.1-DR1-1999/09/30


2/583

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. KenanSystems 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, containsproprietary information and trade secrets of Kenan Systems Corporation, and is provided in accordance with aKenan Systems Corporation license agreement or confidentiality agreement. Copying, modifying, or

distributing this documentation in violation of a license agreement, confidentiality agreement, United StatesCopyright 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.


3/583

ABP-9.1-DR1-1999/09/30

TTTable of Contents

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

1 Introduction............................................................................................1

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

Additional Documents....................................................................................4

2 Admin Tables..........................................................................................7

ABI_SOURCE_RECORD_TYPES ..................................................................9ABI_SOURCE_REF........................................................................................10ABI_SOURCE_VALUES ...............................................................................11ACCESS_REGION_REF................................................................................12ACCESS_REGION_VALUES .......................................................................13

ACCOUNT_CATEGORY_REF ....................................................................14ACCOUNT_CATEGORY_VALUES ...........................................................15ACCOUNT_MOVE_TABLES.......................................................................16ACCT_SEG_MAP ..........................................................................................17ACCT_SEG_REF ............................................................................................18ACCT_SEG_VALUES....................................................................................19ADJ_REASON_CODE_REF .........................................................................20ADJ_REASON_CODE_VALUES.................................................................21ADJ_TRANS_DESCR ....................................................................................22

AGGR_USAGE_DEFINITIONS_REF .........................................................25AGGR_USAGE_DEFINITIONS_VALUES.................................................26AGGR_USAGE_RESTRICTIONS................................................................27ARB_TAB_DEPENDS ...................................................................................28ARCHIVE_ACTION_REF ............................................................................29ARCHIVE_ACTION_VALUES....................................................................30ARCHIVE_TAPES .........................................................................................31ARCHIVE_TASKS .........................................................................................32

ARCH_MODE_REF.......................................................................................34ARCH_MODE_VALUES ..............................................................................35ARCH_TABLE_DEPENDS_REF..................................................................36ARCH_TYPE_REF .........................................................................................37ARCH_TYPE_VALUES.................................................................................38ATM_CUSTOM_TABLE_DEF.....................................................................39ATM_FIELD_DEF..........................................................................................40ATM_POPLIST_REF......................................................................................41


4/583

Table of Contentsiv

ABP-9.1-DR1-1999/09/30

TT

ATM_POPLIST_VALUES.............................................................................42BILLING_FREQUENCY_REF......................................................................43

BILLING_FREQUENCY_VALUES .............................................................44BILL_ADDRESS .............................................................................................45BILL_CLASS_REF..........................................................................................47BILL_CLASS_VALUES .................................................................................48BILL_CYCLE...................................................................................................49BILL_DISP_METH_REF................................................................................50BILL_DISP_METH_VALUES.......................................................................51BILL_EXPRESSION_GROUPS.....................................................................52BILL_EXPRESSION_GROUP_REF..............................................................53BILL_EXPRESSION_GROUP_VALUES.....................................................54BILL_EXPRESSION_REF..............................................................................55BILL_EXPRESSION_VALUES .....................................................................56BILL_FMT_OPT_REF ....................................................................................57BILL_FMT_OPT_VALUES ...........................................................................58BILL_FMT_SECTION_EXCL_REF..............................................................59BILL_FMT_SECTION_EXCL_VALUES .....................................................60BILL_FMT_SECTION_TYPE_REF...............................................................61

BILL_FMT_SECTION_TYPE_VALUES......................................................62BILL_FMT_TEMPLATE_CODE_REF .........................................................63BILL_FMT_TEMPLATE_CODE_VALUES ................................................64BILL_FONT_REF ...........................................................................................65BILL_FONT_VALUES...................................................................................67BILL_FONT_WIDTH.....................................................................................68BILL_FORMAT_CODE_TYPE_REF............................................................69BILL_FORMAT_CODE_TYPE_VALUES...................................................70BILL_FORMAT_DISPLAY_TYPES .............................................................71BILL_FORMAT_PRODUCTS.......................................................................72BILL_FORMAT_TEMPLATE.......................................................................73BILL_INSERTS................................................................................................75BILL_INSERT_GROUPS...............................................................................76BILL_LINE_REF .............................................................................................78BILL_LINE_VALUES ....................................................................................80BILL_MESSAGES...........................................................................................81BILL_MESSAGE_GROUPS ..........................................................................82

BILL_PERIOD_REF .......................................................................................84BILL_PERIOD_VALUES...............................................................................85BILL_REF_NO_MASTER..............................................................................86BILL_SECTIONS............................................................................................87BILL_SIZE .......................................................................................................88BILL_TEXT_GROUPS ...................................................................................89BILL_TEXT_GROUP_REF ............................................................................90BILL_TEXT_GROUP_VALUES ...................................................................91


5/583

vTable of Contents

ABP-9.1-DR1-1999/09/30

TT

BILL_TEXT_REF.............................................................................................92BILL_TEXT_VALUES....................................................................................93

BMF_TRANS_DESCR ...................................................................................94CCARD_AVS_RESPONSE_CODES............................................................97CCARD_RESPONSE_CODE_REF...............................................................98CCARD_RESPONSE_CODE_VALUES......................................................99CCARD_TYPE_CODE_RANGE................................................................100CCARD_TYPE_CODE_REF .......................................................................101CCARD_TYPE_CODE_VALUES ..............................................................102CC_BALANCE .............................................................................................103CDR_COMP_STATUS_REF.......................................................................104CDR_COMP_STATUS_VALUES ..............................................................105CDR_CONSOLIDATION_KEYS...............................................................106CDR_DATA_WORK....................................................................................107CDR_OUTCOLLECTS.................................................................................114CDR_RAW_USAGE ....................................................................................119CDR_RUNNING_TOTAL_MASK ............................................................120CELL_ID_REF...............................................................................................121CELL_ID_VALUES......................................................................................122

CELL_ID_ZONE_ID_MAP.........................................................................123CIBER_ARBOR_FLD_XREF.......................................................................124CIBER_ARBOR_USAGE_TYPE_XREF .....................................................125CIBER_FLD_ERROR_CODES....................................................................126CIBER_FROM_NPANXX............................................................................127CIBER_INCOLLECTS..................................................................................128CIBER_INCOLLECTS_ERROR..................................................................133CIBER_LINE_RANGES...............................................................................138CIBER_OPERATOR_SID_BID ...................................................................139CIBER_ROAMING_AGREEMENT...........................................................141CIBER_SID_BID_DEF..................................................................................143CIBER_SID_BID_MARKET........................................................................144CIBER_SID_BID_SEQ_NUM......................................................................145CLASS_OF_SERVICE_CODE_REF...........................................................146CLASS_OF_SERVICE_CODE_VALUES ..................................................147CLEARING_HOUSE_CONTACTS...........................................................148CLEARING_HOUSE_DIVISION...............................................................150

CLEARING_HOUSE_ID_REF ...................................................................151CLEARING_HOUSE_ID_VALUES...........................................................152CLEARING_HOUSE_INFO.......................................................................153CMF_STATUS_CHG_REASON_REF.......................................................157CMF_STATUS_CHG_REASON_VALUES ..............................................158CMF_STATUS_REF .....................................................................................159CMF_STATUS_VALUES ............................................................................160COLLECTION_STATUS_REF....................................................................161


6/583

Table of Contentsvi

ABP-9.1-DR1-1999/09/30

TT

COLLECTION_STATUS_VALUES...........................................................162COL_COLLECTOR......................................................................................163

COL_COLLECTOR_GROUP .....................................................................164COL_EVENT_DEFINITION.......................................................................165COL_MESSAGES_TEXT.............................................................................166COL_ORDER_ASSOC.................................................................................167COL_ORDER_REF.......................................................................................168COL_ORDER_VALUES ..............................................................................169COL_SCENARIO_DEFINITION...............................................................170COL_SCENARIO_PARAMETERS ............................................................171COL_THRESH_PARAMETERS.................................................................173

COMPONENT_CMF_ELIGIBILITY..........................................................174COMPONENT_DEFINITION_REF ..........................................................175COMPONENT_DEFINITION_VALUES..................................................176COMPONENT_EMF_ELIGIBILITY..........................................................177COMPONENT_NRCS.................................................................................178CONTRACT_TYPES....................................................................................179CORRIDOR_PLAN_GROUPS ...................................................................182CORRIDOR_PLAN_ID_REF......................................................................184

CORRIDOR_PLAN_ID_VALUES .............................................................186COUNTRY_CODE_REF..............................................................................187COUNTRY_CODE_VALUES.....................................................................188COUNTRY_DIAL_CODES.........................................................................189COUNTRY_JURISDICTION ......................................................................190CSR_ACCT_SEG ..........................................................................................191CSR_INFORMATION .................................................................................192CSR_SUPERVISORS ....................................................................................194CURRENCY_LOCALE................................................................................195CURRENCY_TYPE_REF.............................................................................196CURRENCY_TYPE_VALUES ....................................................................197DB_MESSAGES ............................................................................................199DENIAL_REASON_REF.............................................................................200DENIAL_REASON_VALUES....................................................................201DEPOSIT_TYPE_REF ..................................................................................202DEPOSIT_TYPE_VALUES..........................................................................203DESCRIPTIONS ...........................................................................................204

DEVICES .......................................................................................................205DISCONNECT_REASON_REF..................................................................206DISCONNECT_REASON_VALUES.........................................................207DISCOUNT_DEFINITIONS .......................................................................208DISCOUNT_PLANS....................................................................................211DISCOUNT_RESTRICTIONS ....................................................................212DISCOUNT_TARGETS...............................................................................214DISTANCE_BANDS....................................................................................216


7/583

viiTable of Contents

ABP-9.1-DR1-1999/09/30

TT

DISTANCE_BANDS_ID_REF ....................................................................217DISTANCE_BANDS_ID_VALUES ...........................................................218

EFT_CONTROL ...........................................................................................219EFT_RESPONSE_CODE_REF ....................................................................220EFT_RESPONSE_CODE_VALUES ...........................................................221EMF_CONFIGURATION ...........................................................................222EMF_CONFIG_ID_REF ..............................................................................224EMF_CONFIG_ID_VALUES......................................................................225EMF_STATUS_CHG_REASON_REF .......................................................226EMF_STATUS_CHG_REASON_VALUES...............................................227EMF_STATUS_REF......................................................................................228

EMF_STATUS_VALUES.............................................................................229EQUIP_CLASS_CODE_REF.......................................................................230EQUIP_CLASS_CODE_VALUES..............................................................231EQUIP_TYPE_CODE_REF .........................................................................232EQUIP_TYPE_CODE_VALUES.................................................................233ERROR_SEVERITIES...................................................................................234EXRATE_CLASS_REF.................................................................................235EXRATE_CLASS_VALUES ........................................................................236

EXTERNAL_ID_TYPE_REF .......................................................................237EXTERNAL_ID_TYPE_VALUES...............................................................238EXT_ACCESS_METHOD_REF..................................................................239EXT_ACCESS_METHOD_VALUES .........................................................240EXT_CONTACTS.........................................................................................241EXT_CONTACTS_STATUS .......................................................................245EXT_FTP_ACCESS.......................................................................................246EXT_KERMIT_ACCESS..............................................................................247EXT_LOCAL_DIR_ACCESS.......................................................................248EXT_SOCKET_ACCESS..............................................................................249EXT_SOURCE_ID_REF...............................................................................250EXT_SOURCE_ID_VALUES ......................................................................251EXT_SOURCE_TYPE_REF .........................................................................252EXT_SOURCE_TYPE_VALUES.................................................................253FILE_STATUS...............................................................................................254FILE_TYPE_REF...........................................................................................258FILE_TYPE_VALUES ..................................................................................259

FRANCHISE_CODE_REF ..........................................................................260FRANCHISE_CODE_VALUES..................................................................261GEOCODE_OVERRIDES............................................................................262GROUP_AMOUNT .....................................................................................264GROUP_FUNCTION ..................................................................................265GSM_ROAMING_AGREEMENT..............................................................266GUI_INDICATOR_REF ..............................................................................269GUI_INDICATOR_VALUES......................................................................270


8/583

Table of Contentsviii

ABP-9.1-DR1-1999/09/30

TT

GUI_MESSAGES..........................................................................................271IGEN_ADDRESS_FORMATS ....................................................................272

IGEN_ADDRESS_FORMAT_REF .............................................................273IGEN_ADDRESS_FORMAT_VALUES ....................................................274INDUSTRY_TYPE_REF...............................................................................276INDUSTRY_TYPE_VALUES......................................................................277INSERT_FOREIGN_KEY_REF...................................................................278INSERT_FOREIGN_KEY_VALUES..........................................................279INSERT_GRP_ID_REF ................................................................................280INSERT_GRP_ID_VALUES........................................................................281IO_DEVICES .................................................................................................282

JNL_CUSTOM .............................................................................................. 283JNL_CYCLE ..................................................................................................285JNL_EMF_BOOK_REF ................................................................................286JNL_EMF_BOOK_VALUES ....................................................................... 287JNL_FEED_HEADER .................................................................................. 288JNL_FEED_LAYOUT ..................................................................................290JNL_FEED_TRAILER ..................................................................................293JNL_KEYS .....................................................................................................295

JNL_KEYS_MASK........................................................................................302JNL_RUNS ....................................................................................................304JNL_SUBCYCLE...........................................................................................305JURISDICTIONS ..........................................................................................306JURISDICTION_CLASS_REF.....................................................................307JURISDICTION_CLASS_VALUES............................................................308LANGUAGE_CODE_REF..........................................................................309LANGUAGE_CODE_VALUES .................................................................310LANGUAGE_LOCALE...............................................................................311LBX_ERROR .................................................................................................313LBX_ERROR_STATUS_REF.......................................................................315LBX_ERROR_STATUS_VALUES..............................................................316LBX_FILE_STATUS .....................................................................................317LBX_PAYMENT_TYPES.............................................................................319LBX_POST_DATED.....................................................................................320LBX_SOURCE_ID_REF...............................................................................322LBX_SOURCE_ID_VALUES ......................................................................324

MKT_CODE_REF.........................................................................................325MKT_CODE_VALUES................................................................................326MSG_GRP_ID_REF......................................................................................327MSG_GRP_ID_VALUES.............................................................................328NET_ACTION_REF.....................................................................................329NET_ACTION_VALUES............................................................................330NET_INTERFACE_ACTIONS ...................................................................331NET_INTERFACE_ELIGIBILITY ..............................................................332
http://-/?-http://-/?-


9/583

ixTable of Contents

ABP-9.1-DR1-1999/09/30

TT

NET_INTERFACE_REF ..............................................................................333NET_INTERFACE_VALUES .....................................................................334

NOTE_CODES..............................................................................................335NOTE_TEXT .................................................................................................336NRC_TRANS_DESCR .................................................................................337NRC_TYPE_GROUPS .................................................................................341OPEN_ITEM_ID_REF .................................................................................342OPEN_ITEM_ID_VALUES.........................................................................343OPEN_ITEM_PRIORITY.............................................................................344OWNING_COST_CTR_REF.......................................................................345OWNING_COST_CTR_VALUES..............................................................346

PACKAGE_CMF_ELIGIBILITY.................................................................347PACKAGE_COMPONENTS......................................................................348PACKAGE_COMPONENT_MEMBERS..................................................349PACKAGE_DEFINITION_REF .................................................................351PACKAGE_DEFINITION_VALUES.........................................................352PACKAGE_GROUP_REF...........................................................................353PACKAGE_GROUP_VALUES ..................................................................354PACKAGE_NRCS........................................................................................355

PAYMENT_FILE_DETAIL.........................................................................356PAYMENT_FILE_HEADER.......................................................................357PAYMENT_FILE_TRAILER.......................................................................358PLAN_ID_CREDIT_REF.............................................................................359PLAN_ID_CREDIT_VALUES....................................................................360PLAN_ID_DISCOUNT_REF......................................................................361PLAN_ID_DISCOUNT_VALUES .............................................................362POINT_CATEGORY_REF ..........................................................................363POINT_CATEGORY_VALUES .................................................................364POINT_CLASS_REF ....................................................................................365POINT_CLASS_VALUES ...........................................................................366POINT_REGION_REF.................................................................................367POINT_REGION_VALUES........................................................................368PRIVACY_LEVEL_REF...............................................................................369PRIVACY_LEVEL_VALUES......................................................................370PROCESS_QUEUE.......................................................................................371PROCESS_SCHED.......................................................................................372

PROCESS_STATUS......................................................................................374PRODUCT_ELEMENTS .............................................................................375PRODUCT_ELEMENT_RELATIONS.......................................................380PRODUCT_GROUPS ..................................................................................381PRODUCT_LINES .......................................................................................382PROVIDER_ADDRESS ...............................................................................384PROVIDER_CLASS_REF............................................................................385PROVIDER_CLASS_VALUES ...................................................................386


10/583

Table of Contentsx

ABP-9.1-DR1-1999/09/30

TT

RATABLE_UNIT_CLASS_REF..................................................................387RATABLE_UNIT_CLASS_VALUES.........................................................388

RATE_AGGR_USAGE ................................................................................389RATE_CLASS_DESCR ................................................................................391RATE_CURRENCY .....................................................................................392RATE_CURRENCY_GROUP.....................................................................394RATE_CURRENCY_GROUP_REF............................................................395RATE_CURRENCY_GROUP_VALUES...................................................396RATE_CURRENCY_REF............................................................................397RATE_CURRENCY_VALUES ...................................................................399RATE_DISCOUNT.......................................................................................400

RATE_LATE_FEE ........................................................................................402RATE_NRC ...................................................................................................404RATE_PERIODS...........................................................................................406RATE_PERIOD_REF ...................................................................................409RATE_PERIOD_VALUES...........................................................................410RATE_RC ......................................................................................................411RATE_UNIT_CR ..........................................................................................413RATE_USAGE..............................................................................................415

RATE_USAGE_BANDS..............................................................................418RATE_USAGE_BANDS_OVERRIDES .....................................................419RATE_USAGE_OVERRIDES .....................................................................420RAW_USAGE_FIELD_MAPPING............................................................423RECORD_FIELD_DEF ................................................................................426RECORD_FIELD_MAP...............................................................................429RECORD_TYPE_MAP ................................................................................432RECORD_TYPE_REF ..................................................................................433RECORD_TYPE_SEQ_NUM......................................................................436RECORD_TYPE_VALUES..........................................................................437REFUND_REASON_CODE_REF ..............................................................438REFUND_REASON_CODE_VALUES .....................................................439REGULATORY_ID_REF.............................................................................440REGULATORY_ID_VALUES ....................................................................441REPLICATION_TABLES............................................................................442REV_RCV_COST_CENTER_REF ..............................................................443REV_RCV_COST_CENTER_VALUES .....................................................444

ROAMING_CLEARING_HOUSE_MEMBERS.......................................445ROAMING_INVOICE_SUMMARY..........................................................446ROAMING_OPERATOR_REF...................................................................447ROAMING_OPERATOR_VALUES ..........................................................448ROAMING_RATE_KEYS ...........................................................................449ROAMING_TRANSFER_DETAIL ............................................................450ROAMING_TRANSFER_TAX_DETAIL ..................................................454SALES_CHANNEL_REF ............................................................................456


11/583

xiTable of Contents

ABP-9.1-DR1-1999/09/30

TT

SALES_CHANNEL_VALUES....................................................................458SDR_EXCHANGE_RATES.........................................................................459

SEQ_NUM.....................................................................................................460SERVER_CATEGORY_REF........................................................................461SERVER_CATEGORY_VALUES...............................................................462SERVICE_CENTERS....................................................................................463SERVICE_CENTER_TYPES........................................................................465SERVICE_CENTER_TYPE_REF ................................................................466SERVICE_CENTER_TYPE_VALUES........................................................467SERVICE_PROVIDERS_REF......................................................................468SERVICE_PROVIDERS_VALUES .............................................................471

STATE_REF...................................................................................................472STATE_VALUES ..........................................................................................473SUSPENDED_REASON_REF ....................................................................474SUSPENDED_REASON_VALUES............................................................475SYSTEM_MESSAGES..................................................................................476SYSTEM_MODULES...................................................................................477SYSTEM_PARAMETERS............................................................................478TAP_MAPPING ...........................................................................................479

TAX_ASSIGNMENTS .................................................................................481TAX_CHARGE_ELEMENTS......................................................................483TAX_CODES_COMM .................................................................................486TAX_ELEM_DEFAULT_LOC....................................................................489TAX_OVERRIDES........................................................................................491TAX_PKG_INST_ID_REF...........................................................................493TAX_PKG_INST_ID_VALUES ..................................................................495TAX_RATES_VAT.......................................................................................496TAX_STATUS_REF......................................................................................498TAX_STATUS_VALUES.............................................................................499TAX_TYPE_COMM_REF............................................................................500TAX_TYPE_COMM_VALUES...................................................................501TICKLER........................................................................................................502TIMEZONE_REF..........................................................................................504TIMEZONE_VALUES.................................................................................505TRANSLATION...........................................................................................506TRANS_SOURCE_REF ...............................................................................507

TRANS_SOURCE_VALUES.......................................................................508UNIT_CR_DEFINITIONS...........................................................................509UNIT_CR_PLANS .......................................................................................511UNIT_CR_RESTRICTIONS........................................................................512USAGE_ALARM_REF ................................................................................514USAGE_ALARM_VALUES........................................................................515USAGE_JURISDICTION.............................................................................516USAGE_POINTS..........................................................................................519


12/583

Table of Contentsxii

ABP-9.1-DR1-1999/09/30

TT

USAGE_POINTS_TEXT..............................................................................521USAGE_TYPES.............................................................................................522

USAGE_TYPES_SPLIT................................................................................531USAGE_TYPES_UNITS ..............................................................................532USAGE_TYPE_GROUPS ............................................................................533USAGE_UNITS_CONVERT.......................................................................534USAGE_UNITS_TYPE_REF .......................................................................535USAGE_UNITS_TYPE_VALUES ..............................................................536VIP_CODE_REF ...........................................................................................537VIP_CODE_VALUES ..................................................................................538ZIPCODE.......................................................................................................539

ZONE_CLASS_REF .....................................................................................540ZONE_CLASS_VALUES ............................................................................541ZONE_REF....................................................................................................542ZONE_VALUES...........................................................................................543

Fields...................................................................................................545

1


13/583

ABP-9.1-DR1-1999/09/30

111 Introduction

Welcome to the Database Reference. This document contains adescription of every table used by Arbor/BP, with descriptions offields, rules, triggers, indexes, and related information.

This is a reference document intended for use by individuals who arealready familiar with the architecture and data model for the Arbor/BP

billing system. See other Arbor/BP documents listed in AdditionalDocuments on page 4 for more information about Arbor/BP. Inparticular, see the Configuration Guidefor instructions on populatingconfigurable 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 volumesand 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, youmay find the following list of changes useful. This is not a complete listof improvements and alterations made to this document or the product;rather, it is an overview of majorchanges in document organizationand/or product functionality. For more complete information about

product changes, see the Product Release Bulletin.

1


14/583

Chapter 1 Introduction2

ABP-9.1-DR1-1999/09/30

11

Tables Added

Table 1lists 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

1


15/583

3Whats New in This Manual

ABP-9.1-DR1-1999/09/30

11

Table 2lists the tables added to the Admin database in Release 9.0

Table 3lists the tables added to the Admin database in Release 9.1

Table 4lists the tables removed from the Admin database:


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


CLEARING_HOUSE_DIVISION IGEN_ADDRESS_FORMAT_VALUES

IGEN_ADDRESS_FORMATS ZIPCODE

IGEN_ADDRESS_FORMAT_REF

Table 4 Removed Tables

TAX_PARAMS (9.0)

1


16/583


ABP-9.1-DR1-1999/09/30

11

Information Added

The Database Reference Guidenow lists foreign keys and checkconstraints, 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 ApplicationProgrammer Interface.

API ReferenceABP-9.1-APIR-1999/09/30

Detailed description of all fields and objects in the ApplicationProgrammer Interface.

Billing Operations GuideABP-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/30Detailed description of fields and tables in the Catalog andCustomer databases.

Database Reference, Vol. 3 (Summary)ABP-9.1-DR3-1999/09/30

Summary of all database tables.

1


17/583

5Additional Documents

ABP-9.1-DR1-1999/09/30

11

Guide to Invoice DesignABP-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 rateschedules) and how to configure them in the database.

iCARE Developers KitABP-9.1-iC-1999/09/30

Operation, configuration, and maintenance instructions foriCARE, a Web-based customer-care solution.

Journals GuideABP-9.1-JG-1999/09/30

Detailed description of Journal module functionality.

Product Release BulletinABP-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 detailreports, and input and output file formats.

System Administrator GuideABP-9.1-SAG-1999/09/30

Installation, configuration, and maintenance instructions forthe Arbor/BP system.

Technical ReferenceABP-9.1-TR-1999/09/30

Detailed descriptions of inputs, outputs, and processing flow ofall modules.

User GuideABP-9.1-UG-1999/09/30

Instructions for using the Customer Care interface.

Additionally, a Software Documentation Update(SDU) or ReleaseNotesmay be available for your deployment, containing additionalinformation not covered in other documents.

You may also need to refer to documentation for other products, suchas operating systems, database management systems, tax packages,

1


18/583


ABP-9.1-DR1-1999/09/30

11

and third-party software integrated with Arbor/BP.


19/583

ABP-9.1-DR1-1999/09/30

22

2 Admin Tables

This chapter contains a detailed description of every table in theArbor/BP Admin database, in alphabetical order. The description ofeach 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, andindexes defined on the table.

Descriptions of every field in the table.

The description of each field includes the following information:

Field name

Data typeand size (see below) Comments brief field description

Values rules that constrain field values (preceded by R:) anddefault 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 relationaldatabase (RDB) system in use in your deployment. For example, the is_defaultfield in ACCESS_REGION_REFis a Number(1)field in anOracle database and a bitfield in a Sybase database.

Every field description in this document contains a single documenteddata type. Table 5 lists the valid documented data types and theircorresponding RDB data types for Oracleand Sybase.


20/583

Chapter 2 Admin Tables8

ABP-9.1-DR1-1999/09/30

22

Table 5also includes minimum and maximum values for eachdocumented type. These are not necessarily the minimum and

maximum supported by your database; rather, they are the minimumand maximum values supported by Arbor/BP for fields of this type.Therefore, you should not enter field values that exceed the minimumor maximum values documented here, even if the corresponding RDBdata type allows those values.

Admin Tables

Table 5 Field Types

DocumentedType

OracleType

SybaseType

MinimumValue

MaximumValue

bit Number(1,0) bit (1 byte) 0 1

char[N] char(N) char[N] N characters N characters

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

datetime date 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.image long raw image (16 bytes)

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

int Number(10,0) int(4 bytes)

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

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

numeric Number(18,0) numeric (10)(8 bytes)

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

999,999,999,999,999,999

smalldt date smalldatetime(4 bytes)

varies varies

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

smallint Number(6,0) smallint(2 bytes)

-32,768(-215)

32,767(215 - 1)

text long text (16 bytes)

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

tinyint Number(3,0) tinyint (1 byte) 0 255

varchar[N] varchar2(N) varchar[N] 0 characters N characters

Variable-length string.N cannot exceed 255.


21/583

ABP-9.1-DR1-1999/09/30

AA

ABI_SOURCE_RECORD_TYPES

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

Used by the following modules: ABI

Triggers: target_typehas a valid type code that corresponds to the value of target_table.

Indexes: unique on source_id, abi_source_record_typeunique on target_table, target_type

Field Name Data Type Comments Values Null

source_id int Data source ID, from ABI_SOURCE_REF.

abi_source_record_type

tinyint Type of record from source biller:1 = credit invoice record2 = debit invoice3 = postbill adjustment4 = non-recurring charge

(R: 1, 2, 3, 4)

target_table tinyint Table to which Arbor/BP should write record based on record type:1 =ADJ 2 =NRC 3 =BMF

(R: 1, 2, 3)

target_type smallint Corresponding type code for the NRC, ADJ, or BMFrecord.


22/583

ABP-9.1-DR1-1999/09/30

AA

ABI_SOURCE_REF

Configurable. Reserved for future use.

Describes valid billing sources. Admin table. Read-only copy exists on Customer server.


Triggers: Only one row may have is_default= 1.

Indexes: unique on source_id


source_id int Unique internal ID for ABI source.

missed_bill_code

tinyint Indicates behavior if records from this billing source are missing atbilling time:1 = create bill showing zero due for source2 = create bill omitting section associated with source

3 = hold the bill until data received

(R: 1, 2, 3)

revenue_owner tinyint Defines who owns the revenue associated with this bill ing source:1 = Arbor/BP2 = someone else

(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 ormodify.

(D: 0)


23/583

ABP-9.1-DR1-1999/09/30

AA

ABI_SOURCE_VALUES

Configurable. Reserved for future use.

Describes billing sources defined in ABI_SOURCE_REF. Admin table. Read-only copy exists on Customer server.


Triggers: language_codeexists in LANGUAGE_CODE_REF.source_idexists in ABI_SOURCE_REF.

Indexes: unique on source_id, language_code


source_id int Source ID, from ABI_SOURCE_REF.

language_code smallint Language code, from LANGUAGE_CODE_REF.

short_display char 5 Short text description for ABI source. Null

display_value varchar 80 Text description to be displayed on screen.


24/583

ABP-9.1-DR1-1999/09/30

AA

ACCESS_REGION_REF

Static. Defines valid access regions for vertical and horizontal rating. Populated via the LOAD_USG_PTS utility. Admintable. Read-only copy exists on Customer server.


Indexes: clustered, unique on access_region


access_region char 5 Unique identifier of an access region (LATA).



(D: 0)


25/583

ABP-9.1-DR1-199

9/09/30

AA

ACCESS_REGION_VALUES

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

Triggers: language_codeexists in LANGUAGE_CODE_REF.access_regionexists in ACCESS_REGION_REF.

Indexes: clustered, unique on access_region, language_code


access_region char 5 Access region, from ACCESS_REGION_REF.


short_display char 5 Abbreviated version of the display value. Null



26/583

ABP-9.1-DR1-199

9/09/30

AA

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


Indexes: non-unique on is_business, account_category

unique onaccount_category


account_category

tinyint Unique identifier of an account category. (R: != 255)



(D: 0)

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_dateto set ppdd_datefor interim

bills for ac-counts of this category. If -1 (default), use ppdd_date

from customers next bill cycle.

(D: -1) (R: >= -1)

consolidate_

usage

bit Does the account category allow CAP to summarize usage?

(1 = yes)

(D: 0)


27/583

ABP-9.1-DR1-199

9/09/30

AA

ACCOUNT_CATEGORY_VALUES

Configurable. Describes account categories defined in ACCOUNT_CATEGORY_REF. Admin table. Read-only copy existson Customer server.


Triggers: language_codeexists in LANGUAGE_CODE_REF.account_categoryexists in ACCOUNT_CATEGORY_REF.

Indexes: unique onaccount_category

,language_code


account_category

tinyint Account category identifier, from ACCOUNT_CATEGORY_REF.





28/583

ABP-9.1-DR1-199

9/09/30

AA

ACCOUNT_MOVE_TABLES

Configurable. Contains information about what data in which tables needs to be moved. Admin table. Read-only copyexists on Customer server.

Used by the following modules: AMP

Indexes: This table has no indexes.


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 infrom_tables.

Null

from_tables varchar 255 The FROM clause of the SQL query used to find the information tomove.

where_clause varchar 255 The WHERE conditions of the SQL query used to find theinformation to move.

run_order smallint Order in the execution sequence for insert. Tables with higherorder will be inserted first and deleted last. If Null, the order is notimportant.

Null


29/583

ABP-9.1-DR1-199

9/09/30

AA

ACCT_SEG_MAP

Configurable. Maps customer segments to other branding fields. Admin table. Read-only copy exists on Customerserver.

Indexes: clustered, unique on acct_seg_id


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.

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, fromSERVICE_CENTERS.

service_inquiry_center

smallint 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.


30/583

ABP-9.1-DR1-199

9/09/30

AA

ACCT_SEG_REF

Configurable. Describes customer account segments. Read-only copies exist on Customer and Catalog servers. Run thereplicate.plscript after modifying this table. See the System Administrator Guidefor more information aboutreplicate.pl. Admin table.

Used by the following modules: CUSTINFO, API

Triggers: No row may have is_default= 1.

Indexes: unique on acct_seg_id


acct_seg_id int Unique internal ID for a segment of accounts. (R: > 0)



(D: 0)


31/583

ABP-9.1-DR1-1999/09/30

AA

ACCT_SEG_VALUES

Configurable. Describes account segments defined in ACCT_SEG_REF. Read-only copies exist on Customer and Catalogservers. Run the replicate.plscript after modifying this table. See the System Administrator Guidefor more informationabout replicate.pl. Admin table.

Used by the following modules: CUSTINFO, API

Triggers: language_codeexists in LANGUAGE_CODE_REF.acct_seg_idexists in ACCT_SEG_REF.

Indexes: unique on acct_seg_id, language_code


acct_seg_id int Account segment ID, from ACCT_SEG_REF.

language_code int Language code, from LANGUAGE_CODE_REF.

short_display char 5 Short text description for account segment. Null



32/583

ABP-9.1-DR1-1999/09/30

AA

ADJ_REASON_CODE_REF

Configurable. Defines valid adjustment reasons, which are included in pop-up selection lists in the GUI and used forbooking adjustments. Admin table. Read-only copy exists on Customer server.

Used by the following modules: CUSTINFO, JNL


Indexes: clustered, unique on adj_reason_code


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 tothe proper journal account.



(D: 0)


33/583

ABP-9.1-DR1-1999/09/30

AA

ADJ_REASON_CODE_VALUES

Configurable. Describes adjustment reason codes defined in ADJ_REASON_CODE_REF. Admin table. Read-only copyexists on Customer server.


Triggers: language_codeexists in LANGUAGE_CODE_REF.adj_reason_codeexists in ADJ_REASON_CODE_REF.

Indexes: clustered, unique on adj_reason_code, language_code


adj_reason_code

smallint Adjustment reason code, from ADJ_REASON_CODE_REF.




A


34/583

ABP-9.1-DR1-1999/09/30

AA

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: If trans_target_idis not zero, then it must exist in PRODUCT_ELEMENTS, NRC_TRANS_DESCR, USAGE_TYPES,or PRODUCT_LINEStables.description_codemust exist in DESCRIPTIONS.If is_refinance= 1, trans_target_typemust be 4 (misc adjustment).

If adj_trans_category= 1 and trans_sign= -1, billing_categorymust be 2 or 3 (credit adjustments to post-billed charges go against past charges or credit notes).If adj_trans_category= 1 and trans_sign= 1, billing_categorymust be 1 (Debit adjustments to post-billedcharges go against current charges).If adj_trans_category= 5, trans_target_typemust be 3 and billing_category= 1 (ensure category 5 can only beused for pre-billed usage adjs).If adj_trans_category= 6 or 7, billing_categorymust be 2.trans_target_idis updated with correct value, depending on value of trans_target_type, as specified in fielddescription.

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_classeither tax_classexists in TAX_RATES_VATor is = -1, -2, or NULL.

Indexes: unique on adj_trans_code


35/583

ABP-9.1-DR1-1999/09/30

AA


adj_trans_code smallint Unique internal identifier of an adjustment type.

trans_target_type

smallint Transaction target type:1 = recurring charge for a product defined in PRODUCT_ELEMENTS2 = non-recurring charge defined in NRC_TRANS_DESCR3 = usage charge defined in USAGE_TYPES4 = open item id, defined in OPEN_ITEM_ID_REF

5 = recurring charge for product line, from PRODUCT_LINES6 = taxes9 = system-generated reversal, in other words, not in a specifictable.

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

trans_target_id smallint Identifier of transaction target type. This is to cross-reference theappropriate table. For transaction type 9 this field will be zero.

adj_trans_category

tinyint Category of adjustment transaction:1 = pre-rated5 = pre-billed usage adjustment

6 = adj backout for new charges7 = 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 charges2 = apply to past charges3 = apply to credit note

4 = apply to credit note reversals. Non-balance affecting, usuallygenerated during invoice backout.

(R: 1, 2, 3, 4)

billing_level smallint Billing level: 0 = account level 1 = service instance level (R: 0, 1)

description_code smallint Description from DESCRIPTIONStable.

AA


36/583

ABP-9.1-DR1-1999/09/30

AA

tax_class smallint Tax class from TAX_RATES_VAT, or-1 = exempt-2 = outside scope of lawNull indicates that the deployment doesnt required VAT taxation.

Null

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

booked by another system.

(D: 1)

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)



37/583

ABP-9.1-DR1-1999/09/30

AA

AGGR_USAGE_DEFINITIONS_REFConfigurable. Defines aggregate usage rate structures. Admin table. Read-only copy exists on Customer server.

Used by the following modules: CAP, BIP, CUSTINFO

Triggers: Only one row may have is_default= 1.inactive_dtmust be later than active_dt, or NULL.

Indexes: unique on aggr_usage_id


aggr_usage_id smallint Unique ID of an aggregate usage rate structure.

aggr_usage_type

tinyint 2 = incremental aggregate usage rate6 = 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. Null

create_dt smalldt Date the rate structure was defined.



(D: 0)

AA


38/583

ABP-9.1-DR1-1999

/09/30

AA

AGGR_USAGE_DEFINITIONS_VALUESConfigurable. Describes aggregate usage definitions defined in AGGR_USAGE_DEFINITIONS_REF. Admin table. Read-only copy exists on Customer server.

Used by the following modules: BIF, CUSTINFO

Triggers: language_codeexists in LANGUAGE_CODE_REF.aggr_usage_idexists in AGGR_USAGE_DEFINITIONS_REF.language_codeand aggr_usage_idcannot be updated.

Indexes: unique on aggr_usage_id, language_code


aggr_usage_id smallint Aggregate rate ID, from AGGR_USAGE_DEFINITIONS_REF.





39/583

ABP-9.1-DR1-1999

/09/30

AA

AGGR_USAGE_RESTRICTIONSConfigurable. 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

Triggers: aggr_usage_id exists in AGGR_USAGE_DEFINITIONS_REF.restricted_idexists in appropriate table, based on restriction_type(see below).Rows with the same aggr_usage_idand restriction_typeshould have the same is_exclusionvalue.

Indexes: non-unique on aggr_usage_idunique on aggr_usage_id, restriction_type, restricted_domain, restricted_id


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) Null

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

Null

is_exclusion bit 0 = aggregate rate should be applied only to the restricted entity1 = aggregate rate should be applied to everything excepttherestricted entity

AA


40/583

ABP-9.1-DR1-1999

/09/30

AA

ARB_TAB_DEPENDSStatic. 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


depend_id smallint Used by Arbor/OM.key_nm varchar 255 Used by Arbor/OM.

parent_nm varchar 255 Used by Arbor/OM.

child_nm varchar 255 Used by Arbor/OM.

parent_cols varchar 255 Used by Arbor/OM.

child_cols varchar 255 Used by Arbor/OM.


41/583

ABP-9.1-DR1-1999

/09/30

AA

ARCHIVE_ACTION_REFStatic. Reserved for future use.

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


Indexes: unique on arch_action


arch_action smallint Archive action code:1 = database move data2 = database delete data3 = flat file move4 = flat file delete5 = database external archive (in other words, to tape device)

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

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

modify.(D: 0)

AA


42/583

ABP-9.1-DR1-1999

/09/30

AA

ARCHIVE_ACTION_VALUESConfigurable. Reserved for future use.

Describes archive actions defined in ARCHIVE_ACTION_REF. Admin table. Read-only copy exists on Customer server.

Triggers: language_codeexists in LANGUAGE_CODE_REF.arch_actionexists in ARCHIVE_ACTION_REF.

Indexes: unique on arch_action, language_code


arch_action smallint Archive action, from ARCHIVE_ACTION_REF.


short_display char 5 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.

Null

display_value varchar 80 Description of archive action.


43/583

ABP-9.1-DR1-1999

/09/30

AA

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

Indexes: clustered, unique on table_name, arch_date, db_namenon-unique on tape_id, serv_tape_id


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. (D: 0)

serv_tape_id tinyint Reserved for future use.

AA


44/583

ABP-9.1-DR1-1999/09/30

AA

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

Triggers: If arch_action= 5 (archive to tape), there can only be one table per archive task.task_namemust exist in PROCESS_SCHEDor be NULL.

Indexes: unique on task_name, arch_action, arch_from

Field Name Data Type Comments Values Nulltask_name char 10 Name used to identify this archive task.

arch_action smallint Archive action code, from ARCHIVE_ACTION_REF. (R: 1, 2, 3, 4, 5)

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 fordelete actions.

Null

file_pattern char 16 Files matching file_patternwill be archived. Null

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

Null

db_criteria1 char 80 Used only for database archiving. Contains where clause (withoutthe 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 8 Process currently performing archive task, or Null if not currently

active.

Null


45/583

ABP-9.1-DR1-1999/09/30

AA

last_arch datetime Date and time this archive task was last run. Null

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

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


AA


46/583

ABP-9.1-DR1-1999/09/30

AA

ARCH_MODE_REFStatic. Defines valid archive modes. Admin table. Read-only copy exists on Customer server.

Used by the following modules: ARCH

Triggers: Only one row can have is_default= 1.

Indexes: clustered, unique on arch_mode_id


arch_mode_id smallint Unique archive mode ID:1 = Count Only2 = Archive and Delete3 = Delete Only4 = Full Archive Restore5 = Invoice-level Restore

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

modify.

(D: 0)



47/583

ABP-9.1-DR1-1999/09/30

AA

ARCH_MODE_VALUESConfigurable. Describes archive modes. Admin table. Read-only copy exists on Customer server.


Triggers: language_codeexists in LANGUAGE_CODE_REF.arch_mode_idexists in ARCH_MODE_REF.

Indexes: clustered, unique on arch_mode_id, language_code


arch_mode_id smallint Archive mode ID, from ARCH_MODE_REF.



short_display char 5 Short text description.

AA


48/583

ABP-9.1-DR1-1999/09/30

AA

ARCH_TABLE_DEPENDS_REFStatic. Identifies the tables associated with each archive type. Admin table. Read-only copy exists on Customer server.


Triggers: Ensure arch_type_idexists in ARCH_TYPE_REF.

Indexes: clustered, unique on arch_table_id


arch_table_id smallint Unique table ID.

arch_type_id smallint Archive type used to archive this table, from ARCH_TYPE_REF. Agiven 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 forBILL_INVOICE).


49/583

ABP-9.1-DR1-1999/09/30

AA

ARCH_TYPE_REFStatic. Defines valid archive types. Admin table. Read-only copy exists on Customer server.


Triggers: Only one row can have is_default= 1.

Indexes: clustered, unique on arch_type_id


arch_type_id smallint Archive type:1 = Archive old invoices (BILL_INVOICEtable)2 = Archive bill images (BILL_IMAGEtable)


(D: 0)


AA


50/583

ABP-9.1-DR1-1999/09/30

AA

ARCH_TYPE_VALUESConfigurable. Describes archive types. Admin table. Read-only copy exists on Customer server.


Triggers: language_codeexists in LANGUAGE_CODE_REF.arch_type_idexists in ARCH_TYPE_REF.

Indexes: clustered, unique on arch_type_id, language_code


arch_type_id smallint Archive type ID, from ARCH_TYPE_REF.



short_display char 5 Short text description.


51/583

ABP-9.1-DR1-1999/09/30

AA

ATM_CUSTOM_TABLE_DEFConfigurable. Identifies deployment-specific tables for inclusion in the ACE interface. Admin table.

Used by the following modules: ATM

Indexes: unique on table_name


table_name char 30 Name of deployment-specific table.

server_type tinyint Type of server on which the table resides. (R: 1, 2, 3) Null

AA


52/583

ABP-9.1-DR1-1999/09/30

AA

ATM_FIELD_DEFStatic/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.


Indexes: unique on table_name, field_name


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 Reserved for future use; leave Null. Null

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 1 = cross_field_nameis described in DESCRIPTIONS.2 =cross_field_nameis described in a_VALUEStable.3 = cross_field_nameis not described in the database.

Null


53/583

ABP-9.1-DR1-1999/09/30

AA

ATM_POPLIST_REFStatic/configurable. Holds values for certain pop-up selection lists in ATM. Edit this table for custom tables defined inATM_CUSTOM_TABLE_DEF, otherwise do not edit. This table cannot be modified through ATM. Admin table.



Indexes: clustered, unique on table_name, field_name, int_value, char_value




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

char_value varchar 12 Field value (if char or varchar). Null

is_default bit Always set to 0. (D: 0)

is_internal bit Always set to 0. (D: 0)

AA


54/583

ABP-9.1-DR1-1999/09/30

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

Triggers: language_codeexists in LANGUAGE_CODE_REF.table_name, field_name, char_value, andint_valueexist in ATM_POPLIST_REF.

Indexes: clustered, unique on table_name, field_name, language_code, char_value, int_value




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

char_value varchar 12 Field value (if char or varchar). Null


short_display char 5 Leave blank. Null

display_value varchar 80 Description used in the pop-up list.


55/583

ABP-9.1-DR1-1999/09/30

BB

BILLING_FREQUENCY_REFStatic. Describes the valid billing frequencies (daily, monthly, and so on). Admin table. Read-only copy exists onCustomer server.

Used by the following modules: CUSTINFO, BIP


Indexes: unique on billing_frequency


billing_frequency tinyint Billing frequency code:1 = daily 2 = weekly 3 = monthly 4 = quarterly6 = annually



(D: 0)

BB


56/583

ABP-9.1-DR1-1999/09/30

BILLING_FREQUENCY_VALUESConfigurable. Describes billing frequencies defined in BILLING_FREQUENCY_REF. Admin table. Read-only copy existson Customer server.

Triggers: language_codeexists in LANGUAGE_CODE_REF.billing_frequencyexists in BILLING_FREQUENCY_REF.

Indexes: clustered, unique on billing_frequency, language_code


billing_frequency tinyint Billing frequency, from BILLING_FREQUENCY_REF.





57/583

ABP-9.1-DR1-1999/09/30

BB

BILL_ADDRESSConfigurable. Provides support for deployment-specific bill formatting for front-page address. Admin table. Read-onlycopy exists on Customer server.

Used by the following modules: BIF

Triggers: bill_fmt_optexists in BILL_FMT_OPT_REF.country_codeexists in COUNTRY_CODE_REF.Only one row may have is_default= 1.

Indexes: unique on bill_fmt_opt, country_code, address_line, address_line_orderunique on bill_fmt_opt, country_code, address_field


bill_fmt_opt int Bill format option, from BILL_FMT_OPT_REF.

country_code smallint Country code, from