Integration Layer Processes and Web Services
Purpose: This topic provides a master listing of integration layer processes and their characteristics, including whether they process inbound or outbound messages, require queues, or must be stopped and started. This topic also includes a listing of web services that do not use integration layer processes, and provides troubleshooting information for XML messages.
In this chapter:
• Web Services without Integration Layer Processes
• Troubleshooting XML Messages and Integration Layer Processes
For more information: See:
• Generic Web Services describes how to use the CWMessageIn Web Service to process XML messages for integration layer jobs that ordinarily use advanced queuing. This topic also describes how to use the CWServiceIn Web Service, which does not require an integration layer job to process the message.
• XML Messages provides a master list of Order Management System XML messages, including links to the DTDs, schemas, sample messages, and descriptions of message layouts.
• Working with Integration Layer Processes (IJCT) describes the screens you use to work with and configure integration layer jobs.
• Advanced Queuing for more information on using advanced queuing to send messages between Order Management System and an external system.
• Working with Web Service Authentication (WWSA) describes how to define which Order Management System web service endpoints require basic web service authentication.
This table describes:
• the integration layer processes
• their functions
• the jobs they initiate
• the messages they handle
• whether they require a queue
• whether they need to be active
• their communication type setting.
Process |
Function |
Submitted job or program |
Messages |
Needs Queue? |
Must be Active? |
Comm type? |
Billing Updates |
At periodic intervals, processes deferred billing updates for records in the Invoice Header table whose Process Date field is 0. The Outbound delay time defines how often the job processes the deferred billing updates. Example: If the Outbound delay time is 60, the system looks for deferred billing updates to process every 60 seconds. See Delay Billing Updates (K85) for processing details. |
BILL_UPD (ILR0022) |
This job does not generate or receive any messages and is used only to submit the Delay Billing Update Process at defined intervals. |
no |
yes |
message queue (but does not process any message) |
Order Broker integration |
Order Management System sends and receives order information and updates. See the Order Broker Integration for an overview. |
BROKER (ILR0022) |
Sends and receives information using Oracle Retail Order Broker’s message formats; see Sample Order Broker Messages for examples. |
no |
yes |
web service |
Customer history, order inquiry (inbound/ outbound) |
Order Management System receives a CustHistRequest for customer order history or information on a specific order, and generates a response (CWCUSTHISTOUT or CWORDEROUT). See Generic Customer History API for an overview. |
CUST_HIST (ILO0012) |
CustHistRequest (to Order Management System)
CWCUSTHISTOUT (from Order Management System)
CWORDEROUT (from Order Management System) |
no (if passing target of CUSTHISTIN) |
no (if passing target of CUSTHISTIN) |
message queue or CWMessageIn web service |
Customer download (outbound) |
Order Management System generates an outbound CWCustomerDownload XML message when you create, change, or delete a customer. See Generic Customer Download API for an overview. |
CUST_OUT (ILR0022) |
CWCustomerDownload (from Order Management System) |
yes |
yes |
message queue |
Customer inquiry/ search (inbound/ outbound) |
Order Management System receives a CWCustomerInqRequest for information on one or more customers matching specific search criteria, and generates a CWCustomerInqResponse. See Generic Customer Inquiry (Search) API for an overview. |
CUST_SRCH (ILO0022) |
CWCustomerInq Request (to Order Management System)
CWCustomerInq Response (from Order Management System) |
no (if passing target of CWCUSTSRCH) |
no (if passing target of CWCUSTSRCH) |
message queue or CWMessageIn web service |
Customer API (inbound) |
Order Management System receives a new customer or a change to an existing customer. See Generic Customer API for an overview. Note: If using the CWCustomer web service, the CUSTOMR_IN IJCT job is not used. |
CUSTOMR_IN (ILO0019)
|
CWCustomerIn (to Order Management System) |
no |
no |
CWCustomer web service or CWMessageIn web service |
(inbound) |
Order Management System receives email messages and creates Correspondence History and Correspondence History Detail records; attempts to assign the emails to customers; flags the emails as being in error if they cannot be assigned, or include inconsistent or invalid information. See Email Repository Overview. |
(ILO0001) |
CWEmail (to Order Management System) |
yes |
yes |
message queue or CWMessageIn web service |
Email (outbound) |
Order Management System generates the a generic outbound XML message rather than an actual email, so that you can you can use the information to produce a reformatted HTML email that includes promotional material. See Outbound Email API. |
EMAIL_OUT |
CWEmailOut (from Order Management System) |
yes |
yes |
message queue |
Inventory download (outbound) |
Order Management System sends inventory availability information to another system in the CWInventoryDownload message. See Generic Inventory Download API for an overview. |
INV_DOWNLD (ILR0022) |
CWInventory Download (from Order Management System) |
yes |
yes |
message queue |
Inventory inquiry (inbound/ outbound) |
Order Management System receives a CWInventoryInquiryRequest for inventory availability on a specific item/SKU and generates a CWInventoryInquiryResponse. See Generic Inventory Inquiry API for an overview. |
INV_INQURY (ILO0013) |
CWInventoryInquiry (to Order Management System)
CWInventoryInquiryResponse (from Order Management System) |
yes |
yes |
message queue or CWMessageIn web service |
Invoice Outbound (outbound) |
Order Management System sends invoice information in the CWInvoiceOut message to another system, such as a retail store, financial system, or warehouse management system. See Generic Invoice Download API for an overview. |
INVOICE_OUT (ILR0022) |
CWInvoiceOut (from Order Management System) |
yes |
yes |
message queue |
Inventory transaction processor (inbound) |
Order Management System receives inventory transactions in the inCreateInvXaction message and updates inventory information, such as in the Item Location and Item Warehouse tables. Any errors create Item Transaction Error records. See Generic Inventory Transaction Upload for an overview. |
INVTRAN_IN (ILO0008) |
inCreateInvXaction (to Order Management System) |
yes |
yes |
message queue or CWMessageIn web service |
Item Outbound (outbound) |
Order Management System sends item and SKU information in the CWItemOut message to another system, such as a retail store or warehouse management system. See Generic Item Download API. |
ITEM_OUT (ILR0022) |
CWItemOut (from Order Management System) |
yes |
yes |
message queue |
Merchandise locator (outbound/ inbound) |
Order Management System sends a request for inventory information to an external system, such as Oracle Retail Order Broker, and receives a response listing external warehouse and store locations where the specified item is available. See Merchandise Locator API for an overview. |
N/A |
LocateItems request (from Order Management System)
LocateItems response (to Order Management System)
Note: The CWMerchLoc request and response messages are used only to support processing the LocateItems request and response messages and the merchandise locator API, and are not themselves generic API messages. |
no |
no |
web service |
Order Cleanup |
Rejects orders that have been abandoned on the web storefront if, for example, the customer closes the browser window. This process uses the Time Limit for Suspended E-Commerce Orders (G43) setting to determine the number of minutes to wait before rejecting an order. Only orders of the type specified in the E-Commerce Order Type (G42) system control value are eligible for cleanup, and the cleanup takes place only if the Get Orders from E-Commerce (G35) system control value is selected. The system generates the E-Commerce Orders Cleanup Log each time it deletes a suspended order and writes a record in the Deleted Order Table. |
ORDER_CLN |
This job does not generate or receive any messages and is used only to submit the order cleanup. |
no |
no |
message queue |
Order processor (inbound/ outbound) |
Order Management System receives new orders through a generic order interface and optionally generates detailed or simple acknowledgments, as requested in the inbound order message. See Generic Order Interface (Order API) for an overview. |
ORDER_IN (ILO0003) If the ORDER_IN job uses a web service and does not read from or write to queues (the default setting in Order Management System 1.1 or higher), there is no need to start or stop the job. |
CWOrderIn (to Order Management System)
CWOrderOut (from Order Management System) |
no |
no |
CWOrderIn web service (but can specify message queue or use CWMessageIn web service) |
Pick Outbound |
Order Management System sends a Pick Message from Order Management System (CWPickOut) for each pick slip generated. See Generic Pick Out API for an overview. |
PICK_OUT (ILR0022) |
CWPickOut (from Order Management System) |
yes |
yes |
message queue |
Purchase Order Outbound |
Order Management System sends a CWPurchaseOrderOut message to a warehouse management system or an EDI vendor. See Generic Outbound Purchase Order API. |
PO_OUT (ILR0022) |
CWPurchaseOrderOut (from Order Management System) |
yes |
yes |
message queue |
Return Inbound |
Order Management System receives a Return Request Message (CWReturnIn) to create and process a return against a specified order line. Optionally, the process sends a Return Response Message (CWReturnOut) to the external system, indicating if the return processed successfully or if an error occurred. See Inbound Return API for an overview. |
RETURN_IN (ILO0021) |
CWReturnIn (to Order Management System)
CWReturnOut (from Order Management System) |
no (if passing target of CWRETURNIN) |
no (if passing target of CWRETURNIN) |
message queue or CWMessageIn web service |
Return Authorization Outbound |
Order Management System sends a Return Authorization Outbound XML Message (CWReturnRAOut) when a return authorization is created, changed, or deleted. See Outbound Return API for an overview. |
RETURN_OUT (ILR0022) |
CWReturn AuthorizationOut (from Order Management System) |
yes |
yes |
message queue |
Tax Request (inbound / outbound) |
Order Management System sends a request for tax information for an order to an external system, and then receives the response. See Use Generic Tax XML Interface (J10) and the Vertex Interface. |
TAX_INT This process does not submit a job; it is used to determine the XML message format and the queue used to transmit the message. You do not need to start or end this job. |
CWTaxRequest (from Order Management System)
CWTaxResponse (to Order Management System) |
no |
no |
web service |
Vendor Outbound (outbound) |
Order Management System sends a CWVendorOut message to another system, such as a retail store or warehouse management system. |
VENDOR_OUT (ILR0022) |
CWVendorOut (from Order Management System) |
yes |
yes |
message queue |
Workflow processing (inbound) |
Order Management System receives the CWWorkflow XML message from an outside source and creates a tickler, based on the information in the message. This process does not process any message other than CWWorkflow. See Workflow Management Overview and Setup and WF (Remote Workflow) Event Processing. |
WORKFLOW (ILO0002) |
CWWorkflow (to Order Management System) |
yes |
yes |
message queue or CWMessageIn web service |
Web Services without Integration Layer Processes
The following web services allow you to process XML messages directly without using a process at the Work with Integration Layer Process Screen.
Troubleshooting XML Messages and Integration Layer Processes
Question |
Possible Solution |
What are some reasons why inbound messages might not be processed? |
If the process uses a JMS provider (advanced queuing): • Is the queue name correct? (Note: Queue names are case-sensitive.) • Is the Enabled flag selected for the process queue at the Integration Layer Process Queue Screen? • Did the server end unexpectedly while the process was active? If so, the Work with Integration Layer Process Screen might display a Status of Active even if the process is no longer running. See Changing Process Status for information on how to reset the status. |
Do you need to use a JMS provider (advanced queuing) for integration layer processes or e-commerce? |
You can use the Generic Web Services to send XML messages if you prefer not to use advanced queuing. |
What is the purpose of an integration layer job that doesn’t need to be stopped or started? |
Some possible purposes: • To specify the version of an outbound XML message • To specify the queue where an interactive process writes an outbound message |
Are all integration layer processes listed at the Work with Integration Layer Process Screen? |
If you have hidden a process, it is not listed. See Hiding an Integration Layer Process. |
How can I track the messages processed? |
See Order Management System Application Logs for information on the logs you can use to track XML messages. |
How can the version number of an XML message be higher than the Order Management System release number? |
XML version numbers do not increase in sync with the current Order Management System release number; instead, the XML version number increases each time new elements or attributes are added to the message, which can occur multiple times between major Order Management System releases. See XML Versions for a discussion. |
Does the inbound XML version number matter? |
The inbound XML version number is informational, indicating when new elements or attributes are added. Even if the inbound XML version number is lower than the one in which the new elements or attributes were added, the integration layer job can still process the inbound message if the elements or attributes were added prior to the current Order Management System release. See XML Versions for a discussion. |
Is it necessary to start and stop a process manually? |
See Scheduling Jobs and Additional Interface (INT) Periodic Functions for more information on how to schedule a periodic function and for a list of the periodic functions used to start and stop the integration layer jobs. |
Where can I find DTDs, schemas, and sample XML messages? |
See XML Messages. |
| Working with Integration Layer Processes (IJCT) | Contents | SCVs | Search | Glossary | Reports | Solutions | XML | Index | Translating Special Characters |
SO01_10r OMS 17.1 September 2018 OTN