v4 macOS Quickstart

This article outlines installing the Senzing SDK natively on macOS, performing loading and entity resolution, analysis and exploration of the outcomes of entity resolution, and how to prepare and load your own data to Senzing.

The installation steps only need to be completed once. During installation you will be asked to accept the End User License Agreement (EULA).

Installing Senzing

Senzing is installed on macOS with Homebrew. As of v4.4.0 the command-line tools are native binaries and no longer require a Python runtime.

Add the Homebrew tap

Add the Senzing tap to Homebrew. This only needs to be completed once.

brew tap senzing/senzingsdk https://github.com/Senzing/homebrew-senzingsdk

brew trust senzing/senzingsdk

Install the cask

brew install --cask senzingsdk

To accept the EULA without an interactive prompt, for example in a CI pipeline, set HOMEBREW_SENZING_ACCEPT_EULA before installing.

HOMEBREW_SENZING_ACCEPT_EULA=i_accept_the_senzing_eula brew install --cask senzingsdk

ls "$(brew --prefix)/opt/senzing/er/lib/libSz.dylib"

The cask installs the sqlite and openssl@3 formulae if they are not already present. To use PostgreSQL, also install libpq.

brew install libpq && brew link libpq --force

Create a Senzing project

To begin using Senzing, first create a project. This deploys an instance of Senzing into a specified path. The project folder must not already exist and will be created by the sz_create_project utility.

$(brew --prefix)/opt/senzing/er/bin/sz_create_project <senzing_project_path>

Creating and using projects provides independent and isolated instances of Senzing. Projects can be upgraded from prior Senzing versions.

For example, the following command creates the Senzing project in your current users home path in a new directory named senzing:

$(brew --prefix)/opt/senzing/er/bin/sz_create_project ~/senzing

Configure environment

To utilize your new project, environment variables need to be set indicating where to find resources for the project. The setupEnv script is project dependent and needs to be run whenever you are working with a project, for example between logging in and out of shell sessions. To setup the environment, change to your project directory and source the setupEnv file.

cd <senzing_project_path>

source setupEnv

Updating database with Senzing ER configuration

A Senzing instance is configured with a Senzing Entity Resolution configuration. The Senzing ER configuration is stored as a JSON document. On a fresh installation this configuration needs to be registered in the Senzing database. This step only needs to be performed once initially for a new project.

./bin/sz_setup_config -a

./bin/sz_setup_config

Loading the truth set data

To get started with some data, load the Senzing example truth set by:

Understanding the truth set files

The truth set demo includes three main types of files, each serving a distinct purpose in entity resolution:

• Customers: Represent your subjects of interest such as these customers. But they could easily be employees for insider threat detection, vendors for supply chain management, or other tracked entities. These records form the core dataset you aim to analyze and resolve.
• Watchlist: Contains entities you want to avoid due to potential risks. Examples include past fraudsters, known terrorists, money launderers, or entities on mandated exclusion lists (e.g., sanctions lists like OFAC). By integrating watchlist data, Senzing helps you identify high-risk entities by matching them against your subject records. This enables risk assessment by flagging connections to undesirable entities, helping you mitigate threats like fraud, regulatory non-compliance, or reputational damage.
• Reference List: Includes supplemental data purchased or acquired about individuals (e.g., demographics, past addresses, contact methods) or companies (e.g., firmographics, corporate structure, executives, ownership). This data enriches your understanding of your subjects by providing additional context, such as historical addresses to track entity movement or corporate hierarchies to identify ultimate beneficial owners. This deeper insight improves entity resolution accuracy and supports use cases like customer profiling or due diligence.

Download the files

curl -O https://raw.githubusercontent.com/Senzing/truth-sets/main/truthsets/demo/customers.jsonl

curl -O https://raw.githubusercontent.com/Senzing/truth-sets/main/truthsets/demo/reference.jsonl

curl -O https://raw.githubusercontent.com/Senzing/truth-sets/main/truthsets/demo/watchlist.jsonl

Add the data sources

sz_configtool

Type help or ? for help

addDataSource CUSTOMERS

Data source successfully added!

addDataSource REFERENCE

Data source successfully added!

addDataSource WATCHLIST

Data source successfully added!

save

WARNING: This will immediately update the current configuration in the Senzing repository with the current configuration!

Are you certain you wish to proceed and save changes? (y/n)

y

Configuration changes saved

quit

Load the files

sz_file_loader -f customers.jsonl

sz_file_loader -f reference.jsonl

sz_file_loader -f watchlist.jsonl

Explore the results

See EDA Tools: sz_explorer

sz_explorer

  ____|  __ \     \
  __|    |   |   _ \   Senzing
  |      |   |  ___ \  Exploratory Data Analysis
 _____| ____/ _/    _\


Type help or ? to list commands.

(szeda) get CUSTOMERS 1070

Entity summary for entity 98: Jie Wang
┼───────────┼────────────────────────────────────────┼─────────────────┼
│ Sources   │ Features                               │ Additional Data │
┼───────────┼────────────────────────────────────────┼─────────────────┼
│ CUSTOMERS │ NAME: Jie Wang (PRIMARY)               │ AMOUNT: 100     │
│ 1069      │ NAME: 王杰 (NATIVE)                    │ AMOUNT: 200     │
│ 1070      │ DOB: 9/14/93                           │ DATE: 1/26/18   │
│           │ GENDER: Male                           │ DATE: 1/27/18   │
│           │ GENDER: M                              │ STATUS: Active  │
│           │ ADDRESS: 12 Constitution Street (HOME) │                 │
│           │ NATIONAL_ID: 832721 Hong Kong          │                 │
│           │ NATIONAL_ID: 832721                    │                 │
│           │ RECORD_TYPE: PERSON                    │                 │
┼───────────┼────────────────────────────────────────┼─────────────────┼
│ REFERENCE │ NAME: Wang Jie (PRIMARY)               │ CATEGORY: Owner │
│ 2013      │ DOB: 1993-09-14                        │ STATUS: Current │
│           │ RECORD_TYPE: PERSON                    │                 │
│           │ REL_POINTER: 2011 (OWNS 60%)           │                 │
┼───────────┼────────────────────────────────────────┼─────────────────┼
└── Disclosed relation (1)
    └── --> OWNS 60% (1)
        └── 182: Hajah Mamunah Jln Pisang CUSTOMERS (1) | REFERENCE (1) +REL_POINTER(OWNS 60%:)

Mapping your own data

At this point you are ready to map and load your own data. Mapping is the process of converting your source data into a structure Senzing understands ready to load.

Consider these examples, in your data an attribute describing a personal full name is in a database table with the column name fullname. In Senzing a full name is represented by the term NAME_FULL. Similarly for address line 1, your database column is named addressline1, in Senzing this is represented by the term ADDR_LINE1.

Your task in mapping is to determine which attributes in your data source(s) are appropriate for use in entity resolution, extract those attributes and construct the structure describing those attributes to send to Senzing. The following is an example of a Senzing mapped JSON structure for an entry from a data source.

{
  "DATA_SOURCE": "CUSTOMERS",
  "RECORD_ID": "1001",
  "RECORD_TYPE": "PERSON",
  "PRIMARY_NAME_LAST": "Smith",
  "PRIMARY_NAME_FIRST": "Robert",
  "DATE_OF_BIRTH": "12/11/1978",
  "ADDR_TYPE": "MAILING",
  "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132",
  "PHONE_TYPE": "HOME",
  "PHONE_NUMBER": "702-919-1300",
  "EMAIL_ADDRESS": "[email protected]"
}

Start developing

The Senzing SDK ships for Java and C# on macOS.