Optim Data Privacy Providers  11.7.0
 All Data Structures Files Functions Variables Macros Groups Pages
Folder structure of the zipped package
Folder

Contents

Images32

ODPP libraries for 32 Bit environments

aix

ODPP AIX libraries

aix_udf_ora

ODPP AIX libraries for Oracle UDFs

rhel

ODPP Red Hat Linux libraries

rhel_udf_db2

ODPP Red Hat Linux/SUSE libraries for DB2 UDFs

rhel_udf_nz

ODPP Red Hat Linux/SUSE libraries for Netezza UDFs

rhel_udf_ora

ODPP Red Hat Linux/SUSE libraries for Oracle UDFs

win

ODPP Windows libraries

win_udf_db2

ODPP Windows libraries for DB2 UDFs

win_udf_mss

ODPP Windows libraries for SQL Server UDFs

win_udf_ora

ODPP Windows libraries for Oracle UDFs

win_udf_tera

ODPP Windows libraries for Teradata UDFs

Images64

ODPP libraries for 64 Bit environments

aix

ODPP AIX libraries

aix_udf_db2

ODPP AIX libraries for DB2 UDFs

aix_udf_ora

ODPP AIX libraries for Oracle UDFs

rhel

ODPP Red Hat Linux/SUSE libraries

rhel_udf_db2

ODPP Red Hat Linux/SUSE libraries for DB2 UDFs

rhel_udf_ora

ODPP Red Hat Linux/SUSE libraries for Oracle UDFs

win

ODPP Windows libraries

win_udf_db2

ODPP Windows libraries for DB2 UDFs

win_udf_mss

ODPP Windows libraries for SQL Server UDFs

win_udf_ora

ODPP Windows libraries for Oracle UDFs

win_udf_tera

ODPP Windows libraries for Teradata UDFs

Replacement Data

Replacement data in CSV format and DDL for DB2

Data

Replacement data in the form of CSV files and database-specific DDL is intended to be
used for lookup purposes. The DDL scripts are for DB2 only.

Doc

Documents and Developer's Guide

Developer_Guide

ODPP Developer’s Guide provides user guide type instructions for C/C++ type programming using the ODPP API’s.

ODPP_v11.7_Release_Notes.pdf

ODPP v11.7 Release Notes

ODPP-Users-Guide.pdf

ODPP Users Guide provides usage-type information on using and licensing ODPP.

ReadMe.pdf

ODPP v11.7 ReadMe

Scripts

Scripts

createODPPsymboliclinks.sh

This shell script may be used to re-create symbolic links for the ODPP and ICU libraries on UNIX.

Usage:
sh createODPPsymboliclinks.sh <path> <major_ver> <full_ver> <hybrid version> <cleanonly>

Where:
<path> - This is the path to the folder containing the ODPP binaries.
<major_ver> - This is the major version (e.g. 11.7).
<full_ver> - This is the full version (e.g. 11.7.0.0).
<hybrid version> - This is the hybrid 2 position ODPP version (e.g. 117).
<cleanonly> - This removes all symbolic links.

removeODPP.bat

This script can be used to remove the existing ODPP version binaries on Windows. This script supports versions up till ODPP 11.7.0.0

Usage:
removeODPP.bat <path>

Where:
<path> - This is the path to the folder containing the ODPP binaries.

removeODPP.sh

This shell script can be used to remove the existing ODPP version binaries on Unix. This script supports versions up till ODPP 11.7.0.0

Usage:
sh removeODPP.sh <path>

Where:
<path> - This is the path to the folder containing the ODPP binaries.

Samples

Sample Code

App_CCN

A sample C++-type program that details the use of the ODPP APIs for invoking the ODPP CCN service provider.

CMExit_ODPP_CCN

A sample Optim Column Map Exit C-type program that details the use of the ODPP APIs for invoking the ODPP CCN service provider. See Optim_CMEsit_ODPP_CCN.doc/.mht for complete details on this sample application.

ODPP_AFFLANGEXIT

A sample Affinity custom language exit implementation.

ODPP_HASHEXIT

A sample ODPP HASH exit implementation.

SrvPrv

A sample C language DLL that demonstrates an ODPP Service Provider Interface (SPI) module. This sample may be used as a guide for creating yourr own SPI module which may be plugged into the ODPP framework.

zOS_CMExit

This folder contains a C language and a COBOL lauguage Optim/z Column Map Exits (CMEs) that demonstrate the use of the ODPP APIs from an Optim/z CME.

include Contains ODPP common-type header files for the samples


Images and Headers

Applications integrating with ODPP should either link to the ODP Provider Core library or load it dynamically. All other libraries other than the core library are managed by the ODPP core library. The ODPP core library is libODPProvider.11.7.0.0.a for AIX, libODPProvider.so.11.7.0.0 for Linux and ODPProvider.11.7.dll for Windows.

Files common to all providers:

Applications integrating with ODPP should include these header files to use ODPP APIs, Structures, #defines, Error codes and Parameters.

S/N Name Folder

Description

1 ODPPCmnAPI.h include

API declarations

2 ODPPCmnOprH.h include

Parameter declarations

3 ODPPDataTypesH.h include

Data Type declarations

4 ODPPCmnErrCodes.h include

Error codes

5 ODPPTokIdsH.h include

Error Token Identifiers

6 ODPPErrMsgs_EN.xml include

Error messages (English) XML

7 ODPPCmnApiX.h include User written ODPP service providers declarations.


Doc

This folder contains ODPP documentation and the Release Notes.

Developer's Guide
The Developer's Guide provides clients with details on using the ODPP APIs and structures in their applications. It provides details on the API's structures and Parameters (Operands in ODPP terms) and is a step-by-step guide to:

The Developer's Guide also includes details on all parameters and their allowable values for each service provider.

To launch the Developer's Guide:

  1. In the Developer_Guide folder, double-click launch.bat, or
  2. In the html folder, double-click index.html



Replacement Data

Replacement data in the form of CSV files and database-specific DDL is intended to be used for lookup purposes.

The CSV files can be loaded to the database using the DDL files provided along with the data.

Samples

This folder contains sample code.

App_CCN:
This folder contains A sample C++ type program that details the use of the ODPP APIs for invoking the ODPP CCN service provider. The code shows how to populate various structures such as service definition, field definition, row definition, row set and call Provider APIs starting from initialization to termination.

CMExit_ODPP_CCN:
This folder contains A sample Optim Column Map Exit C-type program that details the use of the ODPP APIs for invoking the ODPP CCN service provider. See Optim_CMEsit_ODPP_CCN.doc/.mht for complete details on this sample application.

ODPP_HASHEXIT:
This folder contains A sample ODPP HASH exit C-type program that details the use of the ODPP HASH exit.

SrvPrv:
A sample C language DLL that demonstrates an ODPP Service Provider Interface (SPI) module. This sample may be used as a guide for creating yourr own SPI module which may be plugged into the ODPP framework.

zOS_CMExit:
This folder contains a C language and a COBOL lauguage Optim/z Column Map Exits (CMEs) that demonstrate the use of the ODPP APIs from an Optim/z CME.

include:
This folder contains header files required for the execution of App_CCN and CMExit_ODPP_CCN applications.