Sonic Alert Oracle Telecommunications Billing Inegrator B31540 02 User Manual

Oracle® Telecommunications Billing Integrator  
Implementation Guide  
Release 12  
Part No. B31540-02  
December 2006  
Contents  
Send Us Your Comments  
Preface  
1
Introduction to Telecommunications Billing Integrator  
2
3
Implementing Telecommunications Billing Integrator  
Implementation Tasks for Oracle Telecommunications Billing Integrator  
iii  
A Configuring Oracle Applications InterConnect  
iv  
B APIs in Telecommunications Billing Integrator  
C Message Maps and DTDs for XML Gateway  
D XML Messages in TBI  
Glossary  
Index  
v
Send Us Your Comments  
Oracle Telecommunications Billing Integrator Implementation Guide, Release 12  
Part No. B31540-02  
Oracle welcomes customers' comments and suggestions on the quality and usefulness of this document.  
Your feedback is important, and helps us to best meet your needs as a user of our products. For example:  
Are the implementation steps correct and complete?  
Did you understand the context of the procedures?  
Did you find any errors in the information?  
Does the structure of the information help you with your tasks?  
Do you need different information or graphics? If so, where, and in what format?  
Are the examples correct? Do you need more examples?  
If you find any errors or have any other suggestions for improvement, then please tell us your name, the  
name of the company who has licensed our products, the title and part number of the documentation and  
the chapter, section, and page number (if available).  
Note: Before sending us your comments, you might like to check that you have the latest version of the  
document and if any concerns are already addressed. To do this, access the new Applications Release  
Online Documentation CD available on Oracle MetaLink and www.oracle.com. It contains the most  
current Documentation Library plus all documents revised or released recently.  
Send your comments to us using the electronic mail address: [email protected]  
Please give your name, address, electronic mail address, and telephone number (optional).  
If you need assistance with Oracle software, then please contact your support representative or Oracle  
Support Services.  
If you require training or instruction in using Oracle software, then please contact your Oracle local office  
and inquire about our Oracle University offerings. A list of Oracle offices is available on our Web site at  
www.oracle.com.  
vii  
Preface  
Intended Audience  
Welcome to Release 12 of the Oracle Telecommunications Billing Integrator Implementation  
Guide.  
This guide is intended for implementers and administrators of the Telecommunications  
Billing Integrator application. This guide assumes you have a working knowledge of  
the following:  
The principles and customary practices of your business area.  
Oracle Telecommunications Billing Integrator  
Oracle XML Gateway  
To learn more about Oracle XML Gateway, see the Oracle XML Gateway User's  
Guide.  
Oracle Workflow  
To know more about Oracle Workflow, see the Oracle Workflow Administrator's  
Guide.  
See Related Information Sources on page xi for more Oracle Applications product  
information.  
TTY Access to Oracle Support Services  
Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services  
within the United States of America 24 hours a day, seven days a week. For TTY  
support, call 800.446.2398.  
ix  
Documentation Accessibility  
Our goal is to make Oracle products, services, and supporting documentation  
accessible, with good usability, to the disabled community. To that end, our  
documentation includes features that make information available to users of assistive  
technology. This documentation is available in HTML format, and contains markup to  
facilitate access by the disabled community. Accessibility standards will continue to  
evolve over time, and Oracle is actively engaged with other market-leading technology  
vendors to address technical obstacles so that our documentation can be accessible to all  
of our customers. For more information, visit the Oracle Accessibility Program Web site  
at http://www.oracle.com/accessibility/ .  
Accessibility of Code Examples in Documentation  
Screen readers may not always correctly read the code examples in this document. The  
conventions for writing code require that closing braces should appear on an otherwise  
empty line; however, some screen readers may not always read a line of text that  
consists solely of a bracket or brace.  
Accessibility of Links to External Web Sites in Documentation  
This documentation may contain links to Web sites of other companies or organizations  
that Oracle does not own or control. Oracle neither evaluates nor makes any  
representations regarding the accessibility of these Web sites.  
Structure  
This chapter provides a brief introduction to the features in TBI.  
This chapter lists the implementation considerations for TBI.  
This chapter discusses the tasks to implement Oracle Telecommunications Billing  
Integrator.  
This appendix provides information on configuring Oracle Applications InterConnect  
(OAI).  
This appendix provides information on the APIs in TBI.  
This appendix provides information on the message maps and DTDs for Oracle XML  
Gateway.  
x
This appendix provides information on the XML messages in TBI.  
Related Information Sources  
Oracle Telecommunications Billing Integrator shares business and setup information  
with other Oracle Applications products. Refer to other guides when you set up and use  
Oracle Telecommunications Billing Integrator. You can read the guides online by  
choosing Library from the expandable menu on your HTML help window, by reading  
from the Oracle Applications Document Library CD included in your media pack, or by  
using a Web browser with a URL that your system administrator provides.  
If you require printed guides, you can purchase them from the Oracle Store at  
http://oraclestore.oracle.com.  
Integration Repository  
The Oracle Integration Repository is a compilation of information about the service  
endpoints exposed by the Oracle E-Business Suite of applications. It provides a  
complete catalog of Oracle E-Business Suite's business service interfaces. The tool lets  
users easily discover and deploy the appropriate business service interface for  
integration with any system, application, or business partner.  
The Oracle Integration Repository is shipped as part of the E-Business Suite. As your  
instance is patched, the repository is automatically updated with content appropriate  
for the precise revisions of interfaces in your environment.  
Guides Related to All Products  
Oracle Applications User's Guide  
This guide explains how to enter data, query, run reports, and navigate using the  
graphical user interface (GUI). This guide also includes information on setting user  
profiles, as well as running and reviewing reports and concurrent processes. You can  
access this user's guide online by choosing "Getting Started with Oracle Applications"  
from any Oracle Applications help.  
Guides Related to This Product  
Oracle Telecommunications Service Ordering Process Guide  
This manual provides information on setting up Oracle Order Management that is  
specific to the Oracle Telecommunications Service Ordering solution.  
Oracle XML Gateway User's Guide  
This manual describes the XML Gateway features and architecture and provides  
information on Message Designer, XML Gateway Setup, and Execution Engine.  
xi  
 
Oracle Workflow Developer's Guide  
This guide explains how to define new workflow business processes and customize  
existing Oracle Applications-embedded workflow processes. It also describes how to  
define and customize business events and event subscriptions.  
Installation and System Administration  
Oracle Applications Concepts  
This book is intended for all those planning to deploy Oracle E-Business Suite Release  
12, or contemplating significant changes to a configuration. After describing the Oracle  
Applications architecture and technology stack, it focuses on strategic topics, giving a  
broad outline of the actions needed to achieve a particular goal, plus the installation and  
configuration choices that may be available.  
Oracle Applications Installation Guide: Using Rapid Install  
This book is intended for use by anyone who is responsible for installing or upgrading  
Oracle Applications. It provides instructions for running Rapid Install either to carry  
out a fresh installation of Oracle Applications Release 12, or as part of an upgrade from  
Release 11i to Release 12. The book also describes the steps needed to install the  
technology stack components only, for the special situations where this is applicable.  
Oracle Applications Upgrade Guide: Release 11i to Release 12  
This guide provides information for DBAs and Applications Specialists who are  
responsible for upgrading a Release 11i Oracle Applications system (techstack and  
products) to Release 12. In addition to information about applying the upgrade driver,  
it outlines pre-upgrade steps and post-upgrade steps, and provides descriptions of  
product-specific functional changes and suggestions for verifying the upgrade and  
reducing downtime.  
Oracle Applications Maintenance Procedures  
This guide describes how to use AD maintenance utilities to complete tasks such as  
compiling invalid objects, managing parallel processing jobs, and maintaining snapshot  
information. Part of Maintaining Oracle Applications, a 3-book set that also includes  
Oracle Applications Patching Procedures and Oracle Applications Maintenance  
Utilities.  
Oracle Applications System Administrator's Documentation Set  
This documentation set provides planning and reference information for the Oracle  
Applications System Administrator. Oracle Applications System Administrator's Guide -  
Configuration contains information on system configuration steps, including defining  
concurrent programs and managers, enabling Oracle Applications Manager features,  
and setting up printers and online help. Oracle Applications System Administrator's Guide  
- Maintenance provides information for frequent tasks such as monitoring your system  
with Oracle Applications Manager, managing concurrent managers and reports, using  
diagnostic utilities, managing profile options, and using alerts. Oracle Applications  
System Administrator's Guide - Security describes User Management, data security,  
xii  
function security, auditing, and security configurations.  
Oracle Alert User's Guide  
This guide explains how to define periodic and event alerts to monitor the status of  
your Oracle Applications data.  
Oracle Applications Developer's Guide  
This guide contains the coding standards followed by the Oracle Applications  
development staff and describes the Oracle Application Object Library components that  
are needed to implement the Oracle Applications user interface described in the Oracle  
Applications User Interface Standards for Forms-Based Products. This manual also  
provides information to help you build your custom Oracle Forms Developer forms so  
that the forms integrate with Oracle.  
Other Implementation Documentation  
Oracle Workflow Administrator's Guide  
This guide explains how to complete the setup steps necessary for any Oracle  
Applications product that includes workflow-enabled processes, as well as how to  
monitor the progress of runtime workflow.  
Oracle Workflow Developer's Guide  
This guide explains how to define new workflow business processes and customize  
existing Oracle Applications-embedded workflow processes. It also describes how to  
define and customize business events and event subscriptions.  
Oracle Workflow User's Guide  
This guide describes how Oracle Applications users can view and respond to workflow  
notifications and monitor the progress of their workflow processes.  
Oracle Workflow API Reference  
This guide describes the APIs provided for developers and administrators to access  
Oracle Workflow.  
Oracle eTechnical Reference Manuals  
Each eTechnical Reference Manual (eTRM) contains database diagrams and a detailed  
description of database tables, forms, reports, and programs for a specific Oracle  
Applications product. This information helps you convert data from your existing  
applications, integrate Oracle Applications data with non-Oracle applications, and write  
custom reports for Oracle Applications products. Oracle eTRM is available on  
OracleMetalink.  
Do Not Use Database Tools to Modify Oracle Applications Data  
Oracle STRONGLY RECOMMENDS that you never use SQL*Plus, Oracle Data  
Browser, database triggers, or any other tool to modify Oracle Applications data unless  
xiii  
otherwise instructed.  
Oracle provides powerful tools you can use to create, store, change, retrieve, and  
maintain information in an Oracle database. But if you use Oracle tools such as  
SQL*Plus to modify Oracle Applications data, you risk destroying the integrity of your  
data and you lose the ability to audit changes to your data.  
Because Oracle Applications tables are interrelated, any change you make using an  
Oracle Applications form can update many tables at once. But when you modify Oracle  
Applications data using anything other than Oracle Applications, you may change a  
row in one table without making corresponding changes in related tables. If your tables  
get out of synchronization with each other, you risk retrieving erroneous information  
and you risk unpredictable results throughout Oracle Applications.  
When you use Oracle Applications to modify your data, Oracle Applications  
automatically checks that your changes are valid. Oracle Applications also keeps track  
of who changes information. If you enter information into database tables using  
database tools, you may store invalid information. You also lose the ability to track who  
has changed your information because SQL*Plus and other database tools do not keep a  
record of changes.  
xiv  
1
Introduction to Telecommunications Billing  
Integrator  
This chapter provides a brief introduction to the features in TBI.  
This chapter covers the following topics:  
Telecommunications Billing Integrator Overview  
Telecommunications Billing Integrator (TBI) provides a seamless integration between  
Oracle E-Business Suite (EBS) and one or more external billing applications to assist in  
customer management and enhance business benefits.  
Telecommunications service providers use Oracle EBS to create and maintain data.  
They use external billing applications to bill the customers for the services and products  
ordered through Oracle EBS. Oracle TBI is an interface between Oracle EBS and the  
external billing applications. Oracle TBI enables exchange of information between  
Oracle EBS and the billing applications to ensure that data essential for billing purposes  
Introduction to Telecommunications Billing Integrator 1-1  
     
is made available to the external billing application.  
TBI depends on the Oracle Telecommunications Service Ordering (TSO) solution. The  
TSO solution leverages multiple components in the Oracle E-Business Suite (EBS) to  
enable telecommunications service providers to add, change, move or disconnect  
telecommunication services.  
Telecommunications service providers also use Oracle EBS to conduct post-sale  
interactions with customers, such as processing service requests and billing inquiries.  
Oracle EBS provides information on customers, accounts, products and sales orders  
which is replicated and synchronized in the external billing applications. Oracle TBI  
provides the customer care agent with the bill summary information and actual  
customer bill images from the billing application. It provides bill summary data in  
Oracle Contact Center. Oracle TBI thus addresses the need for fast and efficient access  
to billing information and EBS data.  
Telecommunications Billing Integrator Features  
The key features of TBI are:  
Information Exchange: TBI enables exchange of information between Oracle EBS  
and external billing applications. TBI publishes details on accounts, products, and  
sales orders to the external billing applications and Oracle EBS receives  
acknowledgements for the published messages.  
Integration with multiple billing systems: TBI can integrate with multiple  
heterogeneous billing applications simultaneously.  
Status Tracking: TBI integrates with the Oracle Collaboration History to monitor  
communication between EBS and the billing applications. TBI uses Collaboration  
History to:  
Support integration with multiple heterogeneous billing systems. TBI uses  
Collaboration History to determine if each of the billing application has  
successfully created accounts and orders. It checks the account messages and  
sales order messages in Collaboration History.  
Ensure that order information is published to billing systems only after each  
billing system has successfully created a party and account.  
Publish updates to party and account relevant to the billing system.  
Track the status of each message that is published to the external billing  
application.  
Allow users to query for specific collaborations by account numbers, order  
numbers, or product/item numbers. Users can view the contents of the  
messages being published and the history of the events.  
1-2 Oracle Telecommunications Billing Integrator Implementation Guide  
 
For more information, see Setting Up Collaboration History, page 3-10.  
Middleware independent: TBI requires a middleware as an integration point to  
billing applications for messaging, transforming, and routing the XML messages.  
TBI can integrate with any middleware that has a native AQ or JMS adapter. TBI  
has been tested and certified using Oracle Applications InterConnect (OAI 9.0.4).  
For information on configuring Oracle Applications InterConnect (OAI 9.0.4), see  
Configuring Oracle Applications InterConnect, page A-1.  
Display bill summary and bill image: TBI provides access to the bill summary data  
through Oracle Contact Center. The Bill Summary UI displays the bill summary for  
a single account number. The customer service agents can view the bill summary  
from the 'Bill Summary' option in Oracle Contact Center. The bill number provided  
in the bill summary UI is linked to the image data supplied by the billing  
application. To enable the 'Bill Summary' option in Oracle Contact Center, see  
Setting up Bill Summary UI, page 3-13.  
Business Event Enabled: Business Event System is a real-time notification system.  
The Business Event System notifies TBI when an account or sales order is created or  
updated. For account update, the TBI users can choose the TCA events they wish to  
subscribe to. For more information, see Subscribing to Account Update Events,  
page 3-21.  
Publishing Information to the Billing Applications  
TBI publishes information on the following EBS entities to the external billing  
applications:  
New Account  
Account Update  
Item/Product  
Sales Order  
Grouped Sales Order  
Publishing New Account Details  
Account information is maintained in Oracle Trading Community Architecture (TCA)  
and is published to the external billing application only when an order is booked for the  
first time for an account.  
For more information, see Integrating Workflow Process for Publishing Account  
Information, page 3-16 and Message Specifications for Account, page D-7.  
Publishing Account Update Details  
Introduction to Telecommunications Billing Integrator 1-3  
     
TBI subscribes to a set of TCA events related to account updates. TBI generates and  
publishes an account message to the billing system when changes relevant to the billing  
system are made to accounts in TCA.  
The updated information is marked in the message. For example: If the credit  
classification information of an account (relevant to the billing system) is changed in  
TCA, TBI publishes the account message with the Credit Classification section marked  
as "U" (Updated).  
If multiple changes are made to an account in TCA, TBI publishes multiple account  
messages.  
For more information, see Subscribing to Account Update Events, page 3-21 and  
Message Specifications for Account, page D-7.  
Publishing Item/Product Details  
TBI provides a concurrent manager program to synchronize the product catalog in  
Oracle EBS with the billing system. Synchronization helps in maintaining accurate  
pricing and billing information. To synchronize a large number of items between EBS  
and the billing system, the concurrent program generates an XML or CSV file for all  
EBS product catalog items that must be uploaded to the billing system. For  
synchronizing small additions, the concurrent program can generate and  
asynchronously publish an XML message of items from the EBS product catalog to the  
billing system.  
For more information, see Setting up and Running the Item Publish Concurrent  
Program, page 3-19 and Message Specifications for Item/Product, page D-30  
Publishing Sales Order Details  
Sales order information is created and maintained in Oracle Order Management. Sales  
orders with multiple order lines are created in Oracle Order Management when:  
A new telecommunications service (example: wireless service) is ordered  
New features (example: voice mail) are added to a service  
Changes are made to features (example: number of rings before voice mail is  
activated)  
Changes (upgrade/downgrade) are made to price packages  
Provisioning actions (example: service is suspended, resumed, moved or  
disconnected) are performed on an active service.  
In the TSO solution, each order line includes a provisioning action, an item (example:  
service, feature, price package, one-time charge, recurring charge), pricing, address, and  
other information. The billing system requires all the information in the order. TBI  
publishes an XML message for each sales order line, to the billing system after each  
order line is fulfilled (provisioned).  
1-4 Oracle Telecommunications Billing Integrator Implementation Guide  
   
