The UMF_SEARCH input document contains the request and search criteria
for a Web services pipeline search. It contains the collection of UMF segments
that structure the incoming data to search the entity database for entities
that contain attribute values that match the search criteria, and then return
the list of entities to the calling application. The results of this Web services
pipeline search are returned to the calling application in a UMF_SEARCH_RESULT
output document.
These UMF tags comprise the ROOT segment for the UMF_SEARCH input
document:
- DSRC_CODE
- Data source code UMF tag that is required, because it references and identifies
the calling application. As part of normal pipeline logging, this data source
code is logged in the UMF_LOG table for each processed UMF_SEARCH.
- The system is already configured with a data source code, 1589, that can
be used for all Web services pipeline searches. This data source code performs
entity resolution processing without resolving the incoming search criteria
with the entity in the entity database that matches the search. You can create
your own data source code for a particular calling application, just be sure
that the data source code is set to not resolve entities.
- DSRC_REF
- Data source reference UMF tag that is required, because it references
the requesting message transaction and is returned to the calling application.
- SRC_CREATE_DT
- Source create date UMF tag that is optional. If this tag contains a value,
it is used for logging.
- SRC_LSTUPD_DT
- Source last updated date UMF tag that is optional. If this tag contains
a value, it is used for logging.
- SRC_LSTUP_US
- Source last updated user UMF tag that is optional. If this tag contains
a value, it is used for logging.
- MIN_LIKE_SCORE
- Minimum resolution (or likeness) score UMF tag that is required to establish
the lowest matching value for the other UMF segments and tags specified. This
numeric score determines what is considered a match between the attribute
values requested and entities in the entity database containing the same attributes.
The higher the score, the more exact the match must be. A score of 100 indicates
an exact match.
- For example, if the search is to find all entities with a specific social
security number, the MIN_LIKE_SCORE determines how closely a social security
number must match to the social security data value specified in the query
before an entity in the database is listed as part of the result-set for this
query.
- FORMAT_CODE
- UMF tag that correlates to a UMF output document format that is specified
in the UMF_FORMAT_CODE table. IBM Relationship Resolution comes with three
built-in format codes for a Web services pipeline search using UMF_SEARCH:
- WS_SUMMARY_TOP10, which returns the top 10 entities that match the search
criteria
- WS_SUMMARY_TOP100, which returns the top 100 entities that match the search
criteria
- WS_SUMMARY query, which returns all entities that match the search criteria
- The only difference between these queries is the number of records returned,
which is specified in the query name.
After the ROOT segment, you then specify the search criteria
using the other available UMF segments and their valid tags for names, addresses,
numbers, characteristics, and email addresses.
Example UMF_SEARCH query
This example UMF_SEARCH query
returns the top 5 entities in the entity database that have a social security
number that exactly matches the social security number of 555-09-8761. Even
if more than entities were found, only the top 5 entities are returned on
the list.
Note: This example is formatted for readability and does not follow
the required one line per UMF record format.
<UMF_SEARCH>
<DSRC_CODE>1589</DSRC_CODE>
<DSRC_REF>1223</DSRC_REF>
<MIN_LIKE_SCORE>100</MIN_LIKE_SCORE>
<MAX_RETURN_CNT>5</MAX_RETURN_CNT>
<FORMAT_CODE>WS_SUMMARY</FORMAT_CODE>
<NUMBER>
<NUM_TYPE>SSN</NUM_TYPE>
<NUM_VALUE>555-09-8761</NUM_VALUE>
</NUMBER>
</UMF_SEARCH>