Installing Upgrading Designing Configuring Deploying Monitoring Administering Troubleshooting Reference JBI Components
Close Print View
Designing: The Master Index Framework and the Runtime Environment
 

Classic Java CAPS

Developing Java CAPS Projects

Using SOAP Message Handlers

Creating a Runtime Environment

Designing Business Processes in the Sun Business Process Manager

Working with TCP/IP HL7 Collaborations

Developing Sun Master Indexes (Repository)

Developing Sun Master Patient Indexes

Developing OTDs for Application Adapters

Developing OTDs for Communication Adapters

Developing OTDs for Database Adapters

Developing OTDs for Web Server Adapters

Designing with Application Adapters

Designing with Communication Adapters

Designing with Web Server Adapters

SWIFT Integration Projects

Java EE Based Components

Designing with Sun JCA Adapters

About the TCP/IP JCA Adapter

Defining Constants and Variables

Using Database Operations

Developing Sun Master Indexes

Related Topics

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

Step 2: Name the Master Index Application

Step 3: Define Source Systems

Step 4: Define the Deployment Environment

Step 5: Define Parent and Child Objects

Step 6: Define the Fields for Each Object

Step 7: Generate the Project 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

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

Match Engine Plug-ins

Standardization Engine Plug-ins

Phonetic Encoders Plug-ins for a Master Index

Implementing Master Index Custom Plug-ins

To Create Custom Plug-ins

Generating the Master Index Application

To Generate the Application for the First Time

To Regenerate the Application

Master Index Database Scripts and Design

Master Index Database Scripts

Master Index Database Requirements

Master Index Database Structure

Designing the Master Index Database

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

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

Step 9: Specify a Starting EUID for a Master Index

Dropping Master Index Database Tables

To Delete 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

Step 3: Create the JDBC Resources

Using the JMS JCA Wizard

Using the JAXB Wizard and Code-Seeder Pallete

The Master Index Framework and the Runtime Environment

This topic was modified for Java CAPS 6 update 1.

Note - MySQL is only supported in Java CAPS 6 Update 1.

The values you enter in the wizard, Configuration Editor or directly in the XML files define how other components of the master index application are generated, such as the database scripts, the Master Index Data Manager, and the dynamic Java API. This section provides an overview of how the values you enter correspond to the runtime environment.

From XML to the Database

The master index database is created using a standard MySQL, Oracle or SQL Server database and a database script generated directly from object.xml. Additional scripts are created based on any user codes or menu lists you defined for the fields in the object structure. Running the database scripts against the database creates the tables necessary for your master index application and also creates startup data, such as external system information, processing codes, and so on.

From XML to the Master Index Data Manager

Based on information you specify in the wizard or Configuration Editor, midm.xml is generated to define the appearance of the Master Index Data Manager (MIDM) . This file defines the fields and appearance of the MIDM and also specifies the searches used by the MIDM. The available search types are defined in query.xml. You can customize many features of the MIDM, including the following.

From XML to the EJB

When you generate the master index application, two additional projects are created, an EJB project and a web application project. The EJB project includes several Java classes that are common to all master index applications as well as a set of custom classes that are specific to the type of object you are indexing. These are based on object.xml. You can use these methods to specify how data is processed into the database. You can also call these methods from Business Processes.

From XML to the Runtime Environment

The information you specify in the master index configuration files is read at runtime when the domain is started. The only exception is object.xml, which is stored only as a record of the object structure. You can modify the configuration files after moving to production; however, for the changes to take effect, you must regenerate the application and then rebuild and redeploy the project to apply the changes to the server. You also need to restart the MIDM and any eWays or Binding Components connected to the application for the changes to take effect. Use caution when modifying these files; changing these files after moving to production might result in loss of data integrity or unexpected weighting and matching results.