The sales order is published after confirming that the account that created the sales  
order is also published. If the account is published, the sales order flow continues to  
publish the sales order message. If the account is not published, the account is  
published before publishing the sales order message.  
For more information, see Integrating Workflow Process for Publishing Sales Order  
Information., page 3-17  
Publishing Group Sales Order Message Details  
A Group Sales Order message is a consolidated sales order XML message which  
contains all the order lines published to the third party billing application instead of  
order lines as individual message. TBI allows you to publish a single message for each  
line or a single grouped sales order message for all the lines in a sales order. Both of  
these options are mutually exclusive.  
Products Used in TBI  
TBI uses the following Oracle applications that provide the underlying technology  
stack, schema, and structure for TBI.  
Oracle Telecommunications Service Ordering (TSO)  
Oracle Collaboration History  
Oracle Contact Center  
Oracle Workflow Business Systems  
Oracle XML Gateway  
Oracle Advanced Queuing  
Enhancements  
The enhancements in this release are:  
Creation of a Grouped Sales Order message that includes all the lines of an order.  
Publish Bill-To account information for a sales order.  
Additional TCA events for Account Update Message.  
Enhancements to the Account Message.  
Enhancements to the Sales Order Message.  
Uptake of JMS compliant queues in XML Gateway.  
Introduction to Telecommunications Billing Integrator 1-5  
   
Grouped Sales Order Message  
This feature provides a single XML message that includes all the lines of an order. This  
enables the billing system to initiate the billing process for the entire order at the same  
time. The complete sales order message is grouped by order number and published to  
the billing application. A single message per order ensures that the dependencies and  
relationships across order lines are maintained when the message is delivered to the  
billing system and the billing system can initiate the billing process for the entire order  
at the same time.  
A group sales order message is useful when an order contains different parts or order  
lines that are provisioned at the same time and the billing also happens at the same  
time. For example: An order for provisioning Wireless Service, Voice Mail and SMS for  
an account. These services are activated immediately and do not have a long waiting  
time. These services also can be billed immediately.  
In the earlier version of TBI, three separate messages would have been created for each  
of the services provided. With group sales order message, billing information for all  
these three items can be sent in a single message. The group sales order message is  
generated after all the billable lines in the order have been successfully fulfilled and the  
products and services on the order are reflected in the customer's installed base.  
Note: Group sales order and sales order line messages are mutually  
exclusive.  
Publish Bill To Accounts for a Sales Order  
The Bill To account (payee account) for each order line is published to the billing  
application. In the previous release, the bill-to accounts were part of the sales order line  
message. In this release, the Bill To accounts are published separately as independent  
account messages.  
Additional TCA Events for Account Update Message  
The TCA events added to the existing Account Update message are:  
oracle.apps.ar.hz.Person.update: This event is triggered when there are changes to  
personal information about a person.  
oracle.apps.ar.hz.Organization.update: This event is triggered when there are  
changes to information related to an organization.  
oracle.apps.ar.hz.CustomerProfile.update: This event is triggered when there are  
changes to information about the credit characteristics of a single customer account,  
customer account site or a party.  
1-6 Oracle Telecommunications Billing Integrator Implementation Guide  
           
oracle.apps.ar.hz.ContactPoint.update: This event is triggered when there are  
changes to information about how to communicate to parties or party sites using  
electronic media such as Electronic Data Interchange (EDI), e-mail, telephone, telex,  
and the Internet.  
Enhancements to Account Message  
The information added to the account message is:  
Customer profile amount for the account.  
Credit classification details of the account.  
Obsoleted Billing Preference Events  
The Billing Preference Events obsoleted in this release are:  
oracle.apps.ar.hz.BillingPreference.create  
oracle.apps.ar.hz.BillingPreference.update  
Obsoleted Billing Preference Information  
The billing preference information obsoleted in this release is:  
BILL_DISPATCH_METHOD  
BILL_FORMAT  
BILL_LANGUAGE  
BILL_TYPE  
BILL_CURRENCY  
Enhancements to Sales Order Message  
The following enhancements have been added to a sales order message:  
Ship To Address of the Order Line: Include Ship To address details like Address  
(Street, City, County, Zip Code, Country), Contact Name (Salutation, First Name,  
Middle Name, Last Name), Contact Phone Number (Primary) and Contact E-mail  
Address (if available) for each order line  
Ship To Contact of the Order Line: Include the Ship to Contact details  
Introduction to Telecommunications Billing Integrator 1-7  
       
Payment Term for the Order Line: Include the payment terms. This information is  
used to calculate when a payment is due and factor in any discounts that are given  
for early payment.  
Periodicity Details of the Order Line: Include periodicity details to indicate how  
often a service is charged.  
Uptake of JMS Compliant Queues in XML Gateway  
XML Gateway generates XML messages in JMS format. There are two new JMS enabled  
AQs: WF_JMS_OUT and WF_JMS_IN that can be setup to directly process outbound  
and inbound JMS messages.  
In outbound transactions, XML Gateway generates the XML message directly in the  
JMS format and enqueues the messages onto the queue WF_JMS_OUT. The middleware  
should be configured to connect to the WF_JMS_OUT queue so that it can dequeue the  
message and utilize it for further processing.  
The Inbound transaction is similar to the outbound transaction. The Middleware  
enqueues the message onto WF_JMS_IN, which is the inbound AQ provided by XML  
Gateway. The XML Gateway dequeues this message and processes it.  
1-8 Oracle Telecommunications Billing Integrator Implementation Guide  
 
2
Implementing Telecommunications Billing  
Integrator  
This chapter lists the implementation considerations for TBI.  
This chapter covers the following topics:  
Implementation Considerations  
Consider the following implementation points before implementing Oracle TBI:  
TBI with TSO, page 2-1  
Middleware in TBI, page 2-2  
External Billing Applications, page 2-2  
TBI with TSO  
Oracle TBI depends on the Oracle Telecommunications Service Ordering (TSO)  
solution.  
The TSO solution leverages multiple components of the Oracle EBS to enable  
telecommunications service providers to order new telecommunications services for  
their customers and to order updates to existing telecommunications service  
configurations. All products, accounts, and orders for telecommunications services  
captured in EBS are synchronized with the third party billing system(s) that rate and  
generate bills for the services ordered.  
Implementing Telecommunications Billing Integrator 2-1  
       
Refer Oracle Telecommunications Service Ordering Process Guide for details.  
Middleware in TBI  
TBI integrates with any middleware that has a native AQ or JMS adapter. TBI has been  
tested and certified with Oracle Applications InterConnect (OAI 9.0.4). For details, see  
Configuring the Middleware., page 3-23  
External Billing Applications  
TBI provides a robust two-way integration which enables exchange of information  
between Oracle E-Business Suite and the external billing applications.  
Routing rules in the middleware allow integration with multiple heterogeneous billing  
applications. Middleware tracks the billing applications and the E-Business Suite  
communicates with the middleware.  
2-2 Oracle Telecommunications Billing Integrator Implementation Guide  
       
Implementation Tasks  
Implementing Oracle TBI involves the following:  
1. Setting Up XML Gateway, page 3-3  
2. Setting Up Collaboration History, page 3-10  
3. Starting Agent Listeners, page 3-13  
4. Setting Up Bill Summary UI, page 3-13  
5. Integration with Order Management Workflow Processes, page 3-16  
6. Setting Up and Running the Item Publish Concurrent Program, page 3-19  
7. Subscribing to Account Update Events, page 3-21  
8. Configuring the Middleware, page 3-23  
Setting up Profile Values  
To set up profile values in TBI, select the TBI administrator responsibility.  
3-2 Oracle Telecommunications Billing Integrator Implementation Guide  
 
Navigation: TBI setup > profile system values.  
Notes  
Unless otherwise mentioned, use the TBI administrator responsibility to complete the  
setups mentioned in this chapter.  
Setting Up XML Gateway  
You must have the TBI Administrator responsibility to access Oracle XML Gateway  
database and forms. Setting up XML Gateway or TBI involves the following:  
1. Defining XML Gateway Profile Values, page 3-3  
2. Defining UTL_FILE_DIR Parameters, page 3-3  
3. Defining XML Standards, page 3-4  
4. Defining a Hub, page 3-4  
5. Defining Transactions, page 3-5  
6. Defining Trading Partners, page 3-10  
Defining XML Gateway Profile Values  
To set the profile options, login to Oracle Forms with the System Administrator  
responsibility.  
Navigation: TBI Setup > Profile System Values  
For details on the XML gateway profile values to be set, refer Oracle XML Gateway  
User's Guide.  
Defining UTL_FILE_DIR Parameters  
Oracle XML Gateway uses the UTL_FILE package to read and write to the server. To  
use Oracle XML Gateway, create folders to store the XML message process logs and the  
XSLT style sheets.  
Use the utl_file_dir parameter in the $ORACLE_HOME/dbs/init<SID>.ora file to define  
folders. Each folder is indicated as ''utl_file_dir = directory_name'' in this file. The folder  
name must be the same as the value defined for the Oracle XML Gateway profile  
ECX_UTL_LOG_DIR file path (ECX:Log File Path).  
For details, refer Oracle XML Gateway User's Guide.  
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-3  
           
Defining XML Standards  
Define Open Applications Group (OAG) as the XML standard.  
Navigation: Oracle XML Gateway Setup > Define XML Standards.  
Notes  
Standard Code: This is the name or code for the standard body of the XML messages.  
Enter 'OAG'  
Standard Type: Enter 'XML'.  
Defining a Hub  
A hub is defined as an integration point within your network.  
Navigation: Oracle XML Gateway Setup > Define Hubs.  
Notes  
Name: Enter 'XNB_HUB'.  
Protocol Type: Select JMS. This value identifies the type of messages that are passed  
through the hub and provides a method for inbound and outbound agent listeners to  
filter the messages from a common queue. If this value is not available in the LOV, it  
must be enabled for the XML Gateway. To enable the values:  
1. Select XML Gateway Setup > Define Lookup Values.  
2. Query for the lookup type 'COMM_METHOD'.  
3. Locate the lookup value with code 'JMS' and enable it.  
Protocol Address: Enter 'WF_JMS_OUT'. This is the outbound queue to process  
outbound transactions.  
Note: Middleware should be configured accordingly, so that it picks up  
the outbound messages from WF_JMS_OUT and enqueues the inbound  
messages to WF_JMS_IN.  
Defining Hub Users  
A hub user represents an application that takes part in the message exchange.  
To define middleware as a hub user, enter XNB as the user name and the hub entity  
code.  
To define the billing application as a hub user, enter the name of the billing application  
as the user name and hub entity code.  
3-4 Oracle Telecommunications Billing Integrator Implementation Guide  
           
The names representing the billing applications setup in the hub  
must be unique.  
Hub entity code values for the various billing applications must be  
same as the key value from BSR.SENDER.COMPONENT.  
Defining Transactions  
Internal transactions are used by the XML Gateway Execution Engine. Internal  
transactions are associated with the trading partner in the trading partner setup. Each  
internal transaction is associated with a number of external transactions that participate  
in the integration.  
For more information about defining transactions, see the Oracle XML Gateway User's  
Guide.  
Navigation: Oracle XML Gateway Setup > Define Transactions.  
Notes  
Queue: The standard inbound queue used in TBI is APPS.ECX_IN_OAG_IN. The field  
is disabled for outbound messages. Default queues are defined during installation.  
Standard Code: Select 'OAG'.  
Transaction Type: This is the product short name for the base Oracle Application. Enter  
'XNB', which is the product short code for TBI.  
Transaction Subtype: This refers to particular transaction within the application  
specified by the Transaction Type. The last letter of the code represents the direction of  
the transaction, that is, "I" for inbound and "O" for outbound. The combination of the  
Transaction Type and the Transaction Subtype identifies an Oracle transaction with  
which the message is associated.  
External Transaction Type: Enter a primary external identifier for the XML message.  
External Transaction Subtype: Enter a secondary external identifier for the XML  
message.  
Internal and External Transactions in XML Gateway  
The following internal transactions have associated external transactions in XML  
Gateway:  
Account Outbound, page 3-6  
Sales Order Outbound, page 3-6  
Group Sales Order Outbound, page 3-7  
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-5  
     
Inventory Item Outbound, page 3-8  
Confirm BOD Inbound, page 3-8  
Account Outbound Internal Transaction  
The following table lists the attributes and values for the account outbound transaction.  
Account Outbound Transaction Values  
Attribute  
Value  
Party Type  
Customer  
Transaction Type  
Transaction Subtype  
Transaction Description  
XNB  
AO  
XNB TCA Account Outbound  
External Transactions for Account Outbound  
The following table lists the details of the external transactions for account outbound  
message.  
External Transactions for Account Outbound  
STD CODE  
DIR  
EXT. TXN.  
TYPE  
EXT. TXN.  
SUBTYPE  
QUEUE  
OAG  
OUT  
ACCOUNT  
SYNC  
-
Internal Transaction for Sales Order Outbound  
Sales Order Outbound  
Attribute  
Value  
Party Type  
Customer  
XNB  
Transaction Type  
3-6 Oracle Telecommunications Billing Integrator Implementation Guide  
   
Attribute  
Value  
Transaction Subtype  
Transaction Description  
SOO  
XNB OM Sales Order Outbound  
External Transactions for Sales Order Outbound  
External Transactions for Sales Outbound  
STD CODE  
DIR  
EXT. TXN.  
TYPE  
EXT. TXN.  
SUBTYPE  
QUEUE  
OAG  
OUT  
SALESORDER  
ADD  
-
Internal Transactions for Group Sales Order Outbound  
Group Sales Order Outbound  
Attribute  
Value  
Party Type  
Customer  
XNB  
Transaction Type  
Transaction Subtype  
Transaction Description  
GSOO  
XNB OM Group Sales Order Outbound  
External Transactions for Group Sales Order Outbound  
External Transactions for Group Sales Order Outbound  
STD CODE  
DIR  
EXT. TXN.  
TYPE  
EXT. TXN.  
SUBTYPE  
QUEUE  
OAG  
OUT  
GRP_SALESOR  
DER  
ADD  
-
Internal Transacations for Inventory Item Outbound  
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-7  
 
Inventory Item Outbound  
Attribute  
Value  
Party Type  
Customer  
Transaction Type  
Transaction Subtype  
Transaction Description  
XNB  
IO  
XNB Inventory Item Outbound  
External Transactions for Inventory Item Outbound  
External Transactions for Inventory Item Outbound  
STD CODE  
DIR  
EXT. TXN.  
TYPE  
EXT. TXN.  
SUBTYPE  
QUEUE  
OAG  
OUT  
ITEM  
SYNC  
-
Internal Transaction for Confirm BOD Inbound  
Confirm BOD Inbound  
Attribute  
Value  
Party Type  
Customer  
XNB  
Transaction Type  
Transaction Subtype  
Transaction Description  
CBODI  
XNB Confirm BOD Inbound  
External Transactions for Confirm BOD Inbound  
3-8 Oracle Telecommunications Billing Integrator Implementation Guide  
   
External Transactions for Confirm BOD Inbound  
STD  
CODE  
DIR EXT. TXN. TYPE EXT. TXN.  
SUBTYPE  
QUEUE  
OAG  
IN  
BOD  
CONFIRM  
APPS.ECX_IN_OAG_Q  
Transactions Enabled for TBI  
The following table lists the transactions enabled for TBI. A (XNB, CBODI) transaction  
must be enabled for each hub user representing a billing application with the correct  
Source Trading Partner Location Code. All transactions must be set as ENABLED.  
Transactions Enabled for TBI  
TXN TYPE TXN SUB  
TYPE  
MAP  
CONN/HU  
B
USERNAM SRCT P  
DOC  
CONF  
E
LOC  
CODE  
XNB  
XNB  
XNB  
AO  
XNB_TCA XNB_HUB XNB  
XNB  
XNB  
XNB  
2
_ACCOUN  
T_OAG72_  
OUT  
SOO  
GSO  
XNB_OM_ XNB_HUB XNB  
SALESOR  
2
DER_OAG  
72_OUT  
XNB_OM_ XNB_HUB XNB  
2 (If GSO)  
GRPSALES  
ORDER_O  
AG72_OU  
T
XNB  
IO  
XNB_INV_ XNB_HUB XNB  
ITEM_OA  
XNB  
2
G72_OUT  
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-9  
 
TXN TYPE TXN SUB  
TYPE  
MAP  
CONN/HU  
B
USERNAM SRCT P  
DOC  
CONF  
E
LOC  
CODE  
XNB  
CBODI  
XNB_CLN  
_CBOD_O  
AG72_IN  
-
-
<Hub  
0
Entity  
Code of  
Billing  
Applicatio  
ns>  
Defining Trading Partners  
A trading partner is an entity which exchanges messages with the XML Gateway. The  
trading partner has many transactions enabled for each hub user. The transactions  
enabled for each hub user determines the type of messages generated and the direction  
of the message. The Protocol Type is populated for outbound messages from the hub  
protocol type. Protocol Type is not applicable for inbound messages.  
For more information about setting up trading partners, see the Oracle XML Gateway  
User's Guide.  
Party and Location for the Hub must be created in TCA. For details, see Oracle Trading  
Community Architecture User Guide.  
Navigation: XML Gateway Setup > Define Trading Partners.  
Notes  
Company Admin Email: Enter the System Administrator's e-mail ID. The System  
Administrator will receive notifications regarding warnings and errors  
Connection/Hub: Enter 'XNB_HUB'. This is required only for outbound messages.  
Destination Trading Partner Location Code: Leave this field blank.  
Document Confirmation: Specifies if the trading partner would like to send or receive a  
confirmation. Select 2 (Always send a confirmation) for outbound messages and select 0  
(Never send a confirmation) for inbound messages.  
Setting Up Oracle Collaboration History  
Oracle Collaboration History maintains a history or record of the communication  
between EBS and the billing applications. Using Collaboration History, you can track all  
the events and messages exchanged during a collaboration including exceptions and the  
XML Payloads where available. Setting up Oracle Collaboration History involves the  
following:  
3-10 Oracle Telecommunications Billing Integrator Implementation Guide  
       
