Senzing Engine Configuration

The Senzing engine requires basic configuration to start up. This configuration is supplied to the engine init functions as a JSON string. 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.

By default, Senzing automatically uses the SENZING_ENGINE_CONFIGURATION_JSON environment variable version of this configuration, if it exists.

If you are already familiar with working with Senzing and have used a project as outlined in the Quickstart Guides, you will be aware of the sz_engine_config.ini file used by the Python tools, such as sz_explorer. The sz_engine_config.ini file is used to get started quickly without needing to immediately understand this configuration. The supplied Senzing Python tools look for this file and convert the entries to a JSON string passed to the init functions.

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.

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.

LICENSESTRINGBASE64

License entitlement represented as base64 data. When you received a license package it will contain a file with the value to use for this setting.

LICENSEFILE

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

Section: SQL

Provides the connection URL to the Senzing repository database.

SENZING_ENGINE_CONFIGURATION_JSON example

{"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:password@127.0.0.1:5432:SZ"}}

Formatted 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:password@127.0.0.1:5432:SZ" }
 }

sz_engine_config.ini example

[PIPELINE]
 SUPPORTPATH=/home/user/senzing/data
 CONFIGPATH=/home/user/senzing/etc
 RESOURCEPATH=/home/user/senzing/resources

[SQL]
 CONNECTION=postgresql://user:password@127.0.0.1:5432:SZ