JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
Understanding Oracle Java CAPS Master Index Processing (Repository)     Java CAPS Documentation
search filter icon
search icon

Document Information

Understanding Oracle Java CAPS Master Index Processing (Repository)

Related Topics

About Oracle Java CAPS Master Index (Repository)

Understanding Master Index Operational Processes (Repository)

Learning About Master Index Message Processing (Repository)

Master Index Inbound Message Processing (Repository)

About Inbound Messages

Master Index Outbound Message Processing (Repository)

About Outbound Messages

Outbound OTD Structure

Outbound Message Trigger Events

Sample Outbound Message

Master Index Inbound Message Processing Logic (Repository)

Master Index Custom Decision Point Logic (Repository)

Master Index Primary Function Processing Logic (Repository)

activateEnterpriseObject

activateSystemObject

addSystemObject

createEnterpriseObject

deactivateEnterpriseObject

deactivateSystemObject

deleteSystemObject

mergeEnterpriseObject

mergeSystemObject

transferSystemObject

undoAssumedMatch

unmergeEnterpriseObject

unmergeSystemObject

updateEnterpriseDupRecalc

updateEnterpriseObject

updateSystemObject

The Master Index Database Structure (Repository)

About the Master Index Database (Repository)

Master Index Database Table Details (Repository)

SBYN_OBJECT_NAME

SBYN_OBJECT_NAMESBR

SBYN_CHILD_OBJECT

SBYN_CHILD_OBJECTSBR

SBYN_APPL

SBYN_ASSUMEDMATCH

SBYN_AUDIT

SBYN_COMMON_DETAIL

SBYN_COMMON_HEADER

SBYN_ENTERPRISE

SBYN_MERGE

SBYN_OVERWRITE

SBYN_POTENTIALDUPLICATES

SBYN_SEQ_TABLE

SBYN_SYSTEMOBJECT

SBYN_SYSTEMS

SBYN_SYSTEMSBR

SBYN_TRANSACTION

SBYN_USER_CODE

Sample Master Index Database Model (Repository)

Working with the Master Index Java API (Repository)

Master Index Java Class Types (Repository)

Static Master Index Java Classes (Repository)

Dynamic Master Index Object Classes (Repository)

Dynamic OTD Methods

Dynamic Business Process Methods

Dynamic Master Index Object Classes (Repository)

Master Index Parent Object Classes (Repository)

Definition

Methods

ObjectNameObject

Description

Syntax

Parameters

Returns

Throws

addChild

Description

Syntax

Parameters

Returns

Throws

addSecondaryObject

Description

Syntax

Parameters

Returns

Throws

copy

Description

Syntax

Parameters

Returns

Throws

dropSecondaryObject

Description

Syntax

Parameters

Returns

Throws

getObjectNameId

Description

Syntax

Parameters

Returns

Throws

getChild

Description

Syntax

Parameters

Returns

Throws

getField

Description

Syntax

Parameters

Returns

Throws

getChildTags

Description

Syntax

Parameters

Returns

Throws

getMetaData

Description

Syntax

Parameters

Returns

Throws

getSecondaryObject

Description

Syntax

Parameters

Returns

Throws

isAdded

Description

Syntax

Parameters

Returns

Throws

isRemoved

Description

Syntax

Parameters

Returns

Throws

isUpdated

Description

Syntax

Parameters

Returns

Throws

setObjectNameId

Description

Syntax

Parameters

Returns

Throws

setField

Description

Syntax

Parameters

Returns

Throws

setAddFlag

Description

Syntax

Parameters

Returns

Throws

setRemoveFlag

Description

Syntax

Parameters

Returns

Throws

setUpdateFlag

Description

Syntax

Parameters

Returns

Throws

structCopy

Description

Syntax

Parameters

Returns

Throws

Master Index Child Object Classes (Repository)

Definition

Methods

ChildObject

Description

Syntax

Parameters

Returns

Throws

copy

Description

Syntax

Parameters

Returns

Throws

getChildId

Description

Syntax

Parameters

Returns

Throws

getField

Description

Syntax

Parameters

Returns

Throws

getMetaData

Description

Syntax

Parameters

Returns

Throws

getParentTag

Description

Syntax

Parameters

Returns

Throws

setChildId

Description

Syntax

Parameters

Returns

Throws

setField

Description

Syntax

Parameters

Returns

Throws

structCopy

Description

Syntax

Parameters

Returns

Throws

Dynamic Master Index OTD Methods (Repository)

Dynamic Master Index OTD Methods (Repository)

activateEnterpriseRecord

Description

Syntax

Parameters

Returns

Throws

activateSystemRecord

Description

Syntax

Parameters

Returns

Throws

addSystemRecord

Description

Syntax

Parameters

Returns

Throws

deactivateEnterpriseRecord

Description

Syntax

Parameters

Returns

Throws

deactivateSystemRecord

Description

Syntax

Parameters

Returns

Throws

executeMatch

Syntax

Parameters

Returns

Throws

executeMatchUpdate

Syntax

Parameters

Returns

Throws

findMasterController

Syntax

Parameters

Returns

Throws