1. Defining Collaboration History Profile Values, page 3-11  
2. Defining Lookup Values, page 3-11  
3. Setting up Collaboration Events, page 3-12  
4. Setting up Final Collaboration Event, page 3-12  
Defining Collaboration History Profile Values  
Log into Oracle Forms and navigate to TBI Setup > Profile System Values and set up  
profile values for Collaboration History.  
Notes  
The profile values for Collaboration History are:  
1. CLN: Enable_History_Tracking  
2. CLN: Debug Level  
3. CLN: Debug Log Directory  
Defining Lookup Values for Collaboration  
Lookup values are used to integrate XML Gateway with the Supply Chain Trading  
Connector to enable Collaboration History Tracking. Use the applications Developer  
responsibility to define the lookup values  
Navigation: Application : Lookups > Application Object Library  
Notes  
The following table lists the lookup values.  
Lookup Types  
Lookup Type  
Lookup Code  
Description  
Enable  
d?  
CLN_APPLICATION_ID  
881  
Oracle  
Y
Telecommunications  
Billing Integrator  
CLN_COLLABORATION XNB_ITEM  
_TYPE  
TBI Item  
Y
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-11  
       
Lookup Type  
Lookup Code  
Description  
Enable  
d?  
CLN_COLLABORATION XNB_ACCOUNT  
_TYPE  
TBI Account  
Y
Y
Y
Y
Y
CLN_COLLABORATION XNB_SALESORDER  
_TYPE  
TBI Sales Order  
TBI Sync Item  
CLN_COLLABORATION XNB_SYNC_ITEM  
_DOC_TYPE  
CLN_COLLABORATION XNB_SYNC_ACCOUNT  
_DOC_TYPE  
TBI Sync Account  
TBI Add Sales Order  
CLN_COLLABORATION XNB_ADD_SALESORDE  
_DOC_TYPE  
R
Note: After updating the lookup values, bounce the Apache server on  
the environment only if the values are not reflected in the Collaboration  
Setup UI.  
Setting Up Collaboration Events  
A Collaboration Event represents a system component acting on information in a  
message or XML Payload.  
Navigation: Workflow Administrator : Collaboration Monitor : SetUp > Collaboration  
Event Definition  
Notes  
Application: Select the Oracle Application that owns the collaboration.  
Document Type: Select the Document Message Payload identified for the event.  
Setting up the Final Collaboration Event  
The final collaboration event must be set up in Collaboration History to record the final  
status of the overall collaboration. The final event is generally the occurrence of an  
inbound or outbound message in the XML Gateway. After the collaboration is created  
or updated from the business flow, the collaboration can be tracked using the  
Collaboration History function.  
Navigation: Workflow Administrator : Collaboration Monitor : SetUp > Collaboration  
3-12 Oracle Telecommunications Billing Integrator Implementation Guide  
       
Final Event Definition  
Checking Status of Agent Listeners  
The following Agent Listeners must be running for TBI to function:  
Workflow Deferred Agent Listener  
Workflow Deferred Notification Agent Listener  
Workflow Error Agent Listener  
Workflow Inbound Notifications Agent Listener  
Workflow Inbound JMS Agent Listener  
Navigation: Workflow Administrator : Oracle Applications Manager > Workflow  
Manager. Click the Agent listeners icon.  
Setting Up Bill Summary UI  
The Bill Summary UI is integrated with Oracle Contact Center and can be accessed from  
Oracle Contact Center through a special menu. Oracle TBI uses the OA Framework for  
Bill Summary UI.  
Setting up Bill Summary UI involves the following:  
1. Defining Bill Summary UI Profile Options, page 3-13  
2. Providing Access to Bill Summary UI to a Responsibility, page 3-14  
3. Personalizing the Form, page 3-15  
4. Accessing the Bill Summary UI from Oracle Contact Center, page 3-16  
5. Loading Bill Summary Data, page 3-16  
Defining Bill Summary UI Profile Options  
The following table lists the profile values for Bill Summary UI.  
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-13  
             
Bill Summary UI Profiles Values  
Profile Option  
Value  
XNB: Bill Image  
Source  
Specifies the source of the image displayed on the bill. The values are:  
Application: The source of the bill image is application specific.  
The billing application provides the URL to the bill details and the  
bill summary.  
File System: The bill image can be retrieved from the file system.  
XNB: Bill Image  
Location  
Specifies the location of the bill image in the file system. 'XNB: Bill  
Image Source' must be set to 'File System'. The path specified must be a  
relative path accessible to the application web server.  
The path specified is appended to the $OA_HTML path of the web  
server to retrieve the bill image.  
XNB: Bill Image  
Format  
Specifies the format of the bill image. This value is used as the file  
extension for the image name, which is same as the bill number. For  
example: gif, jpeg.  
Providing Access and Enabling the Bill Summary UI  
To access Bill Summary UI from Oracle Contact Center, select a responsibility that has  
access to Oracle Contact Center. Use the System Administrator responsibility.  
Navigation: Security : Responsibility > Define  
Steps:  
1. Query for 'Menu' to identify the root level menu attached to the responsibility.  
2. Navigate to Application > Menu. Query for the menu identified in the previous  
step.  
3. Add the seeded function XNB_OA_ACCT_BILL_DETAILS to the menu with the  
following values:  
Function: XNB_OA_BILL_DETAILS  
Description: XNB Account Bill Details OA Page  
4. To enable the Bill Summary UI, add the seeded function  
3-14 Oracle Telecommunications Billing Integrator Implementation Guide  
   
XNB_OA_ACCT_BILL_DETAILS to the menu with the following values:  
Function: XNB_OA_ACCT_BILL_SUMMARY  
Description: XNB Account Bill Summary OA Page  
Personalizing Oracle Contact Center for TBI  
TBI allows personalization in Oracle Contact Center to invoke the Bill Summary UI.  
You can do this from the Contact Center form  
Navigation: Help > Diagnostic > Custom Code > Personalize.  
1. Create a Function. Name the function 'Bill Summary Function' or as appropriate.  
2. Select the 'Enabled' check box to enable the function.  
3. Select the Condition tab and enter the following details.  
In the Trigger Event field, enter 'WHEN-NEW-FORM-INSTANCE.'  
In the Processing Mode field, enter 'Not in Enter-Query Mode'.  
4. Select the Actions tab and enter the following details.  
From the Type list, select Menu.  
From the Menu Entry list, select 'SpecialXX'. XX represents the number that is  
not used by any other entry.  
In the Menu Label field, enter Bill Summary.  
To separate menu items with a line, enable Render Line Before Menu.  
5. Create another function. Name the function 'OA Bill Summary Page' or as  
appropriate.  
6. Select the 'Enabled' check box to enable the function.  
7. Select the Conditions Tab and enter the following details.  
Select the Trigger event. It must be same as the one specified in the Menu,  
SpecialXX.  
From the Type list, select Builtin.  
For Builtin Type, select Launch a Function.  
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-15  
   
In the Function Code field, enter XNB_OA_ACCT_BILL_SUMMARY.  
In the Parameters field, enter  
='AccountNumber='||:CUSTOMER_HEADER_BLK.CUST_ACCOUNT_NUMB  
ER  
Accessing the Bill Summary UI from Oracle Contact Center  
To access the Bill Summary UI, select an account from Oracle Contact Center. From the  
Tool or More Tools menu, select the menu that you had set up in the previous  
procedure. The Bill summary UI appears.  
Loading Bill Summary Data  
Data must be uploaded at required intervals to the XNB_BILL_SUMMARIES table for  
billing details to be displayed accurately in the Bill Summary. Load the data at the end  
of every billing cycle. To upload the data, call the bill summary APIs. Refer Bill  
Summary Bulk Insert APIs for details, page B-1.  
Integration with Order Management Workflow Processes  
Oracle TBI works in conjunction with the following Order Management Workflow  
processes:  
XNBFLOWS.ACCOUNT_PROCESS: Publishes new account information.  
The XNBFLOWS.SALES_ORDER_PROCESS: Publishes the sales order (line)  
information.  
XNBFLOWS.GROUP_SALESORDER_PUBLISH: Publishes the Group Sales Order  
information.  
Integrating Workflow Process for Publishing Account Information  
When an order is created for a new account (an account that has not been published to  
the billing system) in Order Management, the Order Management header flow uses the  
Business Event System to trigger the TBI account publish process. The TBI account  
publish process generates the XML and loads it into the AQ. You must create the  
workflow function for publishing accounts. The figure below shows the workflow  
process for publishing account information.  
3-16 Oracle Telecommunications Billing Integrator Implementation Guide  
               
Workflow Process for Publishing Account Information  
Navigation: In WorkFlow Builder, open the OM Order Header (OEOH) workflow.  
Notes  
Enter the following parameters:  
Internal Name: XNB_ACCOUNT_PUBLISH  
Display Name: XNB Account Publish  
Function Name: xnb_cmn_pvt.publish_account_info  
Integrating Workflow Process for Publishing Sales Order Information  
When an order is created in Oracle Order Management, the Order Management order  
line flow uses the Business Event System to trigger the TBI sales order publish process.  
Each Sales Order line is an individual XML message because each order line  
corresponds to an item ordered by a customer. The figure below gives the workflow  
process for publishing sales order information.  
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-17  
   
Workflow Process for Publishing Sales Order Information  
Integrating Workflow Process for Publishing Sales Order Information involves the  
following:  
1. Defining Sales Order Line Profile Values, page 3-18  
2. Creating the Workflow Function, page 3-19  
Note: GSO and Sales Order Line are mutually exclusive.  
Defining Sales Order Line Profile Option  
The profile option to set the sales order line is XNB: Account Republish. The values are:  
NEVER: Account information in the sales order line is published only if that  
account was never published. This is the default value.  
ALWAYS: Account information in the sales order line is published till all the billing  
applications (in case of multiple Billing Applications) send a confirmation BOD  
with status SUCCESS to the Oracle E-Business Suite.  
ONERROR: Account information in the sales order line is published only if a failure  
confirmation BOD with status ERROR was sent by at least one of the billing  
applications and that billing application has not sent a confirmation BOD with  
status SUCCESS in the past.  
3-18 Oracle Telecommunications Billing Integrator Implementation Guide  
   
Creating the Workflow Function  
Create the workflow function for publishing sales order information.  
Navigation: In WorkFlow Builder, open the OM Order Line (OEOL) workflow.  
Notes  
Internal Name: XNB_SALESORDER_PUBLISH  
Display Name: XNB Sales Order Publish  
Function Name: xnb_cmn_pvt.publish_salesorder_info  
Integrating Workflow Process for Publishing Group Sales Order  
Information  
Create the workflow function for publishing group sales order information. The figure  
below shows the workflow process for publishing Group Sales Order Information.  
Workflow Process for Publishing Group Sales Order Information  
Navigation: In Workflow Builder, open the OM Order Header (OEOH) workflow.  
Notes  
Enter the following parameters for the new function:  
Internal Name: XNB_GRP_SALESORDER_PUBLISH  
Display Name: XNB Group Sales Order Publish  
Function Name: xnb_cmn_pvt.publish_grpsalesorder_info  
Setting Up and Running the Item Publish Concurrent Program  
You must have the System Administrator responsibility and the Telecommunications  
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-19  
         
Billing Integrator Administrator responsibility to setup and run the concurrent program  
for Oracle TBI.  
Setting up and running the item publish concurrent program involves:  
1. Defining Item Batch Export Profile Values.  
2. Submitting the Item Publish Request.  
Item Batch Export Profile Values  
The following table lists the profile values for Item Batch Export Profile.  
Item Batch Export Profile Values  
Profile Option  
Value  
XNB: Items Batch Message Type  
The values are:  
CSV Batch File: Generates a batch file in  
Comma Separated Values format.  
XML Batch File: Generates a batch file in  
XML format.  
XML Message: Generates an XML  
message for each inventory item and is  
published through the middleware.  
XNB: Items Batch File Location  
Name of the folder in which TBI generates the  
Inventory Items Batch file (XML or CSV). The  
file is generated by the Item Batch Export  
Concurrent Request. This is required if the  
XNB: Items Batch Message Type profile value  
is set to CSV Batch File or XML Batch File.  
The following table lists the seeded values for Item Batch Export concurrent program.  
Seeded Values for Item Batch Export Concurrent Program  
Name  
Value  
Program  
Telecom Billing Integrator Items Publish  
3-20 Oracle Telecommunications Billing Integrator Implementation Guide  
 
Name  
Value  
Short Name  
Application  
Executable  
XNB_ITEMS_PUBLISH  
Telecommunications Billing Integrator  
XNB_ITEMS_PUBLISH  
Submitting the Item Publish Request  
Update the billing application each time an item is added or updated in the inventory.  
You can do this in two ways:  
1. Use the batch mode which supports CSVs and XML files.  
2. Publish the details in a real time asynchronous mode using Item Publish Flow  
'XNBFLOWS.ITEM_PROCESS'. TBI uses the workflow process to publish the  
item/product information.  
For both options, use the Item Batch Export concurrent program. Select the items that  
need to be published based on the parameters of the concurrent program which initiate  
the item publish flow. Only the items that are invoiceable  
(INVOICEABLE_ITEM_FLAG = N) by the external billing applications are published.  
Select the TBI Administrator responsibility to submit an item publish request.  
Navigation: Requests > Submit Request.  
Notes  
Request Name: Select 'Telecommunications Billing Integrator Items Publish'.  
Billing Application: Name of the hub entity code of the billing application.  
From Date: Publishes all items updated between the from date and the current date.  
Inventory Organization: Inventory organization of the items to be published/exported.  
Inventory Category Set: Inventory category set of the items to be published/exported.  
Inventory Category: Inventory category of the items to be published/exported.  
Subscribing to Account Update Events  
TBI allows you to subscribe to a set of TCA events. When the subscribed event occurs,  
TBI verifies if the account updated in TCA is relevant to the billing system. If so, TBI  
publishes the account XML message to the billing system. The qualifier within the XML  
message is marked with a "U" next to the updated information.  
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-21  
     
Navigation: TBI Setup > Subscribe to Events > Account Update Events.  
Supported Events  
The following table lists the supported events.  
Sl.  
No  
Event Name  
Event Display Name  
Description  
1
2
3
4
5
6
7
8
9
oracle.apps.ar.hz.CustAcctSiteUse. CustomerAccount Site  
create Usage Create  
Triggered when a new  
customer account site  
usage is created.  
oracle.apps.ar.hz.CustAcctSiteUse. CustomerAccount Site  
update Usage Update  
Triggered when a  
customer account site  
usage is updated.  
oracle.apps.ar.hz.CustAcctRelate.c Related Accounts  
reate Create  
Triggered when a new  
customer account  
relation is created.  
oracle.apps.ar.hz.CustAcctRelate.u Related Accounts  
pdate Update  
Triggered when a  
customer account  
relation is updated.  
oracle.apps.ar.hz.CustProfileAmt.c Customer Profile  
reate Amounts Create  
Triggered when a new  
customer profile  
amount is created.  
oracle.apps.ar.hz.CustProfileAmt.u Customer Profile  
Triggered when a  
customer profile  
amount is updated.  
pdate  
Amounts Update  
oracle.apps.ar.hz.CustAccount.up  
date  
Customer Account  
Update  
Triggered when a  
customer account  
information is updated.  
oracle.apps.ar.hz.Person.update  
Person Update  
Triggered when Party  
Details of type Person  
is updated.  
oracle.apps.ar.hz.Organization.up  
date  
Organization Update  
Triggered when Party  
Details of type  
Organization is  
updated.  
3-22 Oracle Telecommunications Billing Integrator Implementation Guide  
 
Sl.  
No  
Event Name  
Event Display Name  
Description  
10  
oracle.apps.ar.hz.CustomerProfile. Customer Profile  
Triggered when  
Customer Profile  
details are updated.  
update  
Update  
11  
oracle.apps.ar.hz.ContactPoint.up  
date  
Contact Points Update  
Triggered when  
Contact Point details  
are updated.  
Configuring the Middleware  
Oracle TBI uses generic XML gateway compatible Advance Queues (AQ) for all  
outgoing and incoming messages. They are:  
1. WF_JMS_IN: This inbound queue is used for all inbound messages that are sent to  
TBI. Once the billing application receives the message, it sends a Confirmation  
Business Object Document (CBOD) with appropriate status to the Middleware,  
which queues it onto the WF_JMS_IN. The Workflow Agent configured on the  
WF_JMS_IN queue picks up the message and calls the workflow handlers to  
process the message.  
2. WF_JMS_OUT: This is the JMS Outbound queue that processes outbound  
transactions. The Account XML message generated in JMS Format is published to  
the JMS Outbound queue (WF_JMS_OUT). The Collaboration history is updated to  
reflect the account message publish status.  
Note: If Oracle Applications Interconnect (OAI 9.0.4) is used as the  
middleware, refer Appendix A for details on configuring OAI 9.0.4. If a  
non-OAI middleware is used, refer to the respective documentation for  
the configuration details.  
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-23  
   
A
Configuring Oracle Applications  
InterConnect  
This appendix provides information on configuring Oracle Applications InterConnect  
(OAI).  
This appendix covers the following topics:  
Oracle Applications InterConnect Overview  
Oracle Applications InterConnect (OAI 9.0.4) is the middleware for TBI. The  
components of OAI applicable to TBI are: OAI Hub and OAI Adapter for Advanced  
Queues (AQ).  
The OAI Hub contains all the mapping and transformation data required for integration  
in its repository. The repository is maintained in an Oracle database on the hub  
machine. The OAI adapter is attached to an application participating in the integration  
and is responsible for transfer of data from and to the respective application and the  
OAI hub. Each adapter performs the necessary data transformation based on the OAI  
repository metadata.  
Configuring OAI as the middleware for TBI involves:  
1. Setting Up OAI Hub, page A-2  
2. Setting up OAI Adapter for Advanced Queues, page A-3  
3. Dropping the Hub Schema, page A-4  
Configuring Oracle Applications InterConnect A-1  
         
