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
To Create the Database Structure
Step 9: Specify a Starting EUID for a Master Index
Each master index application requires two database connection pools; one for the master controller and one for the sequence manager. To set up the connection pools, you need to create the connection pools and then define a JDBC resource for each. This section provides general instructions for setting up the connection pools. For more information about the procedures in this section, see the online help provided with the GlassFish Admin Console.
Perform the following steps to define database connectivity through the application server:
If you are using a MySQL or Oracle database, you need to manually install or copy the database driver to the application server environment. If you are using a SQL Server database, you can skip this step.
For Oracle, you can either install the driver on the application server or copy the ojdbc14.jar file from your Oracle client installation (Oracle_client\jdbc\lib) to app_server_home\lib. To install the driver, see the documentation for the GlassFish server.
For MySQL, download and extract the latest MySQL Connector/J — for connecting to MySQL from Java. You can access the driver at the MySQL downloads page. Copy mysql-connector-java-5.1.6-bin.jar to app_server_home\lib.
Once the driver is installed or copied, continue to Step 2: Create two JDBC Connection Pools.
The JDBC connection pools provide connections to the master index database. You need to create two connection pools that are configured in the same way.
Before proceeding, make sure you have the relevant information about the master index database (such as the database name, URL, and administrator login credentials).
Before You Begin
If you are using an Oracle or MySQL database, add the database driver to the application server environment, as described in Step 1: Add the MySQL or Oracle Driver to the Application Server.
You can access the console from the Services window in NetBeans.
javax.sql.DataSource – Use this class if the master index application is using local transactions only.
javax.sql.XADataSource – Use this class if the master index application transactions are distributed, either within the application or across applications.
javax.sql.ConnectionPoolDataSource – Use this class if the master index application is using local transactions only. This class provides possible performance improvements.
Note - Make sure you configure Transaction properties to match the transaction mode you specified for the master index application and the connection pool Resource Type you selected.
URL – The URL that points to the database. The syntax of the URL is jdbc:oracle:thin:@host:port:database_name.
Note - If you are using a third-party JDBC driver, refer to the documentation for that driver for information about the URL.
user – The login ID for the user you created in Step 2: Create a Master Index Database and User.
password – The password for the above user.
ImplicitCachingEnabled – An indicator of whether implicit statement caching is enabled. Set this property to true.
MaxStatements – The maximum number of statements in the cache. Set this property to 1000.
URL – The URL that points to the database. The syntax of the URL is jdbc:mysql://server:port/database_name.
Note - If you are using a third-party JDBC driver, refer to the documentation for that driver for information about the URL.
user – The login ID for the user you created in Step 2: Create a Master Index Database and User.
password – The password for the above user.
DatabaseName – The name of the database.
databaseName – The name of the database.
portNumber – The port number for the database.
serverName – The name of the server that is hosting the database.
user – The login ID for the user you created in Step 2: Create a Master Index Database and User.
password – The password for the above user.
SendStringParametersAsUnicdoe – An indicator of whether string parameters are sent to the database in Unicode or in the default character encoding of the database. Set this property to false.
MaxPooledStatements – The maximum number of prepared statements in the cache. Set this property to 1000.
A JDBC resource (also known as a data source) gives the master index application the ability to connect to the database. Two JDBC resources are required.
Before You Begin
Create the JDBC connection pools, as described in Step 2: Create two JDBC Connection Pools.
The name must be in the form jdbc/application_nameDataSource, where application_name is the name of the master index application. For example, jdbc/PersonDataSource.
In the Pool Name field, enter the name of the second JDBC connection pool you created.
The name of the JDBC resource must be in the form jdbc/application_nameSequenceDataSource, where application_name is the name of the master index application. For example, jdbc/PersonSequenceDataSource.