endeca url optimization api for the rad toolkit for url optimization api for the rad toolkit for...

Download Endeca URL Optimization API for the RAD Toolkit for URL Optimization API for the RAD Toolkit for ASP.NET Developer's Guide Endeca Confidential Endeca Confidential Endeca URL Optimization

Post on 18-Mar-2018

214 views

Category:

Documents

1 download

Embed Size (px)

TRANSCRIPT

  • Endeca URL Optimization API forthe RAD Toolkit for ASP.NET

    Developer's Guide

    Version 2.1.3 March 2012

  • Contents

    Preface.............................................................................................................................7About this guide............................................................................................................................................7Who should use this guide............................................................................................................................7Conventions used in this guide.....................................................................................................................8Contacting Oracle Endeca Customer Support..............................................................................................8

    Chapter 1: Installation................................................................................9System requirements....................................................................................................................................9Installing the URL Optimization API............................................................................................................10Package contents.......................................................................................................................................10

    Chapter 2: Introduction............................................................................13Introduction to URL optimization.................................................................................................................13Overview of the URL Optimization API capabilities....................................................................................13Duplicate content and URL canonicalization..............................................................................................15

    Chapter 3: Setting up a Reference Application......................................17Reference application prerequisites............................................................................................................17About the sample UrlProvider.....................................................................................................................17Integrating the URL Optimization API with the Content Assembler reference application..........................18

    Chapter 4: Implementing URL optimization...........................................21Implementing URL optimization with a new application..............................................................................21Modifying an existing application built with the RAD Toolkit for ASP.NET...................................................22

    Chapter 5: Preparing your application....................................................25Preparing your dimensions.........................................................................................................................25Preparing your properties...........................................................................................................................25Handling images and external JavaScript files in optimized URLs.............................................................26URL transitioning........................................................................................................................................26

    Chapter 6: Building URLs with the URL Optimization API....................27About using multiple UrlManagers..............................................................................................................27

    Working with multiple UrlManagers.....................................................................................................27Working with multiple UrlProviders......................................................................................................28Invalid command combinations...........................................................................................................29

    About avoiding invalid URLs.......................................................................................................................30About ensuring that URLs are optimized....................................................................................................30

    Building an optimized URL to select a dimension value from a BusinessRule object.........................31Building an optimized URL to an aggregate record detail page..........................................................31Building optimized URLs without using convenience methods............................................................32

    Chapter 7: Configuring URLs..................................................................35Anatomy of an optimized Endeca URL ......................................................................................................35Creating an SEO UrlProvider......................................................................................................................36About optimizing the misc-path...................................................................................................................38

    Optimizing URLs for navigation pages................................................................................................39Canonicalization configuration options................................................................................................43Optimizing URLs for record detail pages.............................................................................................44Optimizing URLs for aggregate record detail pages............................................................................48

    Configuring the path-param-separator........................................................................................................52About optimizing the path-params and query string...................................................................................53

    Moving Endeca parameters out of the query string.............................................................................54Modifying Endeca parameters.............................................................................................................55

    iii

  • Encoding Endeca parameters.............................................................................................................56Removing session-scope parameters.................................................................................................57About passing non-Endeca parameters to the API..............................................................................58Characters that should be excluded from the URL path......................................................................58

    Using the SeoUrlProvider with your application..........................................................................................59

    Chapter 8: Integrating with the Sitemap Generator...............................61The Sitemap Generator urlconfig.xml file...................................................................................................61Sample SeoUrlProvider and sample urlconfig.xml mapping.......................................................................61

    About using regular expressions in string formatters with the Sitemap Generator..............................65Adding custom dimensions to the Sitemap Generator configuration..........................................................65Modifying the root query.............................................................................................................................66Example Sitemap Generator integration.....................................................................................................68Integrating the URL configuration files with the Sitemap Generator...........................................................70

    Endeca URL Optimization API for the RAD Toolkit for ASP.NETiv

  • Copyright and disclaimer

    Copyright 2003, 2012, Oracle and/or its affiliates. All rights reserved.

    Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may betrademarks 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 restrictionson use and disclosure and are protected by intellectual property laws. Except as expressly permittedin 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 byany means. Reverse engineering, disassembly, or decompilation of this software, unless required bylaw for interoperability, is prohibited.

    The information contained herein is subject to change without notice and is not warranted to beerror-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 licensingit on behalf of the U.S. Government, the following notice is applicable:

    U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integratedsoftware, any programs installed on the hardware, and/or documentation, delivered to U.S. Governmentend users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulationand agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, andadaptation of the programs, including any operating system, integrated software, any programs installedon the hardware, and/or documentation, shall be subject to license terms and license restriction

Recommended

View more >