4. Importing OAI maps to the Repository, page A-5  
Setting Up OAI Hub  
Use this procedure to set up the OAI hub.  
1. Choose the hub machine.  
2. Install Oracle 9iR2 database version 9.2.0.2.1 or higher on the hub machine. Use  
Oracle Database Configuration Assistant to create an empty database instance to  
serve as the hub repository. Set the following parameters:  
HOST: SID: PORT information for the new database instance.  
Passwords for system and users for the new database instance.  
TNS name entry for the new database instance.  
3. Install Oracle Applications InterConnect Hub version 9.0.4.0.1 on the hub machine.  
The OAI Hub must be installed in a separate Oracle Home. Provide the following  
details:  
Hub DB Parameters: Provide the Host/Port/SID information.  
Schema Names: Default name for the OAI hub repository schema is  
'oaihub904'.  
4. Provide the following schema details:  
Schema: Oaihub904, owf_mgr  
Schema User Name: oaihub904, Owf_mgr  
Password: <hub_user_password>, <workflow_user_password>  
5. To create database objects in the hub schema, change folder to  
OAI_HOME/oai/9.0.4/repository.  
6. Run the following command: hubschema - create system/<system_user_pwd>  
<hub_user_pwd> <HubDB_TNS_Name>  
7. Run the following script to start the repository service:  
<OAI_HOME>/oai/9.0.4/repository/start  
8. To stop the repository service, use the following command:  
<OAI_HOME>/oai/9.0.4/repository/stop  
A-2 Oracle Telecommunications Billing Integrator Implementation Guide  
   
Setting up OAI Adapter for Advanced Queues  
The Advanced Queuing Adapter (AQ Adapter) allows an instance of E-Business Suite  
to send or receive information to and from the OAI Hub. The AQ adapter connects to  
the E-Business Suite database and OAI Hub. It reads and writes into the advanced  
queues in the E-Business database.  
Use this procedure to install and setup the OAI Adapter for Advanced Queues.  
1. Install Oracle Application Server InterConnect AQ Adapter v.9.0.4. Provide the  
following details:  
Hub DB parameters (Host/ Port/ SID): Connection information to the hub  
database.  
Password: Password of the hub schema user.  
App Name: Used to identify an application participating in the integration.  
Every instance of an AQ adapter is associated with a particular application.  
Example: ORA_APPS.  
Application Spoke DB (Host/ Port/ SID): Connection information to the  
application database on which the advanced queues are configured. This  
information usually pertains to an applications database instance. For example:  
(myserver.domain.com:<port number>:mySID).  
Spoke Application Database User and Password: User name and password to  
connect to the Application Spoke DB.  
Consumer: WF_JMS_OUT  
2. After installation, ensure that the aq_bridge_owner parameter in the adapter.ini file  
is set to the schema name in the Spoke DB (Example: "APPLSYS").  
3. Optionally, to configure the adapter after installation, customize the parameters in  
the adapter.ini file. Locate the adapter.ini file in  
<OAI_HOME>/oai/9.0.4/adapters/<ADAPTER_NAME> folder on the host.  
OAI_HOME is the Oracle home of OAI and ADAPTER_NAME is the application  
name given to the adapter. Edit the following parameters in adapter.ini file:  
application: The application name given to the adapter.  
aq_bridge_host: The host name of the Application Spoke DB.  
aq_bridge_port: The DB port of the Application Spoke DB.  
aq_bridge_instance: The SID of the Application Spoke DB.  
Configuring Oracle Applications InterConnect A-3  
   
aq_bridge_username: The username to connect to the Spoke DB.  
encrypted_aq_bridge_password: The encrypted password of the  
aq_bridge_username. To encrypt a password, use the  
OAI_HOME/oai/9.0.4/bin/encrypt utility from the console. This utility generates  
cipher text and prints it on the console, which can be copied to the adapter.ini  
file.  
aq_bridge_owner: The name of the schema to which the AQs in the spoke  
database belongs. This value should be set to a valid schema name before the  
adapter is started.  
4. Optionally, you can configure the following parameters to improve the  
performance of the adapter:  
agent_pipeline_to_hub = false  
agent_pipeline_from_hub = false  
agent_log_level = 0  
5. Copy the DTDs from APPL_TOP at the following location: $XNB_TOP/xml/oag72,  
and place them in the home folder of the adapter on the host file system, i.e.  
<OAI_HOME>/oai/9.0.4/adapters/<ADAPTER_NAME>. The AQ Adapter requires  
the DTDs of the XML messages that it reads and writes into the AQs.  
6. To start an adapter service, run the following script from the console:  
<OAI_HOME>/oai/9.0.4/adapters/<ADAPTER_NAME>/start  
7. To stop an adapter service, run the following script from the console:  
<OAI_HOME>/oai/9.0.4/adapters/<ADAPTER_NAME>/stop  
Note: The following file contains the log of adapter activities:  
<OAI_HOME>/oai/9.0.4/adapters/<ADAPTER_NAME>/logs/<latest_ti  
mestamp>/oailog.txt  
Dropping the Hub Schema  
To drop the hub schema, you must stop the adapters and the repository service. The  
steps are:  
1. Run the following script from the console to stop the adapters:  
<OAI_HOME>/oai/9.0.4/adapters/<ADAPTER_NAME>/stop  
A-4 Oracle Telecommunications Billing Integrator Implementation Guide  
       
2. Run the following script from the console to stop the repository service:  
<OAI_HOME>/oai/9.0.4/repository/stop  
3. Run the following script at the command prompt:  
<OAI_HOME>/oai/9.0.4/repository/hubschema –drop  
system/<system_user_pwd> <hub_user_pwd> <HubDB_TNS_Name>  
Importing OAI Maps to the Repository  
Seeded integration maps are provided as database export files. This metadata must be  
imported into an existing OAI 9.0.4 hub repository. Before importing the OAI maps to  
the repository, you must drop the existing Hub Schema.  
Use this procedure to import an OAI map.  
1. Run the following script at the command prompt:  
<OAI_HOME>/oai/9.0.4/repository/oaiimport <IntegrationMap_file>  
<hub_user_name> system/<system_user_pwd> <hub_user_pwd>  
<HubDB_TNS_Name>  
Note: The values are:  
hub_user_name: Hub schema owner user name. Default is  
oaihub904.  
IntegrationMap_file: The path to the database export file  
containing the map.  
HubDB_TNS_Name: The TNS entry for the database.  
2. If the repository service stops, run the following script to start the repository  
service:  
<OAI_HOME>/oai/9.0.4/repository/start  
3. If the adapter service stops, run the following script from the console to start the  
adapter service:  
<OAI_HOME>/oai/9.0.4/adapters/<ADAPTER_NAME>/start  
Configuring Oracle Applications InterConnect A-5  
   
B
APIs in Telecommunications Billing  
Integrator  
This appendix provides information on the APIs in TBI.  
This appendix covers the following topics:  
Bill Summary Bulk Insert APIs  
Bill Summary Bulk Insert APIs  
The summary data in the Bill Summary UI is fetched from the XNB_BILL_SUMMARIES  
table in Oracle E-Business Suite. The XNB_BILL_SUMMARIES_PKG public package  
provides the API to do a bulk insert in the XNB Bill Summary tables.  
Procedure: INSERT_ROW_BATCH  
The INSERT_ROW_BATCH procedure is used to insert new bill summary records from  
external billing applications into Oracle E-Business Suite.  
Syntax: XNB_BILL_SUMMARIES_PKG.Insert_Row_Batch(p_api_version,  
bill_summaries, x_return_status, x_msg_data);  
The following table lists the parameters for the procedure.  
APIs in Telecommunications Billing Integrator B-1  
       
Procedure: INSERT_ROW_BATCH  
Parameter Name  
p_api_version  
IN /Out  
IN  
Data Type  
Description  
NUMBER  
Version of the API  
p_bill_summaries  
IN  
bill_summaries_table PL/SQL table type  
that contains the  
record type required  
for creating bill  
summaries.  
x_return_status  
OUT  
VARCHAR2  
Returns the status of  
the create operation.  
The values returned  
are:  
S: When the  
operation is a  
success.  
E: When the  
operation is not a  
success due to a  
known error.  
x_msg_data  
OUT  
VARCHAR2  
A concatenated string  
of all the error and  
warning messages  
that are put into the  
message stack.  
Procedure: UPDATE_ROW_BATCH  
The UPDATE_ROW_BATCH procedure is used to update existing bill summary  
records from external billing application into Oracle E-Business Suite.  
Syntax: XNB_BILL_SUMMARIES_PKG.Update_Row_Batch(p_api_version,  
bill_summaries, x_return_status, x_msg_data);  
The table below lists the parameters for the UPDATE_ROW_BATCH procedure.  
B-2 Oracle Telecommunications Billing Integrator Implementation Guide  
 
Procedure: UPDATE_ROW_BATCH  
Parameter Name In /Out Data Type  
Description  
p_api_version  
IN  
NUMBER  
Version of the API  
p_bill_summaries IN  
bill_summaries_table  
PL/SQL table type that contains the  
record type required for creating  
bill summaries.  
x_return_status  
OUT  
VARCHAR2  
Returns the status of the update  
operation. The values returned are:  
S : When the operation is a  
success.  
E: When the operation is not a  
success due to a known error.  
x_msg_data  
OUT  
VARCHAR2  
A concatenated string of all the  
error and warning messages that  
are put into the message stack.  
Bill Summary Public Table Type: BILL_SUMMARIES_TABLE  
The following table lists the specifications for the BILL_SUMMARIES_TABLE.  
Specifications for BILL_SUMMARIES_TABLE  
Table Type Name  
Record Type  
Description  
bill_summaries_table  
TABLE OF  
PL/SQL record type that  
contains all the attributes  
required for creating bill  
summaries.  
bill_summaries_rec  
Bill Summary Public Record Type: BILL_SUMMARIES_REC  
The following table lists the specifications for BILL_SUMMARIES_REC.  
APIs in Telecommunications Billing Integrator B-3  
   
Specifications for BILL_SUMMARIES_REC  
Attribute Name  
Data Type  
Description  
Mandatory attributes  
account_number  
VARCHAR2(30)  
Account Number of the  
customer that must exist in  
Oracle E-Business Suite. This  
field is mandatory for insert  
record.  
The foreign key is  
hz_cust_accounts.account_nu  
mber.  
bill_number  
VARCHAR2(30)  
Bill reference number. This  
field is for insert and update  
record and must be unique.  
billing_vendor_name  
bill_cycle_end_date  
VARCHAR2 (240)  
DATE  
Name of the billing vendor.  
Billing cycle contains an end  
date of the cycle. This is  
required for insert API only  
(not for update API).  
Optional Attributes  
-
-
total_amount_due  
VARCHAR2 (30)  
Total amount due for all open  
bills.  
adjustments  
VARCHAR2 (30)  
VARCHAR2 (30)  
Unapplied adjustments or  
payments up to this bill cycle.  
unresolved_disputes  
Total amount of open  
disputes.  
bill_cycle_start_date  
due_date  
DATE  
DATE  
Start date of the billing cycle.  
Timestamp indicating when  
the bill is due.  
new_charges  
VARCHAR2 (30)  
New charges for this bill.  
B-4 Oracle Telecommunications Billing Integrator Implementation Guide  
Attribute Name  
Data Type  
Description  
Payment  
VARCHAR2 (30)  
Total payment received on  
this bill up to this billing  
cycle.  
Balance  
VARCHAR2 (30)  
Balance for this bill, after the  
payments etc.  
previous_balance  
bill_location_url  
due_now  
VARCHAR2 (30)  
VARCHAR2 (240)  
VARCHAR2 (30)  
-
Location of the bill online.  
Amount currently due for an  
account.  
created_by  
NUMBER (15)  
NUMBER (15)  
NUMBER (15)  
NUMBER  
-
last_updated_by  
last_update_login  
object_version_number  
attribute_category  
-
-
Used for locking purposes.  
VARCHAR2 (30)  
Descriptive flexfield structure  
defining column  
attribute1 to attribute 15  
VARCHAR2 (150)  
Descriptive flexfield segment  
column  
APIs in Telecommunications Billing Integrator B-5  
C
Message Maps and DTDs for XML Gateway  
This appendix provides information on the message maps and DTDs for Oracle XML  
Gateway.  
This appendix covers the following topics:  
Maps and DTDs Overview  
TBI provides predefined maps and the corresponding DTDs for the XML Gateway. All  
the maps and DTDs are automatically loaded into the XML Gateway repository during  
the installation process and attached to the transactions in the XML Gateway.  
The map files are located at $XNB_TOP/patch/115/xml/US. $XNB_TOP is the top level  
folder for the TBI related files.  
The DTD files for TBI and OAGIS are located in $XNB_TOP/xml/oag72.  
Maps in XML Gateway  
The following table lists the maps in XML Gateway.  
Maps in XML Gateway  
Supported Flow  
Map Internal Name  
TCA Account Publish (Add and Update)  
OM Sales Order Publish  
XNB_TCA_ACCOUNT_OAG72_OUT.xgm  
XNB_OM_SALESORDER_OAG72_OUT.xgm  
Message Maps and DTDs for XML Gateway C-1  
   
Supported Flow  
Map Internal Name  
Inventory Item Publish  
XNB Confirm BOD  
XNB_INV_ITEM_OAG72_OUT.xgm  
XNB_CLN_CBOD_OAG72_IN.xgm  
OM Group Sales Order Publish  
XNB_OM_GRPSALESORDER_OAG72_OUT.  
xgm  
Note: The names of message maps are based on the internal names of  
the map and have an .xgm extension. For example, the file name for  
TCA Account Publish Map is  
XNB_TCA_ACCOUNT_OAG72_OUT.xgm.  
DTDs in XML Gateway  
DTDs in XML Gateway  
Map Internal Name  
DTD  
Root Element  
XNB_TCA_ACCTUPDATE_  
OAG72_OUT.xgm  
xnb_update_account_001.dtd CUSTOMER_ACCOUNT_001  
XNB_OM_SALESORDER_O  
AG72_OUT  
xnb_add_salesorder_001.dtd  
SALES_ORDER_001  
ITEM_SYNC_001  
XNB_INV_ITEM_OAG72_OU xnb_update_item_001.dtd  
T
XNB_CLN_CBOD_OAG72_I  
N
xnb_002_confirm_bod_004.dt CONFIRM_BOD_004  
d
XNB_OM_GRPSALESORDER xnb_add_grpsalesorder_001.d GRPSALES_ORDER_001  
_OAG72_OUT.xgm td  
Open Applications Group (OAG) Conforming DTDs  
TBI provides the following OAG conforming DTDs:  
oagis_domains.dtd  
C-2 Oracle Telecommunications Billing Integrator Implementation Guide  
oagis_entity_extensions.dtd  
oagis_extensions.dtd  
oagis_fields.dtd  
oagis_resources.dtd  
oagis_segments.dtd  
The OAG Integration Specification DTDs are available in $XNB_TOP/xml/oag72. This  
folder also contains the XNB-specific DTDs when they are loaded into the XML  
Gateway repository.  
Loading and Deleting Maps  
Maps can be reloaded manually into the repository using the XML Gateway Map  
loader. Run the following command, from the APPL_TOP to load the Map.  
$ java oracle.apps.ecx.loader.LoadMap <uname> <passwd> <host:port:sid>  
<map_name.xgm>  
To delete maps from the repository, run the following command:  
$ java oracle.apps.ecx.loader.DeleteMap <uname> <passwd> <host:port:sid>  
<map_internal_name>  
Loading and Deleting DTDs  
Every time a patch is applied and the existing DTDs are updated or new DTDs are  
introduced, the DTDs are automatically loaded to the repository so there is no need to  
load them manually. For more information on loading DTDs and maps, refer Oracle  
XML Gateway User's Guide. The OAG conformant DTDs need not be loaded into the  
repository.  
Before loading the TBI Specific DTDs, ensure that the OAGIS DTDs are present in the  
same directory.  
To load the DTDs while debugging, open the '$XNB_TOP/xml/oag72' directory under  
APPL_TOP and run the following command:  
$ java oracle.apps.ecx.loader.LoadDTDToClob <uname> <passwd>  
<host:port:sid><dtd_name.dtd> <root_element> <runtime_location>  
To delete the DTD associated with a map, run the following command:  
$ java oracle.apps.ecx.loader.DeleteDTDFromClob <uname> <passwd>  
host:port:sid <dtd_name.dtd> <root_element> <runtime_location>  
The script values are:  
uname, passwd, host, port, sid: Database connection parameters.  
Message Maps and DTDs for XML Gateway C-3  
   
dtd_name.dtd : TBI specific DTDs.  
root_element: root element of the DTD.  
runtime_location: Set to xnb/oag72  
C-4 Oracle Telecommunications Billing Integrator Implementation Guide  
D
XML Messages in TBI  
This appendix provides information on the XML messages in TBI.  
This appendix covers the following topics:  
Message Specifications for Product/Item  
XML Message Overview  
TBI uses XML Gateway to generate XML messages. The XML messages in TBI conform  
to the Open Applications Group Integration Specifications (OAGIS) standard and are  
published as OAG Business Object Documents (BODs) to the external billing  
applications.  
A BOD contains the following:  
1. Control Area (CNTROLAREA): This is the header area defining the identification of  
the message, the purpose, the sender details, and the time stamp information. All  
BODs have the same structure for the Control Area.  
2. Data Area (DATAAREA): The data area contains the business specific data that is  
being communicated by the BOD. This area defines the actual business object, such  
XML Messages in TBI D-1  
     
as the TCA account or the OM Sales Order. The structure and content of this area  
varies based on the DTD for each message.  
Outbound and Inbound BOD  
TBI provides the XML DTDs for all the messages exchanged between E-Business Suite  
and the external billing applications. These DTDs must be used to define BODs in the  
messaging middleware. TBI generates outbound BODs corresponding to:  
1. TCA Account (Add and Update)  
2. OM Sales Order  
3. Inventory Item  
4. Grouped Sales Order  
There is only one inbound BOD for TBI. This is the ConfirmBOD (CBOD). The CBOD is  
used by the billing application to return the status of processing the outbound BODs.  
Note: The DTDs for BODs must be used along with the OAG based  
DTDs to define the business objects in the messaging middleware. The  
OAG based DTDs are modified to include extensions for TBI.  
XML Message Format  
Oracle XML Gateway generates the TBI outbound messages and they are delivered as  
Advanced Queue payloads. The inbound messages (CBOD messages) from a billing  
application must contain information that the E-Business Suite can use to track success  
or failure of a published outbound message.  
Outbound Messages  
The outbound messages publish information on the Oracle E-Business Suite objects,  
such as customers, products, sales orders, and so on to the external billing applications.  
Messages are delivered to the Outbound AQ: XNB_JMS_OUTBOUND queue and are  
picked up by the middleware adapters from the queue.  
JMS Message Structure  
The table below lists the structure of the JMS standard message.  
D-2 Oracle Telecommunications Billing Integrator Implementation Guide  
     
