The Programs (which include both the software and documentation) contain proprietary information; they
are provided under a license agreement containing restrictions on use and disclosure and are also protected
by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or
decompilation of the Programs, except to the extent required to obtain interoperability with other
independently created software or as specified by law, is prohibited.
The information contained in this document is subject to change without notice. If you find any problems in
the documentation, please report them to us in writing. This document is not warranted to be error-free.
Except as may be expressly permitted in your license agreement for these Programs, no part of these
Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any
purpose.
If the Programs are delivered to the United States Government or anyone licensing or using the Programs on
behalf of the United States Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS
Programs, software, databases, and related documentation and technical data delivered to U.S. Government
customers are "commercial computer software" or "commercial technical data" pursuant to the applicable
Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,
disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall
be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent
applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted
Rights (June 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065.
The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently
dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,
redundancy and other measures to ensure the safe use of such applications if the Programs are used for such
purposes, and we disclaim liability for any damages caused by such use of the Programs.
The Programs may provide links to Web sites and access to content, products, and services from third parties.
Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all
risks associated with the use of such content. If you choose to purchase any products or services from a third
party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality
of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party,
including delivery of products or services and warranty obligations related to purchased products or services.
Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third
party.
Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its
affiliates. Other names may be trademarks of their respective owners.
Send Us Your Comments
Preface
1 Introduction to Telecommunications Billing Integrator
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: appsdoc_us@oracle.com
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
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
Preface
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
1 Introduction to Telecommunications Billing Integrator
This chapter provides a brief introduction to the features in TBI.
This chapter lists the implementation considerations for TBI.
3 Implementation Tasks for Oracle Telecommunications Billing Integrator
This chapter discusses the tasks to implement Oracle Telecommunications Billing
Integrator.
A Configuring Oracle Applications InterConnect
This appendix provides information on configuring Oracle Applications InterConnect
(OAI).
B APIs in Telecommunications Billing Integrator
This appendix provides information on the APIs in TBI.
C Message Maps and DTDs for XML Gateway
This appendix provides information on the message maps and DTDs for Oracle XML
Gateway.
D XML Messages in TBI
x
This appendix provides information on the XML messages in TBI.
Glossary
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 Features
• Publishing Information to the Billing Applications
• Products Used in TBI
• Enhancements
• Grouped Sales Order Message
• Publish Bill To Accounts for a Sales Order
• Additional TCA Events for Account Update Message
• Enhancements to Account Message
• Enhancements to Sales Order Message
• Uptake of JMS Compliant Queues in XML Gateway
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.
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).
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.
Group sales order and sales order line messages are mutually
Note:
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.
•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.
This chapter lists the implementation considerations for TBI.
This chapter covers the following topics:
• Implementation Considerations
• TBI with TSO
• Middleware in TBI
• External Billing Applications
Implementation Considerations
2
TBI with TSO
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
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.
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.
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
Defining UTL_FILE_DIR Parameters, page 3-3
2.
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.
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.
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.
•The names representing the billing applications setup in the hub
•Hub entity code values for the various billing applications must be
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.
must be unique.
same as the key value from BSR.SENDER.COMPONENT.
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
AttributeValue
Party TypeCustomer
Transaction TypeXNB
Transaction SubtypeAO
Transaction DescriptionXNB TCA Account Outbound
External Transactions for Account Outbound
The following table lists the details of the external transactions for account outbound
message.
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 TYPETXN SUB
TYPE
XNBAOXNB_TCA
QUEUE
SUBTYPE
MAPCONN/HUBUSERNAMESRCT P
LOC
CODE
XNB_HUBXNBXNB2
_ACCOUN
T_OAG72_
OUT
DOC
CONF
XNBSOOXNB_OM_
SALESOR
DER_OAG
72_OUT
XNBGSOXNB_OM_
GRPSALES
ORDER_O
AG72_OU
T
XNBIOXNB_INV_
ITEM_OA
G72_OUT
XNB_HUBXNBXNB2
XNB_HUBXNBXNB2 (If GSO)
XNB_HUBXNBXNB2
Implementation Tasks for Oracle Telecommunications Billing Integrator 3-9
TXN TYPETXN SUB
TYPE
MAPCONN/HUBUSERNAMESRCT P
LOC
CODE
DOC
CONF
XNBCBODIXNB_CLN
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.
_CBOD_O
AG72_IN
--<Hub
Entity
Code of
Billing
Applicatio
ns>
0
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:
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
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.
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 OptionValue
XNB: Bill Image
Source
XNB: Bill Image
Location
XNB: Bill Image
Format
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.
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.
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
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.
Select the 'Enabled' check box to enable the function.
2.
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.
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:
Defining Sales Order Line Profile Values, page 3-18
1.
Creating the Workflow Function, page 3-19
2.
GSO and Sales Order Line are mutually exclusive.
Note:
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.
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:
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 OptionValue
XNB: Items Batch Message TypeThe 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 LocationName 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
Update the billing application each time an item is added or updated in the inventory.
You can do this in two ways:
Use the batch mode which supports CSVs and XML files.
1.
Publish the details in a real time asynchronous mode using Item Publish Flow
2.
'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.
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
Triggered when a
customer account
information is updated.
Details of type Person
is updated.
Details of type
Organization is
updated.
Sl. NoEvent Name Event Display NameDescription
10oracle.apps.ar.hz.CustomerProfile.
update
11oracle.apps.ar.hz.ContactPoint.up
date
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.
Customer Profile
Update
Contact Points UpdateTriggered when
Triggered when
Customer Profile
details are updated.
Contact Point details
are updated.
If Oracle Applications Interconnect (OAI 9.0.4) is used as the
Note:
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
• Setting Up OAI Hub
• Setting up OAI Adapter for Advanced Queues
• Dropping the Hub Schema
• Importing OAI Maps to the Repository
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
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.
•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
Copy the DTDs from APPL_TOP at the following location: $XNB_TOP/xml/oag72,
5.
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:
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:
This appendix provides information on the APIs in TBI.
This appendix covers the following topics:
• Bill Summary Bulk Insert APIs
• Procedure: INSERT_ROW_BATCH
• Procedure: UPDATE_ROW_BATCH
• Bill Summary Public Table Type: BILL_SUMMARIES_TABLE
• Bill Summary Public Record Type: BILL_SUMMARIES_REC
B
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.
attribute1 to attribute 15VARCHAR2 (150)Descriptive flexfield segment
column
APIs in Telecommunications Billing Integrator B-5
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
• Loading and Deleting Maps
• Loading and Deleting DTDs
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.
C
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 FlowMap Internal Name
TCA Account Publish (Add and Update)XNB_TCA_ACCOUNT_OAG72_OUT.xgm
OM Sales Order PublishXNB_OM_SALESORDER_OAG72_OUT.xgm
Message Maps and DTDs for XML Gateway C-1
Supported FlowMap Internal Name
Inventory Item PublishXNB_INV_ITEM_OAG72_OUT.xgm
XNB Confirm BODXNB_CLN_CBOD_OAG72_IN.xgm
OM Group Sales Order Publish XNB_OM_GRPSALESORDER_OAG72_OUT.
DTDs in XML Gateway
DTDs in XML Gateway
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.
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.
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:
This appendix provides information on the XML messages in TBI.
This appendix covers the following topics:
• XML Message Overview
• Outbound and Inbound BOD
• XML Message Format
• Outbound Messages
• Inbound Messages
• Seeded XML Messages
• Message Specifications for Account Information
D
• Message Specifications for Sales Order Line
• Message Specifications for Product/Item
• Message Specifications For Group Sales Order Line
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.
HEADER.REPLYTO.NAMEName of the Application Replied To
HEADER.REPLYTO.ADDRESSAddress of the Application Replied To
HEADER.REPLYTO.PROTOCOLProtocol Used in Replying
HEADER.USERIDUser Id
HEADER.APPIDApplication Id
HEADER.GROUPIDGroup Id
HEADER.GROUPSEQGroup Sequence
HEADER.PROPERTIESProperties
TEXT_LENLength of the Payload
TEXT_VCHas the Payload If TEXT_LEN < 4000 bytes
LOBHas the Payload If TEXT_LEN > 4000 bytes
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.
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.
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.
The party type can
only be Person,
Organization, Group
or Relationship.
Taxpayer registration
number, also known
as the VAT number.
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_ADDRESSCUSTOMER_INFOHZ_PARTIES.EMAIL
_ADDRESS
Email Address
CUSTOMER_NAMECUSTOMER_INFOName of the
Customer
PERSON_IDENTIFIERCUSTOMER_NAMEHZ_PARTIES.PERSO
N_IDENTIFIER
PERSON_TITLECUSTOMER_NAMEHZ_PARTIES.PERSO
N_TITLE
PERSON_PRE_NAM
E_
ADJUNCT
PERSON_FIRST_NAMECUSTOMER_NAMEHZ_PARTIES.PERSO
PERSON_MIDDLE_
NAME
CUSTOMER_NAMEHZ_PARTIES.PERSO
N_PRE_NAME_ADJ
UNCT
N_FIRST_NAME
CUSTOMER_NAMEHZ_PARTIES.PERSO
N_MIDDLE_NAME
-
Personal identifier,
such as driver's
license or passport
number.
A professional or
family title. For
example, Don or The
Right Honorable.
Salutary introduction,
such as Mr. or Herr.
First name of the
person
Middle name of the
person
PERSON_LAST_NAMECUSTOMER_NAMEHZ_PARTIES.PERSO
N_LAST_NAME
PERSON_NAME_SU
FFIX
SALUTATIONCUSTOMER_INFOHZ_PARTIES.SALUT
ADDRESSCUSTOMER_INFOIdentifying Address-
CUSTOMER_NAMEHZ_PARTIES.PERSO
N_NAME_SUFFIX
ATION
Last or surname of
the person
Indicates the place in
a family structure.
For example, in Tom
Jones III, the "III" is
the suffix.
Phrase used to
address a party in any
correspondence.