====================================================================== Endeca Presentation APIs - Installation Instructions and Release Notes GENERAL (6.3.0) * Release Date: July 2012 * The Endeca Presentation APIs provide APIs to the Endeca MDEX Engine and Log Server. The APIs are available in two packages: - The Presentation API for UNIX, which includes the Java version of the API only (JAR files, Javadoc, and Installation and Release Notes file. - The Presentation API for Windows, which includes both the Java version of the API (JAR files, Javadoc, and Installation and Release Notes file) and also the .NET version of the API (DLL files, CHM Help, and Installation and Release Notes file). * The release notes may have been updated since the release date. The latest release notes are available through the Oracle Endeca Commerce documentation page on the Oracle Technology Network at http://www.oracle.com/technetwork/indexes/documentation/endecaguidedsearch-1552767.html or by contacting Oracle Endeca Customer Support. SYSTEM REQUIREMENTS (6.3.0) The Java version of the Presentation API can be run using any of the following versions of Java: - Sun JDK 1.4.2, 5.0 (1.5), and 6.0 (1.6) - IBM JDK 1.4.2, 5.0 (1.5), and 6.0 (1.6) The .NET version of the Presentation API and the RAD Toolkit for ASP.NET can be run using any of the following versions of .NET: - .NET 2.0 and 3.5 The Presentation API is supported on 64-bit operating systems. INSTALLATION (6.3.0) The Presentation API is distributed as a ZIP file for Windows and as a compressed TAR file for UNIX. To install the Presentation API: 1. Ensure you have installed the Endeca MDEX Engine. 2. Download the Presentation API from the Oracle Software Delivery Cloud and save it to a local directory. 3. Extract the Presentation API package locally. Depending on the platform you selected during download, you will have one of the following installation files: - presAPI__x86_64pc-win32.zip (for Windows) - presAPI__x86_64pc-linux.tgz (for UNIX) 4. Extact the installation file to the root drive of your Endeca installation directory. For example, if you installed Endeca to the default location on Windows, you would extract the Presentation API file to C:\. That extracts to create: C:\Endeca\PresentationAPI. 5. Under the PresentationAPI\ directory, locate the appropriate APIs, and copy the APIs to the lib directory of your Web application. - On Java platforms, copy the JAR files from PresentationAPI\\java\lib to the WEB-INF\lib directory of your Web application. - On .NET platforms, copy the DLL files in PresentationAPI\\dotNET\lib to the bin directory of your Web application. UNINSTALLATION (6.3.0) 1. Close your Web application. 2. Delete the APIs from the appropriate directory of your Web application. 3. Delete the PresentationAPI directory from your Endeca installation. MIGRATION (6.3.0) * IFCORE-1567: Record Details and Aggregate Record Details query types now respect per-query field selections. Previously, if you used the ENEQuery.setSelection() method (Java) or the ENEQuery.Selection property (.NET), the specified fields were returned only on records in the record list from the navigation results. Records returned from ERec or AggrERec queries were not affected by the specified list of fields. With this release, records returned from ERec or AggrERec queries will also contain only fields included in the specified list. Note that with this change, if you specify a field list for an ENEQuery instance that contains both Navigation and ERec or AggrERec queries, the records returned for both queries will use the same list of specified fields. Previously the fields returned with ERec or AggrERec results would use the fields specified in the render_config.xml file of the instance configuration. FEATURES (6.3.0) * IFCORE-1514: The recommended API for retrieving search reports for Dimension Search and Record Search has changed. The proper Java methods to use are as follows: - Navigation.getESearchReportsComplete - DimensionSearchResult.getESearchReportsComplete The proper .NET equivalents to use are as follows: - Navigation.ESearchReportsComplete - DimensionSearchResult.ESearchReportsComplete The following Java methods are now deprecated: - Navigation.getESearchReports - DimensionSearchResult.getESearchReports The .NET equivalents are also deprecated: - Navigation.ESearchReports - DimensionSearchResult.ESearchReports * IFCORE-1391: Refinement counts can be enabled globally for all dimension values. To support this enhancement, the Presentation API has a new GlobalDimSearchRefinementConfig class in both the Java and .NET versions of the API. This class allows you to set a Boolean value to specify whether refinement counts are enabled globally for all dimension value search results. In addition, the class also allows you to globally set the maximum number of dimension values that can be returned per dimension. You can also set refinement count and show count options on a per-query basis using DimSearchRefinementConfig class. For details about GlobalDimSearchRefinementConfig and DimSearchRefinementConfig, see the "Presentation API Reference (Javadoc)", the "Presentation and Logging API for .NET Reference (HTML Help)", and "Using Dimension Search" in the "MDEX Engine Basic Development Guide". Also, as part of this work, the following Java methods are now deprecated: - ENEQuery.setDimSearchNumDimValues - ENEQuery.getDimSearchNumDimValues - UrlEneQuery.setDp The .NET equivalents are also deprecated: - ENEQuery.DimSearchNumDimValues Property - UrlENEQuery.SetDp Method * IFUB-170: A number of enhancements have been made to Dimension Value Search: Maximum search depth can now be set for Dimension Value search. To support this enhancement, the methods getMaxDepth and setMaxDepth have been added to the GlobalDimSearchRefinementConfig class. These methods set the maximum depth globally on a per query basis. Inert dimensions can now be returned returned via Dimension Value search. To support this enhancement, the methods getIncludeInert and setIncludeInert have been added to the GlobalDimSearchRefinementConfig class. These methods set the ability to include inert synonyms globally on a per query basis. Dimension Value Synonyms can now be returned via Dimension Value search. To support this enhancement, the methods getSynonyms and setSynonyms have been added to the DimSearchRefinementConfig and GlobalDimSearchRefinementConfig classes. These methods set the ability to show synonyms globally or on individual dimensions on a per query basis. For details about GlobalDimSearchRefinementConfig and DimSearchRefinementConfig, see the "Presentation API Reference (Javadoc)", the "Presentation and Logging API for .NET Reference (HTML Help)", and "Using Dimension Search" in the "MDEX Engine Basic Development Guide". BUG FIXES (6.3.0) Java API (6.3.0) * BUG18639: The API previously would omit quotes from inter-statement lookup keynames. This caused errors when keys had a space in their names. ======================================================================