JMS Message Structure  
HEADER  
Main Header  
HEADER.REPLYTO  
HEADER.REPLYTO.NAME  
HEADER.REPLYTO.ADDRESS  
HEADER.REPLYTO.PROTOCOL  
HEADER.USERID  
HEADER.APPID  
Reply to Information  
Name of the Application Replied To  
Address of the Application Replied To  
Protocol Used in Replying  
User Id  
Application Id  
HEADER.GROUPID  
HEADER.GROUPSEQ  
HEADER.PROPERTIES  
TEXT_LEN  
Group Id  
Group Sequence  
Properties  
Length of the Payload  
Has the Payload If TEXT_LEN < 4000 bytes  
Has the Payload If TEXT_LEN > 4000 bytes  
TEXT_VC  
LOB  
JMS Message Header Properties for CBOD  
The message properties contains fields that identify the type of message, the standard it  
uses, the entity that the message refers to, the sender details, the transportation, and the  
authentication information. In CBOD messages, XML Gateway refers these properties  
to identify the correct map to execute.  
The following table explains the properties that are published in the Advanced Queue  
message.  
XML Messages in TBI D-3  
Fields in the Advanced Queue Message  
Field  
Value  
ECX_MESSAGE_TYPE  
XML  
ECX_MESSAGE_STANDARD  
ECX_TRANSACTION_TYPE  
ECX_TRANSACTION_SUBTYPE  
ECX_PARTY_SITE_ID  
OAG  
BOD  
CONFIRM  
Sender Billing application  
oracle.apps.ecx.jms.receive (Seeded)  
Unique key for every run  
BES_EVENT_NAME  
BES_EVENT_KEY  
Inbound Messages  
Inbound messages contain acknowledgements for the published messages or  
information on the bill summary.  
The Confirm BOD message generated by a billing application is another BOD and  
follows the OAG definition for a BOD. This message contains a control area as well as a  
data area.  
The value of CNTROLAREA.SENDER.COMPONENT in the  
inbound messages should correspond to the XML Gateway hub  
user identification (Hub Entity Code) that is set for the respective  
external billing application. TBI uses this field to identify the billing  
application that sent a given confirm BOD.  
The DATAAREA.CONFIRM_BOD.CONFIRM.CNTROLAREA  
field should contain the control area of the message being  
confirmed. For example, if a CBOD is confirming a TCA account  
message, this field should contain the control area of the account  
message. The SENDER.REFERENCEID field is used by the XML  
Gateway to identify the message being confirmed. The control area  
of the message being confirmed can be copied exactly in this field.  
The DATAAREA.CONFIRM_BOD.CONFIRM.STATUSLVL field  
D-4 Oracle Telecommunications Billing Integrator Implementation Guide  
 
contains the status of the processing done on the message being  
confirmed. If the status is '00', it indicates that the processing was  
successful. If the status is '99', it indicates that the processing was a  
failure.  
XML Messages in TBI D-5  
Structure of the CBOD XML Message  
Structure of the CBOD XML Message  
<?xml version = ''1.0'' standalone = ''no''?>  
<!DOCTYPE CONFIRM_BOD_004 SYSTEM "xnb_002_confirm_bod_004.dtd">  
<CONFIRM_BOD_004>  
<CNTROLAREA>  
<BSR>  
<VERB value="CONFIRM">CONFIRM</VERB>  
<NOUN value="BOD">BOD</NOUN>  
<REVISION value="004">004</REVISION>  
</BSR>  
<SENDER>  
<LOGICALID>NO_VALUE(SNDR)</LOGICALID>  
<COMPONENT>BILLAPP_1</COMPONENT>  
<TASK>CONFIRM</TASK>  
<REFERENCEID>NO_VALUE(REF)</REFERENCEID>  
<CONFIRMATION>0</CONFIRMATION>  
<LANGUAGE>en</LANGUAGE>  
<CODEPAGE>ISO 8859-1</CODEPAGE>  
<AUTHID>NO_VALUE(AUTHID)</AUTHID>  
</SENDER>  
<DATETIME qualifier="CREATION">  
<YEAR>2004</YEAR>  
<MONTH>05</MONTH>  
<DAY>12</DAY>  
<HOUR>11</HOUR>  
<MINUTE>12</MINUTE>  
<SECOND>39</SECOND>  
<SUBSECOND>1010</SUBSECOND>  
<TIMEZONE>+0000</TIMEZONE>  
</DATETIME>  
</CNTROLAREA>  
<DATAAREA>  
<CONFIRM_BOD>  
<CONFIRM>  
<CNTROLAREA>  
<BSR>  
<VERB value="ADD">ADD</VERB>  
<NOUN value="ACCOUNT">ACCOUNT</NOUN>  
<REVISION value="001">001</REVISION>  
</BSR>  
<SENDER>  
<LOGICALID>ORACLE</LOGICALID>  
<COMPONENT>XNB</COMPONENT>  
<TASK>AAO</TASK>  
<REFERENCEID>C12X4MST.US.ORACLE.COM:oracle.apps.xnb.salesorder.create:XN  
B:SALESORDER_LINE : 43125:294654</REFERENCEID>  
<CONFIRMATION>2</CONFIRMATION>  
<LANGUAGE>US</LANGUAGE>  
<CODEPAGE>UTF8</CODEPAGE>  
<AUTHID>APPS</AUTHID>  
</SENDER>  
<DATETIME qualifier="CREATION">  
<YEAR>2005</YEAR>  
<MONTH>01</MONTH>  
<DAY>04</DAY>  
<HOUR>21</HOUR>  
<MINUTE>06</MINUTE>  
D-6 Oracle Telecommunications Billing Integrator Implementation Guide  
<SECOND>06</SECOND>  
<SUBSECOND>0000</SUBSECOND>  
<TIMEZONE>+0000</TIMEZONE>  
</DATETIME>  
</CNTROLAREA>  
<STATUSLVL>00</STATUSLVL>  
<DESCRIPTN>THE BOD WAS PROCESSED SUCCESSFULLY</DESCRIPTN>  
</CONFIRM>  
</CONFIRM_BOD>  
</DATAAREA>  
</CONFIRM_BOD_004>  
Seeded XML Messages  
TBI provides seeded XML messages for the following:  
Account information  
Sales order information  
Item information  
GSO  
Message Specifications for Account Information  
The following table lists the message specifications for account information.  
Message Specifications for Account  
XML Tag  
XML Parent Tag  
Field in E-Business  
Suite  
Description  
ACCOUNT_INFO  
DATAAREA  
Account information  
CUST_ACCOUNT_I  
D
ACCOUNT_INFO  
HZ_CUST_ACCOUN Customer account  
TS.  
identifier.  
CUST_ACCOUNT_I  
D
ACCOUNT_NUMBE ACCOUNT_INFO  
R
HZ_CUST_ACCOUN Account Number.  
TS.  
ACCOUNT_NUMBE  
R
STATUS  
ACCOUNT_INFO  
HZ_CUST_ACCOUN Customer status flag.  
TS. STATUS  
XML Messages in TBI D-7  
     
