Oracle B31540-02 Implementation Manual Download Page 71

Page: 71 / 110

XML Messages in TBI

D-7

<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
TS.
CUST_ACCOUNT_I
D

Customer account
identifier.

ACCOUNT_NUMBE
R

ACCOUNT_INFO

HZ_CUST_ACCOUN
TS.
ACCOUNT_NUMBE
R

Account Number.

STATUS

ACCOUNT_INFO

HZ_CUST_ACCOUN
TS. STATUS

Customer status flag.

Summary of Contents for B31540-02

Page 1: ...Oracle Telecommunications Billing Integrator Implementation Guide Release 12 Part No B31540 02 December 2006 ...

Page 2: ... 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...

Page 3: ...essage 1 6 Publish Bill To Accounts for a Sales Order 1 6 Additional TCA Events for Account Update Message 1 6 Enhancements to Account Message 1 7 Enhancements to Sales Order Message 1 7 Uptake of JMS Compliant Queues in XML Gateway 1 8 2 Implementing Telecommunications Billing Integrator Implementation Considerations 2 1 TBI with TSO 2 1 Middleware in TBI 2 2 External Billing Applications 2 2 3 I...

Page 4: ...TBI 3 15 Accessing the Bill Summary UI from Oracle Contact Center 3 16 Loading Bill Summary Data 3 16 Integration with Order Management Workflow Processes 3 16 Integrating Workflow Process for Publishing Account Information 3 16 Integrating Workflow Process for Publishing Sales Order Information 3 17 Defining Sales Order Line Profile Option 3 18 Creating the Workflow Function 3 19 Integrating Work...

Page 5: ...for XML Gateway Maps and DTDs Overview C 1 Loading and Deleting Maps C 3 Loading and Deleting DTDs C 3 D XML Messages in TBI XML Message Overview D 1 Outbound and Inbound BOD D 2 XML Message Format D 2 Outbound Messages D 2 Inbound Messages D 4 Seeded XML Messages D 7 Message Specifications for Account Information D 7 Message Specifications for Sales Order Line D 20 Message Specifications for Prod...

Page 6: ......

Page 7: ...ur 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 m...

Page 8: ......

Page 9: ...ss 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 dedica...

Page 10: ...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 Introduct...

Page 11: ...d 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 Use...

Page 12: ...sts 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 Procedure...

Page 13: ...is 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...

Page 14: ...ything 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 cha...

Page 15: ...nts 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...

Page 16: ... 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 integ...

Page 17: ... 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 wi...

Page 18: ...t 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 Ord...

Page 19: ...der 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...

Page 20: ...ed 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 me...

Page 21: ...e 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 mes...

Page 22: ...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 utiliz...

Page 23: ...th 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 telecommunication...

Page 24: ...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 bil...

Page 25: ...eway Profile Values Defining UTL_FILE_DIR Parameters Defining XML Standards Defining a Hub Defining Hub Users Defining Transactions Internal and External Transactions in XML Gateway Transactions Enabled for TBI Defining Trading Partners Setting Up Oracle Collaboration History Defining Collaboration History Profile Values Defining Lookup Values for Collaboration Setting Up Collaboration Events Sett...

Page 26: ...nformation Setting Up and Running the Item Publish Concurrent Program Item Batch Export Profile Values Submitting the Item Publish Request Subscribing to Account Update Events Supported Events Configuring the Middleware 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...

Page 27: ...ge 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 X...

Page 28: ... 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 shoul...

Page 29: ...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...

Page 30: ...ribute Value Party Type Customer Transaction Type XNB Transaction Subtype AO Transaction Description 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 fo...

Page 31: ...SUBTYPE QUEUE OAG OUT SALESORDER ADD Internal Transactions for Group Sales Order Outbound Group Sales Order Outbound Attribute Value Party Type Customer Transaction Type XNB Transaction Subtype GSOO Transaction Description 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 SUB...