getEnterpriseRecordByEUID

Description

Syntax

Parameters

Returns

Throws

getEnterpriseRecordByLID

Description

Syntax

Parameters

Returns

Throws

getEUID

Description

Syntax

Parameters

Returns

Throws

getLIDs

Description

Syntax

Parameters

Returns

Throws

getLIDsByStatus

Description

Syntax

Parameters

Returns

Throws

getSBR

Description

Syntax

Parameters

Returns

Throws

getSystemRecord

Description

Syntax

Parameters

Returns

Throws

getSystemRecordsByEUID

Description

Syntax

Parameters

Returns

Throws

getSystemRecordsByEUIDStatus

Description

Syntax

Parameters

Returns

Throws

lookupLIDs

Description

Syntax

Parameters

Returns

Throws

mergeEnterpriseRecord

Description

Syntax

Parameters

Returns

Throws

mergeSystemRecord

Description

Syntax

Parameters

Returns

Throws

searchBlock

Description

Syntax

Parameters

Returns

Throws

searchExact

Description

Syntax

Parameters

Returns

Throws

searchPhonetic

Description

Syntax

Parameters

Returns

Throws

transferSystemRecord

Description

Syntax

Parameters

Returns

Throws

updateEnterpriseRecord

Description

Syntax

Parameters

Returns

Throws

updateSystemRecord

Description

Syntax

Parameters

Returns

Throws

Dynamic Business Process Methods (Repository)

Master Index Helper Classes (Repository)

SystemObjectName Master Index Class (Repository)

Definition

Fields

Methods

Inherited Methods

ClearFieldIndicator Field

SystemObjectName

Description

Syntax

Parameters

Returns

Throws

getClearFieldIndicator

Description

Syntax

Parameters

Returns

Throws

getField

Description

Syntax

Parameters

Returns

Throws

getObjectName

Description

Syntax

Parameters

Returns

Throws

setClearFieldIndicator

Description

Syntax

Parameters

Returns

Throws

setField

Description

Syntax

Parameters

Returns

Throws

setObjectName

Description

Syntax

Parameters

Returns

Throws

Master Index Parent Beans (Repository)

Definition

Methods

Inherited Methods

ObjectNameBean

Description

Syntax

Parameters

Returns

Throws

countChild

Description

Syntax

Parameters

Returns

Throws

countChildren

Description

Syntax

Parameters

Returns

Throws

countChildren

Description

Syntax

Parameters

Returns

Throws

deleteChild

Description

Syntax

Parameters

Returns

Throws

getChild

Description

Syntax

Parameters

Returns

Throws

getChild

Description

Syntax

Parameters

Returns

Throws

getField

Description

Syntax

Parameters

Returns

Throws

getObjectNameId

Description

Syntax

Parameters

Returns

Throws

setChild

Description

Syntax

Parameters

Returns

Throws

setChild

Description

Syntax

Parameters

Returns

Throws

setField

Description

Syntax

Parameters

Returns

Throws

setObjectNameId

Description

Syntax

Parameters

Returns

Throws

Master Index Child Beans (Repository)

Definition

Methods

Inherited Methods

ChildBean

Description

Syntax

Parameters

Returns

Throws

delete

Description

Syntax

Parameters

Returns

Throws

getField

Description

Syntax

Parameters

Returns

Throws

getChildId

Description

Syntax

Parameters

Returns

Throws

setField

Description

Syntax

Parameters

Returns

Throws

setChildId

Description

Syntax

Parameters

Returns

Throws

DestinationEO Master Index Class (Repository)

Definition

Methods

getEnterpriseObjectName

Description

Syntax

Parameters

Returns

Throws

SearchObjectNameResult Master Index Class (Repository)

Definition

Methods

getEUID

Description

Syntax

Parameters

Returns

Throws

getComparisonScore

Description

Syntax

Parameters

Returns

Throws

getObjectName

Description

Syntax

Parameters

Returns

Throws

SourceEO Master Index Class (Repository)

Definition

Methods

getEnterpriseObjectName

Description

Syntax

Parameters

Returns

Throws

SystemObjectNamePK Master Index Class (Repository)

Definition

Methods

SystemObjectNamePK

Description

Syntax

Parameters

Returns

Throws

getLocalId

Description

Syntax

Parameters

Returns

Throws

getSystemCode

Description

Syntax

Parameters

Returns

Throws

Master Index Match Types and Field Names (Repository)

Master Index Match and Standardization Types (Repository)

Oracle Java CAPS Match Engine Match Types (Repository)

Person Match Types

BusinessName Match Types

Address Match Types

Miscellaneous Match Types

Master Index Match Types and Field Names (Repository)

You can select a Match Type for each field defined in the Oracle Java CAPS Master Index wizard. Each match type defines a different type of standardization, normalization, phonetic encoding, and matching logic in the Match Field file. The following topics describe each match type and how each affects the logic in the Match Field file.

Master Index Match and Standardization Types (Repository)

For each field that will be used for matching in the master index application, you can select a match type in the wizard. When you select a match type for a field, Oracle Java CAPS Master Index automatically adds that field to the match string in the Match Field file and, in many cases, generates additional fields in the object definition that are not visible on the wizard. These fields are used for searching and matching and they should not be modified.