ACCOUNT_NAME  
DATETIME  
ACCOUNT_INFO  
ACCOUNT_INFO  
HZ_CUST_ACCOUN Description chosen by  
TS.  
external party.  
ACCOUNT_NAME  
HZ_CUST_ACCOUN Date when the  
TS.  
customer account was  
ACCOUNT_ESTABLI originally established.  
SHED_DATE  
TAX_CODE  
ACCOUNT_INFO  
ACCOUNT_INFO  
HZ_CUST_ACCOUN Tax code for this  
TS. TAX_CODE  
customer.  
TAX_HEADER_LEV  
EL  
HZ_CUST_ACCOUN Indicate if item is tax  
TS.  
header or a line item.  
TAX_HEADER_LEV  
EL_FLAG  
_FLAG  
HOLD_BILL_FLAG  
ACCOUNT_INFO  
ACCOUNT_INFO  
HZ_CUST_ACCOUN Indicates if the bill  
TS.  
receivable should be  
held or not.  
HOLD_BILL_FLAG  
ACCOUNT_EXT  
_ATTRIBUTES  
Extended Attributes  
-
ATTRIBUTE1 to  
ATTRIBUTE15  
ACCOUNT_EXT_  
ATTRIBUTES  
HZ_CUST_ACCOUN Descriptive Flexfield  
TS. ATTRIBUTE1 to  
HZ_CUST_ACCOUN  
TS. ATTRIBUTE15  
segment for Account.  
RELATED_ACCOUN DATAAREA  
TS  
Related Accounts  
Information  
-
RELATED_CUST  
_ACCOUNT_ID  
RELATED_ACCOUN HZ_CUST_ACCT_RE Related Customer  
TS  
LATE_ALLRELATED Account Id  
_CUST_ACCOUNT_I  
D
RELATED_CUST  
RELATED_ACCOUN HZ_CUST_ACCOUN Related Customer  
TS  
TS.ACCOUNT_NUM Account Number.  
BER  
_ACCOUNT_NUMB  
ER  
RELATED_CUST  
RELATED_ACCOUN HZ_CUST_ACCOUN Related Customer  
TS  
TS.ACCOUNT_NAM Account Name  
E
_ACCOUNT_NAME  
D-8 Oracle Telecommunications Billing Integrator Implementation Guide  
RELATIONSHIP_TY  
PE  
RELATED_ACCOUN HZ_CUST_ACCT_RE Relationship Type  
TS  
LATE_ALL.  
RELATIONSHIP_TY  
PE  
ORG_ID  
RELATED_ACCOUN HZ_CUST_ACCT_RE Organization Id  
TS LATE_ALL.ORG_ID  
BILL_TO_FLAG  
RELATED_ACCOUN HZ_CUST_ACCT_RE Bill To Relationship  
TS  
LATE_ALL.BILL_TO Flag  
_FLAG  
SHIP_TO_FLAG  
RELATED_ACCOUN HZ_CUST_ACCT_RE Ship To Relationship  
TS  
LATE_ALL.SHIP_TO Flag  
_FLAG  
TAX_EXEMPTIONS  
EXEMPTION_TYPE  
DATAAREA  
Tax Data  
-
TAX_EXEMPTIONS  
RA_TAX_EXEMPTIO Exemptions can be  
NS_ALL.  
for customers at a  
location, or for items  
at a location.  
EXEMPTION_TYPE  
STATUS  
TAX_EXEMPTIONS  
TAX_EXEMPTIONS  
TAX_EXEMPTIONS  
RA_TAX_EXEMPTIO Approval status for  
NS_ALL. STATUS this exemption.  
TAX_CODE  
RA_TAX_EXEMPTIO Tax code that this  
NS_ALL. TAX_CODE exemption applies to.  
PERCENT_EXEMPT  
RA_TAX_EXEMPTIO Percentage that is  
NS_ALL.  
exempt from tax.  
PERCENT_EXEMPT  
CUSTOMER_EXEMP TAX_EXEMPTIONS  
TION  
RA_TAX_EXEMPTIO Exemption certificate  
NS_ALL.  
number.  
CUSTOMER_EXEMP  
TION  
_NUMBER  
_NUMBER  
DATETIME  
TAX_EXEMPTIONS  
RA_TAX_EXEMPTIO Last date that this  
NS_ALL.  
exemption is  
effective.  
END_DATE  
XML Messages in TBI D-9  
DATETIME  
TAX_EXEMPTIONS  
TAX_EXEMPTIONS  
RA_TAX_EXEMPTIO First date that this  
NS_ALL.  
exemption is  
effective.  
START_DATE  
REASON_CODE  
RA_TAX_EXEMPTIO The reason for this  
NS_ALL.  
exemption.  
REASON_CODE  
EXEMPT_PERCENT1 TAX_EXEMPTIONS  
EXEMPT_PERCENT2 TAX_EXEMPTIONS  
EXEMPT_PERCENT3 TAX_EXEMPTIONS  
EXEMPT_PERCENT4 TAX_EXEMPTIONS  
RECEIPT_METHODS DATAAREA  
RA_TAX_EXEMPTIO Percentage of the  
NS_ALL. exemption to apply to  
EXEMPT_PERCENT1 this portion of the  
Sales Tax Location  
Flexfield.  
RA_TAX_EXEMPTIO Percentage of the  
NS_ALL.  
exemption to apply to  
EXEMPT_PERCENT2 this portion of the  
Sales Tax Location  
Flexfield.  
RA_TAX_EXEMPTIO Percentage of the  
NS_ALL.  
exemption to apply to  
EXEMPT_PERCENT3 this portion of the  
Sales Tax Location  
Flexfield.  
RA_TAX_EXEMPTIO Percentage of the  
NS_ALL.  
exemption to apply to  
EXEMPT_PERCENT4 this portion of the  
Sales Tax Location  
Flexfield.  
Various Receipt  
Methods  
-
CUST_RECEIPT_ME  
THOD  
RECEIPT_METHODS RA_CUST_RECEIPT_ Uniquely identifies  
METHODS.CUST_RE the customer receipt  
CEIPT_METHOD_ID method.  
_ID  
RECEIPT_METHOD_ RECEIPT_METHODS RA_CUST_RECEIPT_ Identifies the receipt  
ID  
METHODS.RECEIPT method identifier.  
_METHOD_ID  
D-10 Oracle Telecommunications Billing Integrator Implementation Guide  
RECEIPT_METHOD_ RECEIPT_METHODS AR_RECEIPT_METH Receipt Method  
NAME  
ODS.  
Name  
RECEIPT_METHOD_  
NAME  
PRIMARY_FLAG  
DATETIME  
DATETIME  
RECEIPT_METHODS RA_CUST_RECEIPT_ Indicates if customer  
METHODS.PRIMAR  
Y_FLAG  
receipt method is  
primary.  
RECEIPT_METHODS RA_CUST_RECEIPT_ Start date of the  
METHODS.START_D customer receipt  
ATE  
methods  
RECEIPT_METHODS RA_CUST_RECEIPT_ End date of the  
METHODS.END_DA customer receipt  
TE  
methods  
CUSTOMER_INFO  
PARTY_NUMBER  
DATAAREA  
Customer Personal  
Information  
-
CUSTOMER_INFO  
HZ_PARTIES.PARTY Unique identification  
_NUMBER  
number for the  
customer  
PARTY_NAME  
PARTY_TYPE  
CUSTOMER_INFO  
CUSTOMER_INFO  
HZ_PARTIES.PARTY Customer Name  
_NAME  
HZ_PARTIES.PARTY The party type can  
_TYPE  
only be Person,  
Organization, Group  
or Relationship.  
TAX_REFERENCE  
CUSTOMER_INFO  
HZ_PARTIES.TAX_R Taxpayer registration  
EFERENCE  
number, also known  
as the VAT number.  
JGZZ_FISCAL_CODE CUSTOMER_INFO  
HZ_PARTIES.JGZZ_  
FISCAL_CODE  
Taxpayer  
identification  
number, a unique  
identifier of person or  
organization. This can  
be: SSN or income  
taxpayer ID in the US,  
fiscal code or NIF in  
Europe.  
XML Messages in TBI D-11  
EMAIL_ADDRESS  
CUSTOMER_INFO  
CUSTOMER_INFO  
HZ_PARTIES.EMAIL Email Address  
_ADDRESS  
CUSTOMER_NAME  
Name of the  
Customer  
-
PERSON_IDENTIFIE CUSTOMER_NAME  
R
HZ_PARTIES.PERSO Personal identifier,  
N_IDENTIFIER  
such as driver's  
license or passport  
number.  
PERSON_TITLE  
CUSTOMER_NAME  
HZ_PARTIES.PERSO A professional or  
N_TITLE  
family title. For  
example, Don or The  
Right Honorable.  
PERSON_PRE_NAM CUSTOMER_NAME  
E_  
HZ_PARTIES.PERSO Salutary introduction,  
N_PRE_NAME_ADJ  
UNCT  
such as Mr. or Herr.  
ADJUNCT  
PERSON_FIRST_NA  
ME  
CUSTOMER_NAME  
CUSTOMER_NAME  
HZ_PARTIES.PERSO First name of the  
N_FIRST_NAME person  
PERSON_MIDDLE_  
NAME  
HZ_PARTIES.PERSO Middle name of the  
N_MIDDLE_NAME person  
PERSON_LAST_NA  
ME  
CUSTOMER_NAME  
HZ_PARTIES.PERSO Last or surname of  
N_LAST_NAME the person  
PERSON_NAME_SU CUSTOMER_NAME  
FFIX  
HZ_PARTIES.PERSO Indicates the place in  
N_NAME_SUFFIX  
a family structure.  
For example, in Tom  
Jones III, the "III" is  
the suffix.  
SALUTATION  
ADDRESS  
CUSTOMER_INFO  
CUSTOMER_INFO  
HZ_PARTIES.SALUT Phrase used to  
ATION  
address a party in any  
correspondence.  
Identifying Address  
-
D-12 Oracle Telecommunications Billing Integrator Implementation Guide  
ADDRLINE  
ADDRESS  
CONTACT(  
Identifying Address  
Line of the Customer  
HZ_PARTIES.ADDR  
ESS1;  
HZ_PARTIES.ADDR  
ESS2;  
HZ_PARTIES.ADDR  
ESS3;  
HZ_PARTIES.ADDR  
ESS4)  
CITY  
ADDRESS  
ADDRESS  
HZ_PARTIES.CITY  
City  
COUNTRY  
HZ_PARTIES.COUN Country  
TRY  
COUNTY  
ADDRESS  
HZ_PARTIES.COUN County  
TY  
STATEPROVN  
POSTALCODE  
ADDRESS  
ADDRESS  
HZ_PARTIES.STATE State  
HZ_PARTIES.POSTA Postal code  
L_CODE  
CUSTOMER_EXT_A  
TTRIBUTES  
CUSTOMER_INFO  
Customer Extended  
Attributes  
-
ATTRIBUTE1 to  
ATTRIBUTE15  
CUSTOMER_EXT_  
ATTRIBUTES  
HZ_PARTIES.ATTRI Descriptive Flexfield  
BUTE1 to segment for  
HZ_PARTIES.ATTRI Customer  
BUTE15  
RELATIONSHIP_INF CUSTOMER_INFO  
O
Customer  
--  
Relationship  
Information  
PARENT_PARTY_ID RELATIONSHIP_INF HZ_PARTIES.PARTY Parent Customer Id  
_ID  
O
PARENT_PARTY_N  
AME  
RELATIONSHIP_INF HZ_PARTIES.PARTY Parent Customer  
O
_NAME  
Name  
XML Messages in TBI D-13  
PARENT_RELATIO  
NSHIP_TYPE  
RELATIONSHIP_INF HZ_RELATIONSHIP Either a forward or a  
S. backward  
O
RELATIONSHIP_CO relationship code  
DE  
DATETIME  
RELATIONSHIP_INF HZ_RELATIONSHIP Date relationship  
O
S.END_DATE  
ends  
CUSTOMER_CONT  
ACT_INFO  
CUSTOMER_INFO  
Customer Contact  
Information  
-
CONTACT_POINT_I CUSTOMER_CONT  
HZ_CONTACT_POI  
Identifier for the  
D
ACT  
NTS.CONTACT_POI customer contact  
NT_TYPE  
point.  
_INFO  
CONTACT_POINT_T CUSTOMER_CONT  
HZ_CONTACT_POI  
Lookup:  
YPE  
ACT  
NTS.CONTACT_POI CONTACT_POINT_T  
NT_TYPE  
YPE of phone, fax,  
e-mail, web, telex, or  
EDI  
_INFO  
PRIMARY  
CUSTOMER_CONT  
ACT  
HZ_CONTACT_POI  
NTS.PRIMARY_FLA  
G
Flag to Identify the  
Primary Contact  
Information.  
_INFO  
EDI_TRANSACTION CUSTOMER_CONT  
HZ_CONTACT_POI  
NTS.EDI_TRANSAC  
TION_HANDLING  
ANSI standard code  
for EDI transaction  
type  
ACT  
_HANDLING  
_INFO  
EDI_ID_NUMBER  
CUSTOMER_CONT  
ACT  
HZ_CONTACT_POI  
EDI trading partner  
NTS.EDI_ID_NUMBE number for the  
R
supplier site  
_INFO  
EDI_PAYMENT_ME  
THOD  
CUSTOMER_CONT  
ACT  
HZ_CONTACT_POI  
Indicates how a  
NTS.EDI_PAYMENT payment is to be  
_METHOD  
made through EDI.  
Valid methods are  
ACH and BOP.  
_INFO  
D-14 Oracle Telecommunications Billing Integrator Implementation Guide  
EDI_PAYMENT_FOR CUSTOMER_CONT  
HZ_CONTACT_POI  
Indicates type of  
MAT  
ACT  
NTS.EDI_PAYMENT information being  
_FORMAT  
transmitted with the  
funds if using  
_INFO  
EDI_PAYMENT_ME  
THOD ACH. Valid  
values are CCD, CCP,  
CHZ, CTX, PPD, and  
PPP.  
EMAIL_ADDRESS  
CUSTOMER_CONT  
ACT  
HZ_CONTACT_POI  
E-mail address of the  
NTS.EMAIL_ADDRE contact point  
SS  
_INFO  
URL  
CUSTOMER_CONT  
ACT  
HZ_CONTACT_POI  
NTS.URL  
Uniform resource  
locator  
_INFO  
PHONE_LINE_TYPE CUSTOMER_CONT  
ACT  
HZ_CONTACT_POI  
NTS.PHONE_LINE_  
TYPE  
Lookup code for the  
type of phone line.  
For example, general,  
fax, inbound, or  
outbound.  
_INFO  
PHONE_NUMBER  
CUSTOMER_CONT  
ACT  
HZ_CONTACT_POI  
A telephone number  
NTS.PHONE_NUMB formatted in the local  
ER  
format. The number  
should not include  
area code, country  
code, or extension  
_INFO  
PHONE_COUNTRY_ CUSTOMER_CONT  
HZ_CONTACT_POI  
International country  
CODE  
ACT  
NTS.PHONE_COUN code for a telephone  
TRY_CODE  
number. For example,  
33 for France.  
_INFO  
PHONE_AREA_COD CUSTOMER_CONT  
HZ_CONTACT_POI  
The area code within  
E
ACT  
NTS.PHONE_AREA_ a country code.  
CODE  
_INFO  
PHONE_EXTENSIO  
N
CUSTOMER_CONT  
ACT  
HZ_CONTACT_POI  
NTS.PHONE_AREA_  
CODE  
-
_INFO  
XML Messages in TBI D-15  
PARTY_GROUP  
CUSTOMER_CONT  
ACT  
Party Group Code  
-
_INFO  
GROUP  
PARTY_GROUP  
AST_PARTY_CLASSI Classification code  
FICATION_V.CLASS  
_CODE  
BANK_ACCOUNT_I DATAAREA  
NFO  
Bank Account  
Information  
-
BANK_ACCOUNT  
_NUMBER  
BANK_ACCOUNT_I IBY_EXT_BANK_AC Bank Account  
NFO  
COUNTS.BANK_AC Number  
COUNT_NUM  
BANK_ACCOUNT_  
NAME  
BANK_ACCOUNT_I IBY_EXT_BANK_AC Bank Account Name  
NFO  
COUNTS.  
BANK_ACCOUNT_  
NAME  
BANK_BRANCH_ID BANK_ACCOUNT_I IBY_EXT_BANK_AC Bank Branch  
NFO  
COUNTS.  
Identifier  
BRANCH_ID  
CURRENCY_CODE  
BANK_ACCOUNT_I IBY_EXT_BANK_AC Currency Code  
NFO  
COUNTS.  
CURRENCY_CODE  
ACCOUNT_HOLDE  
R
BANK_ACCOUNT_I HZ_PARTIES.  
NFO PARTY_NAME  
Account Holder  
Name  
_NAME  
DATETIME  
BANK_ACCOUNT_I IBY_PMT_INSTR_US Inactive Date  
NFO ES_ALL. END_DATE  
BANK_NUMBER  
BANK_ACCOUNT_I HZ_ORGANIZATIO Bank Number  
NFO  
N_PROFILES.  
BANK_OR_BRANCH  
_NUMBER  
ADDRESS  
DATAAREA  
Bill To Address  
-
D-16 Oracle Telecommunications Billing Integrator Implementation Guide  
ADDRLINE  
ADDRESS  
CONTACT(  
Bill To Address Line  
of the Account  
HZ_LOCATIONS.AD  
DRESS1;HZ_LOCATI  
ONS.ADDRESS2;HZ_  
LOCATIONS.ADDRE  
SS3;HZ_LOCATIONS  
.
ADDRESS4)  
CITY  
ADDRESS  
ADDRESS  
ADDRESS  
ADDRESS  
ADDRESS  
HZ_LOCATIONS.CI  
TY  
City  
COUNTRY  
COUNTY  
HZ_LOCATIONS.CO Country  
UNTRY  
HZ_LOCATIONS.CO County  
UNTY  
STATEPROVN  
POSTALCODE  
HZ_LOCATIONS.ST State  
ATE  
HZ_LOCATIONS.  
POSTAL_CODE  
Postalcode  
CUST_PROFILE_AM DATAAREA  
TS_INFO  
Customer Profile  
-
Amounts Information  
CUST_ACCT_PROFI CUST_PROFILE_AM HZ_CUST_PROFILE_ Profile Amount  
LE_AMT_ID  
TS_INFO  
AMTS.  
Identifier  
CUST_ACCT_PROFI  
LE_AMT_ID  
CURRENCY_CODE  
AMOUNT  
CUST_PROFILE_AM HZ_CUST_PROFILE_ Currency code  
TS_INFO  
AMTS.  
CURRENCY_CODE  
CUST_PROFILE_AM HZ_CUST_PROFILE_ Transaction Credit  
TS_INFO  
AMTS.  
Limit  
TRX_CREDIT_LIMIT  
XML Messages in TBI D-17  
AMOUNT  
AMOUNT  
AMOUNT  
CUST_PROFILE_AM HZ_CUST_PROFILE_ Over All Credit limit  
TS_INFO  
AMTS.  
OVERALL_CREDIT_  
LIMIT  
CUST_PROFILE_AM HZ_CUST_PROFILE_ Minimum dunning  
TS_INFO  
AMTS.  
amount  
MIN_DUNNING_A  
MOUNT  
CUST_PROFILE_AM HZ_CUST_PROFILE_ Minimum invoice  
TS_INFO  
AMTS.  
amount  
MIN_DUNNING_IN  
VOICE_AMOUNT  
MAX_INTEREST_CH CUST_PROFILE_AM HZ_CUST_PROFILE_ Maximum interest  
ARGE  
TS_INFO  
AMTS.  
charge  
MAX_INTEREST_CH  
ARGE  
AMOUNT  
CUST_PROFILE_AM HZ_CUST_PROFILE_ Minimum statement  
TS_INFO  
AMTS.  
amount  
MIN_STATEMENT_  
AMOUNT  
AMOUNT  
CUST_PROFILE_AM HZ_CUST_PROFILE_ Minimum receipt  
TS_INFO  
AMTS.  
amount  
AUTO_REC_MIN_R  
ECEIPT_AMOUNT  
INTEREST_RATE  
AMOUNT  
CUST_PROFILE_AM HZ_CUST_PROFILE_ Interest rate  
TS_INFO  
AMTS.  
INTEREST_RATE  
CUST_PROFILE_AM HZ_CUST_PROFILE_ Minimum balance  
TS_INFO  
AMTS.  
amount  
MIN_FC_BALANCE_  
AMOUNT  
AMOUNT  
CUST_PROFILE_AM HZ_CUST_PROFILE_ Minimum invoice  
TS_INFO  
AMTS.  
amount  
MIN_FC_INVOICE_  
AMOUNT  
D-18 Oracle Telecommunications Billing Integrator Implementation Guide  
DATETIME  
CUST_PROFILE_AM HZ_CUST_PROFILE_ Expiration date  
TS_INFO  
AMTS.  
EXPIRATION_DATE  
ATTRIBUTE_CATEG CUST_PROFILE_AM HZ_CUST_PROFILE_ Attribute category  
ORY  
TS_INFO  
AMTS.  
ATTRIBUTE_CATEG  
ORY  
PROFILE_AMTS_EX  
CUST_PROFILE_AM Profile Amounts  
-
TENDED_ATTRIBUT TS_INFO  
ES  
Extended Attributes  
ATTRIBUTE1 to  
ATTRIBUTE15  
PROFILE_AMTS_EX  
HZ_CUST_PROFILE_ Extended Attributes  
TENDED_ATTRIBUT AMTS. ATTRIBUTE1  
ES  
to ATTRIBUTE15  
CREDIT_CLASSIFIC  
ATION_INFO  
DATAAREA  
Credit classification  
information  
-
CUST_ACCOUNT_P CREDIT_CLASSIFIC  
ROFILE_ID ATION_INFO  
HZ_CUSTOMER_PR Credit Classification  
OFILES.  
identifier  
CUST_ACCOUNT_P  
ROFILE_ID  
CREDIT_CHECKING CREDIT_CLASSIFIC  
ATION_INFO  
HZ_CUSTOMER_PR Credit checking flag  
OFILES.  
CREDIT_CHECKING  
DATETIME  
CREDIT_CLASSIFIC  
ATION_INFO  
HZ_CUSTOMER_PR Next credit review  
OFILES.  
date  
NEXT_CREDIT_REVI  
EW_DATE  
TOLERANCE  
CREDIT_CLASSIFIC  
ATION_INFO  
HZ_CUSTOMER_PR Tolerance  
OFILES.  
TOLERANCE  
CREDIT_HOLD  
CREDIT_RATING  
CREDIT_CLASSIFIC  
ATION_INFO  
HZ_CUSTOMER_PR Credit hold flag  
OFILES.  
CREDIT_HOLD  
CREDIT_CLASSIFIC  
ATION_INFO  
HZ_CUSTOMER_PR Credit rating  
OFILES.  
CREDIT_RATING  
XML Messages in TBI D-19  
STANDARD_TERMS CREDIT_CLASSIFIC  
ATION_INFO  
HZ_CUSTOMER_PR Standard terms  
OFILES.  
STANDARD_TERMS  
OVERRIDE_TERMS  
DATETIME  
CREDIT_CLASSIFIC  
ATION_INFO  
HZ_CUSTOMER_PR Override terms  
OFILES.  
OVERRIDE_TERMS  
CREDIT_CLASSIFIC  
ATION_INFO  
HZ_CUSTOMER_PR Last credit review  
OFILES.  
date  
LAST_CREDIT_REVI  
EW_DATE  
CREDIT_CLASSIFIC  
ATION  
CREDIT_CLASSIFIC  
ATION_INFO  
HZ_CUSTOMER_PR Credit classification  
OFILES.  
CREDIT_CLASSIFIC  
ATION  
CREDIT_EXTENDED CREDIT_CLASSIFIC  
Credit classification  
extended attributes  
-
_ATTRIBUTES  
ATION_INFO  
ATTRIBUTE1 to  
ATTRIBUTE15  
CREDIT_EXTENDED HZ_CUSTOMER_PR Extended attributes  
_ATTRIBUTES  
OFILES.  
ATTRIBUTE1 to  
ATTRIBUTE15  
Message Specifications for Sales Order Line  
The following table lists the specifications for sales order line information.  
Message Specifications for Sales Order Line  
XML TagT  
XML Parent Tag  
Field in E-Business  
Suite  
Description  
ORDER_LINE_INFO DATAAREA  
Sales order line  
information  
-
ORDER_LINE_ID  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Primary Key to  
identify the Order  
Line  
LINE_ID  
D-20 Oracle Telecommunications Billing Integrator Implementation Guide  
 
