Installation and Configuration Guide

10.1 HotFix 1
- 10.1

Back Next

Configuring the Relationship Graph

Configure the business entity types that you want to display in the relationship graph. For each business entity type, you can configure the potential relationships, the list of columns based on which you want to display the relationship graph, the URL to access the RESTful web services, and other parameters.

To configure the relationship graph, add the following parameters to the

Relationship

section in the relationship configuration file:

Relationship: Defines the identifiers for the relationship table name. The following batch jobs use the identifiers to form the relationship table name:
Load match pairs
Create relationship graph; Use the following attributes:
name. Unique identifier for the relationship table.
OrganizationID. Unique identifier for the organization.
ColumnFamilyName. Identifier for the column family that groups all the columns in the relationship table.
A relationship table name uses the following format:
MDMBDRM<OrganizationID>_<name>
The following sample code defines a relationship table named
MDMBDRMSAP_RelTable
:
<Relationship name="RelTable" OrganizationID="SAP" ColumnFamilyName="cf">
BDRMEntities: Lists the business entity types that you plan to use.
BDRMEntity: Properties for a business entity type. The properties include a name and an icon for the business entity type.
Use the following attributes:
name. Name of the business entity type that you configure.
classType. Icon for the business entity type. Default is none.
Specify one of the following values:

Value
Icon

person

house

cart

request

none; The following sample code configures properties for the
Customer
business entity type:
<BDRMEntity name="Customer" classType="person">
MetaData: Maps the primary key and source columns of the business entity type to the equivalent columns in the other business entity types.; Use the following format to specify the column names:
<MetaData> <ROWID name="<Column1>"><Column2></ROWID> <Source name="<Column3>"><Column4></Source> </MetaData>; Column1
is mapped to
Column2
, and
Column3
is mapped to
Column4
.; For example, if the primary key column in the Customer business entity type is
ID
and the product business entity type contains the customer identifier in the
customerID
column, map the columns.; The following sample code maps the
ID
and
LMT_SOURCE_NAME
columns to the
customerID
and
customerLMT_SOURCE_NAME
columns:
<MetaData> <ROWID name="ID">customerID</ROWID> <Source name="LMT_SOURCE_NAME">customerLMT_SOURCE_NAME</Source> </MetaData>
ConfigurationXML: Absolute path and file name of the configuration file that you use to process the input records of the business entity type.
RESTEndPoint: URL that accesses the RESTful web services of the business entity type. If you do not specify the URL, you cannot search records in the search page of the relationship graph user interface.; The following URL accesses the RESTful web services of the Customer business entity type:
http://localhost:8080/MDMBDRMCustomer360/v4.0/Customer360/
The URL is valid only when you end the URL with the slash (/) character.
DisplayField: Name of the column whose values you want to use as node labels in the relationship graph.
EntityViewFields: List of the columns that you want to display in the right pane of the relationship graph when you select a node. You can use the same column names or use alias names for the columns. If you use alias names, the right pane of the relationship graph displays the alias names.; Use the following format to specify the list of columns:
<EntityViewFields> <Field name="<Field1>"><Field1 Alias></Field> <Field name="<Field2>"><Field2 Alias></Field> <Field name="<Field3>"><Field3 Alias></Field> </EntityViewFields>; The following sample code uses alias names for the
id
and
Name
columns:
<EntityViewFields> <Field name="id">Customer ID</Field> <Field name="LMT_SOURCE_NAME" /> <Field name="Name">Full Name</Field> </EntityViewFields>
RelationshipType: List of relationships that the business entity type can use. You can connect a business entity type with another business entity type through a relationship. The relationship types include inbound and outbound relationships.; The following sample code lists the inbound and outbound relationships for a business entity type:
<RelationshipType> <InBoundRelationship> <Label name="Duplicate" /> <Label name="Household" /> </InBoundRelationship> <OutBoundRelationship> <Label name="Duplicate" /> <Label name="Household" /> </OutBoundRelationship> </RelationshipType>
OutBoundRelationship: List of the outbound relationships that the business entity type can use. The relationships through which an entity connects to other entities are called outbound relationships.; For example, consider Customer and Product as business entity types. The relationship
Owns
connects the customers and the products they own. In this case,
Owns
is an outbound relationship for the Customer business entity type.; The following image shows the outbound relationship of the Customer business entity type:
InBoundRelationship: List of the inbound relationships that the business entity type can use. The relationships through which other entities connect to an entity are called inbound relationships.; For example, consider Customer and Product as business entity types. the relationship
Client
connects the products and the customers who own the products. In this case,
Client
is an inbound relationship for the Customer business entity type.; The following image shows the inbound relationship of the Customer business entity type:
Label: Name of the relationship for the business entity type.
EntityFields: List of the columns that you want to use as filters in the relationship graph.
Field: Name of the column and its properties.
Use the following attributes:
name. Name of the column.
length. Length of the column. Ensure that the value matches with the length of the column that you specify in the
PZMAP
section of the configuration file.
filterable. Indicates whether the column can be used to filter the records. Set to
true
to use the column as a filter, and set to
false
if you do not want to use the column as a filter.
aggregatable. Indicates whether you can aggregate the records that have relationship. When you aggregate the records, the relationship graph shows the total number of related records.
The following sample code configures the properties for the
Age
column:
<Field name="Age" length="5" filterable="true" aggregatable="false">
Facets: Type of filter for the column. Applicable only when you configure the column as a filter.; You can use the following filter types:
Exact. Filters the records based on the value that you provide in the relationship graph.
Enum. Filters the records based on the enumeration values that you configure.
Range. Filters the records based on the range that you configure.
Use the following format to configure the type of filter:
<Facets type="<Filter Type>">
For example, the following sample code configures the filter type as
Enum
:
<Facets type="Enum">
Facet: Enumeration value or range that you want to configure for the column. Applicable only when the filter type is
Enum
or
Range
.; Use the following format to configure enumeration values:
<Facet id="<Identifier>"><Value></Facet>
For example, the following sample code configures the enumeration values for the
Gender
column:
<Field name="Gender" length="2" filterable="true" aggregatable="true"> <Facets type="Enum"> <Facet id="M">Male</Facet> <Facet id="F">Female</Facet> </Facets> </Field>; Use the following format to configure range values:
<Facet id="<Identifier>" min="<Minimum Range Value>" max="<Maximum Range Value>"/>
For example, the following sample code configures the range for the
Age
column:
<Field name="Age" length="5" filterable="true" datatype="integer" aggregatable="false"> <Facets type="Range"> <Facet id="Infant" min="0" max="4" /> <Facet id="Child" min="5" max="12" /> <Facet id="Adult" min="13" max="140" /> </Facets> </Field>