Specifying environment variables for data privacy

Edit online

You can specify the following system environment variables for the data privacy components in Microsoft™ Windows™, UNIX™, Linux™, or z/OS®, except where otherwise noted.

LIBPATH

This UNIX System Services environment variable is required in z/OS to specify the path to the provider directory.

Do the following to set this variable:

  • In z/OS, export LIBPATH to the full path for the provider directory file. Here is an example:

    export LIBPATH=/usr/local/odpp/odppbin

Note for z/OS users: In z/OS, if you are updating your .profile to include an environment variable, you must include the export keyword before each environment variable, as shown in the previous example. However, if you are updating the data set that is referenced by FOPENV DD to include an environment variable, do not include the export keyword before each variable. For example, in the case of the LIBPATH variable, you would specify LIBPATH=/usr/local/odpp/odppbin, without the export keyword. This rule applies to all data privacy-related environment variables for z/OS.
ODPPCACHEL

This environment variable is used to specify the Cache file path. The Cache is enabled by default.

Do the following to set this variable:

  • In Microsoft Windows, set ODPPCACHEL to the full path to the Cache file. Here is an example:

    SET ODPPCACHEL=C:\IBM\Infosphere\Optim\DP\CacheDirectory

  • In UNIX and Linux, export ODPPCACHEL to the full path for the Cache file. Here is an example:

    export ODPPCACHEL=/opt/IBM/Infosphere/Optim/DP/CacheDirectory

  • In z/OS, export ODPPCACHEL to the full path for the Cache file. Here is an example:

    export ODPPCACHEL=/usr/local/odpp/CacheDirectory

ODPPERRL

This environment variable is used to specify the path to the error message file.

Note for users of release 11.3.0.6 or higher: For Optim™ release 11.3.0.6 and higher, this environment variable is not required because ODPP messages are no longer contained in file ODPPErrMsgs_EN.xml; these messages are now contained internally in the ODPP software. Therefore, the ODPPERRL environment variable, which was formerly used to point to this file, is no longer needed. For reference, ODPP return codes and messages are stored in file ODPPMessages.txt in the Doc directory.

For releases of Optim lower than 11.3.0.6, do the following to set this required variable:

  • In Microsoft Windows, set ODPPERRL to the full path to the error message file. Here is an example:

    SET ODPPERRL=C:\IBM\Infosphere\Optim\DP\include

  • In UNIX and Linux, export ODPPERRL to the full path to the error message file. Here is an example:

    export ODPPERRL=/opt/IBM/Infosphere/Optim/DP/include

  • In z/OS, export ODPPERRL to the full path to the error message file. Here is an example:

    export ODPPERRL=/usr/local/odpp/odppbin

ODPPICUDIR

This optional environment variable is used to specify the path to the ICU (International Components for Unicode) files. To support database-specific code pages, ICU uses database-specific packages, such as OPMICU*.DAT and OPMICU*.ALS. By default, these files are placed in a separate ICU files folder during the installation process, except in z/OS. In z/OS, the files are placed in the odppbin folder. In most cases, you do not need to set this variable unless you are instructed to set it by IBM® Optim Support.

Do the following to set this variable:

  • In Microsoft Windows, set ODPPICUDIR to the full path to the ICU files. Here is an example:

    SET ODPPICUDIR=C:\IBM\Infosphere\Optim\DP\icufiles

  • In UNIX and Linux, export ODPPICUDIR to the full path to the ICU file. Here is an example:

    export ODPPICUDIR=/opt/IBM/Infosphere/Optim/DP/icufiles

  • In z/OS, export ODPPICUDIR to the full path to the ICU file. Here is an example:

    export ODPPICUDIR=/usr/local/odpp/odppbin

ODPPLIBL

This required environment variable is used to specify the path to the Optim data privacy provider library (ODPP).

Do the following to set this variable:

  • In Microsoft Windows, set ODPPLIBL to the full path to the library. Here is an example:

    SET ODPPLIBL=C:\IBM\Infosphere\Optim\DP\bin

  • In UNIX and Linux, export ODPPLIBL to the full path to the library. Here is an example:

    export ODPPLIBL=/opt/IBM/Infosphere/Optim/DP/bin

  • In z/OS, export ODPPLIBL to the full path to the library. Here is an example:

    export ODPPLIBL=/usr/local/odpp/odppbin

ODPPLL

This required environment variable is used to specify the path to either the permanent license file, OPDP.LIC, or the 90 day trial license file, OPTRIAL.LIC, for data privacy. See License file locations for the data privacy components for details.

Do the following to set this variable:

  • In Microsoft Windows, set ODPPLL to the full path to the license file for data privacy. Here is an example:

    SET ODPPLL=C:\IBM\Infosphere\Optim\DP\license

  • In UNIX and Linux, export ODPPLL to the full path to the license file for data privacy. Here is an example:

    export ODPPLL=/opt/IBM/Infosphere/Optim/DP/license

  • In z/OS, export ODPPLL to the full path to the license file for data privacy. Here is an example:

    export ODPPLL=/usr/local/odpp/license

ODPPTRCL

This environment variable is used to specify the path to the directory where the trace files are generated by the Optim data privacy providers.

Do the following to set this variable:

  • In Microsoft Windows, set ODPPTRCL to the full path to the trace files. Here is an example:

    SET ODPPTRCL=C:\IBM\Infosphere\Optim\DP\tracefiles

  • In UNIX and Linux, export ODPPTRCL to the full path to the trace files. Here is an example:

    export ODPPTRCL=/opt/IBM/Infosphere/Optim/DP/tracefiles

  • In z/OS, export ODPPTRCL to the full path to the trace files. Here is an example:

    export ODPPTRCL=/usr/local/odpp/tracefiles

ODPPINSTMGR
Because of the UDF implementation architecture in SQL Server and Teradata, the state of the ODPP code in the UDF does not persist between invocations of the UDF. The ODPP Instance Manager, depending on the setting of the ODPPINSTMGR environment variable, will ensure that the initialized masking provider persists between calls. The Instance Manager can be used to improve performance. However, increased memory usage and possible changes in behavior may occur when ODPPINSTMGR is set to 2, as described in the following table.
Note: This environment variable applies to the SQL Server and Teradata UDFs.
The values for this environment variable are as follow:
Value Effect
0 No use of Instance Manager (default). The data privacy provider string is reparsed for every row, allowing the UDFs to use the least amount of memory but at a performance cost.
1 Instance Manager is used to cache the data privacy provider strings and avoid reparsing.
2 Instance Manager is used to cache data privacy provider information. This mode provides the best performance, but causes more memory to be consumed for each new provider string. It also can affect the behavior of: