explain

If you are beginning your journey with Senzing, please start with Senzing Quick Start guides.

You are in the Senzing Garage where projects are "tinkered" on. Although this GitHub repository may help you understand an approach to using Senzing, it's not considered to be "production ready" and is not considered to be part of the Senzing product. Heck, it may not even be appropriate for your application of Senzing!

⚠️ WARNING: explain is still in development ⚠️ _

At the moment, this is "work-in-progress" with Semantic Versions of 0.n.x. Although it can be reviewed and commented on, the recommendation is not to use it yet.

Synopsis

explain is a command in the senzing-tools suite of tools. It is used to explain aspects of senzing-tools.

Overview

explain performs the following:

1. Explains a message. Example:

   senzing-tools explain --message-id SZSDK60010032

Install

1. The explain command is installed with the senzing-tools suite of tools. See senzing-tools install.

Use

export LD_LIBRARY_PATH=/opt/senzing/er/lib/
senzing-tools explain [flags]

1. For options and flags:

   1. Online documentation

   2. Runtime documentation:

      export LD_LIBRARY_PATH=/opt/senzing/er/lib/
      senzing-tools explain --help

2. In addition to the following simple usage examples, there are additional Examples.

Using command line options

1. ✏️ Specify database using command line option. Example:

   export LD_LIBRARY_PATH=/opt/senzing/er/lib/
   senzing-tools explain

2. See Parameters for additional parameters.

Using environment variables

1. ✏️ Specify database using environment variable. Example:

   export SENZING_TOOLS_MESSAGE_ID=senzing-60010032
   export LD_LIBRARY_PATH=/opt/senzing/er/lib/
   senzing-tools explain

2. See Parameters for additional parameters.

Parameters

• LD_LIBRARY_PATH
• SENZING_TOOLS_COMMAND
• SENZING_TOOLS_MESSAGE_ID
• SENZING_TOOLS_TTY_ONLY

References

1. API documentation
2. Development
3. Errors
4. Examples
5. Package reference