Entity 360 Layout and Component Configuration Library/1/0756... · Abstract You can configure the layout and component content for the Entity 360 view. This article describes how

Entity 360 Layout and Component

Configuration

© 2014 Informatica Corporation. No part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica Corporation. All other company and product names may be trade names or trademarks of their respective owners and/or copyrighted materials of such owners.

AbstractYou can configure the layout and component content for the Entity 360 view. This article describes how to configure the Entity 360 view layout and how to configure content for predefined components and custom components. This article contains XML code examples to help you understand how to configure Entity 360.

Supported Versions• MDM Multidomain Edition 10.0.0

Table of ContentsEntity 360 Configuration Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Entity 360 Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Entity 360 View Example. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

How to Enable the Entity 360 View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

How to Add a Component to the Entity 360 View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

How to Write XML for Defining Components. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

How to Write XML for Defining Layouts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

How to Update the C_REPOS_COMPONENT_INSTANCE Table . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Entity 360 Configuration OverviewThe Entity 360 view in Informatica Data Director displays a wide range of data related to an entity. The Entity 360 view consists of multiple components.

Each component displays data related to an entity. You can configure predefined components and custom components to appear in the Entity 360 view. When you configure the layout of the Entity 360 view, you can configure a unique layout for a role, or you can configure the same layout for multiple roles.

Note: Informatica Data Director Data Masking and Informatica Data Director Data Security are not available in the Entity 360 view.

The Entity 360 view layout consists of the following areas:

Main area

An area that is three columns wide. Components can span one, two, or three columns. You can place multiple components in the Main area.

Tools area

An area that is a single column in the right-hand side of the Entity 360 view. You can place multiple components in the Tools area.

Entity 360 ComponentsMDM Multidomain Edition comes with preconfigured components that you can arrange on the Entity 360 view. You can also place custom components on the Entity 360 view.

You can place the following component types on the Entity 360 view:

2

Data View

Predefined. Displays the data of the root node and child objects of the composite object. The component name in the configuration file is RootCo.

Match

Predefined. Displays records that match the entity. The component name in the configuration file is MatchMerge.

Related Records

Predefined. Displays the records that relate to the entity. The component name in the configuration file is GetOneHop.

Cross-reference Systems

Predefined. Displays the source systems that contributed to the entity data. The component name in the configuration file is XrefSystems.

External Link

Displays a custom component of your choice. To configure custom components, you can use an inline frame that embeds an external web page, or you can use HTML code and Javascript. The component name in the configuration file is ExternalLink.

Entity 360 View ExampleThe following image show a typical Entity 360 view:

1. main area2. tools area, which contains one custom component3. data view component, which spans three columns4. related records component, which spans one column5. matches component, which spans one column6. source systems component, which spans one column7. custom component, which spans three columns

You must use XML to define the content and layout of the components in the Entity 360 view.

Informatica Data Director uses the C_REPOS_COMPONENT_INSTANCE table in the Informatica Data Director repository to store the definition of the components. After you define the component in XML, you need to upload the XML code to the C_REPOS_COMPONENT_INSTANCE table. The XML code includes the name, the type, and the

3

XML code that defines the component. Use a database tool that can handle the BLOB data type to upload the XML code to the C_REPOS_COMPONENT_INSTANCE repository database table.

How to Enable the Entity 360 ViewYou enable the Entity 360 View in the cmxserver.properties file.

In the cmxserver.properties file, set the cmx.e360.view.enabled property to true to enable the Entity 360 view. After you update the server properties, restart the application server for the changes to take effect.

How to Add a Component to the Entity 360 ViewFollow these steps when adding a component to the Entity 360 view:

1. Write XML for defining components.

2. Write XML for defining layouts.

3. Update the C_REPOS_COMPONENT_INSTANCE table.

Note: To configure the Entity 360 view, you require direct access to the C_REPOS_COMPONENT_INSTANCE table to insert data into it. There is no tool in the user interface of Informatica Data Director to configure the components for the Entity 360 view.

How to Write XML for Defining ComponentsFor each Entity 360 component, follow the XML examples to write the XML correctly and enter the necessary elements and attributes.

Data View Component Configuration

To configure the data view component, you can specify a row to display the parent record and you can specify rows to display child records. In each row, you can specify which fields appear, and the order in which the fields appear.

In the row element of the XML configuration code, you can specify a value of table for the view attribute to display the fields in a table. If you do not specify a value for the view attribute, you can configure sections to display entity data. For each row, you can configure field elements for each field of data that you want to appear in the data view component.

