Quickstart Guide

Overview

This article outlines connecting to the Senzing software repository for your Linux distribution, installing the Senzing API package and performing your first ingestion of data with supplied demo data. 

The intended and supported platforms are RedHat / CentOS and Debian based systems on  x86_64 architectures. For full and up to date information see System Requirements. 

If you were previously accustomed to installing and working with Senzing from the TGZ deployment method please additional see Migrating From a TGZ to RPM/DEB Deployment.

Installing Senzing - Red Hat Based Distributions

Add and enable the Senzing repository to the currently configured list managed by yum. This step only needs to be completed once. 

• sudo yum install https://senzing-production-yum.s3.amazonaws.com/senzingrepo-1.0.0-1.x86_64.rpm

  

The latest version of Senzing can now be installed. As part of the installation you will be asked to accept the End User License Agreement (EULA), this can be viewed at https://senzing.com/end-user-license-agreement/

• sudo yum install senzingapi

   

Installing Senzing - Debian Based Distributions

Add and enable the Senzing repository to the currently configured list managed by apt. These 4 step only needs to be completed once. 

• sudo apt install apt-transport-https

• wget https://senzing-production-apt.s3.amazonaws.com/senzingrepo_1.0.0-1_amd64.deb

• sudo apt install ./senzingrepo_1.0.0-1_amd64.deb

• sudo apt update

The latest version of Senzing can now be installed. As part of the installation you will be asked to accept the End User License Agreement (EULA), this can be viewed at https://senzing.com/end-user-license-agreement/

• sudo apt install senzingapi

Creating 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 G2CreateProject.py utility. 

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

• python3 /opt/senzing/g2/python/G2CreateProject.py ~/senzing

The above command will create the project in your current users home path in a new directory named senzing.

Environment Configuration 

Now setup your environment variables for the project. The setupEnv script is project dependent and needs to be run whenever you are working with a Senzing project; for example between logging in and out of shell sessions. 

• cd <project_path>
• source setupEnv

Update Database with Senzing Configuration

The Senzing engine is configured with a JSON document, on a fresh install this document needs to be registered in the Senzing database. This only needs to happen once with a new project. 

• python3 python/G2SetupConfig.py

Loading the Sample Demo Data

You can now load some sample demo data

• python3 python/G2Loader.py -P

G2Loader with only the -P argument will perform a purge of any existing data in the Senzing repository database (an embedded SQLite database on a default deployment) and load the sample data identified within the python/demo/sample/project.csv file. 

Consuming the Entity Resolved Data

Once loading has completed the next suggested steps in getting started explain how to use two other supplied python utilities to review and explore the sample data:

• G2Export
• G2Command

Using a Different Database for the Senzing Repository

Senzing embeds SQLite to expedite getting started without having to deploy and configure a relational database for the Senzing repository. This article uses this embedded SQLite database, if you would like to use a different supported database please see the Technical Database section.