Advanced Features
This section describes the advanced features in Developer Studio.
Copyright ©
Legal Notices
Developer Studio Help
Documentation Home
Highlighting
Prev
Next
Contents
Search
Preface
Welcome to Oracle Endeca Developer Studio
Overview of Developer Studio functions
Deprecated Features
Parts of the Developer Studio window
Important Endeca concepts
About your Endeca Developer Studio Project
About Oracle Endeca Workbench
Developer Studio workflows
Getting Started
Creating and Validating Projects
Creating a new project based on a template
Opening a project
Saving a project
Backing up a project
Displaying project components
The View Menu
Resizing columns in a view
Closing a project
Exiting Endeca Developer Studio
Validating your project
About the Messages pane
Clearing messages
Closing an editor
Closing an active view in a project
Closing all open views in a project
Copying messages to the clipboard
The menu bar and toolbar
The Project Explorer
The Messages window
The status bar
The work area
Preparing Data, Properties, and Dimensions
Preparing Your Source Data
Importing Source Data
Adding a record adapter to load data
Record Adapter editor
General
Sources
Record Index
Transformer
Pass Throughs
Comment
Giving Forge permission to access source data
Input formats
Delimited
Delimited example
Tips When Using Delimited Format
Fixed width
Fixed Width example
Vertical
Tips For Using Vertical Format
ODBC
Pass Throughs tab
General tab
ODBC example
Supported data types
JDBC
General tab
Pass Throughs tab
Supported data types
Exchange
General tab
Pass Throughs tab
Retrieving attachments and other documents
Document
XML
General tab
Transformer tab
XML example
Binary
Custom
Filtering empty properties
About character limits in text extracts
About providing pass-through information
Adding pass-through information for a record adapter
Modifying pass-through information
Removing a pass-through element from a record adapter
Overriding Java home and class path settings
Joining Source Data
Implementing a join
Adding a record cache
Record Cache editor
General
Sources
Record Index
Comment
Adding a record assembler
Record Assembler editor
Sources
Record Index
Record Join
Comment
Configuring the join in the record assembler
Adding and Editing Source Properties
About adding and editing source properties
Record Manipulator editor
Sources
Record Index
Comment
Using Perl Manipulators to change Source Properties
About Perl Manipulators
Adding a Perl manipulator
Perl Manipulator editor
General
Sources
Record Index
Comment
Perl manipulator methods
Writing code in a Perl manipulator
Using an external Perl file
Using an external Perl class
Requirements for a Perl class
Method Override editor
Using Java Manipulators to change Source Properties
About Java Manipulators
Java Manipulator editor
Sources
Pass Throughs
Comment
Preparing for Indexing
Adding an indexer adapter
Indexer Adapter editor
General
Sources
Comment
Preparing Your Endeca Properties
About Endeca properties
Adding an Endeca property to an application
Working with Endeca Properties
Viewing all of your Endeca properties
Sorting properties in the Properties view
Adding a new Endeca property
Changing an Endeca property
Deleting an Endeca property
Using time, datetime, and duration property types
Loading date and time data
Using the .NET framework's DateTime structure
Working with time zones
Mapping a source property to an Endeca property
Property editor
General
Search Tab
Configuring Endeca Property Behavior
Enabling Display
Enabling Endeca property display in a record list
Enabling Endeca property display on a record page
Configuring Record Sort
About precomputing sort indices on a property
Configuring an Endeca property for record sort
Specifying a default record sort order
Relevance ranking versus record sort
Controlling the order of record results
About geospatial sorting
Preparing your geocode source data
Configuring a geocode Endeca property for sort
Mapping, presenting, and sorting by geocode properties
Troubleshooting record sorts
Enabling Record Search
Enabling a property for record search
Using Range Filtering
Using range filters
Enabling a property for range filtering
About geospatial filtering
Configuring a geocode Endeca property for filtering
Enabling Record Rollups
About aggregated Endeca records
About automatic phrasing
Enabling a property for record rollup
Enabling Wildcard Search
Enabling wildcard search for an Endeca property
Setting a property to use as the record spec
Troubleshooting Endeca properties
Preparing Your Dimension Hierarchy
About dimensions and dimension values
Dimensions
Dimension values
Auto-generated dimensions
Dimension value synonyms
Dimension.xml file
Adding Pipeline Support for Dimensions
Pipeline components that support dimensions
Dimension adapters
Dimension server
Persisting auto-generated dimensions
Supplying dimension data to property mappers
Adding a dimension adapter
Dimension Adapter editor
General
Sources
Transformer
Comment
Adding a dimension server
Dimension Server editor
General
Sources
Comment
Working with Dimensions and Dimension Values
Basic Dimension Tasks
About the Dimensions view
Viewing all of your dimensions
Sorting dimensions in the Dimensions view
Creating dimensions
Modifying dimensions
Deleting dimensions
Dimension editor
General
Search
Advanced
Dynamic Ranking
Cluster Discovery
Checking the ID of a dimension
Adding a dimension to a dimension group
Mapping a property to a dimension
Populating a Dimension with Dimension Values
About viewing dimension values
Associating properties with a dimension value
Viewing dimension values for a particular dimension
Dimension Value editor
Working with Manually Created Dimension Values
Adding dimension values
Configuring dimension values
Editing dimension values
Deleting dimension values
Renaming a dimension value
Specifying Dimension Value Synonyms
About synonyms
Adding synonyms to a dimension value
Creating Range Dimension Values
About range dimension values
Configuring a range dimension value
Synonym configuration for range dimension values
Classifying records with ranges
Combining exact and range matching
Using NEG_INF and POS_INF
A note about locale and encoding
Creating an "other" dimension value
Troubleshooting range dimension values
Providing additional descriptive information for a dimension value
Ranking Dimension Values
Controlling the order of dimension values
Ranking dimension values manually
Setting a default dimension value order
Manual versus auto-generated dimension values
Creating Non-navigable Dimension Values
Making a dimension value non-navigable (inert)
A typical scenario
Pruning dimension value refinements by frequency of occurrence
Ranking dimension values manually
Editing auto-generated dimension values
Loading versus promoting
Loading and promoting requirements
Cleaning up after promoting dimensions
Loading and promoting an auto-generated dimension
Cleaning up after promoting dimensions
Configuring Dimension Behavior
Enabling and Disabling Display
Enabling dimension display in a record list
Enabling dimension display on a record page
Preventing a dimension from appearing in the navigation controls
Configuring Record Sort
Specifying a default record sort order
Precomputing sort indices on a dimension
Relevance ranking versus record sort
Controlling the order of record results
Troubleshooting record sorts
Enabling Search
Enabling a dimension for record search
Dimension Search Configuration editor
Expanding search to include dimension hierarchy
Hierarchical search during record searches
Hierarchical search during dimension searches
Using hierarchical search during dimension searches
Using hierarchical search during record searches
Using Range Filtering
Using range filters
Enabling a dimension for range filtering
Enabling Wildcard Search
Enabling wildcard search for a dimension
Ranking Dimensions
Ranking dimensions manually
Counting the Number of Records Per Dimension Value
About dimension statistics
Enabling refinement statistics
Enabling Record Rollups
About aggregated Endeca records
Enabling a dimension for record rollups
Enabling Multi-Select AND or OR Dimensions
About multi-select dimensions
Enabling a dimension for multi-select
Multi-select OR and hierarchical dimensions
Working with Large Dimension Hierarchies
Enabling Collapsible Dimensions
About collapsible dimensions
Creating a collapsible dimension hierarchy
Making a dimension value collapsible
Setting a collapsible dimension threshold
A typical scenario
Creating Sift Dimensions
About sift dimensions
Configuring sift dimension values
Sifting an auto-generated dimension value
Sift dimension values and matching
Sift hierarchy recommendations
Saving autosift state information
Creating a sift dimension hierarchy
Defining a sift dimension as autogenerated
Using NEG_INF and POS_INF
A note about locale and encoding
Creating an "other" dimension value
A typical scenario
Setting the primary dimension
Troubleshooting dimensions
Mapping Source Properties
Understanding Source Property Mapping
About property mapping
Using a single property mapper
About explicit mapping
Choosing a match mode
Normal
Must Match
Auto Generate
Mapping Rules of Thumb
Mapping Example
Wine Type Dimension
Country Dimension
Body Dimension
Assigning multiple mappings to a single source property
Working with Property Mappers
Adding a property mapper
Property Mapper editor
Sources
Record Index
Advanced
Comment
Viewing existing property mappings
Creating Explicit Meanings
Establishing a dimension mapping
Establishing a property mapping
Establishing a null mapping
Advanced Property Mapping Techniques
Advanced techniques introduced
About mapping source properties to like-named dimensions
When no mapping is found
Priority order of source property mapping
About using null mappings to override implicit and default mappings
About setting a default maximum length for source property values
Troubleshooting source property mapping
Configuring Application Features
Configuring Precedence Rules
About precedence rules
Treatment of target dimensions associated with multiple precedence rules
The Precedence Rules view
Viewing all of your precedence rules
Precedence Rule editor
Creating precedence rules
Modifying precedence rules
Deleting precedence rules
Standard versus leaf precedence rules
Precedence rules and the implicit selection of dimension values
When precedence rules are overridden
Tips and troubleshooting for precedence rules
Configuring User Profiles
About user profiles
Viewing all of your user profiles
Creating user profiles
Modifying user profiles
Deleting user profiles
Specifying a user profile as a dynamic business rule trigger
Configuring Search Interfaces
Configuring Search
About search configuration
Using the Thesaurus
About the thesaurus
Creating thesaurus entries
Modifying thesaurus entries
Deleting thesaurus entries
Sorting thesaurus entries
Filtering thesaurus entries
Thesaurus entry recommendations
A thesaurus entry should never include a form that is a substring of another
Stop words should not be used in thesaurus forms
Avoid multi-word thesaurus forms where single-word forms are appropriate
Thesaurus forms should not use non-searchable characters.
One-way Thesaurus Entry editor
Two-way Thesaurus Entry editor
Using Stemming
About stemming
Enabling stemming
Stemming editor
Using Search Characters
About search characters
Adding search characters
Deleting search characters
Search Characters editor
Using Stop Words
About stop words
Creating stop words
Modifying stop words
Deleting stop words
Sorting stop words
Recommended stop words list
Using Automatic Phrasing
About automatic phrasing
Automatic phrasing and query expansion
Automatic phrasing, spelling correction, and DYM
Adding Phrases to a Project
Methods for adding phrases
Importing phrases from an XML file
Extracting phrases from dimension names
Adding search characters that support automatic phrasing
Tips and troubleshooting for automatic phrasing
Using the Spelling Dictionary
About the spelling dictionary
Specifying constraints on spelling dictionary content
Configuring Search Interface Options
About search interfaces
Viewing all of your search interfaces
Search Interfaces view
Creating search interfaces
Modifying search interfaces
Deleting search interfaces
Search Interface editor
Allowing cross-field matches
Customizing partial matching
Using Snippeting
About snippeting
Snippet format and size
Snippet property names
Snippets are dynamically generated properties
Enabling snippeting
Troubleshooting snippets
Using Relevance Ranking Modules
About relevance ranking
Creating ranking modules
Modifying ranking modules
Deleting ranking modules
Changing the order of ranking modules
Editing Static module parameters
Editing Phrase module parameters
Recommended relevance ranking strategies
Ranking Modules in Detail
Exact
Field
First
First's interaction with other features
Frequency
Glom
Interpreted
Maximum Field
Nterms
Number of Fields
Phrase
Configuring the Phrase module
Ranking based on sub-phrases
About approximate matching
Applying spelling correction, thesaurus, and stemming with the Phrase module
Editing Phrase module parameters
Summary of Phrase module option interactions
Effects of match modes on Phrase behavior
Stop words and Phrase module behavior
Phrase module behavior with cross-field matches and multiple matches
Treatment of wildcards by the Phrase module
Proximity
Spell
Static
Weighted Frequency
Configuring Keyword Redirects
About keyword redirects
Multiple keyword redirect triggers
Creating keyword redirects
Modifying keyword redirects
Deleting keyword redirects
Keyword Redirect editor
Grouping Keyword Redirects
About keyword redirect groups
Creating a keyword redirect group
Deleting a keyword redirect group
Redirect Group editor
Configuring Dynamic Business Rules
Using dynamic business rules to promote records
Comparing dynamic business rules to content management publishing
Dynamic business rule constructs
Record promotion examples
An example with one rule promoting records
An expanded example with three rules
Suggested workflow using Endeca tools to promote records
Incremental Implementation
Building Rules and Their Supporting Constructs
Building the Supporting Constructs
Building the supporting constructs for rules
Ensuring promoted records are always produced
The Zones View
Zone editor
Working with Styles
About styles
Controlling the number of promoted records
Performance and the Maximum Records setting
Ensuring consistent property usage with property templates
Indicating how to display promoted records
Creating a style
Style editor
Creating Rules
About creating dynamic business rules
Add Trigger editor
Creating a rule and ordering its results
Specifying when to promote records
Specifying a time trigger to promote records
Specifying which records to promote
Adding custom properties to a rule
Adding static records in rule results
Sorting the rules in the Rules view
Prioritizing rule evaluation order
Rule editor
Triggers
Time Triggers
Targets
Properties
Featured Records
Presenting rules results in a Web application
Grouping Rules
About grouping rules
Creating a rule group
Deleting a rule group
Prioritizing rule groups
Rule Group editor
Rule Group name editor
Interaction between dynamic business rules and rule groups
Applying relevance ranking to rule results
Configuring Dimension Groups
About dimension groups
Viewing all of your dimensions
Creating dimension groups
Modifying dimension groups
Deleting dimension groups
Dimension Group editor
Adding a dimension to an existing group
Dimension groups versus dimension hierarchy
Dimension groups and ranking
Dimension Groups view
Working with Your Pipeline
About pipelines
About the pipeline tab
About the Pipeline Diagram editor
About pipeline components
About adapters
About manipulators
About property mappers
About record assemblers
Record server components
About utility components
Adding a pipeline component
Adding a spider
Spider editor
Adding an update adapter
Update Adapter editor
General
Sources
Comment
Editing a pipeline component
Deleting a pipeline component
Record Manipulators and Expressions
Adding a record manipulator
Editing a record manipulator
About expressions
Adding an expression to a record manipulator
Writing Out Data for Diagnostic Purposes
Writing out record data
Writing out dimension data
Changing the Display of the Pipeline Diagram
Resizing the pipeline diagram
Changing the alignment of selected components in the diagram
Returning to the default layout
Displaying components that have dimension sources
Hiding the dimension flow
About specifying data flow among components
Viewing data flow among components
Connecting pipeline components graphically
About adding and removing pipeline components
Advanced Features
Restricting Access to Records
About access rules
About the Access Control System
Working with multiple access rules
Creating the Endeca.ACL.Allow.Read property
Creating an access rule
Running a baseline update for access rules
Configuring the Web application to use access rules
Crawling source data
About implementing partial updates
Working with external taxonomies
Externally managed
Externally created
The difference between externally managed and externally created taxonomies
Using Stratify taxonomies
Context Sensitive Help
About automatic phrasing
Additional Search Characters dialog box
Bypass URLs dialog box
Dimension Mapping dialog box
Edit Static Relevance Rank Module dialog box
Enqueue URL dialog box
Importing phrases from an XML file
Join Entry dialog box
Key Component dialog box
Mappings dialog box
Member Options dialog box (snippeting)
New Project dialog box
Null Mapping dialog box
Properties dialog box
Property dialog box
Property Mapping dialog box
Import External Dimensions dialog box
Relevance Ranking Modules dialog box
Search Interface Options dialog box
Select Dimension Adapter dialog box
Select Dimension editor
Select Dimension or Property dialog box
Select Dimension Value editor
Select Redirect Group dialog box
Select Rule Group dialog box
Specifying constraints on spelling dictionary content
Stop word editor
Synonyms dialog box
URL Filter dialog box
User Profile editor
Search Terms