Page 32: ... 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 Transaction Type XNB Transaction Subtype CBODI Transaction Description XNB Confirm BOD Inbound External Transactions for Co...

Page 33: ...I 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 E SRCT P LOC CODE DOC CONF XNB AO XNB_TCA _ACCOUN T_OAG72_ OUT XNB_HUB XNB XNB 2 XNB SOO XNB_OM_ SALESOR DER_OAG 72_OUT XNB_HUB XNB XNB 2 XNB GSO XNB_...

Page 34: ...ls 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 Do...

Page 35: ...rofile 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 Applica...

Page 36: ... 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 even...

Page 37: ...ager 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 Respons...

Page 38: ...o 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 ...

Page 39: ...d 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 item...

Page 40: ...y 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 O...

Page 41: ... 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 ...

Page 42: ...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 Acc...

Page 43: ...ormation 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_PUBLI...

Page 44: ...lues 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 Concur...

Page 45: ...LE_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 ...

Page 46: ... Triggered when a new customer account relation is created 4 oracle apps ar hz CustAcctRelate u pdate Related Accounts Update Triggered when a customer account relation is updated 5 oracle apps ar hz CustProfileAmt c reate Customer Profile Amounts Create Triggered when a new customer profile amount is created 6 oracle apps ar hz CustProfileAmt u pdate Customer Profile Amounts Update Triggered when...

Page 47: ...illing 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 mes...

Page 48: ......

Page 49: ... 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...

Page 50: ...lications 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_pass...

Page 51: ...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 ...

Page 52: ..._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...

Page 53: ... 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 t...

Page 54: ......

Page 55: ...C 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 Oracl...

Page 56: ...n 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 Busines...

Page 57: ... 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 TABL...

Page 58: ... insert and update record and must be unique billing_vendor_name VARCHAR2 240 Name of the billing vendor bill_cycle_end_date DATE 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 Unapplied adjustments or payments up to this bill cycle u...

Page 59: ...tc previous_balance VARCHAR2 30 bill_location_url VARCHAR2 240 Location of the bill online due_now VARCHAR2 30 Amount currently due for an account created_by NUMBER 15 last_updated_by NUMBER 15 last_update_login NUMBER 15 object_version_number NUMBER Used for locking purposes attribute_category VARCHAR2 30 Descriptive flexfield structure defining column attribute1 to attribute 15 VARCHAR2 150 Desc...

Page 60: ......

Page 61: ...y 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 ...

Page 62: ...t 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 XNB_INV_ITEM_OAG72_OU T xnb_update_item_001 dtd ITEM_SYNC_001 XNB_CLN_CBOD_OAG72_I N xnb_002_confirm_bod_004 dt d CONFIRM_BO...

Page 63: ...ting 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...

Page 64: ...C 4 Oracle Telecommunications Billing Integrator Implementation Guide dtd_name dtd TBI specific DTDs root_element root element of the DTD runtime_location Set to xnb oag72 ...

Page 65: ...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 s...

Page 66: ...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 informati...

Page 67: ...ADER PROPERTIES Properties TEXT_LEN Length of the Payload TEXT_VC Has the Payload If TEXT_LEN 4000 bytes LOB Has 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 ...

Page 68: ...ge 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 conta...

Page 69: ... TBI D 5 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 ...

Page 70: ...ODEPAGE 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 C...

Page 71: ...er 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 TS CUST_ACCOUNT_I D Customer account identifier ACCOUNT_N...

Page 72: ...COUNT_INFO HZ_CUST_ACCOUN TS HOLD_BILL_FLAG Indicates if the bill receivable should be held or not ACCOUNT_EXT _ATTRIBUTES ACCOUNT_INFO Extended Attributes ATTRIBUTE1 to ATTRIBUTE15 ACCOUNT_EXT_ ATTRIBUTES HZ_CUST_ACCOUN TS ATTRIBUTE1 to HZ_CUST_ACCOUN TS ATTRIBUTE15 Descriptive Flexfield segment for Account RELATED_ACCOUN TS DATAAREA Related Accounts Information RELATED_CUST _ACCOUNT_ID RELATED_A...

