Senzing Engine Configuration

Senzing requires an engine configuration that specifies resource paths, a database connection, and license information. It can be supplied as the SENZING_ENGINE_CONFIGURATION_JSON environment variable or the sz_engine_config.ini file.

By default, Senzing automatically uses the SENZING_ENGINE_CONFIGURATION_JSON environment variable, if it exists. Using a JSON string allows for immutable images and the configuration data to be stored in flexible ways, for example, using Docker images and environment variables.

When constructing your own applications utilizing the Senzing SDK, use familiar or standard procedures for storing and retrieving configuration data.

Only the most common configuration options are described herein. When working with support, we may ask you to set additional parameters for diagnostics.

SENZING_ENGINE_CONFIGURATION_JSON example

Single line:

{"PIPELINE":{"CONFIGPATH":"/etc/opt/senzing","RESOURCEPATH":"/opt/senzing/er/resources","SUPPORTPATH":"/opt/senzing/data","LICENSESTRINGBASE64":"<insert contents of base64 file here>"},"SQL":{"CONNECTION":"postgresql://user:[email protected]:5432:SZ"}}

For readability:

{
  "PIPELINE": {
    "CONFIGPATH": "/etc/opt/senzing",
    "RESOURCEPATH": "/opt/senzing/er/resources",
    "SUPPORTPATH": "/opt/senzing/data",
    "LICENSESTRINGBASE64": "<insert contents of base64 file here>"
  },
  "SQL": {
    "CONNECTION": "postgresql://user:[email protected]:5432:SZ"
  }
}

For setting the environment variable on a command line:

export SENZING_ENGINE_CONFIGURATION_JSON='{"PIPELINE":{"CONFIGPATH":"/etc/opt/senzing","RESOURCEPATH":"/opt/senzing/er/resources","SUPPORTPATH":"/opt/senzing/data","LICENSESTRINGBASE64":"<insert contents of base64 file here>"},"SQL":{"CONNECTION":"postgresql://user:[email protected]:5432:SZ"}}'

sz_engine_config.ini example

[PIPELINE]
SUPPORTPATH=/home/user/senzing/data
CONFIGPATH=/home/user/senzing/etc
RESOURCEPATH=/home/user/senzing/resources
LICENSESTRINGBASE64=<insert contents of base64 file here>

[SQL]
CONNECTION=postgresql://user:[email protected]:5432:SZ

Section: PIPELINE

SUPPORTPATH

Points to the data directory that contains supporting files used by the Senzing engine. If you are utilizing a Senzing project this points to <project_path>/data.

CONFIGPATH

Points to user modifiable files. When using a Senzing project, these files are located in <project_path>/etc.

Licensing

When you receive a license from Senzing, add it to the PIPELINE section using one of the following settings.

LICENSESTRINGBASE64

License entitlement represented as a base64-encoded string. When you receive a license from Senzing, the package contains a file with the base64 value. Copy the entire contents of that file and use it as the value for this setting.

LICENSEFILE

Points to a license file received from Senzing. For existing licenses only. All new licenses use LICENSESTRINGBASE64.

Section: SQL

CONNECTION

Provides the connection URL to the Senzing repository database. The format depends on the database type:

For database tuning guidance, see Database Tuning .