Skip Navigation Links | |
Exit Print View | |
Oracle Java CAPS Master Index User's Guide Java CAPS Documentation |
Oracle Java CAPS Master Index User's Guide
Master Index Development Process Overview
The Master Index Framework and the Runtime Environment
Before You Begin Developing a Master Index
Preliminary Data Analysis for a Master Index
Planning a Master Index Project
Master Index Project Initiation Checklist
Creating a Master Index Application
Step 1: Create a Project and Start the Wizard
To Create a Project and Start the Wizard
Step 2: Name the Master Index Application
To Name the Master Index Application
Step 4: Define the Deployment Environment
To Define the Deployment Environment
Step 5: Define Parent and Child Objects
Creating Objects from a Template
Deleting an Object from the Structure
Step 6: Define the Fields for Each Object
Step 7: Generate the Project Files
To Generate the Configuration Files
Step 8: Review the Configuration Files
Master Index Wizard Field Properties and Name Restrictions
Master Index Wizard Field Name Restrictions
Master Index Wizard General Field Properties
Master Index Wizard MIDM Field Properties
Custom Plug-ins for Master Index Custom Transaction Processing
Master Index Update Policy Plug-ins
Master Index Field Validation Plug-ins
Master Index Field Masking Plug-ins
Master Index Match Processing Logic Plug-ins
Custom Match Processing Logic Methods
Custom Match Processing Logic Plug-in Requirements
Custom Match Processing Configuration
Master Index Custom Plug-in Exception Processing
Custom Plug-Ins for Master Index Custom Components
Master Index Survivor Calculator Plug-ins
Master Index Query Builder Plug-ins
Master Index Block Picker Plug-ins
Master Index Pass Controller Plug-ins
Standardization Engine Plug-ins
Phonetic Encoders Plug-ins for a Master Index
Implementing Master Index Custom Plug-ins
Generating the Master Index Application
To Generate the Application for the First Time
Master Index Database Scripts and Design
Master Index Database Requirements
Database Platform Requirements
Master Index Database Structure
Designing the Master Index Database
Designing for Performance Optimization
Creating the Master Index Database
Step 1: Analyze the Master Index Database Requirements
Step 2: Create a Master Index Database and User
Step 3: Define Master Index Database Indexes
Step 4: Define Master Index External Systems
Master Index Database Table Description for sbyn_systems
Step 5: Define Master Index Code Lists
To Customize Common Table Data for MySQL
To Customize Common Table Data for Oracle
To Customize Common Table Data for SQL Server
Step 6: Define Master Index User Code Lists
Master Index Database Table Description for sbyn_user_code
Step 7: Create Custom Master Index Database Scripts
Step 8: Create the Master Index Database Structure
Dropping Master Index Database Tables
Defining the Database Connection Pools
Step 1: Add the MySQL or Oracle Driver to the Application Server
Step 2: Create two JDBC Connection Pools
To Create the JDBC Connection Pools
Once you have customized the configuration files and generated the master index application, you can create the master index database. Before you begin, make sure you have MySQL, Oracle, or SQL Server installed on the database server.
During this process you can define custom startup data, such as code lists and source systems. The wizard defines SQL statements in the Code List and Systems SQL files (codelist.sql and system.sql) to insert startup data into the database based on information you specify, and you can customize the statements to insert the data relevant to your object structure. The code lists you define are used to translate processing codes from incoming messages into descriptions for the MIDM fields and to create drop-down lists for MIDM fields. System information is required in order to add records to the master index application.
Follow these steps to create the database.
You can also delete the database for testing purposes using the supplied script. See Dropping Master Index Database Tables for more information.
Before you begin to create the master index database, perform an analysis of the structure of the legacy data to be stored in the database and determine the amount of data that will be processed daily. During the analysis, be sure to define the processing codes that need to be stored in the common maintenance tables and the systems that will share data with the master index application. You should also know the length and format of the local IDs assigned by each system.
A database administrator who is familiar with your data and processing requirements should perform this task. After this task is complete, continue to Step 2: Create a Master Index Database and User.
For additional information and guidelines about how to set up your database, see Master Index Database Scripts and Design.
Before beginning this step, complete Step 1: Analyze the Master Index Database Requirements. After you create the database instance and user, continue to Step 3: Define Master Index Database Indexes if you want to define additional database indexes; otherwise skip to Step 4: Define Master Index External Systems.
For this step you need to create a database in which the master index database instance will be created. Use the tools provided by your database vendor to create the database. Using these tools, you define tablespaces, including their sizes and locations; extents; and dump file, log file, and rollback file sizes and locations. Make sure these issues have been thoroughly analyzed and designed before creating the database.
Note - For SQL Server databases, make sure to activate remote authentication.
Once you create the database, you can use standard SQL to create the master index application user for the database. The user you create in this step will be used to create the database structure and to connect to the database through the MIDM and through the application server.
For Oracle, assign the user to the “connect” and “resource” roles for the master index tablespaces. For example:
create user username identified by password; grant connect, resource to username; commit;
where username is the login ID of the administrator user and password is the login password of the administrator user.
For SQL Server, assign this user to the “db_owner” role. You need to create the server login, create the user, and then assign the user to the role. For example:
CREATE LOGIN loginname WITH PASSWORD = ’password’, DEFAULT_DATABASE = database; CREATE USER username FOR LOGIN loginname; USE database; EXECUTE sp_addrolemember ’db_owner’, ’ username’ GO
where loginname is the login ID for the administrator user, password is the login password, database is the database name, and username is the owner of the database tables created in the master index database.
Note - SQL Server allows Windows Authentication, where only a user name is required. Oracle Java CAPS Master Index requires full SQL Server authentication, including both a user name and password. You need to create a database user specifically for the master index application.
For MySQL, you can grant the user access to all permissions, or you can assign the individual permissions listed below. For example:
CREATE USER 'username'@'server_name’ IDENTIFIED BY 'password'; GRANT ALL ON database TO 'username'@'server_name’; GRANT SELECT, INSERT ON database TO 'username'@'server_name’;
where username is the login ID for the user, server_name is the name of the database server, password is the login password, and database is the database name.
If you prefer to assign individual permissions to the user instead of roles, the following permissions are needed.
|
To optimize data processing in the master index application, you can define additional indexes for the database tables that store object data. Best practice is to define indexes for each field used for searching, blocking, or matching. You can define these indexes in create.sql or create a new script. Before you begin this step, complete Step 2: Create a Master Index Database and User.
A SQL script is automatically created to insert the systems you specified in the wizard. These statements are provided in systems.sql in the master index project. Before you begin this step, complete Step 2: Create a Master Index Database and User and, optionally, Step 3: Define Master Index Database Indexes.
For example:
INSERT into sbyn_systems (systemcode, description, status, id_length, format, input_mask, value_mask, create_date, create_userid) VALUES (’ARS’, ’Automated Registration System’, ’A’, 8, ’[0-9]{8}’, ’DD-DDD-DDD’, ’DD^DDD^DDD’, sysdate, 'admin’);
The following table lists and describes the columns in the sbyn_systems database table so you can create SQL statements to insert source system information into the master index database.
You only need to perform this step if you defined any fields in the object structure to have a code module. The SQL script for entering processing codes and descriptions into the database is written in PL/SQL. The wizard creates a stanza incodelist.sql (located under the Database Script node of the project) for each code list you specified in the field properties. You need to customize the file by defining the entries for each code list. This script inserts data into two tables: sbyn_common_header, which lists the types of common table data, and sbyn_common_detail, which lists each common table data element. Before you begin this step, complete Step 4: Define Master Index External Systems.
Note - The codes you specify in this file can be no longer than eight characters (the codes are the second value in the value list for each common table data type and data element).
The statements following this line must be customized.
For example:
-- **** PHONTYPE **** insert into tCodeList values(’L’, ’PHONTYPE’, ’TELEPHONE TYPE’);
insert into tCodeList values(’V’, ’code’, ’code description’);
where “code” is the processing code of the data element and “code description” is the description of the element as you want it to appear on the Master Index Data Manager windows. For example:
-- **** PHONTYPE **** insert into tCodeList values(’L’, ’PHONTYPE’, ’TELEPHONE TYPE’); insert into tCodeList values(’V’, ’H’, ’HOME’); insert into tCodeList values(’V’, ’C’, ’CELL’); insert into tCodeList values(’V’, ’F’, ’FAX’); insert into tCodeList values(’V’, ’O’, ’OFFICE’); insert into tCodeList values(’V’, ’HB’, ’HOME BUSINESS’);
codes tCodeList := tCodeList(
The statements following this line must be customized.
For example:
-- **** PHONTYPE **** tCode(’L’, ’PHONTYPE’, ’TELEPHONE TYPE’),
tCode(’V’, ’code’, ’code description’),
where “code” is the processing code of the data element and “code description” is the description of the element as you want it to appear on the Master Index Data Manager windows. For example:
-- **** PHONTYPE **** tCode(’L’, ’PHONTYPE’, ’TELEPHONE TYPE’), tCode(’V’, ’H’, ’HOME’), tCode(’V’, ’C’, ’CELL’), tCode(’V’, ’F’, ’FAX’), tCode(’V’, ’O’, ’OFFICE’), tCode(’V’, ’HB’, ’HOME BUSINESS’),
For example:
-- **** ADDRTYPE **** tCode(’L’, ’ADDRTYPE’, ’ADDRESS TYPE’), tCode(’V’, ’H’, ’HOME’), tCode(’V’, ’B’, ’BUSINESS’), tCode(’V’, ’M’, ’MAILING’)
begin
The statements following this line must be customized.
For example:
-- **** PHONTYPE **** insert into @codelist values(’L’, ’PHONTYPE’, ’TELEPHONE TYPE’)
insert into @codelist values(’V’, ’code’, ’code description’)
where “code” is the processing code of the data element and “code description” is the description of the element as you want it to appear on the Master Index Data Manager windows. For example:
-- **** PHONTYPE **** insert into @codelist values(’L’, ’PHONTYPE’, ’TELEPHONE TYPE’) insert into @codelist values(’V’, ’H’, ’HOME’) insert into @codelist values(’V’, ’C’, ’CELL’) insert into @codelist values(’V’, ’F’, ’FAX’) insert into @codelist values(’V’, ’O’, ’OFFICE’) insert into @codelist values(’V’, ’HB’, ’HOME BUSINESS’)
If you specified a value for the Constrained By and User Code properties of a field, you must define the user code values for those fields. Below is a sample insert statement for the sbyn_user_code table.
insert into sbyn_user_code (code_list, code, descr, format, input_mask, value_mask) values (’AUXIDDEF’, ’CC’, ’CREDIT CARD’, ’[0-9]{16}’, ’DDDD-DDDD-DDDD-DDDD’, ’DDDD^DDDD^DDDD^DDDD’);
To learn more about the sbyn_user_code table, see Master Index Database Table Description for sbyn_user_code. Complete Step 5: Define Master Index Code Lists before beginning this step.
The following table lists and describes the columns in the sbyn_user_code database table so you can create SQL statements to insert user code data into the master index database.
|
You can insert additional information into the database by creating a custom script. For information about the structure of the master index database, see Oracle Java CAPS Master Index Processing Reference.
After you create the database instance and customize the database scripts, you can create the master index tables and insert the custom data.
Tip - To run this script for Oracle or SQL Server, the command is @create.sql. For MySQL, the command is source create.sql.
By default, the EUIDs assigned by the master index application start with “0”, with padded zeroes added to the left to make the EUID number the correct length (for more information, see Oracle Java CAPS Master Index Configuration Reference ). You can modify this numbering format by changing the value of the seq_name column of the sbyn_seq_table database table where the sequence name is “EUID”. For example:
update sbyn_seq_table set seq_count=1000000001 where seq_name=’EUID’;