Specify the following attributes for the field element:

label

The label that appears for the field.

co

The composite object column name of the field.

type

The data type of the field.

When you upload the data view component configuration to the C_REPOS_COMPONENT_INSTANCE table, specify the following values for the TYPE_NAME, INSTANCE_NAME, and CONFIG_DATA:

TYPE_NAME

RootCo. RootCo is the type name you must use for the predefined data view component.

4

INSTANCE_NAME

An instance name of your choice. When you configure the Entity 360 layout, specify this INSTANCE_NAME in the configuration attribute of the component element.

CONFIG_DATA

Contains the XML configuration code.

Data View Component Configuration Example

You want to display two rows of data in a data view component. In the top row of the data view component, you configure three sections to display data from the Person composite object. In the second section, you want to display a table of the phone data for the person entity.

The following image shows the data view as it appears when you use the data view component configuration in this example:

The following XML sample shows the XML configuration code required to configure the data view component in this example:

<dataViewLayout co='Person' depth='1, 2, 3' cs='readPerson'><row> <section colspan='1'> <field label="First Name" co='firstName' type='text'/> <field label="Middle Name" co='middleName' type='text'/> <field label="Last Name" co='lastName' type='text'/> <field label="Display Name" co='displayName' type='text'/> </section> <section colspan='1'> <field label="Object Type" co='objectType' type='text'/> <field label="Object ID" co='objectID' type='text'/> <field label="Version" co='version' type='text'/> <field label="Score" co='score' type='text'/> </section> <section colspan='1'> <field label="Twitter" co='twitter' type='text'/> <field label="Created" co='created' type='text'/> <field label="Validated" co='validate' type='text'/> </section></row><row co='Person.Phone' view='table'> <section> <field label="Phone Country Cd" co='phoneCountryCd' type='text'/> <field label="Phone Ext Number" co='phoneExtNumber' type='text'/> <field label="Is Valid Ind" co='isValidInd' type='text'/> <field label="Rowid Object" co='rowidObject' type='text'/> <field label="Do Not Call Ind" co='doNotCallInd' type='text'/> <field label="Phone Number" co='phoneNumber' type='text'/> </section></row> </dataViewLayout>

5

Matches Component Configuration

To configure the matches component, specify which field appears in the matches component.

In the XML configuration code, specify the pattern attribute in the labelFormatter element. The pattern attribute value is the field name of the composite object data that you want to display in the matches component.

When you upload the matches component configuration to the C_REPOS_COMPONENT_INSTANCE table, specify the following values for the TYPE_NAME, INSTANCE_NAME, and CONFIG_DATA:

TYPE_NAME

MatchMerge. MatchMerge is the type name you must use for the predefined matches component.

INSTANCE_NAME

An instance name of your choice. When you configure the Entity 360 layout, specify this INSTANCE_NAME for the configuration attribute of the component element.

CONFIG_DATA


Matches Component Configuration Example

You want to display records that match a person composite object. You want to list the matches by their display name.

The following image shows the matches component as it appears when you use the matches component configuration in this example:

The following XML sample shows the XML configuration code required to configure the matches component in this example:

<dataViewLayout co='Person'> <labelFormatter pattern='{DISPLAY_NAME}'/></dataViewLayout>

Related Records Component Configuration

To configure the related records component, you specify a hierarchy profile, sandbox, and entity type.

The related records component is based on the Get One Hop function in the Hierarchy Manager. The related records component displays information about entities that directly relate to an entity in a specified hierarchy configuration.

In the XML configuration code, specify the hmConfigurationUid and hmEnittyTypeUid for the hmConfiguration profile element. For the hmConfigurationUid attribute, specify the hierarchy profile and sandbox in the format HM_CONFIGURATION.<hierarchy profile>|<sandbox>. For the hmEntityTypeUid, specify the entity type in the format HM_ENTITY_TYPE.<entity type>.

When you upload the related records component configuration to the C_REPOS_COMPONENT_INSTANCE table, specify the following values for the TYPE_NAME, INSTANCE_NAME, and CONFIG_DATA:

TYPE_NAME

GetOneHop. GetOneHop is the type name you must use for the predefined related records component.

6

INSTANCE_NAME


CONFIG_DATA


Related Records Component Configuration Example

You want to display records that relate to a person composite object.

The following image shows the related records component as it appears when you use the related records component configuration for this example:

The following XML sample shows the XML configuration code required to configure the related records component in this example:

<dataViewLayout> <hmConfiguration hmConfigurationUid='HM_CONFIGURATION.Default|Master' hmEntityTypeUid='HM_ENTITY_TYPE.Person'> </hmConfiguration></dataViewLayout>