TOP_MODEL_LINE_ ORDER_LINE_INFO OE_ORDER_LINES_  
Identifier of  
ID  
ALL.  
configuration top  
parent line  
TOP_MODEL_LINE_  
ID  
LINK_TO_LINE_ID  
ORDER_NUMBER  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Identifier of  
immediate parent  
component line  
LINK_TO_LINE_ID  
ORDER_HEADER_I  
NFO  
OE_ORDER_HEADE Unique Identifier for  
RS_ALL.ORDER_NU Order  
MBER  
SOLD_TO_PARTY_  
NUMBER  
ORDER_HEADER_I  
NFO  
HZ_PARTIES.  
Unique Identifier for  
Customer  
PARTY_NUMBER  
SOLD_TO_  
ORDER_HEADER_I  
NFO  
HZ_PARTIES.PARTY Customer Name  
_NAME  
PARTY_NAME  
SOLD_TO_ACCOUN ORDER_HEADER_I  
HZ_CUST_ACCOUN Unique Identifier for  
T_  
NFO  
TS.  
Account  
NUMBER  
ACCOUNT_NUMBE  
R
SOLD_TO_ACCOUN ORDER_HEADER_I  
HZ_CUST_ACCOUN Account Name  
TS.  
T_  
NFO  
NAME  
ACCOUNT_NAME  
PRICE_LIST_ID  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Price List  
PRICE_LIST_ID  
PRICE_LIST_NAME  
ORDER_LINE_INFO QP_LIST_HEADERS_ Price List Name used  
VL.DESCRIPTION  
to identify the Price  
List Name  
INVENTORY_ITEM_ ORDER_LINE_INFO OE_ORDER_LINES_  
Inventory Item Id  
ID  
ALL.  
INVENTORY_ITEM_  
ID  
XML Messages in TBI D-21  
INVENTORY_ITEM_ ORDER_LINE_INFO MTL_SYSTEM_ITEM Name of the Product  
NAME S_VL.SEGMENT1  
INVENTORY_ITEM_ ORDER_LINE_INFO MTL_SYSTEM_ITEM Description of the  
DESCRIPTION  
S_VL.DESCRIPTION Product  
ORG_ID  
ORDER_LINE_INFO OE_ORDER_LINES_  
Operating Unit which  
ALL.  
performed this  
transaction  
ORG_ID  
DATETIME  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Determines effective  
list and price  
modifiers  
PRICING_DATE  
UNIT_SELLING_PRI ORDER_LINE_INFO OE_ORDER_LINES_  
Actual price charged  
to customer  
CE  
ALL.  
UNIT_SELLING_PRI  
CE  
UNIT_LIST_PRICE  
QUANTITY  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Price List price for the  
item  
UNIT_LIST_PRICE  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Quantity Ordered  
ORDERED_QUANTI  
TY  
QUANTITY  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Quantity based on  
pricing unit of  
measure  
PRICING_QUANTIT  
Y
INVOICE_TO_ORG_I ORDER_LINE_INFO OE_ORDER_LINES_  
Invoice To  
D
ALL.  
Organization ID  
INVOICE_TO_ORG_I  
D
D-22 Oracle Telecommunications Billing Integrator Implementation Guide  
SHIP_TO_ORG_ID  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Ship To Organization  
ID  
SHIP_TO_ORG_ID  
ACTION  
ORDER_LINE_INFO OE_TRANSACTION Type of Service  
_TYPES_TL.ACTION performed on the  
Order  
CURRENCY_CODE  
ORDER_LINE_INFO QP_LIST_HEADERS_ Currency Code  
VL.CURRENCY_CO  
DE  
CHARGE_PERIODIC ORDER_LINE_INFO OE_ORDER_LINES_  
Charge Periodicity  
Code  
ITY_CODE  
ALL.CHARGE_PERI  
ODICITY_CODE  
CHARGE_PERIODIC ORDER_LINE_INFO MTL_UOM_CONVE  
Charge Periodicity  
ITY_CODE_DESC  
RSIONS.UNIT_OF_M Code Description  
EASURE  
ADDRESS  
ORDER_LINE_INFO OE_ORDER_LINES_  
Ship To Address  
ALL  
.SHIP_TO_ORG_ID  
ADDRLINE  
ADDRESS  
CONCAT(  
Ship To Address Line  
of the Account  
HZ_LOCATIONS.AD  
DRESS1;HZ_LOCATI  
ONS.ADDRESS2;HZ_  
LOCATIONS.ADDRE  
SS3;HZ_LOCATIONS  
.
ADDRESS4)  
CITY  
ADDRESS  
ADDRESS  
ADDRESS  
HZ_LOCATIONS.CI  
TY  
City  
COUNTRY  
COUNTY  
HZ_LOCATIONS.CO Country  
UNTRY  
HZ_LOCATIONS.CO County  
UNTY  
XML Messages in TBI D-23  
STATEPROVN  
POSTALCODE  
ADDRESS  
ADDRESS  
HZ_LOCATIONS.ST State  
ATE  
HZ_LOCATIONS.  
POSTAL_CODE  
Postalcode  
TAX_INFO  
TAX_CODE  
ORDER_LINE_INFO Tax Information  
-
TAX_INFO  
TAX_INFO  
TAX_INFO  
TAX_INFO  
OE_ORDER_LINES_  
ALL.  
Tax code for the line  
TAX_CODE  
TAX_RATE  
DATETIME  
AMOUNT  
OE_ORDER_LINES_  
ALL.  
Tax rate in percentage  
TAX_RATE  
OE_ORDER_LINES_  
ALL.  
Date for tax  
calculation  
TAX_DATE  
OE_ORDER_LINES_  
ALL.  
Tax amount in order  
currency  
TAX_VALUE  
PAYMENT_TERM_I  
NFO  
ORDER_LINE_INFO Payment term  
Information  
-
PAYMENT_TERM_I  
D
PAYMENT_TERM_I  
NFO  
OE_ORDER_LINES_  
Payment Term  
ALL.PAYMENT_TER Identifier  
M_ID  
PAYMENT_TERM_N PAYMENT_TERM_I  
RA_TERMS_VL.NA  
ME  
Payment Term Name  
AME  
NFO  
DESCRIPTION  
PAYMENT_TERM_I  
NFO  
RA_TERMS_VL.DES  
CRIPTION  
Payment Term  
Description  
EXT_ATTRIBUTES  
ORDER_LINE_INFO Order Line Extended  
Attributes  
-
D-24 Oracle Telecommunications Billing Integrator Implementation Guide  
ATTRIBUTE1 to  
ATTRIBUTE15  
EXT_ATTRIBUTES  
OE_ORDER_LINES_  
ALL.  
Descriptive Flexfield  
segments for Order  
Line  
ATTRIBUTE1 to  
ATTRIBUTE15  
INSTALL_BASE_INF DATAAREA  
O
INSTALL_BASE_INF  
O
-
INSTANCE_ID  
INSTALL_BASE_INF CSI_ITEM_INSTANC Unique ID that  
O
ES.  
identifies an item unit  
instance  
INSTANCE_ID  
INSTANCE_NAME  
DATETIME  
INSTALL_BASE_INF CSI_ITEM_INSTANC Used to describe the  
O
ES.INSTANCE_DESC Instance Id  
RIPTION  
INSTALL_BASE_INF CSI_ITEM_INSTANC Installation Date for  
O
ES.  
an Instance.  
INSTALL_DATE  
DATETIME  
INSTALL_BASE_INF CSI_ITEM_INSTANC Activation Start Date  
O
ES.  
ACTIVE_START_DA  
TE  
DATETIME  
QUANTITY  
INSTALL_BASE_INF CSI_ITEM_INSTANC Activation End Date  
O
ES.  
ACTIVE_END_DATE  
INSTALL_BASE_INF CSI_ITEM_INSTANC Quantity  
O
ES.  
QUANTITY  
INSTALL_LOCATIO INSTALL_BASE_INF CSI_ITEM_INSTANC Install Location  
N_ID  
O
ES.  
Identifier  
INSTALL_LOCATIO  
N_ID  
XML Messages in TBI D-25  
LAST_OE_ORDER_L INSTALL_BASE_INF CSI_ITEM_INSTANC Last Order Line  
INE_ID  
O
ES.  
Identifier that  
touched the instance  
LAST_OE_ORDER_L  
INE_  
ID  
ADDRESS  
INSTALL_BASE_INF CSI_ITEM_INSTANC Install At Address  
O
ES.  
INSTALL_AT_ADDR  
ESS  
ATTRIBUTE_VALUE INSTALL_BASE_INF Attribute Value Pairs  
-
-
S
O
of Install Base  
ATTRIBUTE_INFO  
ATTRIBUTE_VALUE Attribute Information  
S
ATTRIBUTE_ID  
ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Attribute Identifier  
TTRIBS.ATTRIBUTE_  
ID  
ATTRIBUTE_LEVEL  
ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Attribute Level  
TTRIBS.ATTRIBUTE_  
LEVEL  
MASTER_ORGANIZ ATTRIBUTE_INFO  
ATION_ID  
CSI_I_EXTENDED_A Master Organization  
TTRIBS.MASTER_OR Identifier  
GANIZATION_ID  
INVENTORY_ITEM_ ATTRIBUTE_INFO  
ID  
CSI_I_EXTENDED_A Inventory Item  
TTRIBS.INVENTORY Identifier  
_ITEM_ID  
ITEM_CATEGORY_I ATTRIBUTE_INFO  
D
CSI_I_EXTENDED_A Item Category  
TTRIBS.ITEM_CATE  
GORY_ID  
Identifier  
ATTRIBUTE_CODE  
ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Attribute Code  
TTRIBS.ATTRIBUTE_  
CODE  
D-26 Oracle Telecommunications Billing Integrator Implementation Guide  
ATTRIBUTE_NAME  
ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Attribute Name  
TTRIBS.ATTRIBUTE_  
NAME  
ATTRIBUTE_CATEG ATTRIBUTE_INFO  
ORY  
CSI_I_EXTENDED_A Attribute Category  
TTRIBS.ATTRIBUTE_  
CATEGORY  
DESCRIPTION  
ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Description  
TTRIBS.DESCRIPTIO  
N
ACTIVE_START_DA ATTRIBUTE_INFO  
TE  
CSI_I_EXTENDED_A Activation Start Date  
TTRIBS.ACTIVE_STA  
RT_DATE  
ACTIVE_END_DATE ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Activation End Date  
TTRIBS.ACTIVE_EN  
D_DATE  
SECURITY_GROUP_ ATTRIBUTE_INFO  
ID  
CSI_I_EXTENDED_A Security Group  
TTRIBS.SECURITY_G Identifier  
ROUP_ID  
VALUE_INFO  
ATTRIBUTE_VALUE Value Information  
-
S
ATTRIBUTE_VALUE VALUE_INFO  
_ID  
CSI_IEA_VALUES.A Instance Extended  
TTRIBUTE_VALUE_I Attribute Value  
D
Identifier.  
ATTRIBUTE_VALUE VALUE_INFO  
CSI_IEA_VALUES.A Instance Extended  
TTRIBUTE_VALUE Attribute Value.  
ACTIVE_START_DA VALUE_INFO  
TE  
CSI_IEA_VALUES.A Activation Start Date  
CTIVE_START_DAT  
E
ACTIVE_END_DATE VALUE_INFO  
CSI_IEA_VALUES.A Activation End Date  
CTIVE_END_DATE  
BILL_TO_PARTY_IN DATAAREA  
FO  
BILL_TO_PARTY_IN  
FO  
-
XML Messages in TBI D-27  
BILL_TO_OWNER_F BILL_TO_PARTY_IN HZ_PARTIES.BILL_T Bill To Owner Flag  
LAG FO O_OWNER_FLAG  
PRIMARY_BILL_TO_ BILL_TO_PARTY_IN HZ_PARTIES.PRIMA Primary Bill To Flag  
FLAG  
FO  
RY_BILL_TO_FLAG  
BILL_TO_PARTY_N  
UMBER  
BILL_TO_PARTY_IN HZ_PARTIES.PARTY Unique Identifier of  
FO _NUMBER the Customer  
BILL_TO_PARTY_N  
AME  
BILL_TO_PARTY_IN HZ_PARTIES.PARTY Customer Name  
FO _NAME  
BILL_TO_ACCOUNT BILL_TO_PARTY_IN HZ_CUST_ACCOUN Unique Identifier of  
_NUMBER  
FO  
TS.  
the Account  
ACCOUNT_NUMBE  
R
BILL_TO_ACCOUNT BILL_TO_PARTY_IN HZ_CUST_ACCOUN Account Name  
_NAME  
FO  
TS.  
ACCOUNT_NAME  
ADDRESS  
BILL_TO_PARTY_IN Bill To Address  
FO  
-
ADDRLINE  
ADDRESS  
CONCAT(  
Bill To Address Line  
of the Account  
HZ_LOCATIONS.AD  
DRESS1;HZ_LOCATI  
ONS.ADDRESS2;HZ_  
LOCATIONS.ADDRE  
SS3;HZ_LOCATIONS  
.
ADDRESS4)  
CITY  
ADDRESS  
ADDRESS  
ADDRESS  
HZ_LOCATIONS.CI  
TY  
City  
COUNTRY  
COUNTY  
HZ_LOCATIONS.CO Country  
UNTRY  
HZ_LOCATIONS.CO County  
UNTY  
D-28 Oracle Telecommunications Billing Integrator Implementation Guide  
STATEPROVN  
POSTALCODE  
ADDRESS  
ADDRESS  
HZ_LOCATIONS.ST State  
ATE  
HZ_LOCATIONS.  
POSTAL_CODE  
Postal code  
PARTY_EXT_ATTRI  
BUTES  
BILL_TO_PARTY_IN Party Extended  
-
FO  
Attributes  
ATTRIBUTE1 to  
ATTRIBUTE15  
PARTY_EXT_ATTRI  
BUTES  
HZ_PARTIES.ATTRI Descriptive Flexfield  
BUTE1 to segment for  
HZ_PARTIES.ATTRI Customer  
BUTE15  
ACCOUNT_EXT_AT BILL_TO_PARTY_IN Account Extended  
-
TRIBUTES  
FO  
Attributes  
ATTRIBUTE1 to  
ATTRIBUTE15  
ACCOUNT_EXT_AT HZ_CUST_ACCOUN Descriptive Flexfield  
TRIBUTES  
TS.  
segment for Account  
ATTRIBUTE1 to  
ATTRIBUTE15  
SHIP_TO_CONTACT DATAAREA  
_INFO  
Ship to Contact  
Information  
-
-
CONTACT_NAME  
SHIP_TO_CONTACT Ship to Contact Name  
_INFO  
PERSON_IDENTIFIE CONTACT_NAME  
R
HZ_PARTIES.PERSO Person Identifier  
N_IDENTIFIER  
PERSON_TITLE  
CONTACT_NAME  
HZ_PARTIES.PERSO Title  
N_TITLE  
PERSON_PRE_NAM CONTACT_NAME  
E_ADJUNCT  
HZ_PARTIES.PERSO Pre Name Adjunct  
N_PRE_NAME_ADJ  
UNCT  
PERSON_MIDDLE_  
NAME  
CONTACT_NAME  
CONTACT_NAME  
HZ_PARTIES.PERSO Middle Name  
N_MIDDLE_NAME  
PERSON_LAST_NA  
ME  
HZ_PARTIES.PERSO Last Name  
N_LAST_NAME  
XML Messages in TBI D-29  
PERSON_NAME_SU CONTACT_NAME  
FFIX  
HZ_PARTIES.PERSO Suffix  
N_NAME_SUFFIX  
SALUTATION  
SHIP_TO_CONTACT HZ_PARTIES.SALUT Salutation  
_INFO ATION  
CONTACT_INFO  
SHIP_TO_CONTACT Ship to Contact  
-
_INFO  
Information  
CONTACT_POINT_T CONTACT_INFO  
YPE  
HZ_CONTACT_POI  
NTS.CONTACT_POI  
NT_TYPE  
Contact Point Type  
EMAIL_ADDRESS  
CONTACT_INFO  
HZ_CONTACT_POI  
NTS.EMAIL_ADDRE  
SS  
Email Address  
Phone Purpose  
Country Code  
Area Code  
PHONE_LINE_TYPE CONTACT_INFO  
HZ_CONTACT_POI  
NTS.PHONE_LINE_  
TYPE  
PHONE_COUNTRY_ CONTACT_INFO  
CODE  
HZ_CONTACT_POI  
NTS.PHONE_COUN  
TRY_CODE  
PHONE_AREA_COD CONTACT_INFO  
E
HZ_CONTACT_POI  
NTS.PHONE_AREA_  
CODE  
PHONE_NUMBER  
CONTACT_INFO  
CONTACT_INFO  
CONTACT_INFO  
HZ_CONTACT_POI  
NTS.PHONE_NUMB  
ER  
Phone Number  
Extension  
PHONE_EXTENSIO  
N
HZ_CONTACT_POI  
NTS.PHONE_EXTEN  
SION  
URL  
HZ_CONTACT_POI  
NTS.URL  
Url  
Message Specifications for Product/Item  
The following table lists the specifications for product.  
D-30 Oracle Telecommunications Billing Integrator Implementation Guide  
   
Message Specifications for Product  
XML Tag  
Parent Component  
Field in E-Business  
Suite  
Description  
ITEM_INFO  
ITEMID  
DATAAREA  
ITEM_INFO  
Item Information  
-
MTL_SYSTEM_ITEM EBS Inventory Item  
S_VL.  
Identifier  
INVENTORY_ITEM_  
ID  
ITEM_NAME  
ITEM_INFO  
ITEM_INFO  
ITEM_INFO  
ITEM_INFO  
MTL_SYSTEM_ITEM EBS Inventory item  
S_VL.SEGMENT1  
ITEM_TYPE  
MTL_SYSTEM_ITEM Inventory Item Type  
S_VL.ITEM_TYPE  
ITEM_TYPE_DESC  
BOM_ITEM_TYPE  
FND_LOOKUP_VAL Inventory Item Type  
UES_VL.MEANING  
Description  
MTL_SYSTEM_ITEM E-Business Suite  
S_VL.  
BOM item type code.  
BOM_ITEM_TYPE  
BOM_ITYPE_DESC  
ITEM_INFO  
ITEM_INFO  
MFG_LOOKUPS.ME E-Business Suite  
ANING  
BOM item type  
description.  
UOM  
MTL_SYSTEM_ITEM Primary Unit of  
S_VL. Measure for the item  
PRIMARY_UNIT_OF in inventory  
_MEASURE  
ITEM_DESCRIPTION ITEM_INFO  
MTL_SYSTEM_ITEM Item/ Product  
S_VL. DESCRIPTION description  
ITEM_STATUS  
ITEM_INFO  
MTL_SYSTEM_ITEM Inventory Item status  
S_VL.  
code  
INVENTORY_ITEM_  
STATUS_CODE  
ITEM_STATUS_DES  
C
ITEM_INFO  
MTL_ITEM_STATUS. Inventory Item status  
DESCRIPTION  
description  
XML Messages in TBI D-31  
DATETIME  
ITEM_INFO  
MTL_SYSTEM_ITEM Start date for the item  
S_VL.  
START_DATE_ACTI  
VE  
DATETIME  
ITEM_INFO  
ITEM_INFO  
MTL_SYSTEM_ITEM End date for the item  
S_VL.  
END_DATE_ACTIVE  
ITEM_CLASS  
MTL_SYSTEM_ITEM Derive from the UOM  
S_VL.  
CLASS.  
PRIMARY_UOM_CO As this is not stored  
DE  
in any entity and it is  
derived from UOM  
we need to know all  
the distinct values of  
UOM  
ATTRIBUTE1 to  
ATTRIBUTE15  
ITEM_INFO  
MTL_SYSTEM_ITEM Descriptive Flexfield  
S_VL.ATTRIBUTE1  
to ATTRIBUTE15  
segment for Item  
Message Specifications For Group Sales Order Line  
The following table lists the message specifications for Group Sales Order Line.  
Message Specifications for Group Sales Order Line  
XML Tag  
XML Parent tag  
DATAAREA  
Field in E-Business  
Suite  
Description  
ORDER_HEADER_I  
NFO  
Order Header  
Information  
-
ORDER_NUMBER  
ORDER_HEADER_I  
NFO  
OE_ORDER_HEADE Unique Identifier for  
RS_ALL.ORDER_NU Order  
MBER  
D-32 Oracle Telecommunications Billing Integrator Implementation Guide  
 