If new fields are generated, they are automatically incorporated into the configuration files and the database script that creates the master index tables. These fields store standardized, normalized, or phonetic versions of the field, depending on the type of matching you choose. In addition, these fields are assigned a match type in the match string in the Match Field file. They might also be defined for standardization in the Match Field file, in which case they will also be assigned a standardization type.


Note - The match types specified in the Match Field file for the fields in the match string are not always the same as the match types you specify in the wizard. Information about match types is provided in the following sections. For more information, see Understanding the Oracle Java CAPS Match Engine.


Oracle Java CAPS Match Engine Match Types (Repository)

The Oracle Java CAPS Master Index wizard match types fall into four primary categories.

The actual standardization and match types entered into the Match Field file vary for each match type you select in the wizard. The match and standardization types for each type of field are listed in the following descriptions. The match types entered into the Match Field file correspond to the match types defined in the match configuration file, MatchConfigFile.cfg.

Person Match Types

The Person match types include PersonLastName and PersonFirstName. These match types are used to normalize and phonetically encode name fields for person matching. For each field with one of these match types, the wizard adds two fields to the object structure for phonetic and standardized versions. If you specify a field with a person match type for blocking in the wizard, the phonetic version of the name is automatically added to the blocking query. The following fields are created when you specify one of the Person match types for a field (field_name refers to the name of the field specified for Person matching).

The corresponding standardization and match types in the Match Field file are listed in Table 24.

Table 24 Person Name Standardization and Match Types

eView Wizard Match Type
Match Field File Standardization Type
Match Field File Match Type
PersonLastName
PersonName
LastName
PersonFirstName
PersonName
FirstName

BusinessName Match Types

The BusinessName match type is designed to help parse, normalize, and phonetically encode a business name. BusinessName matching adds several fields to the object structure and to the match string. If you specify a business name field for blocking, each parsed business name field is added to the blocking query. The corresponding standardization type in the Match Field file for all fields selected for BusinessName matching is also BusinessName. The actual match type assigned to each field varies depending on the type of information in each field.

Table 25 lists the fields created when you select the BusinessName match type for a field along with their corresponding match types in the Match Field file (field_name refers to the name of the field selected for BusinessName matching).


Note - Only specify this type of matching for one business name field; otherwise, the wizard will create duplicate entries in the object structure. If more than one field contains the business name, you can add those fields to the standardization structure in the Match Field file after the wizard creates the configuration files.


Table 25 BusinessName Match Types

Field Name
Description
Added to the Match String?
Match Field File Match Type
field_name_Name
The parsed and normalized version of the business name.
Yes
PrimaryName
field_name_NamePhon
The phonetic version of the business name.
No
field_name_OrgType
The parsed organization type of the business name.
Yes
OrgTypeKeyword
field_name_AssocType
The association type for the business.
Yes
AssocTypeKeyword
field_name_Industry
The name of the industry for the business.
Yes
IndustryTypeKeyword
field_name_Sector
The name of the industry sector (industries are a subset of sectors).
Yes
IndustrySectorList
field_name_Alias
An alias for the business name.
No
field_name_Url
The business’ web site URL.
Yes
Url

Address Match Types

The Address match type is designed to help parse, normalize, and phonetically encode an address for matching or standardizing address information. Address matching adds several fields to the object structure and to the match string. If you specify an address field for blocking, the parsed fields are added to the blocking query. The corresponding standardization type for fields selected for Address matching is Address. The actual match type assigned to each field varies depending on the type of information in each field.

The fields created when you select the Address match type for a field are listed below along with their corresponding match types in the Match Field file (field_name refers to the name of the field selected for Address matching).


Note - Only specify this type of matching for one street address field; otherwise, the wizard will create duplicate entries in the object structure. If more than one field contains the street address, you can define the additional fields in the standardization structure in the Match Field file after the wizard creates the configuration files.


Table 26 Address Match Types

Field Name
Description
Added to Match String?
Match Field File Match Type
field_name_HouseNo
The parsed street number of the address.
Yes
HouseNumber
field_name_StDir
The parsed and normalized street direction of the address.
Yes
StreetDir
field_name_StName
The parsed and normalized street name of the address.
Yes
StreetName
field_name_StPhon
The phonetic version of the street name.
No
field_name_StType
The parsed and normalized street type of the address, such as Boulevard, Street, Drive, and so on.
Yes
StreetType

If you want to search on street addresses but do not want to use these fields for matching, select the Address match type for only one street address field in the wizard. When the wizard is complete, you can remove the address fields from the match string in the Match Field file.

Miscellaneous Match Types

Several additional match types are defined in the wizard for the Oracle Java CAPS Match Engine. These match types are used to indicate matching on a string, date, or number fields other than those described above or to indicate matching on a field that contains a single character (such as the gender field, which might accept “F” for female or “M” for male). These match types do not define standardization for the specified field and do not add any fields to the object structure. If you specify one of these match types for a field in the wizard, the field is added to the match string with a match type of String, Date, Number, or Char.