Source Systems Component Configuration

To configure the source systems component, specify the colors of the bar graph that shows the proportion of contributing records from the source systems. You can specify the color by the HTML color names or by the hexadecimal code number.

The source system component displays the source systems that contributed to the entity data. The source systems appear in order from the largest contributor of cross-reference records to the smallest contributor of cross-reference records. The bar graph color for the largest contributor appears is the color that you define first in the XML configuration code. Specify the HTML color names or the hexadecimal code number in the value attribute of the color element in the XML configuration code.

When you upload the source systems component configuration to the C_REPOS_COMPONENT_INSTANCE table, specify the following values for the TYPE_NAME, INSTANCE_NAME, and CONFIG_DATA:TYPE_NAME

XrefSystems. XrefSystems is the type name you must use for the predefined source systems component.

INSTANCE_NAME


CONFIG_DATA


7

Source Systems Component Configuration Example

You want to configure the bar chart colors for the source systems that contributed to a person composite object.

The following image shows the source systems component as it appears when you use the sources systems component configuration in this example:

The following XML sample shows the XML configuration code required to configure the source systems component in this example:

<xrefSystems> <color value="DarkMagenta" /> <color value="Aqua" /> <color value="ForestGreen" /> <color value="Gold" /> <color value="LightSeaGreen" /> <color value="Orange" /></xrefSystems>

Entity 360 Custom Component Configuration

You can use the ExternalLink configuration type to configure custom components. When you configure custom components, you can use an inline frame to embed an external web page in an Entity 360 component, or you can configure the component with HTML code and Javascript.

You can pass data from the entity to the custom component by placing an entity field name in double braces. For example, if you want to pass the display name to a Bing search custom component, specify {{displayName}}.

To configure the content of the custom component, specify the following values for the TYPE_NAME, INSTANCE_NAME, and CONFIG_DATA columns in the C_REPOS_COMPONENT_INSTANCE table:

TYPE_NAME

ExternalLink. ExternalLink is the type name you must use for custom components.

INSTANCE_NAME


CONFIG_DATA

Contains the inline frame configuration or the HTML and Javascript code.

8

HTML and Javascript Custom Component Example

You want to use HTML and Javascript to display the Twitter feed that belongs to the person entity.

The following image shows the custom component as it appears when you use the custom component configuration for this example:

The following XML sample shows the HTML and Javascript code required to configure the custom component in this example:

<dataViewLayout> <widgetContent><![CDATA[ <div> <a target='_blank' class="twitter-timeline" href="https://twitter.com/{{taxID}}" data-screen-name="{{taxID}}" data-tweet-limit="5" data-show-replies="false" data-widget-id="473181088752222208">Tweets by {{displayName}}</a> <script>!function(d,s,id){ var widgetElem = d.getElementById(id); if (widgetElem) { var widgetParent = widgetElem.parentNode; widgetParent.removeChild(widgetElem); } var js, fjs=d.getElementsByTagName(s)[0], p=/^http:/.test(d.location)?'http':'https'; js=d.createElement(s); js.id=id; js.src=p+"://platform.twitter.com/widgets.js"; fjs.parentNode.insertBefore(js,fjs); }(document,"script","twitter-wjs"); </script> </div>]]> </widgetContent></dataViewLayout>

9

See https://dev.twitter.com/docs/embedded-timelines for more information about the Twitter API code in the example.

Inline Frame Custom Component Example

You want to configure an inline frame to display a Bing search page that is populated with the display name from the composite object.

The following image shows the custom component as it appears when you use the Bing component configuration for this example:

The following XML sample shows the inline frame configuration in the XML configuration code required to configure the custom component in this example:

