Global default settings reference

The tables below describe the most common control script settings that are set globally.

You specify global default settings in the control script for settings that are shared across multiple bricks—for example, a working directory, a JCD port number, or a logging location. You can use any brick setting as a global default, as long as the setting makes sense in a global context. As necessary, you over ride a global default setting for a specific brick by specifying a different value for the setting in the brick’s definition. Unless you decide to over ride a global default, the global setting applies to all bricks in a control script.

Important: You can also override global default settings and brick-specific settings from the command line.

Basic global defaults

Setting	Description
`working_machine`	The machine on which to execute the bricks. This must match the name of a Machine brick, which contains all the information necessary to connect to that machine. This setting is required for remote execution. Otherwise, if it is not specified, the bricks will run on the same machine as the Control Interpreter itself. In a distributed implementation, over ride this setting in each Machine brick. For example, in an implementation with multiple Dgraphs, you would override this setting in each Dgraph brick.
`working_dir`	The directory to use as the current directory when executing the bricks. All relative paths in the brick definitions are relative to this directory.
`stdout_base`	File prefix to indicate where `stdout` will be written. `stdout_base` may be either a full pathname and prefix, or a prefix that is relative to the `working_dir`. Each brick writes its `stdout` to a file whose name begins with this prefix, and ends with the brick name. Note: You can send `stdout` and `stderr` to the same file.
`stderr_base`	File prefix to indicate where `stderr` will be written. `stderr_base` may be either a full pathname and prefix, or a prefix that is relative to the `working_dir`. Each brick writes its `stderr` to a file whose name begins with this prefix, and ends with the brick name. Note: You can send `stdout` and `stderr` to the same file.
`append_stdout`	Specifies whether to append `stdout` or overwrite it (the default). Values are `yes` or `no`. If a brick is executing on a remote machine, this setting is ignored and `stdout` is always appended.
`append_stderr`	Specifies whether to append `stderr` or overwrite it (the default). Values are `yes` or `no`. If a brick is executing on a remote machine, this setting is ignored and `stderr` is always appended.
`endeca_bin`	Path to the bin subdirectory of the Endeca Platform Services distribution you are using. Setting this path is equivalent to setting the path to the `forge` binary. Note: This setting is required if you want to download files from remote machines via the Endeca JCD. Note: There may be other files, such as Perl scripts, that reside in the bin subdirectory along with the forge binary. In order to reference other files in the bin directory, you must provide a complete pathname.
`endeca_mdex_bin`	Path to the bin subdirectory of the Endeca MDEX Engine distribution you are using. Setting this path is equivalent to setting the paths to the `dgidx`, `agidx`, `dgraph`, and `agraph` binaries all at once. You can override the `endeca_mdex_bin` setting in individual bricks with the `dgidx_binary`, `agidx_binary`, `dgraph_binary`, and `agraph_binary` settings. Note: There may be other files that reside in the bin subdirectory along with the `dgidx`, `agidx`, `dgraph`, and `agraph` binaries—for example, `dgwordlist`. The `endeca_mdex_bin` setting applies only to the four core Endeca MDEX Engine binaries. In order to reference other files in the bin directory, you must provide a complete pathname.
`environment_vars`	Specifies the name of a Constants brick that contains the environment variables that should be used while running the system. Note: The environment variables are completely replaced, and not simply added to. Therefore, if you use this setting, you must specify all of the environment variables that you will need, including `PATH`.
`perl_binary`	Path to the Perl interpreter to use on each machine in the deployment. This setting is required if you want to download files from remote machines via the Endeca JCD. Note: You must use version 5.8.3 of Perl as installed with the Endeca software. This path is used for remote file retrieval only. It is not used when running the Control Interpreter itself.
`wget_binary`	Path to the wget file-retrieval program file (installed as part of the standard Endeca installation). This setting is optional; if it is not specified in the control script, the system looks for it in the %ENDECA_ROOT%\bin directory on Windows and in $ENDECA_ROOT/bin on UNIX.
`jcd_port`	The port used to connect to the Endeca JCD. This must match the port listed in the `jcd.conf` file. The standard port for the Endeca JCD is `8088`.
`jcd_use_ssl`	Specifies whether or not the Control Interpreter must use SSL when communicating with the JCD on each machine. Values are `true` and `false`. If you have configured the JCD to use SSL (by setting `ssl=true` and specifying an `sslcertfile` in the `jcd.conf` file), then you must do the following in the control script: Set `jcd_use_ssl` to true. Specify an `sslcertfile`, as described below.
`sslcertfile`	Specifies the path of the certificate file, `eneCert.pem`, that Endeca components (Control Interpreter, Forge, Dgraph, and Agraph) should present when communicating with other Endeca components via SSL. You must set `sslcertfile` as a global default, although you can still override the default by setting a different `sslcertfile` within specific bricks. Note: In order to simplify installation and configuration, all Endeca components use the same certificate file, `eneCert.pem`, for secure communication. The `sslcertfile` you specify in `jcd.conf`, however, configures only the JCD, while the `sslcertfile` you specify in a control script dictates behavior for all other Endeca components, excluding the JCD. Note: This path is also used in conjunction with the `advanced forge_use_ssl` and `ene_use_ssl` settings described below.

Advanced security global defaults

The following settings are used in advanced security situations only.

Setting	Description
`forge_use_ssl`	Specifies whether Forge clients and servers should communicate with each other via SSL when running in parallel Forge mode. Values are `true` and `false`. If `forge_use_ssl` is set to `true`, you must also specify an `sslcertfile`, as described above, to indicate the location of the certificate file that Forge clients should present to Forge servers.
`ene_use_ssl`	When set to `true`, the `ene_use_ssl` setting specifies that: The Control Interpreter should start all MDEX Engines (Dgraphs or Agraphs) with SSL flags enabled. Clients must use SSL to communicate with MDEX Engine servers (Dgraph and Agraph). If `ene_use_ssl` is set to `true`, you must also specify an `sslcertfile`, as described above, to indicate the location of the certificate file that clients should present to MDEX Engine servers.
`sslcafile`	Specifies the path of the certificate authority file, `eneCA.pem`, that Endeca components should use to authenticate communication initiated by their clients.
`sslcipher`	Specifies the cipher the Endeca components should use when communicating with each other via SSL.