Oracle® Endeca Server Developer's Guide Version 7.5.1.1 • May 2013 Copyright and disclaimer Copyright © 2003, 2013, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. UNIX is a registered trademark of The Open Group. 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 END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency- specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. 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. 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. Oracle® Endeca Server: Developer's Guide Version 7.5.1.1 • May 2013 Table of Contents Copyright and disclaimer ..........................................................2 Preface.........................................................................12 About this guide ...............................................................12 Who should use this guide ........................................................12 Conventions used in this guide.....................................................12 Contacting Oracle Customer Support ................................................13 Part I: Overview and Concepts Chapter 1: Oracle Endeca Server Interfaces .........................................15 Oracle Endeca Server overview ....................................................15 Data flow ....................................................................16 Oracle Endeca Server Web services ................................................17 About the Oracle Endeca Server API Reference ........................................19 About the Java client examples ....................................................19 Dgraph configuration documents ...................................................20 Chapter 2: Oracle Endeca Server Concepts..........................................22 About the data model ...........................................................22 Records .................................................................22 Attributes ................................................................23 Assignments on standard attributes .........................................23 Primary keys ..........................................................24 Attribute types ........................................................24 XML representation of records and attributes ......................................25 Examples of records and standard attributes.......................................25 Managed attributes .........................................................27 System records ................................................................28 Property Description Record (PDR) .............................................28 Dimension Description Record (DDR)............................................33 Global Configuration Record (GCR) .............................................35 Understanding which records and properties can be updated...........................38 Part II: Web Services for the Oracle Endeca Server Chapter 3: Using the Configuration Web Service .....................................44 About the Configuration Web Service ................................................44 Configuration Web Service operations ...............................................45 Loading an attribute schema ......................................................49 Loading configuration documents ...................................................51 Oracle® Endeca Server: Developer's Guide Version 7.5.1.1 • May 2013 Table of Contents 4 Performance impact of schema and configuration changes ................................52 Using the Configuration Web Service in Integrator.......................................52 Chapter 4: Using the Conversation Web Service .....................................53 About the Conversation Web Service ................................................53 Conversation Web Service operations ...............................................54 Examples of Conversation Web Service query requests ..................................57 Chapter 5: Using the Entity Configuration Web Service................................62 About entities .................................................................62 About the Entity Configuration Web Service ...........................................68 Operations in the Entity Configuration Web Service......................................69 Sample entity requests ..........................................................70 Chapter 6: Using the Transaction Web Service .......................................73 About outer transactions .........................................................73 When to use outer transactions ....................................................74 About the Transaction Web Service .................................................74 Outer transactions and queries.....................................................75 Transaction Web Service operation description .........................................76 Transaction Web Service operations ................................................77 Rolling back an outer transaction ...................................................79 Notes about inner transactions.....................................................80 Request processing in the presence of transactions .....................................80 Transaction Web Service and Integrator ..............................................81 Performance impact of transactions .................................................81 Chapter 7: About Web Service Versions.............................................82 How version numbers are assigned .................................................82 Obtaining a version number for a Web service .........................................83 Using version numbers in requests..................................................83 Backward-compatibility of Web service versions ........................................84 Resolving incompatibility of Web services and client stubs.................................85 Part III: Working with Records and Record Filters Chapter 8: Working with Records ..................................................87 Filtering data and non-data records .................................................87 Displaying records and attribute values with Studio ......................................88 Displaying records and attribute values with the API .....................................88 Configuring a record list ......................................................88 Understanding a RecordList result ..............................................90 Paging through a record list ...................................................91 Retrieving large numbers of records .............................................93 Displaying attribute values ....................................................94 Performance impact of requesting large numbers of records ...............................94 Performance impact when displaying attribute values ....................................94 Oracle® Endeca Server: Developer's Guide Version