SOLD_TO_ACCOUN ORDER_HEADER_I  
HZ_CUST_ACCOUN Unique Identifier for  
T_  
NFO  
TS.  
Account  
NUMBER  
ACCOUNT_NUMBE  
R
SOLD_TO_ACCOUN ORDER_HEADER_I  
HZ_CUST_ACCOUN Account Name  
TS.  
T_  
NFO  
NAME  
ACCOUNT_NAME  
SOLD_TO_PARTY_  
NUMBER  
ORDER_HEADER_I  
NFO  
HZ_PARTIES.  
Unique Identifier for  
Customer  
PARTY_NUMBER  
SOLD_TO_  
ORDER_HEADER_I  
NFO  
HZ_PARTIES.PARTY Customer Name  
_NAME  
PARTY_NAME  
ORDER_LINE  
ORDER_HEADER_I  
NFO  
Salesorder Line  
Informations  
-
-
ORDER_LINE_INFO ORDER_LINE  
Sales order line  
information  
ORDER_LINE_ID  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Primary Key to  
Identify the Order  
Line  
LINE_ID  
TOP_MODEL_LINE_ ORDER_LINE_INFO OE_ORDER_LINES_  
Identifier of  
ID  
ALL.  
configuration top  
parent line  
TOP_MODEL_LINE_  
ID  
LINK_TO_LINE_ID  
PRICE_LIST_ID  
PRICE_LIST_NAME  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Identifier of  
immediate parent  
component line  
LINK_TO_LINE_ID  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Price List  
PRICE_LIST_ID  
ORDER_LINE_INFO QP_LIST_HEADERS_ Price List Name used  
VL.DESCRIPTION  
to identify the Price  
List Name  
XML Messages in TBI D-33  
INVENTORY_ITEM_ ORDER_LINE_INFO OE_ORDER_LINES_  
Inventory Item Id  
ID  
ALL.  
INVENTORY_ITEM_  
ID  
INVENTORY_ITEM_ ORDER_LINE_INFO MTL_SYSTEM_ITEM Name of the Product  
NAME S_VL.SEGMENT1  
INVENTORY_ITEM_ ORDER_LINE_INFO MTL_SYSTEM_ITEM Description of the  
DESCRIPTION  
S_VL.DESCRIPTION Product  
ORG_ID  
ORDER_LINE_INFO OE_ORDER_LINES_  
Operating Unit which  
ALL.  
performed this  
transaction  
ORG_ID  
DATETIME  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Determines effective  
list and price  
modifiers  
PRICING_DATE  
UNIT_SELLING_PRI ORDER_LINE_INFO OE_ORDER_LINES_  
Actual price charged  
to customer  
CE  
ALL.  
UNIT_SELLING_PRI  
CE  
UNIT_LIST_PRICE  
QUANTITY  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Price List price for the  
item  
UNIT_LIST_PRICE  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Quantity Ordered  
ORDERED_QUANTI  
TY  
QUANTITY  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Quantity based on  
pricing unit of  
measure  
PRICING_QUANTIT  
Y
D-34 Oracle Telecommunications Billing Integrator Implementation Guide  
INVOICE_TO_ORG_I ORDER_LINE_INFO OE_ORDER_LINES_  
Invoice To  
D
ALL.  
Organization ID  
INVOICE_TO_ORG_I  
D
SHIP_TO_ORG_ID  
ORDER_LINE_INFO OE_ORDER_LINES_  
ALL.  
Ship To Organization  
ID  
SHIP_TO_ORG_ID  
ACTION  
ORDER_LINE_INFO OE_TRANSACTION Type of Service  
_TYPES_TL.ACTION performed on the  
Order  
CURRENCY_CODE  
ORDER_LINE_INFO QP_LIST_HEADERS_ Currency Code  
VL.CURRENCY_CO  
DE  
CHARGE_PERIODIC ORDER_LINE_INFO OE_ORDER_LINES_  
Charge Periodicity  
Code  
ITY_CODE  
ALL.CHARGE_PERI  
ODICITY_CODE  
CHARGE_PERIODIC ORDER_LINE_INFO MTL_UOM_CONVE  
Charge Periodicity  
ITY_CODE_DESC  
RSIONS.UNIT_OF_M Code Description  
EASURE  
ADDRESS  
ORDER_LINE_INFO OE_ORDER_LINES_  
Ship To Address  
ALL  
.SHIP_TO_ORG_ID  
ADDRLINE  
ADDRESS  
CONCAT(  
Ship To Address Line  
of the Account  
HZ_LOCATIONS.AD  
DRESS1;HZ_LOCATI  
ONS.ADDRESS2;HZ_  
LOCATIONS.ADDRE  
SS3;HZ_LOCATIONS  
.
ADDRESS4)  
CITY  
ADDRESS  
ADDRESS  
HZ_LOCATIONS.CI  
TY  
City  
COUNTRY  
HZ_LOCATIONS.CO Country  
UNTRY  
XML Messages in TBI D-35  
COUNTY  
ADDRESS  
ADDRESS  
ADDRESS  
HZ_LOCATIONS.CO County  
UNTY  
STATEPROVN  
POSTALCODE  
HZ_LOCATIONS.ST State  
ATE  
HZ_LOCATIONS.  
POSTAL_CODE  
Postalcode  
TAX_INFO  
TAX_CODE  
ORDER_LINE_INFO Tax Information  
-
TAX_INFO  
TAX_INFO  
TAX_INFO  
TAX_INFO  
OE_ORDER_LINES_  
ALL.  
Tax code for the line  
TAX_CODE  
TAX_RATE  
DATETIME  
AMOUNT  
OE_ORDER_LINES_  
ALL.  
The tax rate in  
percentage  
TAX_RATE  
OE_ORDER_LINES_  
ALL.  
It will store the date  
for tax calculation  
TAX_DATE  
OE_ORDER_LINES_  
ALL.  
The Tax amount in  
order currency  
TAX_VALUE  
PAYMENT_TERM_I  
NFO  
ORDER_LINE_INFO Payment term  
Information  
-
PAYMENT_TERM_I  
D
PAYMENT_TERM_I  
NFO  
OE_ORDER_LINES_  
Payment Term  
ALL.PAYMENT_TER Identifier  
M_ID  
PAYMENT_TERM_N PAYMENT_TERM_I  
RA_TERMS_VL.NA  
ME  
Payment Term Name  
AME  
NFO  
DESCRIPTION  
PAYMENT_TERM_I  
NFO  
RA_TERMS_VL.DES  
CRIPTION  
Payment Term  
Description  
D-36 Oracle Telecommunications Billing Integrator Implementation Guide  
EXT_ATTRIBUTES  
ORDER_LINE_INFO Order Line Extended  
Attributes  
-
ATTRIBUTE1 to  
ATTRIBUTE15  
EXT_ATTRIBUTES  
OE_ORDER_LINES_  
ALL.  
Descriptive Flexfield  
segment for Order  
Line  
ATTRIBUTE1  
INSTALL_BASE_INF ORDER_LINE  
O
INSTALL_BASE_INF  
O
-
INSTANCE_ID  
INSTALL_BASE_INF CSI_ITEM_INSTANC Unique ID that  
O
ES.  
identifies an item unit  
instance  
INSTANCE_ID  
INSTANCE_NAME  
DATETIME  
INSTALL_BASE_INF CSI_ITEM_INSTANC Used to describe the  
O
ES.INSTANCE_DESC Instance Id  
RIPTION  
INSTALL_BASE_INF CSI_ITEM_INSTANC Installation Date for  
O
ES.  
an Instance.  
INSTALL_DATE  
DATETIME  
INSTALL_BASE_INF CSI_ITEM_INSTANC Activation Start Date  
O
ES.  
ACTIVE_START_DA  
TE  
DATETIME  
QUANTITY  
INSTALL_BASE_INF CSI_ITEM_INSTANC Activation End Date  
O
ES.  
ACTIVE_END_DATE  
INSTALL_BASE_INF CSI_ITEM_INSTANC Quantity  
O
ES.  
QUANTITY  
INSTALL_LOCATIO INSTALL_BASE_INF CSI_ITEM_INSTANC Install Location  
N_ID  
O
ES.  
Identifier  
INSTALL_LOCATIO  
N_ID  
XML Messages in TBI D-37  
LAST_OE_ORDER_L INSTALL_BASE_INF CSI_ITEM_INSTANC Last Order Line  
INE_ID  
O
ES.  
Identifier that  
touched the Instance  
LAST_OE_ORDER_L  
INE_  
ID  
ADDRESS  
INSTALL_BASE_INF CSI_ITEM_INSTANC Install At Address  
O
ES.  
INSTALL_AT_ADDR  
ESS  
ATTRIBUTE_VALUE INSTALL_BASE_INF Attribute Value Pairs  
-
-
S
O
of Install Base  
ATTRIBUTE_INFO  
ATTRIBUTE_VALUE Attribute Information  
S
ATTRIBUTE_ID  
ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Attribute Identifier  
TTRIBS.ATTRIBUTE_  
ID  
ATTRIBUTE_LEVEL  
ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Attribute Level  
TTRIBS.ATTRIBUTE_  
LEVEL  
MASTER_ORGANIZ ATTRIBUTE_INFO  
ATION_ID  
CSI_I_EXTENDED_A Master Organization  
TTRIBS.MASTER_OR Identifier  
GANIZATION_ID  
INVENTORY_ITEM_ ATTRIBUTE_INFO  
ID  
CSI_I_EXTENDED_A Inventory Item  
TTRIBS.INVENTORY Identifier  
_ITEM_ID  
ITEM_CATEGORY_I ATTRIBUTE_INFO  
D
CSI_I_EXTENDED_A Item Category  
TTRIBS.ITEM_CATE  
GORY_ID  
Identifier  
ATTRIBUTE_CODE  
ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Attribute Code  
TTRIBS.ATTRIBUTE_  
CODE  
D-38 Oracle Telecommunications Billing Integrator Implementation Guide  
ATTRIBUTE_NAME  
ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Attribute Name  
TTRIBS.ATTRIBUTE_  
NAME  
ATTRIBUTE_CATEG ATTRIBUTE_INFO  
ORY  
CSI_I_EXTENDED_A Attribute Category  
TTRIBS.ATTRIBUTE_  
CATEGORY  
DESCRIPTION  
ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Description  
TTRIBS.DESCRIPTIO  
N
ACTIVE_START_DA ATTRIBUTE_INFO  
TE  
CSI_I_EXTENDED_A Activation Start Date  
TTRIBS.ACTIVE_STA  
RT_DATE  
ACTIVE_END_DATE ATTRIBUTE_INFO  
CSI_I_EXTENDED_A Activation End Date  
TTRIBS.ACTIVE_EN  
D_DATE  
SECURITY_GROUP_ ATTRIBUTE_INFO  
ID  
CSI_I_EXTENDED_A Security Group  
TTRIBS.SECURITY_G Identifier  
ROUP_ID  
VALUE_INFO  
ATTRIBUTE_VALUE Value Information  
-
S
ATTRIBUTE_VALUE VALUE_INFO  
_ID  
CSI_IEA_VALUES.A Instance Extended  
TTRIBUTE_VALUE_I Attribute Value  
D
Identifier.  
ATTRIBUTE_VALUE VALUE_INFO  
CSI_IEA_VALUES.A Instance Extended  
TTRIBUTE_VALUE Attribute Value.  
ACTIVE_START_DA VALUE_INFO  
TE  
CSI_IEA_VALUES.A Activation Start Date  
CTIVE_START_DAT  
E
ACTIVE_END_DATE VALUE_INFO  
CSI_IEA_VALUES.A Activation End Date  
CTIVE_END_DATE  
BILL_TO_PARTY_IN ORDER_LINE  
FO  
BILL_TO_PARTY_IN  
FO  
-
XML Messages in TBI D-39  
BILL_TO_OWNER_F BILL_TO_PARTY_IN HZ_PARTIES.BILL_T Bill To Owner Flag  
LAG FO O_OWNER_FLAG  
PRIMARY_BILL_TO_ BILL_TO_PARTY_IN HZ_PARTIES.PRIMA Primary Bill To Flag  
FLAG  
FO  
RY_BILL_TO_FLAG  
BILL_TO_PARTY_N  
UMBER  
BILL_TO_PARTY_IN HZ_PARTIES.PARTY Unique Identifier of  
FO _NUMBER the Customer  
BILL_TO_PARTY_N  
AME  
BILL_TO_PARTY_IN HZ_PARTIES.PARTY Customer Name  
FO _NAME  
BILL_TO_ACCOUNT BILL_TO_PARTY_IN HZ_CUST_ACCOUN Unique Identifier of  
_NUMBER  
FO  
TS.  
the Account  
ACCOUNT_NUMBE  
R
BILL_TO_ACCOUNT BILL_TO_PARTY_IN HZ_CUST_ACCOUN Account Name  
_NAME  
FO  
TS.  
ACCOUNT_NAME  
ADDRESS  
BILL_TO_PARTY_IN Bill To Address  
FO  
-
ADDRLINE  
ADDRESS  
CONCAT(  
Bill To Address Line  
of the Account  
HZ_LOCATIONS.AD  
DRESS1;HZ_LOCATI  
ONS.ADDRESS2;HZ_  
LOCATIONS.ADDRE  
SS3;HZ_LOCATIONS  
.
ADDRESS4)  
CITY  
ADDRESS  
ADDRESS  
ADDRESS  
HZ_LOCATIONS.CI  
TY  
City  
COUNTRY  
COUNTY  
HZ_LOCATIONS.CO Country  
UNTRY  
HZ_LOCATIONS.CO County  
UNTY  
D-40 Oracle Telecommunications Billing Integrator Implementation Guide  
STATEPROVN  
POSTALCODE  
ADDRESS  
ADDRESS  
HZ_LOCATIONS.ST State  
ATE  
HZ_LOCATIONS.  
POSTAL_CODE  
Postalcode  
PARTY_EXT_ATTRI  
BUTES  
BILL_TO_PARTY_IN Party Extended  
-
FO  
Attributes  
ATTRIBUTE1 to  
ATTRIBUTE15  
PARTY_EXT_ATTRI  
BUTES  
HZ_PARTIES.ATTRI Descriptive Flexfield  
BUTE1 to segment for  
HZ_PARTIES.ATTRI Customer  
BUTE15  
ACCOUNT_EXT_AT BILL_TO_PARTY_IN Account Extended  
-
TRIBUTES  
FO  
Attributes  
ATTRIBUTE1 to  
ATTRIBUTE15  
ACCOUNT_EXT_AT HZ_CUST_ACCOUN Descriptive Flexfield  
TRIBUTES  
TS.  
segment for Account  
ATTRIBUTE1 to  
ATTRIBUTE15  
SHIP_TO_CONTACT ORDER_LINE  
_INFO  
Ship to Contact  
Information  
-
-
CONTACT_NAME  
SHIP_TO_CONTACT Ship to Contact Name  
_INFO  
PERSON_IDENTIFIE CONTACT_NAME  
R
HZ_PARTIES.PERSO Person Identifier  
N_IDENTIFIER  
PERSON_TITLE  
CONTACT_NAME  
HZ_PARTIES.PERSO Title  
N_TITLE  
PERSON_PRE_NAM CONTACT_NAME  
E_ADJUNCT  
HZ_PARTIES.PERSO Pre Name Adjunct  
N_PRE_NAME_ADJ  
UNCT  
PERSON_MIDDLE_  
NAME  
CONTACT_NAME  
CONTACT_NAME  
HZ_PARTIES.PERSO Middle Name  
N_MIDDLE_NAME  
PERSON_LAST_NA  
ME  
HZ_PARTIES.PERSO Last Name  
N_LAST_NAME  
XML Messages in TBI D-41  
PERSON_NAME_SU CONTACT_NAME  
FFIX  
HZ_PARTIES.PERSO Suffix  
N_NAME_SUFFIX  
SALUTATION  
SHIP_TO_CONTACT HZ_PARTIES.SALUT Salutation  
_INFO ATION  
CONTACT_INFO  
SHIP_TO_CONTACT Ship to Contact  
-
_INFO  
Information  
CONTACT_POINT_T CONTACT_INFO  
YPE  
HZ_CONTACT_POI  
NTS.CONTACT_POI  
NT_TYPE  
Contact Point Type  
EMAIL_ADDRESS  
CONTACT_INFO  
HZ_CONTACT_POI  
NTS.EMAIL_ADDRE  
SS  
Email Address  
Phone Purpose  
Country Code  
Area Code  
PHONE_LINE_TYPE CONTACT_INFO  
HZ_CONTACT_POI  
NTS.PHONE_LINE_  
TYPE  
PHONE_COUNTRY_ CONTACT_INFO  
CODE  
HZ_CONTACT_POI  
NTS.PHONE_COUN  
TRY_CODE  
PHONE_AREA_COD CONTACT_INFO  
E
HZ_CONTACT_POI  
NTS.PHONE_AREA_  
CODE  
PHONE_NUMBER  
CONTACT_INFO  
CONTACT_INFO  
CONTACT_INFO  
HZ_CONTACT_POI  
NTS.PHONE_NUMB  
ER  
Phone Number  
Extension  
PHONE_EXTENSIO  
N
HZ_CONTACT_POI  
NTS.PHONE_EXTEN  
SION  
URL  
HZ_CONTACT_POI  
NTS.URL  
Url  
D-42 Oracle Telecommunications Billing Integrator Implementation Guide  
Glossary  
Advanced Queuing Adapter  
Used to integrate OAI hub with an Advanced Queue in the spoke application.  
Agent Listener  
Type of service component that processes event messages on agents.  
Hub  
An integration point within your network.  
Hub Schema  
Schema in the database where OAI hub repository resides.  
Hub User  
Represents an application that takes part in the message exchange.  
JMS  
Java Message Service (JMS) API is a messaging standard that allows application  
components based on the Java 2 Platform, Enterprise Edition (J2EE) to create, send,  
receive, and read messages.  
OAI Hub  
Contains all the mapping and transformation data required for integration in its  
repository.  
OAI Maps  
Specification for transforming XML message from application view to common view  
and vice versa.  
Trading Partner  
Entity that exchanges messages with the XML Gateway.  
Glossary-1  
 
Transaction  
Transmission of information between Oracle EBS and Billing application.  
Workflow Function  
Activity in a workflow process which invokes Pl/Sql procedure or function.  
XML Gateway  
Generates the appropriate xml message based on the specifications. provided in the  
XML gateway map file. The message is validated using a DTD. XML Gateway places  
the generated message on the Advanced Queue (AQ) for further processing.  
XML Payload  
Data present within the XML message.  
Glossary-2  
Index  
A
P
Agent Listeners, list of, 3-13  
Profile Option  
Bill Summary UI, 3-13  
Publishing  
B
Account Update Details, 1-3  
Billing Preference, obsoleted, 1-7  
Billing Preference event, obsoleted, 1-7  
Bill Summary UI  
Bill To accounts for a Sales Order, 1-6  
Item/Product Details, 1-4  
New Account Details, 1-3  
Sales Order Details, 1-4  
Accessing, 3-16  
C
S
Collaboration History, 3-10  
profile values, 3-11  
Starting Adapter, A-4  
Stopping Adapter, A-4  
F
T
Final Collaboration Event, 3-12  
Transactions, internal, 3-5  
G
Grouped Sales Order Message, 1-6  
Example, 1-6  
H
Hub user, defining, 3-4  
O
OAI hub, A-1  
Overview, 1-1  
XML Message, D-1  
Overview, OAI, A-1  
Index-1  

ZTE D930 User Manual
Zanussi ZCOF 637 X User Manual
Vestax CDX 15 User Manual
Sony CDX GT30RN User Manual
Sony 1GN User Manual
Seagate BARRACUDA ST3160212AS User Manual
Rosewill RC605 User Manual
Roberts Radio CR9934 User Manual
Philips CD Player AZ1837 User Manual
Philips AJ3916CD User Manual