IM InfoSphere Identity Insight, Version 8.0

RELATED_ENTITY data segment definitions

The RELATED_ENTITY data segment contains the information required to create a relationship with the UMF_ENTITY identity.

Disclosed relationships can also be defined within a UMF_ENTITY document using one or more RELATED_ENTITY data segments. The related entity will be loaded separately and a disclosed relationship will be created between the inbound UMF_ENTITY and the RELATED_ENTITY. A RELATED_ENTITY data segment can contain any data segments allowed in a UMF_ENTITY segment (except other nested RELATED_ENTITY segments).

If you don't specify a datasource (DSRC_CODE) for a RELATED_ENTITY segment, the pipeline generates one that is the same as its containing UMF_ENTITY.

If you don't specify a datasource account (DSRC_ACCT) for a RELATED_ENTITY segment, the pipeline generates one based on a hash of the data for the related entity.

Tag Name Field Type Data Type Required Explanation
DSRC_ACCT   Char(255) No The data source account number of the related identity in the source system.
DSRC_CODE   Char(100) No The data source code of the related entity. Value of containing UMF_ENTITY is inherited if this value is not specified.
DSRC_REF   Char(255) No An optional reference number back the source system record.
LOAD_ACTION   Char(1) No The action to take when loading the segment. Valid values are:
A
Add.
C
Change.
D
Soft delete.
F
Hard delete.
Note: Using a LOAD_ACTION value of F will the data to be permanently deleted.
DESCRIPTION   Char(255) No An optional description of the disclosed relationship.
In this example, the inbound record creates two accounts ('LARRY R SMITH' and 'SARAH SMITH') and relates them via a disclosed relationship (DESCRIPTION='SISTER')
<UMF_ENTITY>
	<DSRC_CODE>100</DSRC_CODE>
	<DSRC_ACCT>1000</DSRC_ACCT>
	<DSRC_REF>1000</DSRC_REF>
	<NAME>
		<NAME_TYPE>M</NAME_TYPE>
		<FULL_NAME>SMITH, LARRY R</FULL_NAME>
	</NAME>
	<RELATED_ENTITY>
		<DSRC_CODE>200</DSRC_CODE>
		<DSRC_REF>NEW_RELATIONSHIP</DSRC_REF>
		<NAME>
			<NAME_TYPE>M</NAME_TYPE>
			<FULL_NAME>SMITH, SARAH</FULL_NAME>
		</NAME>
		<DESCRIPTION>SISTER</DESCRIPTION>
	</RELATED_ENTITY>
</UMF_ENTITY>
In this example, an identity (DSRC_CODE='200' and DSRC_ACCT='999') already exists in the database, and we are creating a disclosed relationship (DESCRIPTION='LAWYER') between that existing identity and this new inbound 'Larry R Smith' identity.
<UMF_ENTITY>
	<DSRC_CODE>100</DSRC_CODE>
	<DSRC_ACCT>1000</DSRC_ACCT>
	<DSRC_REF>1000</DSRC_REF>
	<NAME>
		<NAME_TYPE>M</NAME_TYPE>
		<FULL_NAME>SMITH, LARRY R</FULL_NAME>
	</NAME>
	<RELATED_ENTITY>
		<DSRC_CODE>200</DSRC_CODE>
		<DSRC_ACCT>999</DSRC_ACCT>
		<DSRC_REF>EXISTING_ACCOUNT</DSRC_REF>
		<DESCRIPTION>LAWYER</DESCRIPTION>
	</RELATED_ENTITY>
</UMF_ENTITY>


Feedback

Last updated: 2011