Page 73: ...E TAX_EXEMPTIONS RA_TAX_EXEMPTIO NS_ALL EXEMPTION_TYPE Exemptions can be for customers at a location or for items at a location STATUS TAX_EXEMPTIONS RA_TAX_EXEMPTIO NS_ALL STATUS Approval status for this exemption TAX_CODE TAX_EXEMPTIONS RA_TAX_EXEMPTIO NS_ALL TAX_CODE Tax code that this exemption applies to PERCENT_EXEMPT TAX_EXEMPTIONS RA_TAX_EXEMPTIO NS_ALL PERCENT_EXEMPT Percentage that is ex...

Page 74: ...e of the exemption to apply to this portion of the Sales Tax Location Flexfield EXEMPT_PERCENT3 TAX_EXEMPTIONS RA_TAX_EXEMPTIO NS_ALL EXEMPT_PERCENT3 Percentage of the exemption to apply to this portion of the Sales Tax Location Flexfield EXEMPT_PERCENT4 TAX_EXEMPTIONS RA_TAX_EXEMPTIO NS_ALL EXEMPT_PERCENT4 Percentage of the exemption to apply to this portion of the Sales Tax Location Flexfield RE...

Page 75: ...OMER_INFO DATAAREA Customer Personal Information PARTY_NUMBER CUSTOMER_INFO HZ_PARTIES PARTY _NUMBER Unique identification number for the customer PARTY_NAME CUSTOMER_INFO HZ_PARTIES PARTY _NAME Customer Name PARTY_TYPE CUSTOMER_INFO HZ_PARTIES PARTY _TYPE The party type can only be Person Organization Group or Relationship TAX_REFERENCE CUSTOMER_INFO HZ_PARTIES TAX_R EFERENCE Taxpayer registratio...

Page 76: ... CUSTOMER_NAME HZ_PARTIES PERSO N_PRE_NAME_ADJ UNCT Salutary introduction such as Mr or Herr PERSON_FIRST_NA ME CUSTOMER_NAME HZ_PARTIES PERSO N_FIRST_NAME First name of the person PERSON_MIDDLE_ NAME CUSTOMER_NAME HZ_PARTIES PERSO N_MIDDLE_NAME Middle name of the person PERSON_LAST_NA ME CUSTOMER_NAME HZ_PARTIES PERSO N_LAST_NAME Last or surname of the person PERSON_NAME_SU FFIX CUSTOMER_NAME HZ_...

Page 77: ... HZ_PARTIES STATE State POSTALCODE ADDRESS HZ_PARTIES POSTA L_CODE Postal code CUSTOMER_EXT_A TTRIBUTES CUSTOMER_INFO Customer Extended Attributes ATTRIBUTE1 to ATTRIBUTE15 CUSTOMER_EXT_ ATTRIBUTES HZ_PARTIES ATTRI BUTE1 to HZ_PARTIES ATTRI BUTE15 Descriptive Flexfield segment for Customer RELATIONSHIP_INF O CUSTOMER_INFO Customer Relationship Information PARENT_PARTY_ID RELATIONSHIP_INF O HZ_PART...

Page 78: ...T_POINT_T YPE CUSTOMER_CONT ACT _INFO HZ_CONTACT_POI NTS CONTACT_POI NT_TYPE Lookup CONTACT_POINT_T YPE of phone fax e mail web telex or EDI PRIMARY CUSTOMER_CONT ACT _INFO HZ_CONTACT_POI NTS PRIMARY_FLA G Flag to Identify the Primary Contact Information EDI_TRANSACTION _HANDLING CUSTOMER_CONT ACT _INFO HZ_CONTACT_POI NTS EDI_TRANSAC TION_HANDLING ANSI standard code for EDI transaction type EDI_ID...

