Oracle Commerce Guided Search

Dgidx

A Dgidx component sends the finished data prepared by Forge to the Dgidx program, which generates the proprietary indices for each Dgraph.

Every Application Controller element contains the following attributes:

Attribute	Description
component-id	Required. The name of this instance of the component.
host-id	Required. The alias of the host upon which the component is running.
properties	An optional list of properties, consisting of a required name and an optional value.

The Dgidx element contains the following sub-elements:

Sub-element	Description
args	Command-line flags to pass to Dgidx, expressed as a set of arg sub-elements. If an argument takes a value, the argument and value must be on separate lines in the provisioning file. For example: <args> <arg>--threads</arg> <arg>3</arg> </args>
app-config-prefix	Path and file prefix that define the input for Dgidx. For example, in `/endeca/project/files/myProject`, files beginning with myProject in the directory `/endeca/project/files` are the ones to be considered.
output-prefix	Required. Path and prefix name for the Dgidx output. For example, `output_prefix = c:\temp\wine` generates files that start with “wine” in the `c:\temp` directory.
log-file	The path to and name of the Dgidx log files. If the log-file is not specified, the default is component working directory plus component name plus “.log”. Dgidx can generate three distinct log files: the basic component log file, and two files that log the subtasks described in run-aspell, below. The file dgwordlist logs stdout/stderr for the dgwordlist subtask described below. The name of this file is derived from the Dgidx component’s log-file location, plus the term “dgwordlist”. If an extension exists, “dgwordlist” is added before the extension. For example, if the original log-file is `C:\dir\dgidx-1.log`, then the dgwordlist log would be `C:\dir\dgidx-1.dgwordlist.log`. The file aspellcopy logs the stdout/stderr for the subtask of uploading the Aspell files to Dgidx’s output directory, where the Dgraph can access them. The name of this file is derived from the Dgidx component’s log-file location, plus the term “aspellcopy”. If an extension exists, “aspellcopy” is added before the extension. For example, if the original log-file is `C:\dir\dgidx-1.txt`, then the aspellcopy log would be `C:\dir\dgidx-1.aspellcopy.txt`.
input-prefix	Required. Path and prefix name for the Forge output that Dgidx indexes.
working-dir	Working directory for the process that is launched. If it is specified, it must be an absolute path. If any of the other properties of this component contain relative paths, they are interpreted as relative to the working directory. If working-dir is not specified, it defaults to `$ENDECA_CONF/work/<appName>/<componentName>` on UNIX, or `%ENDECA_CONF%\work\<appName>/<componentName>` on Windows.
run-aspell	Specifies Aspell as the spelling correction mode for the implementation. This causes the Dgidx component to run dgwordlist and to copy the Aspell files to its output directory, where the Dgraph component can access them. The default is true. See log-file above for details on the logging of these subtasks. For Aspell details, see the MDEX Engine Developer's Guide.
temp-dir	A temporary directory used by this component.

Example 14. Example

The following example provisions a Dgidx component to work with the sample wine data:

<dgidx component-id="wine_dgidx" host-id="wine_indexer">
	<args>
		<arg>-v</arg>
	</args>				
	<working-dir>
   C:\Endeca\PlatformServices\reference\sample_wine_data
 </working-dir>
	<input-prefix>.\data\partition0\forge_output\wine</input-prefix>
	<app-config-prefix>
   .\data\partition0\forge_output\wine
 </app-config-prefix>
	<output-prefix>.\data\partition0\dgidx_output\wine</output-prefix>
	<log-file>.\logs\wine_dgidx.log</log-file>
	<run-aspell>true</run-aspell>
</dgidx>

Dgidx

Guided Search Administrator's Guide