Oracle® Enterprise Data Quality for Product Data

R12 PIM Connector API Interface Guide

Release 5.6.2

E23409-01

November 2011

This document describes the Oracle Enterprise Data Quality for Product Data R12 Product Information Management (PIM) Connector application programming interface (API) and contains the following:

"Overview"
"API Database Packages"
"API Database Tables"
"API Database Views"

Overview

Oracle DataLens Server is built on industry-leading DataLens™ Technology to standardize, match, enrich, and correct product data from different sources and systems. The core DataLens Technology uses patented semantic technology designed from the ground up to tackle the extreme variability typical of product data.

Oracle Enterprise Data Quality for Product Data, formerly Oracle Product Data Quality, uses three core DataLens Technology modules: Governance Studio, Knowledge Studio, and Application Studio. The following figure illustrates the process flow of these modules.

Surrounding text describes datalens_diag.gif.

The R12 PIM Connector API provides data objects to facilitate the interaction of Enterprise DQ for Product (EDQP) Data Service Applications (DSAs) with PIM data structures. The R12 PIM Connector API data objects are comprised of database packages, views, and tables, which are described in the following sections.

API Database Packages

The R12 PIM Connector API database packages are described in the following sections.

DLS_CONNECTOR_PUB

Public interface functions and procedures that can be linked to from external processes as follows:

Name	Parameters	Description
`getversion`	None	Function that returns a static string containing the version of the installed R12 PIM Connector. It can be called from SQLPlus or through a Java Database Connectivity connected program. For example, the following SQLPlus `select` statement could be used to obtain the version: `SQL> select dls_connector_pub.getversion from dual;`
`ProduceAutoBuild`	`p_jobid NUMBER` `p_itemclass VARCHAR2`	Procedure and function that takes a DSA `jobid` and the name of the top-level Item Catalog Category (ICC) as parameters, extracts the passed ICC and all descendants. All attributes and distinct attribute values that have been associated with the SemanticModel Display Format are also extracted. All extracted data is inserted into the `DLS_ATTRIBUTE_INFO` table keyed by `jobid`.
`ProduceSampleData`	`p_jobid NUMBER` `p_itemclass VARCHAR2`	Procedure and function that takes a DSA `jobid` and the name of the top-level ICC as parameters, extracts the passed ICC, all descendants, and a random sampling of production item descriptions. The number of rows extracted per ICC is controlled by the Profile Option, DLS_AUTOBUILD_SAMPLE_SIZE. The extracted data is then inserted into the table, `DLS_ITEM_SAMPLE_DATA`.
`ProductionPull`	`p_jobid NUMBER` `p_itemclass VARCHAR2`	Procedure and function that takes a DSA `jobid` and the name of the top-level ICC as parameters, extracts the passed ICC and all descendants, and all production item data. The columns extracted include: `Inventory_Item_ID`, `Organization_Name`, `Description`, and all attributes associated with the ICCs Display Format concatenated into a comma-delimited string. The extracted data is inserted into the DLS_PRODUCTION_PULL table.
`PrepBatch`	`P_jobid NUMBER` `p_batchid INTEGER`	Procedure and function that takes a DSA `jobid` and a PIM WorkBench batch id then calls another public procedure or function to prepare the batch for viewing and manipulation in the WorkBench.
`UpdateItem`	`p_jobid NUMBER` `p_itemxml CLOB`	Procedure that takes a DSA `jobid` key and the XML output from the Oracle AU XML Parameterizer DSA widget as input. Each item passed is then updated back into the interface tables.
`InsertItem`	`p_jobid NUMBER` `p_itemxml CLOB`	Procedure that takes a DSA `jobid` key and the XML output from the Oracle AU XML Parameterizer DSA widget as input. Each item passed is then inserted into the interface tables.
`CreateProductionBatch`	`p_jobid NUMBER` `p_itemclass VARCHAR2` `p_attrtype VARCHAR2`	Procedure and function that takes a DSA `jobid` and the name of the top-level ICC as parameters, extracts the passed in ICC, and all attributes associated with the ICCs SemanticModel Display Format. PIM Workbench batches are created and the extracted data is inserted into the interface tables. The number of records per batch is controlled by the Profile Option, DLS_EGO_IMPORT_BATCH_SIZE.
`ImportBatch`	`p_jobid NUMBER` `p_batchid INTEGER`	Procedure and function that takes a DSA `jobid` and a PIM Workbench batch ID as input, and submits a concurrent request to import the batch into production.
`ImportJobBatchs`	`p_jobid NUMBER`	Procedure and function that takes a DSA `jobid` and invokes the batch import process.
`UpdateBatchStatus`	`p_jobid NUMBER` `p_batchid NUMBER` `p_batchstatus VARCHAR2`	Function that takes a DSA `jobid` and a PIM Workbench batch ID as input, and checks the status of the import batch into production job.
`ConcatProdAttributes`	`p_catalogid INTEGER` `p_inventoryid INTEGER` `p_orgid VARCHAR2`	Function that retrieves and returns a comma-delimited list of the passed in item's production attribute values. Only the semantic attributes are extracted by this function.
`ConcatIntrfAttributes`	`p_itemclassid INTEGER` `p_batchid NUMBER` `p_transactionid VARCHAR2`	Function that retrieves and returns a comma-delimited list of the passed in item's attribute values that are stored in the interface tables. Only the semantic attributes are extracted by this function.
`FinalizeLoad`	`p_jobid INTEGER` `p_loadtype DEFAULT g_item_batch_type`	Procedure and function that finalizes an external data load by creating n of batches, and then moving the newly loaded items into the created batch. The Profile Option, DLS_EGO_IMPORT_BATCH_SIZE, is used to control the number of records inserted into a batch.