Page 79: ... ACT _INFO HZ_CONTACT_POI NTS PHONE_LINE_ TYPE Lookup code for the type of phone line For example general fax inbound or outbound PHONE_NUMBER CUSTOMER_CONT ACT _INFO HZ_CONTACT_POI NTS PHONE_NUMB ER A telephone number formatted in the local format The number should not include area code country code or extension PHONE_COUNTRY_ CODE CUSTOMER_CONT ACT _INFO HZ_CONTACT_POI NTS PHONE_COUN TRY_CODE In...

Page 80: ...r BANK_ACCOUNT_ NAME BANK_ACCOUNT_I NFO IBY_EXT_BANK_AC COUNTS BANK_ACCOUNT_ NAME Bank Account Name BANK_BRANCH_ID BANK_ACCOUNT_I NFO IBY_EXT_BANK_AC COUNTS BRANCH_ID Bank Branch Identifier CURRENCY_CODE BANK_ACCOUNT_I NFO IBY_EXT_BANK_AC COUNTS CURRENCY_CODE Currency Code ACCOUNT_HOLDE R _NAME BANK_ACCOUNT_I NFO HZ_PARTIES PARTY_NAME Account Holder Name DATETIME BANK_ACCOUNT_I NFO IBY_PMT_INSTR_U...

Page 81: ...CO UNTY County STATEPROVN ADDRESS HZ_LOCATIONS ST ATE State POSTALCODE ADDRESS HZ_LOCATIONS POSTAL_CODE Postalcode CUST_PROFILE_AM TS_INFO DATAAREA Customer Profile Amounts Information CUST_ACCT_PROFI LE_AMT_ID CUST_PROFILE_AM TS_INFO HZ_CUST_PROFILE_ AMTS CUST_ACCT_PROFI LE_AMT_ID Profile Amount Identifier CURRENCY_CODE CUST_PROFILE_AM TS_INFO HZ_CUST_PROFILE_ AMTS CURRENCY_CODE Currency code AMO...

Page 82: ...ARGE CUST_PROFILE_AM TS_INFO HZ_CUST_PROFILE_ AMTS MAX_INTEREST_CH ARGE Maximum interest charge AMOUNT CUST_PROFILE_AM TS_INFO HZ_CUST_PROFILE_ AMTS MIN_STATEMENT_ AMOUNT Minimum statement amount AMOUNT CUST_PROFILE_AM TS_INFO HZ_CUST_PROFILE_ AMTS AUTO_REC_MIN_R ECEIPT_AMOUNT Minimum receipt amount INTEREST_RATE CUST_PROFILE_AM TS_INFO HZ_CUST_PROFILE_ AMTS INTEREST_RATE Interest rate AMOUNT CUST...

Page 83: ...ATION_INFO DATAAREA Credit classification information CUST_ACCOUNT_P ROFILE_ID CREDIT_CLASSIFIC ATION_INFO HZ_CUSTOMER_PR OFILES CUST_ACCOUNT_P ROFILE_ID Credit Classification identifier CREDIT_CHECKING CREDIT_CLASSIFIC ATION_INFO HZ_CUSTOMER_PR OFILES CREDIT_CHECKING Credit checking flag DATETIME CREDIT_CLASSIFIC ATION_INFO HZ_CUSTOMER_PR OFILES NEXT_CREDIT_REVI EW_DATE Next credit review date TO...

Page 84: ...CREDIT_CLASSIFIC ATION Credit classification CREDIT_EXTENDED _ATTRIBUTES CREDIT_CLASSIFIC ATION_INFO Credit classification extended attributes ATTRIBUTE1 to ATTRIBUTE15 CREDIT_EXTENDED _ATTRIBUTES HZ_CUSTOMER_PR OFILES ATTRIBUTE1 to ATTRIBUTE15 Extended attributes Message Specifications for Sales Order Line The following table lists the specifications for sales order line information Message Speci...

