Modifying Deployment Template files to support custom applications
This section provides information about deploying custom applications.
Copyright ©
Legal Notices
Guided Search Administrator's Guide
Documentation Home
Feedback
Highlighting
Prev
Up
Next
Contents
Search
Preface
About this guide
License restrictions for Rule Manager
Who should use this guide
Conventions used in this guide
Contacting Oracle Support
Oracle Commerce Guided Search Applications
Components of Guided Search applications
Tools and Frameworks
MDEX Engine
Platform Services
Content Acquisition System
About the Oracle Endeca Application Controller
EAC architecture
EAC Central Server
EAC Agents
EAC architecture example
The Deployment Template
About the AppConfig.xml file
About deploying an application with the Deployment Template
Files in a Guided Search application
Application configuration files
Instance configuration files
Command-line scripts
Java libraries
Forge state files
Permissions for Deployed Application Files
Architecture for small and medium throughput
Medium implementation with higher throughput
Small implementation with lower throughput
Designing a Portable Application
Controlling paths to ensure interoperability across environments
Use forward slashes
Use relative paths in the pipeline
Use variables in scripts
Creating a custom file for environment-specific settings
Planning and configuring server topology
Creating and Duplicating Environments
Staging and production environments
Implementation size
Managing Content in the Staging and Production Environments
Publishing content changes in a staging environment
Consolidating generation data in a staging environment
Promoting application content to a production environment
Multiple server environments
Deploying and initializing an application
About deploying applications
Deploying and initializing an application
Directories created by the Deployment Template
Configuring automated, file-based deployment
Running a baseline update with test data
Running a baseline update with production data
Running a partial update with production data
Running CAS crawls
Provisioning an application with the Endeca Application Controller
Updating application configuration for a provisioned application
Removing a component from an application
Configuring the application on multiple servers
Adding MDEX Engine servers and Dgraphs to the servers
Additional customization tasks
Replicating application definitions across environments
Replicating application definitions
Collecting the files that make up an application
Changing the IP address for the EAC Central Server machine
Working with Multiple Sites
About sites
Site definitions
Site definition properties
URL pattern matching in the site definition.
Site-based filters
Site-based keyword redirects
Keyword redirect groups
Adding a site to an existing application
Configuring site-based keyword redirects
Configuring site awareness in action links
Updating a site
Removing a site
Configuring Communication Between Components
About Workbench interaction with the Endeca Configuration Repository
Specifying Workbench authentication credentials for the Endeca Configuration Repository
Password Expiry and Account Locking for Workbench Users
Password security requirements for Workbench users
About Workbench interaction with the MDEX Engine
About accessing files on remote servers
About cross-domain policy files
Setting up a cross-domain policy file
Configuring the Assembler
Configuring the Assembler administrative servlet
Configuring Workbench
The Workbench session cookie
Configuring Workbench locales
About configuring Workbench for locales
Locales for custom extensions and menus
Localizing Workbench extensions
Localizing menu nodes
Configuring the Report Scheduler for locales
Configuring Workbench logs
Managing Users in Workbench
Users and permissions in Workbench
User management and LDAP
User management and Oracle Commerce Single Sign-On
Special characters
Logging in to Workbench as an administrator
Changing the administrator's password
Best practices
Adding administrators to Workbench
Adding groups to Workbench
Adding business users to Workbench
Modifying users and groups
Changing a group's membership
Deleting users from Workbench
Configuring the user inactivity logout
Integrating LDAP with Oracle Commerce Workbench
About LDAP integration with Workbench
Supported versions of LDAP
User authentication in Workbench with LDAP enabled
Permissions for LDAP users and groups
Granting Workbench administrator privileges to LDAP users and groups
Enabling LDAP authentication in Workbench
About disabling LDAP authentication in Workbench
About the LDAP login configuration file
Templates used in the LDAP login profile
Syntax of LDAP login profile configuration parameters
Configuration parameters for the LDAP login profile
Configuration parameters for identity information stored in LDAP
LDAP path parameters
About specifying multiple values for parameters in the LDAP login profile
Specifying the location of the LDAP login configuration file
Specifying the location of the LDAP login configuration file using Windows Services
Troubleshooting user authentication in Workbench with LDAP enabled
Incorrect Username or Password
An error occurs while trying to validate your credentials
Configuring SSL for Oracle Commerce Workbench
About configuring SSL in Workbench
Enabling the SSL version of Oracle Commerce Workbench
Modifying the server.xml for the Endeca Tools Service
Customizing Oracle Commerce Workbench
The navigation menu and launch page
Navigation menu nodes
Predefined menu nodes in Oracle Commerce Workbench
About navigation menu leaf items
Predefined menuitem elements
Updating the Oracle Commerce Workbench menu and launch page
Hiding user segment settings in Workbench
Workbench extensions
Configuring extensions in Workbench
Extension element attributes
Enabling extensions in Oracle Commerce Workbench
URL tokens and Workbench extensions
URL token reference
Token-based authentication for Workbench extensions
Troubleshooting Workbench extensions
If the extension does not have a link in the navigation menu or launch page:
If the link displays in the menu but the extension does not display when you click the link:
If an error message displays after updating ws-extensions.xml:
Integrating Workbench with the Business Control Center
Integrating Workbench with Oracle Commerce Single Sign-On
Integrating Workbench with Oracle Access Management Single Sign-On
Enabling Identity Assertion validation in OAM
Configuring an EAC Application
About configuring an EAC application
Application configuration files
Configuring the application configuration files
Global configuration
The LockManager
Dgraph configuration
Global Dgraph settings
Individual Dgraph settings
Dgraph clusters and hosts
Restart, update, and content groups
Startup and shutdown scripts
Enabling SSL for a Dgraph
Data Ingest configuration with Forge
Defining indexers
CAS crawl configuration
The custom-component configuration properties
Common configuration properties
Configuration properties specific to MDEX-compatible output
Example
Configuration properties specific to Record Store output
Example
Configuration properties specific to record file output
Example
Endeca Configuration Repository
The custom-component configuration properties
IFCR configuration properties
Example
Reporting
Logging and reporting configuration
Log servers
Fault tolerance and polling interval properties
Fault tolerance property
Polling interval properties
Fault tolerance and polling interval for utilities
Replacing the Default Forge Pipeline
About the XML configuration files
About the sample pipelines
Sample pipeline overview
Creating a new project
Modifying an existing project
Configuring a record specifier
Forge flags
Primary Forge flags
Partial update Forge flags
Input record adapters
Dimension adapters
Indexer adapters
Output record adapters
Dimension servers
Common errors
Unable to Find Pipeline.epx
Missing Configuration Files
MDEX Engine Fails to Start
Record Adapter Unable to Open File
Modifying Index Configuration for an Application
Overview of the Index Configuration Command-line Utility
Help options
Command-line options
About index configuration ownership
Creating and deleting import owners
Examining index configuration for an owner
Overwriting index configuration per owner
Setting global configuration
Merging index configuration from multiple owners
About the schema for the index configuration file
Schema for an Endeca property, derived property, or dimension
Schema for an attribute node that defines an Endeca property
Schema for an attribute node that defines an Endeca derived property
Schema for an attribute node that defines an Endeca dimension
Example index configuration for two owners and all configuration types
Schema for precedence rules
Schema for a precedenceRule node to define a precedence rule
Example index configuration for precedence rules
Schema for global index configuration
Schema for a searchIndexConfig node
Example index configuration for global settings
Getting the index configuration for an application
Getting the merged index configuration for an application
Setting the index configuration for an application
Deleting the index configuration associated with an owner
An example of changing multi-select on a dimension
An example of changing a product.brand.name property to a dimension
An example of setting dimension display order
Configuration overrides
Modifying Deployment Template files to support custom applications
Custom application descriptors
Configuring an automated/file-based deployment for a custom application
Monitoring Application Components
Determining the state of the EAC Central Server and Agents
Starting and stopping the EAC
Starting the EAC from inittab
Logs for the EAC Central Server
Optimizing EAC memory usage
Checking the status of application components
Using the Assembler administrative servlet
The Assembler performance statistics page
General statistics
Worst root event statistics
Per event statistics
Enabling performance logging
Using the EAC Administration Console in Workbench
Monitoring Host and Component status
Starting and stopping the MDEX Engine
Running a baseline update
Starting and stopping the Log Server
Rolling Log Server logs
Archiving Dgraph log files
About Workbench logs
Configuring and Viewing Assembler Usage Reports
About product licensing and usage reports
Configuring usage logging
Scheduling usage collection
Usage log format
Generating usage reports from log files
Administering the MDEX Engine
Administering the Dgidx
About Dgidx processing
Dgidx memory usage
Running the Dgidx process with the Deployment Template
Running the Dgidx binary at the command prompt
Tips for speeding up indexing time
Troubleshooting Dgidx failures
Troubleshooting Deployment Template failures with Dgidx
Troubleshooting memory allocation failures with Dgidx
Dgidx logs
Dgidx log details for text search indexing
Dgidx handling of records with missing or duplicate record spec values
Variations in Dgidx indexing time
Administering a Dgraph
Checking Dgraph with the ping command
Specifying arguments to the Dgraph in the Deployment Template
Collecting debugging information
The logs created by the Dgraph
Dgraph request log
Dgraph error log
Update log
Process start log
EQL per-query statistics log
Troubleshooting baseline update failures
Troubleshooting partial updates
Accessing failed update files
Permission to access index directories
Identifying connection errors
Troubleshooting socket and port errors with Dgraph
Managing the Dgraph core dump files
Managing Dgraph crash dump files on Windows
Managing Dgraph core dump files on Linux and Solaris
Dgraph administrative and configuration operations
Dgraph URL operation syntax
List of administrative operations
help
ping
flush
exit
restart
audit
auditreset
stats
statsreset
logroll
update
Processing updates from a single file
updateaspell
updatehistory
reload-services
List of configuration operations
help
update
About MDEX Engine logging variables
Logging variable operation syntax
List of supported logging variables
log-enable
log-disable
log-status
Configuring the Relevance Ranking Evaluator
About the Relevance Ranking Evaluator
Configuring an MDEX Engine
Configuring Relevance Ranking Evaluator properties
Troubleshooting Application Components
Troubleshooting publishing content from the Endeca Configuration Repository to the MDEX Engine
Analyzing Deployment Template script errors
Releasing locks set by the Deployment Template in the EAC
Avoiding defunct EAC processes on UNIX
Backing Up an Assembler Application
About backing up and restoring a Guided Search application
Backing up an application from the Workbench
Backing up the application state
Backing up the Workbench configuration files
Backing up CAS configurations
Assembler application file reference
Non-essential files
Restoring an Assembler Application
Restoring a backup of a site to the Endeca Configuration Repository
Restoring a backup of the application state
Restoring a backup of Workbench configuration files
Exporting and Importing Workbench Content
Steps for Exporting and Importing Workbench Content
Types of Workbench Content That Can be Exported and Imported In Public Format
Types of Workbench Content that Are Exported and Imported in Other (non-Public) Formats
Steps for Exporting and Importing a Complete Set of Workbench Content
Exporting Workbench Content in Public Formats
Overview of Exporting and Importing Workbench Content
Exporting Workbench Content
Importing Workbench Content
Exporting and Importing Permissions
Folders for Exported Content
Public JSON Formats for Exported Content
Public JSON Formats for Content Items
Triggers
Example of a content-item
Public JSON Formats for deployment-settings
Public JSON Formats for Keyword Redirects
Public JSON Formats for Page-Root and Page
Public JSON Formats for Phrases
Public JSON Formats for Site Homes
Public JSON Formats for Templates
Public JSON Formats for Thesaurus
Public JSON Formats for User Segments
Public JSON Formats for Workbench Settings
Public JSON Formats for Workspaces
Public format for workspace-root
Public format for workspace
Public formats within workspace documents
Update example
Move example
Guided Search Environment Variables and Port Usage
Guided Search environment variables
MDEX Engine variables
Endeca Tools Service
Platform Services variables
Endeca Tools and Frameworks variables
Other variables
Guided Search ports
Service ports
Deployment Template ports
Assembler ports
Reference implementation ports
Guided Search Flag Reference
Dgidx flags
Dgraph flags
XML Configuration Files
About the XML configuration files
Creating XML configuration files
Deployment Template Script Reference
Deployment Template script reference
Provisioning scripts
Forge-based data processing
Dgraph baseline update script using Forge
Dgraph partial update script using Forge
Preventing non-nillable element exceptions
Dgraph baseline update script using Forge and a CAS full crawl script
Dgraph partial update script using Forge and a CAS incremental crawl script
Multiple CAS crawls and Forge updates
CAS-based data processing
Dgraph baseline update script using CAS
Dgraph partial update script using CAS
CAS crawl scripts for Record Store output
CAS crawl scripts for record file output
Report generation
The Endeca Application Controller eaccmd Utility
Running eaccmd
eaccmd usage
eaccmd Feedback
About incremental provisioning
Incrememental provisioning guidelines
About the def_file setting
About the --force flag
Adding a component in eaccmd
Removing a component in eaccmd
Modifying a component in eaccmd
Adding a host in eaccmd
Removing a host in eaccmd
Modifying a host in eaccmd
Adding a script in eaccmd
Removing a script in eaccmd
Modifying a script in eaccmd
Component and utility status verbosity
Server component status verbosity
Batch component status verbosity
Specifying the EAC Central Server host and port
Application component reference
Forge
Dgidx
Dgraph
LogServer
ReportGenerator
eaccmd command reference
Provisioning commands
Provisioning example
Incremental provisioning commands
Incremental provisioning example
Synchronization commands
About the Synchronization service
Component and script control commands
Component control example
Utility commands
General notes on Application Controller utilities
The List Directory Contents (ls) command
Wildcard behavior
Delimiting wildcard arguments
The Shell utility
Shell utility examples
Troubleshooting the Shell utility
The Copy utility
Copy utility examples
About the Copy utility
Destination directories
Failure and recovery
Explicit machine naming
Delimiting wildcard elements
Copying across platforms
The Archive utility
Backup operations
Backup operation example
Rollback operations
Rollback operation example
The Endeca Application Controller Development Toolkit
EAC Development Toolkit distribution and package contents
eacToolkit.jar
eacComponents.jar
eacHandlers.jar
spring.jar
bsh-2.0b4.jar
EAC Development Toolkit usage
Application Configuration File
Spring framework
XML schema
Application elements
Hosts
Components
Utilities
Customization/extension within the toolkit's schema
Implement a custom component
Extend an existing object
Implement custom functionality in BeanShell scripts
Customization/extension beyond the toolkit's schema
BeanShell Scripting
Script implementation
BeanShell interpreter environment
About implementing logic in BeanShell
Command Invocation
Invoke a method on an object
Identify available methods
Update application definition
Remove an application
Display component status
Endeca Application Controller API Reference
Using the Application Controller WSDL
Simple types in the Application Controller WSDL
Interface Reference
ComponentControl interface
startComponent(FullyQualifiedComponentIDType startComponentInput)
stopComponent(FullyQualifiedComponentIDType stopComponentInput)
Synchronization interface
setFlag(FullyQualifiedFlagIDType setFlagInput)
removeFlag(FullyQualifiedFlagIDType removeFlagInput)
removeAllFlags(IDType removeAllFlagsInput)
listFlags(IDType listFlagsInput)
Utility interface
startBackup(RunBackupType startBackupInput)
startFileCopy(RunFileCopyType startFileCopyInput)
startRollback(RunRollbackType startRollbackInput)
startShell(RunShellType startShellInput)
stop(FullyQualifiedUtilityTokenType)
getStatus(String applicationID, String token)
listDirectoryContents(ListDirectoryContentsInputType listDirectoryContentsInput)
Provisioning interface
defineApplication(ApplicationType application)
getApplication(IDType getApplicationInput)
getCanonicalApplication(IDType getCanonicalApplicationInput)
listApplicationIDs(listApplicationIDsInput)
removeApplication(RemoveApplicationType removeApplicationInput)
addComponent(AddComponentType addComponentInput)
removeComponent(RemoveComponentType removeComponentInput)
updateComponent(UpdateComponentType updateComponentInput)
addHost(AddHostType addHostInput)
updateScript(UpdateScriptType updateScriptInput)
removeHost(RemoveHostType removeHostInput)
updateHost(UpdateHostType updateHostInput)
addScript(AddScriptType addScriptInput)
removeScript(RemoveScriptType removeScriptInput)
ScriptControl interface
startScript(FullyQualifiedScriptIDType startScriptInput)
stopScript(FullyQualifiedScriptIDType stopScriptInput)
getScriptStatus(FullyQualifiedScriptIDType getScriptStatusInput)
Class Reference
AddComponentType class
AddComponentType properties
AddHostType class
AddHostType properties
AddScriptType class
AddScriptType properties
ApplicationIDListType class
ApplicationIDListType properties
ApplicationType class
ApplicationType properties
BackupMethodType class
BackupMethodType fields
BatchStatusType class
BatchStatusType properties
ComponentListType class
ComponentListType properties
ComponentType class
ComponentType properties
DgidxComponentType class
DgidxComponentType properties
DgraphComponentType class
DgraphComponentType properties
DirectoryListType class
DirectoryListType property
DirectoryType class
DirectoryType properties
EACFault class
EAC Fault property
FilePathListType class
FilePathListType property
FilePathType class
FilePathType properties
FlagIDListType class
FlagIDListType property
ForgeComponentType class
ForgeComponentType properties
FullyQualifiedComponentIDType class
FullyQualifiedComponentIDType properties
FullyQualifiedFlagIDType class
FullyQualifiedFlagIDType properties
FullyQualifiedHostIDType class
FullyQualifiedHostIDType properties
FullyQualifiedScriptIDType class
FullyQualifiedScriptIDType properties
FullyQualifiedUtilityTokenType class
FullyQualifiedUtilityTokenType properties
HostListType class
HostListType property
HostType class
HostType properties
ListApplicationIDsInput class
ListDirectoryContentsInputType class
ListDirectoryContentsInputType properties
LogServerComponentType class
LogServerComponentType properties
PropertyListType class
PropertyListType property
PropertyType class
PropertyType properties
ProvisioningFault class
ProvisioningFault properties
RemoveApplicationType class
RemoveApplicationType properties
RemoveComponentType class
RemoveComponentType properties
RemoveHostType class
RemoveHostType properties
RemoveScriptType class
RemoveScriptType properties
ReportGeneratorComponentType class
ReportGeneratorComponentType properties
RunBackupType class
RunBackupType properties
RunFileCopyType class
RunFileCopyType properties
RunRollbackType class
RunRollbackType properties
RunShellType class
RunShellType properties
RunUtilityType class
RunUtilityType properties
ScriptListType class
ScriptListType properties
ScriptType class
ScriptType properties
SSLConfigurationType class
SSLConfigurationType properties
StateType class
StateType fields
StatusType class
StatusType properties
TimeRangeType class
TimeRangeType fields
TimeSeriesType class
TimeSeriesType fields
UpdateComponentType class
UpdateComponentType properties
UpdateHostType class
UpdateHostType properties
UpdateScriptType class
UpdateScriptType properties
Search Terms
