The UMF_QUERY input document contains the collection of
UMF segments that structure the incoming data to query the entity
database, and then find and return information about a specific entity
to the calling application. It contains the request and search criteria
for a Web services pipeline query.
The information in a UMF_QUERY input document is based
on SQL statements. The results of this Web services pipeline search
are returned to the calling application in a UMF_QUERY_RESULT output
document. UMF_QUERY undertakes an "Enhanced Query / Find by Attribute"
query.
These required UMF elements and segments comprise the
UMF_QUERY 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_QUERY.
- 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.
- FORMAT_CODE
- UMF tag that correlates to a UMF output document format that is
specified in the UMF_OUTPUT_FORMAT table. IBM InfoSphere Identity
Insight comes with three built-in format codes for a Web services
pipeline search using UMF_QUERY:
- WS_DETAIL, which returns all available entity data for the requested
entity ID
- WS_RELATION, which returns a list of all entities related to the
input entity at 1-degree
- WS_ALERT query, which returns all alerts in the system involving
the input entity ID
For undertaking EQ (Enhanced Query / Find By Attribute) via
this input-document, the following FORMAT_CODE must be specified.
ENHANCED_QUERY_RESULT
example:
<UMF_QUERY><FORMAT_CODE>ENHANCED_QUERY_RESULT</FORMAT_CODE><ATTRIBUTE><ATTR_TYPE>CIT</ATTR_TYPE>
<ATTR_VALUE>CANADA</ATTR_VALUE></ATTRIBUTE></UMF_QUERY>
- ENTITY_ID
- This required UMF tag specifies the entity ID for the entity in
the search. The system returns a response with details of the known
data about this entity from the entity database, based on the other
query criteria.
You then specify the optional
search criteria using the other available UMF segments and their valid
tags for names, addresses, numbers, characteristics, and e-mail addresses.
- NAME
- Query for name attributes that define the name of the person,
organization, place or item, as defined by the entity model and the
incoming identity.
- NUMBER
- Query for number attributes that are comprised of data that is
usually described as a number, such as credit card numbers, phone
numbers, and passport numbers.
- ADDRESS
- Query for address attributes that define a location of the identity
and typically contain standard address information: street name and
number, unit or building number, city, state, country, and postal
code.
- ATTRIBUTE
- Query for characteristic attributes that define other identity
traits or information that is not expressed through the other kinds
of attributes.
- EMAIL
- Query for e-mail attributes that define Internet e-mail addresses.
Example UMF_QUERY search
This example UMF_QUERY
uses the WS_DETAIL format code to query the entity database and return
all known information about Entity ID 1223:
Note: This example
is formatted for readability and does not follow the required one
line per UMF record format.
<UMF_QUERY>
<DSRC_CODE>1589</DSRC_CODE>
<DSRC_REF>546</DSRC_REF>
<FORMAT_CODE>WS_DETAIL</FORMAT_CODE>
<ENTITY_ID>1223</ENTITY_ID>
</UMF_QUERY>