Page 85: ...TIES PARTY_NUMBER Unique Identifier for Customer SOLD_TO_ PARTY_NAME ORDER_HEADER_I NFO HZ_PARTIES PARTY _NAME Customer Name SOLD_TO_ACCOUN T_ NUMBER ORDER_HEADER_I NFO HZ_CUST_ACCOUN TS ACCOUNT_NUMBE R Unique Identifier for Account SOLD_TO_ACCOUN T_ NAME ORDER_HEADER_I NFO HZ_CUST_ACCOUN TS ACCOUNT_NAME Account Name PRICE_LIST_ID ORDER_LINE_INFO OE_ORDER_LINES_ ALL PRICE_LIST_ID Price List PRICE_...

Page 86: ...NE_INFO OE_ORDER_LINES_ ALL PRICING_DATE Determines effective list and price modifiers UNIT_SELLING_PRI CE ORDER_LINE_INFO OE_ORDER_LINES_ ALL UNIT_SELLING_PRI CE Actual price charged to customer UNIT_LIST_PRICE ORDER_LINE_INFO OE_ORDER_LINES_ ALL UNIT_LIST_PRICE Price List price for the item QUANTITY ORDER_LINE_INFO OE_ORDER_LINES_ ALL ORDERED_QUANTI TY Quantity Ordered QUANTITY ORDER_LINE_INFO O...

Page 87: ...DER_LINES_ ALL CHARGE_PERI ODICITY_CODE Charge Periodicity Code CHARGE_PERIODIC ITY_CODE_DESC ORDER_LINE_INFO MTL_UOM_CONVE RSIONS UNIT_OF_M EASURE Charge Periodicity Code Description ADDRESS ORDER_LINE_INFO OE_ORDER_LINES_ ALL SHIP_TO_ORG_ID Ship To Address ADDRLINE ADDRESS CONCAT HZ_LOCATIONS AD DRESS1 HZ_LOCATI ONS ADDRESS2 HZ_ LOCATIONS ADDRE SS3 HZ_LOCATIONS ADDRESS4 Ship To Address Line of t...

Page 88: ...e in percentage DATETIME TAX_INFO OE_ORDER_LINES_ ALL TAX_DATE Date for tax calculation AMOUNT TAX_INFO OE_ORDER_LINES_ ALL TAX_VALUE Tax amount in order currency PAYMENT_TERM_I NFO ORDER_LINE_INFO Payment term Information PAYMENT_TERM_I D PAYMENT_TERM_I NFO OE_ORDER_LINES_ ALL PAYMENT_TER M_ID Payment Term Identifier PAYMENT_TERM_N AME PAYMENT_TERM_I NFO RA_TERMS_VL NA ME Payment Term Name DESCRI...

Page 89: ...STALL_BASE_INF O CSI_ITEM_INSTANC ES INSTANCE_DESC RIPTION Used to describe the Instance Id DATETIME INSTALL_BASE_INF O CSI_ITEM_INSTANC ES INSTALL_DATE Installation Date for an Instance DATETIME INSTALL_BASE_INF O CSI_ITEM_INSTANC ES ACTIVE_START_DA TE Activation Start Date DATETIME INSTALL_BASE_INF O CSI_ITEM_INSTANC ES ACTIVE_END_DATE Activation End Date QUANTITY INSTALL_BASE_INF O CSI_ITEM_INS...

