IM InfoSphere Identity Insight, Version 8.0

WS_SUMMARY format codes

IBM InfoSphere Identity Insight comes with three pre-built format codes for use with the UMF_SUMMARY input document: WS_SUMMARY, WS_SUMMARY_TOP10, and WS_SUMMARY_TOP100. These format codes return a list of entities that match the criteria specified in the UMF_SUMMARY input document. The only difference between these format codes is the maximum number of records returned, which is specified in the format code name.

Example of a Web services pipeline search using the WS_SUMMARY_TOP10 format code

This example Web services pipeline search returns the top 10 entities in the entity database that most closely match the following search criteria:
  • Name: Joe Franklin
  • Phone number: 415-555-3325
  • Date of birth: January 2, 1956
It uses the UMF_SEARCH input document to specify this criteria, also specifying the format code of WS_SUMMARY_TOP10.
Note: This example is formatted for readability and does not follow the required one line per UMF record format.
<UMF_SEARCH>
	<FORMAT_CODE>WS_SUMMARY_TOP10</FORMAT_CODE>
	<DSRC_CODE>1589</DSRC_CODE>
	<DSRC_REF>556</DSRC_REF>
	<MIN_LIKE_SCORE>80</MIN_LIKE_SCORE>
	<NAME>
		<NAME_TYPE>M</NAME_TYPE>
		<LAST_NAME>FRANKLIN</LAST_NAME>
		<FIRST_NAME>JOE</FIRST_NAME>
	</NAME>
	<NUMBER>
		<NUM_TYPE>PHONE</NUM_TYPE>
		<NUM_VALUE>415-555-3325</NUM_VALUE>
	</NUMBER>
	<ATTRIBUTE>
		<ATTR_TYPE>DOB</ATTR_TYPE>
		<ATTR_VALUE>01/02/1956</ATTR_VALUE>
	</ATTRIBUTE>
</UMF_SEARCH>

After sending this UMF_SEARCH document through Web services for processing by a Web services pipeline, the calling application receives a response in the following UMF_SEARCH_RESULT document:

<UMF_SEARCH_RESULT>	
	<DSRC_CODE>1589</DSRC_CODE>
	<ENTITY>
		<MATCHED_ENTITY_ID>38763</MATCHED_ENTITY_ID>
		<ENT_NAME>FRANKLIN, JOEY</ENT_NAME>
		<ENT_PHONE>415-555-3325</ENT_PHONE>
		<ENT_DOB>01/02/1956</ENT_DOB>
		<LIKE_SCORE>90</LIKE_SCORE>
	</ENTITY>	
	<ENTITY>
		<MATCHED_ENTITY_ID>87</MATCHED_ENTITY_ID>
		<ENT_NAME>FRANKLIN, JOSEPH</ENT_NAME>
		<ENT_PHONE>415-555-3325</ENT_PHONE>
		<ENT_DOB>02/01/1956</ENT_DOB>
		<LIKE_SCORE>80</LIKE_SCORE>
	</ENTITY>
	<ENTITY>
		<MATCHED_ENTITY_ID>330</MATCHED_ENTITY_ID>
		<ENT_NAME>FRANKLIN, J</ENT_NAME>
		<ENT_PHONE>451-555-3325</ENT_PHONE>
		<ENT_DOB>01/02/1956</ENT_DOB>
		<LIKE_SCORE>80</LIKE_SCORE>
	</ENTITY>	
	<FROM_NODE>556</FROM_NODE>
	<FORMAT_CODE>WS_SUMMARY_TOP10</FORMAT_CODE>
	<MIN_LIKE_SCORE>80</MIN_LIKE_SCORE>
	<PAGE_NUM>1</PAGE_NUM>
	<RETURN_CNT>3</RETURN_CNT>
</UMF_SEARCH_RESULT>

In this case, there were only 3 entities in the entity database that matched the search criteria with a minimum likeness score of 80.



Feedback

Last updated: 2011