<dataViewLayout> <widgetContent><![CDATA[<style> #box { height: 500px; overflow: auto; }</style><div id="box"><iframe src="http://www.bing.com/search?q=Informatica+{{displayName}}" allowtransparency="true" frameborder="0" scrolling="no" style="border:none;overflow:auto;height:100%;width:100%" ></iframe></div> ]]> </widgetContent></dataViewLayout>

How to Write XML for Defining LayoutsAs with defining Entity 360 components, ensure you follow the XML examples to write the XML correctly.

Entity 360 Layout Configuration

Configure the layout configuration XML code to arrange the location of the components in the Entity 360 view. Configure the layout for each composite object that you want to view in the Entity 360 view.

The Entity 360 view is divided into a three-column wide main area and a one-column wide tools area.

Specify the following attributes for the component element:type

The component type. Corresponds to the Type_Name of the component. You can specify RootCo, MatchMerge, GetOneHop, or XrefSystems for the preconfigured components, or ExternalLink for custom components.

10

configuration

The instance name. Corresponds to the INSTANCE_NAME you chose for the component.

colspan

The number of columns that the component spans. The colspan value for a component in the main area can be 1, 2, or 3. The colspan value for a component in the tools area can be 1.

When you upload the configuration to the C_REPOS_COMPONENT_INSTANCE table, specify the following values for the TYPE_NAME, INSTANCE_NAME, and CONFIG_DATA columns.

TYPE_NAME

ContainerCoView

INSTANCE_NAME

The composite object name.

CONFIG_DATA


Entity 360 Component Layout Configuration Example

You want to configure an Entity 360 layout that consists of several components in the main area and a custom Twitter component in the tools area.

The following image shows the Entity 360 view layout as it appears when you use the layout configuration for this example:

The following XML sample shows the XML configuration code required to configure the layout in this example::

<componentContainer> <layout> <mainArea> <component type='RootCo' configuration='Person_Co' colspan='3' /> <component type='MatchMerge' configuration='Person_MatchMerge' colspan='1' /> <component type='GetOneHop' configuration='Person_GetOneHop' colspan='1' /> <component type='XrefSystems' configuration='Default' colspan='1' /> <component type='ExternalLink' configuration='Bing_ExternalLink' colspan='3' />

11

</mainArea> <toolsArea> <component type='ExternalLink' configuration='Twitter_ExternalLink' colspan='1' /> </toolsArea></mainArea>

How to Update the C_REPOS_COMPONENT_INSTANCE TableThe C_REPOS_COMPONENT_INSTANCE repository database table stores the Entity 360 configuration information. Use the following instructions to update the C_REPOS_COMPONENT_INSTANCE table with the Entity 360 components and layout definitions.

In the table, you must update specific columns and specific type names for each component. Then you update the C_REPOS_COMPONENT_INSTANCE table with your changes.

C_REPOS_COMPONENT_INSTANCE

The C_REPOS_COMPONENT_INSTANCE repository database table stores the Entity 360 configuration information.

The following table describes the C_REPOS_COMPONENT_INSTANCE table columns:

Column Name Data Type Description

ROWID_INSTANCE CHAR(14) Row identifier.

INSTANCE_NAME VARCHAR2(255) Name of configuration data instance.

TYPE_NAME VARCHAR2(255) Type of a component. The TYPE_NAME can be RootCo, MatchMerge, GetOneHop, XrefSystems, or ExternalLink for component content configuration. The TYPE_NAME is ContainerCoView for layout configuration.

CONFIG_DATA BLOB XML code that defines the content and layout of the components to display in the Entity 360 view.

CREATE_DATE TIMESTAMP(6) Date the row was created.

CREATED_BY VARCHAR2(50) Person who created the row.

LAST_UPDATE_DATE TIMESTAMP(6) Last time the row was updated.

UPDATED_BY VARCHAR2(50) Person who last updated the row.

Type Name for Components

When you create components in the C_REPOS_COMPONENT_INSTANCE repository database table, the TYPE_NAME column needs specific values for each type of component.

The following table describes the TYPE_NAME value you need to specify for each Entity 360 component:

Component Type Name

Data View RootCo

Matches MatchMerge

12

Component Type Name

Related Records GetOneHop

Source Systems XrefSystems

Custom ExternalLink

Uploading the XML Configuration Code

To upload the XML configuration code, use a database tool that can handle the BLOB data type to upload the code to the C_REPOS_COMPONENT_INSTANCE repository database table. You must specify values for INSTANCE_NAME, TYPE_NAME, and CONFIG_DATA.

Note: You must restart the application server after you upload the XML configuration code to the C_REPOS_COMPONENT_INSTANCE repository database table.

Updating the Entity 360 Configuration

To update the Entity 360 configuration file, update the LAST_UPDATE_DATE field and use the Repository Manager to validate the composite object configuration.

1. Edit the XML configuration file with the required updates to the Entity 360 view configuration.

2. Use a database tool that can handle the BLOB data type to upload the XML file to repository table C_REPOS_COMPONENT_INSTANCE. Upload the XML file to the CONFIG_DATA column of the row for the required component. Save the database changes.

3. Restart the application server.

AuthorMDM Documentation Team

13

Documents

Entity 360 Layout and Component Configuration Library/1/0756... · Abstract You can configure the layout and component content for the Entity 360 view. This article describes how