Page 90: ...S Attribute Information ATTRIBUTE_ID ATTRIBUTE_INFO CSI_I_EXTENDED_A TTRIBS ATTRIBUTE_ ID Attribute Identifier ATTRIBUTE_LEVEL ATTRIBUTE_INFO CSI_I_EXTENDED_A TTRIBS ATTRIBUTE_ LEVEL Attribute Level MASTER_ORGANIZ ATION_ID ATTRIBUTE_INFO CSI_I_EXTENDED_A TTRIBS MASTER_OR GANIZATION_ID Master Organization Identifier INVENTORY_ITEM_ ID ATTRIBUTE_INFO CSI_I_EXTENDED_A TTRIBS INVENTORY _ITEM_ID Invent...

Page 91: ...XTENDED_A TTRIBS ACTIVE_EN D_DATE Activation End Date SECURITY_GROUP_ ID ATTRIBUTE_INFO CSI_I_EXTENDED_A TTRIBS SECURITY_G ROUP_ID Security Group Identifier VALUE_INFO ATTRIBUTE_VALUE S Value Information ATTRIBUTE_VALUE _ID VALUE_INFO CSI_IEA_VALUES A TTRIBUTE_VALUE_I D Instance Extended Attribute Value Identifier ATTRIBUTE_VALUE VALUE_INFO CSI_IEA_VALUES A TTRIBUTE_VALUE Instance Extended Attribu...

Page 92: ...E BILL_TO_PARTY_IN FO HZ_PARTIES PARTY _NAME Customer Name BILL_TO_ACCOUNT _NUMBER BILL_TO_PARTY_IN FO HZ_CUST_ACCOUN TS ACCOUNT_NUMBE R Unique Identifier of the Account BILL_TO_ACCOUNT _NAME BILL_TO_PARTY_IN FO HZ_CUST_ACCOUN TS ACCOUNT_NAME Account Name ADDRESS BILL_TO_PARTY_IN FO Bill To Address ADDRLINE ADDRESS CONCAT HZ_LOCATIONS AD DRESS1 HZ_LOCATI ONS ADDRESS2 HZ_ LOCATIONS ADDRE SS3 HZ_LOC...

Page 93: ...E1 to ATTRIBUTE15 ACCOUNT_EXT_AT TRIBUTES HZ_CUST_ACCOUN TS ATTRIBUTE1 to ATTRIBUTE15 Descriptive Flexfield segment for Account SHIP_TO_CONTACT _INFO DATAAREA Ship to Contact Information CONTACT_NAME SHIP_TO_CONTACT _INFO Ship to Contact Name PERSON_IDENTIFIE R CONTACT_NAME HZ_PARTIES PERSO N_IDENTIFIER Person Identifier PERSON_TITLE CONTACT_NAME HZ_PARTIES PERSO N_TITLE Title PERSON_PRE_NAM E_ADJ...

Page 94: ...CT_INFO HZ_CONTACT_POI NTS EMAIL_ADDRE SS Email Address PHONE_LINE_TYPE CONTACT_INFO HZ_CONTACT_POI NTS PHONE_LINE_ TYPE Phone Purpose PHONE_COUNTRY_ CODE CONTACT_INFO HZ_CONTACT_POI NTS PHONE_COUN TRY_CODE Country Code PHONE_AREA_COD E CONTACT_INFO HZ_CONTACT_POI NTS PHONE_AREA_ CODE Area Code PHONE_NUMBER CONTACT_INFO HZ_CONTACT_POI NTS PHONE_NUMB ER Phone Number PHONE_EXTENSIO N CONTACT_INFO HZ...

Page 95: ...UP_VAL UES_VL MEANING Inventory Item Type Description BOM_ITEM_TYPE ITEM_INFO MTL_SYSTEM_ITEM S_VL BOM_ITEM_TYPE E Business Suite BOM item type code BOM_ITYPE_DESC ITEM_INFO MFG_LOOKUPS ME ANING E Business Suite BOM item type description UOM ITEM_INFO MTL_SYSTEM_ITEM S_VL PRIMARY_UNIT_OF _MEASURE Primary Unit of Measure for the item in inventory ITEM_DESCRIPTION ITEM_INFO MTL_SYSTEM_ITEM S_VL DESC...

