Oracle Commerce Guided Search

Dgraph

A Dgraph element launches the Dgraph (MDEX Engine) software, which processes queries against the indexed Endeca records.

Every Application Controller component 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 Dgraph element contains the following sub-elements:

Sub-element	Description
args	Command-line flags to pass to Dgraph, 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>
port	Required. The port at which the Dgraph should listen. The default is 8000.
log-file	The path to and name of the Dgraph log file. If the log-file is not specified, the default is component working directory plus component name plus “.log”.
input-prefix	Required. Path and prefix name for the Dgidx output that the Dgraph uses as an input.
app-config-prefix	Path and file prefix that define the input for the Dgraph. For example, in `/endeca/project/files/myProject`, files beginning with myProject in the directory `/endeca/project/files` are the ones to be considered.
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.
startup-timeout	Specifies the amount of time in seconds that the Application Controller waits while starting the Dgraph. If it cannot determine that the Dgraph is running in this timeframe, it times out. The default is 60.
req-log-file	Path to and name of the request log.
spell-dir	If specified, is the directory in which the Dgraph will look for Aspell files. If it is not specified, the Dgraph will look for Aspell files in the Dgraph’s input directory (that is, input-prefix without the prefix). For example, if input-prefix is /dir/prefix and all the Dgraph input files are /dir/prefix.*, the Dgraph will look for the Aspell files in /dir/.
update-dir	Specifies the directory from which the Dgraph reads partial update file. For more information, see the Endeca Partial Updates Guide.
update-log-file	Specifies the file for update-related log messages.
temp-dir	A temporary directory used by this component.
ssl-configuration	Contains three sub-elements of its own: cert-file: The cert-file specifies the path of the eneCert.pem certificate file that is used by the Dgraph to present to any client. This is also the certificate that the Application Controller Agent should present to the Dgraph when trying to talk to the Dgraph. The file name can be a path relative to the component’s working directory. ca-file: The ca-file specifies the path of the eneCA.pem Certificate Authority file that the Dgraph uses to authenticate communications with other Guided Search components. The file name can be a path relative to the component’s working directory. cipher: Specify one or more cryptographic algorithms, one of which Dgraph will use during the SSL negotiation. If you omit this setting, the Dgraph chooses a cryptographic algorithm from its internal list of algorithms. See the Endeca Commerce Security Guide for more information..

Example 15. Example

The following example provisions an SSL-enabled Dgraph component for use with the sample wine data:

<dgraph component-id="wine_dgraph" host-id="wine_indexer">
 <args>
	  <arg>--spl</arg>
	  <arg>--dym</arg>
 </args>
 <port>8000</port>
 <working-dir>
   C:\Endeca\PlatformServices\reference\sample_wine_data
 </working-dir>
 <input-prefix>.\data\partition0\dgraph_input\wine</input-prefix>
 <app-config-prefix>
   .\data\partition0\dgraph_input\wine
 </app-config-prefix>
 <log-file>.\logs\wine_dgraph.log</log-file>
 <req-log-file>.\logs\wine_dgraph_req_log.out</req-log-file>
 <startup-timeout>120</startup-timeout>
 <ssl-configuration>
	  <cert-file>
     C:\Endeca\PlatformServices\workspace\etc\eneCert.pem
   </cert-file>
	  <ca-file>
     C:\Endeca\PlatformServices\workspace\etc\eneCA.pem
   </ca-file>
	  <cipher>AES128-SHA</cipher>
 </ssl-configuration>
</dgraph>

Dgraph

Guided Search Administrator's Guide