DLS_CONNECTOR_PVT

Private implementation functions and procedures that should not be linked to from external processes because they support the DLS_CONNECTOR_PUB functions and procedures.

API Database Tables

The following tables are created for use by the R12 PIM Connector API database objects:

Table Name	Description
`dls_alt_item_categories`	Global temporary table used to build Alternate Catalog records to be inserted or updated into the `MTL_ITEM_CATEGORIES_INTERFACE` interface table.
`dls_attribute_info`	Used to return data from the `ProduceAutobuild` procedure.
`dls_attr_discovery`	A template table and can be removed.
`dls_attr_info`	A template table and can be removed.
`dls_extract_attributes`	A template table and can be remove.d.
`dls_item_sample_data`	Used to return sample data from the `ProduceSampleData` procedure.
`dls_job_batches`	Stores created batch ID's by `jobid`.
`dls_job_messages`	Stores all unexpected messages generated by the connector keyed by `jobid`.
`dls_production_pull`	Stores items extracted using the `ProductionPull` procedure.
`dls_semantic_cache`	iA template table and can be removed.
`dls_supported_primary_attrs`	A template table and can be removed.
`dls_usr_attr_values`	Global temporary table used to build user defined attribute records to be inserted or updated into the `EGO_ITM_USR_ATTR_INTRFC` interface table.

API Database Views

The following views are created by the R12 PIM Connector API database objects:

View Name	Description
`DLS_INTERFACE_PULL_V`	Returns all columns in the `MTL_SYSTEM_ITEMS_INTERFACE` interface table and an additional column that contains the semantic attribute names and values concatenated together from the `EGO_ITM_USR_ATTR_INTRFC` interface table.
`DLS_PRODUCTION_PULL_V`	Returns all columns in the `MTL_SYSTEM_ITEMS_B` interface table and an additional column containing the semantic attribute names and values concatenated together from the production `EGO` interface tables.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Oracle Enterprise Data Quality for Product Data R12 PIM Connector API Interface Guide, Release 5.6.2

E23409-01

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. 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, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.