Page 96: ...ed from UOM we need to know all the distinct values of UOM ATTRIBUTE1 to ATTRIBUTE15 ITEM_INFO MTL_SYSTEM_ITEM S_VL ATTRIBUTE1 to ATTRIBUTE15 Descriptive Flexfield 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 Field in E Busin...

Page 97: ...ER_I NFO Salesorder Line Informations ORDER_LINE_INFO ORDER_LINE Sales order line information ORDER_LINE_ID ORDER_LINE_INFO OE_ORDER_LINES_ ALL LINE_ID Primary Key to Identify the Order Line TOP_MODEL_LINE_ ID ORDER_LINE_INFO OE_ORDER_LINES_ ALL TOP_MODEL_LINE_ ID Identifier of configuration top parent line LINK_TO_LINE_ID ORDER_LINE_INFO OE_ORDER_LINES_ ALL LINK_TO_LINE_ID Identifier of immediate...

Page 98: ...NFO OE_ORDER_LINES_ ALL ORG_ID Operating Unit which performed this transaction DATETIME ORDER_LINE_INFO OE_ORDER_LINES_ ALL PRICING_DATE Determines effective list and price modifiers UNIT_SELLING_PRI CE ORDER_LINE_INFO OE_ORDER_LINES_ ALL UNIT_SELLING_PRI CE Actual price charged to customer UNIT_LIST_PRICE ORDER_LINE_INFO OE_ORDER_LINES_ ALL UNIT_LIST_PRICE Price List price for the item QUANTITY O...

Page 99: ...RENCY_CO DE Currency Code CHARGE_PERIODIC ITY_CODE ORDER_LINE_INFO OE_ORDER_LINES_ ALL CHARGE_PERI ODICITY_CODE Charge Periodicity Code CHARGE_PERIODIC ITY_CODE_DESC ORDER_LINE_INFO MTL_UOM_CONVE RSIONS UNIT_OF_M EASURE Charge Periodicity Code Description ADDRESS ORDER_LINE_INFO OE_ORDER_LINES_ ALL SHIP_TO_ORG_ID Ship To Address ADDRLINE ADDRESS CONCAT HZ_LOCATIONS AD DRESS1 HZ_LOCATI ONS ADDRESS2...

Page 100: ...NFO OE_ORDER_LINES_ ALL TAX_RATE The tax rate in percentage DATETIME TAX_INFO OE_ORDER_LINES_ ALL TAX_DATE It will store the date for tax calculation AMOUNT TAX_INFO OE_ORDER_LINES_ ALL TAX_VALUE The Tax amount in order currency PAYMENT_TERM_I NFO ORDER_LINE_INFO Payment term Information PAYMENT_TERM_I D PAYMENT_TERM_I NFO OE_ORDER_LINES_ ALL PAYMENT_TER M_ID Payment Term Identifier PAYMENT_TERM_N...

Page 101: ...nstance INSTANCE_NAME INSTALL_BASE_INF O CSI_ITEM_INSTANC ES INSTANCE_DESC RIPTION Used to describe the Instance Id DATETIME INSTALL_BASE_INF O CSI_ITEM_INSTANC ES INSTALL_DATE Installation Date for an Instance DATETIME INSTALL_BASE_INF O CSI_ITEM_INSTANC ES ACTIVE_START_DA TE Activation Start Date DATETIME INSTALL_BASE_INF O CSI_ITEM_INSTANC ES ACTIVE_END_DATE Activation End Date QUANTITY INSTALL...

Page 102: ...S Attribute Information ATTRIBUTE_ID ATTRIBUTE_INFO CSI_I_EXTENDED_A TTRIBS ATTRIBUTE_ ID Attribute Identifier ATTRIBUTE_LEVEL ATTRIBUTE_INFO CSI_I_EXTENDED_A TTRIBS ATTRIBUTE_ LEVEL Attribute Level MASTER_ORGANIZ ATION_ID ATTRIBUTE_INFO CSI_I_EXTENDED_A TTRIBS MASTER_OR GANIZATION_ID Master Organization Identifier INVENTORY_ITEM_ ID ATTRIBUTE_INFO CSI_I_EXTENDED_A TTRIBS INVENTORY _ITEM_ID Invent...

Page 103: ...TENDED_A TTRIBS ACTIVE_EN D_DATE Activation End Date SECURITY_GROUP_ ID ATTRIBUTE_INFO CSI_I_EXTENDED_A TTRIBS SECURITY_G ROUP_ID Security Group Identifier VALUE_INFO ATTRIBUTE_VALUE S Value Information ATTRIBUTE_VALUE _ID VALUE_INFO CSI_IEA_VALUES A TTRIBUTE_VALUE_I D Instance Extended Attribute Value Identifier ATTRIBUTE_VALUE VALUE_INFO CSI_IEA_VALUES A TTRIBUTE_VALUE Instance Extended Attribut...

Page 104: ...E BILL_TO_PARTY_IN FO HZ_PARTIES PARTY _NAME Customer Name BILL_TO_ACCOUNT _NUMBER BILL_TO_PARTY_IN FO HZ_CUST_ACCOUN TS ACCOUNT_NUMBE R Unique Identifier of the Account BILL_TO_ACCOUNT _NAME BILL_TO_PARTY_IN FO HZ_CUST_ACCOUN TS ACCOUNT_NAME Account Name ADDRESS BILL_TO_PARTY_IN FO Bill To Address ADDRLINE ADDRESS CONCAT HZ_LOCATIONS AD DRESS1 HZ_LOCATI ONS ADDRESS2 HZ_ LOCATIONS ADDRE SS3 HZ_LOC...

Page 105: ... to ATTRIBUTE15 ACCOUNT_EXT_AT TRIBUTES HZ_CUST_ACCOUN TS ATTRIBUTE1 to ATTRIBUTE15 Descriptive Flexfield segment for Account SHIP_TO_CONTACT _INFO ORDER_LINE Ship to Contact Information CONTACT_NAME SHIP_TO_CONTACT _INFO Ship to Contact Name PERSON_IDENTIFIE R CONTACT_NAME HZ_PARTIES PERSO N_IDENTIFIER Person Identifier PERSON_TITLE CONTACT_NAME HZ_PARTIES PERSO N_TITLE Title PERSON_PRE_NAM E_ADJ...

Page 106: ...I NT_TYPE Contact Point Type EMAIL_ADDRESS CONTACT_INFO HZ_CONTACT_POI NTS EMAIL_ADDRE SS Email Address PHONE_LINE_TYPE CONTACT_INFO HZ_CONTACT_POI NTS PHONE_LINE_ TYPE Phone Purpose PHONE_COUNTRY_ CODE CONTACT_INFO HZ_CONTACT_POI NTS PHONE_COUN TRY_CODE Country Code PHONE_AREA_COD E CONTACT_INFO HZ_CONTACT_POI NTS PHONE_AREA_ CODE Area Code PHONE_NUMBER CONTACT_INFO HZ_CONTACT_POI NTS PHONE_NUMB ...

Page 107: ...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 mess...

Page 108: ...rocess 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 ...

Page 109: ...laboration Event 3 12 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 P Profile Option Bill Summary UI 3 13 Publishing Account Update Details 1 3 Bill To accounts for a Sales Order 1 6 Item Product Details 1 4 New Account Details 1 3 Sales Order Details 1 4 S Starting Adapter A 4 Stopping Adapter A 4 T Transactions i...

Page 110: ......

Search results

Summary of Contents for B31540-02

Reviews:

Oracle B31540-02, Implementation Manual, Page: 71 / 110

Search results

Summary of Contents for B31540-02

Reviews: