app tool kit

IBM InfoSphere Master Data ManagementVersion 10.0

Application Developer Plugin UserGuideUpdated: February 2012

GI13-2634-00

��

NoteBefore using this information and the product that it supports, read the information in “Notices and trademarks” on page23.

Edition Notices

This document contains proprietary information of IBM. It is provided under a license agreement and is protectedby copyright law. The information contained in this publication does not include any product warranties, and anystatements provided in this manual should not be interpreted as such.

When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in anyway it believes appropriate without incurring any obligation to you.

© Copyright IBM Corporation 2011, 2012.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

Chapter 1. IBM InfoSphere Master DataManagement Application Plugin . . . . 1Features of InfoSphere MDM Application Plugin . . 1Benefits of using InfoSphere MDM ApplicationPlugin . . . . . . . . . . . . . . . . 1

Chapter 2. Installation overview forInfoSphere MDM Application Plugin. . . 3System requirements for InfoSphere MDMApplication Plugin . . . . . . . . . . . . 3Installing InfoSphere MDM Application Plugin . . . 3

Chapter 3. Creating Web applicationsusing the InfoSphere MDM ApplicationPlugin . . . . . . . . . . . . . . . 5Creating an InfoSphere MDM application project . . 5

InfoSphere MDM Application project directories . 6Configuring MDM server settings . . . . . . . 6Domain samples . . . . . . . . . . . . . 7Customizing the domain sample view configurationfile. . . . . . . . . . . . . . . . . . 7

Example: View configuration file for IBM InitiateMaster Data Service applications. . . . . . . 8

Example: View configuration file for InfoSphereMDM Server applications. . . . . . . . . 10

Mapping the domain sample to the application viewdefinition . . . . . . . . . . . . . . . 11

Example: Mapping definitions for IBM InitiateMaster Data Service applications . . . . . . 11Example: Mapping definitions for InfoSphereMDM Server applications. . . . . . . . . 14

Chapter 4. Deploying applications . . . 17Deployment strategies . . . . . . . . . . . 17Deploying a dynamic web project . . . . . . . 17Creating an enterprise application project . . . . 18Exporting an artifact file . . . . . . . . . . 18Verifying deployed applications . . . . . . . 19

Legal Statement. . . . . . . . . . . 21

Notices and trademarks . . . . . . . 23

Index . . . . . . . . . . . . . . . 27

Contacting IBM . . . . . . . . . . . 29

© Copyright IBM Corp. 2011, 2012 iii

iv InfoSphere MDM Application Developer Plugin User Guide

Chapter 1. IBM InfoSphere Master Data ManagementApplication Plugin

Use the plugin to build custom, lightweight, robust applications for IBM®

InfoSphere® Master Data Management (MDM) products.

The plugin contains a library of built-in, Dojo widgets and domain samples thatyou can customize for your specific applications. You can build applications thatdisplay, access, and manipulate the data managed by InfoSphere MDM products.For example, you can quickly assemble widgets into an application to search for anentity, look at a sorted list of results, and view the relationships to other entities forany item in the result list.

IBM InfoSphere Master Data Management Application Plugin must be installedinto an integrated development environment (IDE). The supported IDEs are:v Eclipsev Rational Application Developer (RAD)v Rational Software Architect (RSA)

The plugin is part of the IBM InfoSphere Master Data Management ApplicationToolkit.

Features of InfoSphere MDM Application PluginThe plugin includes widgets and domain samples that you can use to quicklyassemble InfoSphere MDM applications. You can customize the appearance andbehavior of the widgets and domain samples for your particular applications.

The plugin includes the following features:v Widget library - A suite of reusable Dojo widgets to enable common use cases of

InfoSphere MDM technology. You can view, add, edit, and search for entities, aswell as view the relationships between entities.

v Domain samples - HTML files that you can use to combine widgets together asa starting point for your end-to-end MDM applications.

v Customization - You can modify the behavior of the widgets and domainsamples without coding. For example, you can select the fields that you wantdisplayed on a search page. There are several built-in configuration files that youcan modify to change the display and the behavior of the widgets within adomain sample.

Benefits of using InfoSphere MDM Application PluginThe plugin helps both developers and end users achieve greater efficiency withoutsacrificing quality or transparency.

In particular, you gain the following benefits using the InfoSphere MDMApplication Plugin:v Fast time to value - Build your solutions quickly with reusable widgets and

application templates.

© Copyright IBM Corp. 2011, 2012 1

v Reduce implementation costs - Use the built-in user interface widgets and savetime and effort on developing your interfaces and APIs.

v Increase capabilities of existing applications - Enhance your existingapplications by adding robust InfoSphere MDM search and data managementfunctions.

v Reduced architectural complexity - Work with any data model so thefunctionality and user interfaces can be reused across business processes.

v Extensibility - Swiftly customize the behavior and appearance of yourapplications.

2 InfoSphere MDM Application Developer Plugin User Guide

Chapter 2. Installation overview for InfoSphere MDMApplication Plugin

The process for installing the plugin InfoSphere MDM Application Plugin dependson the InfoSphere MDM software that you are using.v If you are using IBM Initiate® Master Data Service and the IBM Initiate

Workbench, the InfoSphere MDM Application Plugin is installed when youinstall the Initiate workbench. You can use the workbench to create MDMapplication toolkit projects. No separate installation is required.

v If you are using the InfoSphere MDM Application Toolkit, the InfoSphere MDMApplication Plugin is included with the toolkit. You must install the plugin intoone of the supported IDEs: Eclipse, Rational® Application Developer (RAD), orRational Software Architect (RSA).

System requirements for InfoSphere MDM Application PluginBefore you install the toolkit plugin, ensure that your environment meets thesystem requirements.

You must have:v One of the supported integrated development environments (IDEs) installed:

Eclipse, Rational Application Developer (RAD), or Rational Software Architect(RSA). This documentation focuses on installing the toolkit plugin on RAD orRSA. Rational Application Developer (RAD) includes specific features fordeveloping with the JavaScript Dojo toolkit. With Rational ApplicationDeveloper (RAD), you can quickly deploy applications to your preferredapplication server for testing or production.

v An application server installed in the development environment. Thisdocumentation focuses on developing applications using WebSphere®

Application Server Version 7.0.0.17.Related tasks:“Installing InfoSphere MDM Application Plugin”An administrator should install the toolkit plugin into one of the supportedintegrated development environments (IDEs).“Creating an enterprise application project” on page 18Some application servers require that you use an enterprise application project toembed the web application. WebSphere Application Server (WAS) is an example ofone type of application server that has this requirement.

Installing InfoSphere MDM Application PluginAn administrator should install the toolkit plugin into one of the supportedintegrated development environments (IDEs).

Before you begin

Ensure that your environment meets the system requirements for the InfoSphereMDM Application Plugin.


Eclipse installation: If you installed Eclipse using IBM Installation Manager, youcan install the toolkit plugin on Eclipse using IBM Installation Manager. Otherwiseyou must install the toolkit on Rational Application Developer (RAD), or RationalSoftware Architect (RSA).

About this task

This documentation describes how to install the toolkit plugin on RAD or RSA.

Procedure1. Open your development environment and select Help > IBM Installation

Manager to launch IBM Installation Manager.2. On the initial IBM Installation Manager screen select File > Preferences.3. On the Repositories tab click Add Repository.4. Browse to the com.ibm.mdm.application.toolkit.offering.zip file, which is

included with your IBM InfoSphere MDM installation files.5. Click Test Connection to validate your installation files.6. Click OK.7. The initial IBM Installation Manager screen appears again. Select Install.8. From the list of software packages, select IBM InfoSphere Master Data

Management Application Toolkit and click Next.The IBM Installation Manager searches for your local Rational ApplicationDeveloper (RAD) or Rational Software Architect (RSA) instance.

9. Ensure the instance that you want to use is selected and click Next.The next screen lists the components in IBM InfoSphere Master DataManagement Application Toolkit.

10. Select Application Developer Plugin and click Next.11. On the confirmation page click Install.

Results

After the installation finishes, launch Rational Application Developer (RAD) orRational Software Architect (RSA) to create applications using the plugin.Related concepts:“System requirements for InfoSphere MDM Application Plugin” on page 3Before you install the toolkit plugin, ensure that your environment meets thesystem requirements.


Chapter 3. Creating Web applications using the InfoSphereMDM Application Plugin

About this task

To create an application using the plugin, follow these high-level steps:

Procedure1. Within your integrated development environment (IDE), create a new

InfoSphere MDM Application project.2. Configure the MDM server settings.3. Specify the view definitions for the domain sample that you want to use.4. Specify the mapping definitions of the back-end object model to the user

interface object model.5. Create a deployable artifact file.

Creating an InfoSphere MDM application projectThe first step to creating an MDM application is to create a new project in yourintegrated development environment (IDE).

Before you begin

The InfoSphere MDM Application Plugin must be installed on one of thesupported IDEs: Eclipse, Rational Application Developer (RAD), or RationalSoftware Architect (RSA).

About this task

When you create a new MDM Application project, the new project is a dynamic webproject. You can either use the dynamic web project or create a deployable WAR orEAR file.

A wizard guides you though the steps to create an application project:

Procedure1. Start your development environment.2. Select File > New > Project > IBM InfoSphere MDM Developer Toolkit >

MDM Application Project to open the New MDM Application Project wizard.3. Click Next.4. In the Project name field specify a name for the project.5. In the Location field specify the directory where you want to save this project,

or select Use default location. The default location is the workspace directorythat is currently in use.

6. Under Target server:a. From the Type list select your target master data management server, either

IBM Initiate MDS or IBM InfoSphere MDM Server.b. From the Domain list select Individual or Organization as the target

domain type.


7. Click Finish.

Results

After you complete the New MDM Application Project wizard, a new applicationtoolkit project is added to your development workspace.

InfoSphere MDM Application project directoriesWhen you create a new project, a set of files and artifacts that you need to developyour application are added to the Java Resources\src directory.

You can use the files and artifacts to run one of the domain samples, Individual orOrganization. These domain samples contain common fields and mappings into theMDM servers. These fields and mappings are used when your application isworking with master data that relates to individuals or organizations. The filescontain all of the artifacts that are required by the generated web application,including cascading style sheet (CSS) files and deployment descriptors. The filesincluded are:

Configuration filesThese files includes a mdm.properties file which can be configured to pointyour web application to a different MDM server.

View metadata filesThese files define the fields that display on screen. The format of this viewmetadata is different depending on the MDM server that you use.

Mapping filesThese files contain the mapping information that describe how the viewmetadata maps into the services that are defined on the underlying MDMserver. These mappings are authored in conjunction with the viewmetadata, to allow different data to be returned or set to the underlyingMDM system.

Widget definitionsThese are located in the WebContent/pages directory. These files contain theJavaServer Pages (JSP) that contain widget definitions. A domain samplecan contain several widgets, such as a search form with search results.These JSPs display to the end user when using the Web application. TheJSPs can also be customized if you require styling changes.

Configuring MDM server settingsAfter you create a new project, you need to configure master data management(MDM) settings.

About this task

To configure the server settings:

Procedure1. Launch your development environment.2. Open your InfoSphere MDM application project.3. In the config directory, open the mdm.properties file.4. Change the contextFactory.hostName property value to the IP address of your

MDM server.


5. Change the contextFactory.hostPort property value to the listening port of theyour MDM server.

6. Change the MDM server properties values. The steps to change these valuesdepend on the type of MDM server that you are using:

Option Description

IBM Initiate Master Data Service Ensure that a hub-owned source is definedwithin the IBM Initiate Master Data Serviceusing the IBM Initiate Workbench.

Change the hub.owned.source propertyvalue to an IBM Initiate Master Data Enginesource that is defined solely for the purposesof persisting master data.

IBM InfoSphere Master Data ManagementServer

Ensure that the SSL properties match thesecurity settings of your InfoSphere MDMServer.

7. Save and close the mdm.properties file.

Domain samplesAfter you configure the MDM server settings, use the domain samples that areinstalled with the plug-in as starting points for your own custom applications.

The InfoSphere MDM Application Plugin includes the Individual and Organizationdomain samples.v The Individual domain sample is designed to be used with master data related to

individual people.v The Organization domain sample is designed to be used with master data related

to groups or organizations.

These domain samples contain the most frequently used fields and mappings fromthose fields to the MDM server.

Although you can use the domain samples to demonstrate the capabilities of theplugin, to create applications you will want to make a copy of the domain samplesand customize them for your particular needs.

When you create an MDM application project using either Individual orOrganization domain samples, the project is created with a sample viewconfiguration file. The view configuration file is used by the application to definewhich fields should display on screen.

Any application built using the InfoSphere MDM Application Plugin must useconfigured views which correspond to the view definitions in the domain sampleHTML file. These view definitions determine how a particular widget behaves, theappearance of the widget, and what information the widget contains or requires.

The format of the view configuration file is different for IBM Initiate Master DataService and InfoSphere MDM Server.

Customizing the domain sample view configuration fileYou can change the settings in the view configuration file to customize the valuesfor your own applications.

Chapter 3. Creating Web applications using the InfoSphere MDM Application Plugin 7

Procedure1. In your InfoSphere MDM Application project, open the Java Resources\src

directory.2. Edit the configuration file:

Option Description

IBM Initiate Master Data Service Edit the mdm-views.xml file.

The values in the XML file must correspondwith the views for your application.


Edit the organization.orgmodel file.

The values in the orgmodel file mustcorrespond with the views for yourapplication.

3. Save and close the file.Related reference:“Example: View configuration file for IBM Initiate Master Data Serviceapplications”When you customize views for an application, the views that you use in yourHTML file must refer to the views that are defined in the mdm-views.xml file.“Example: View configuration file for InfoSphere MDM Server applications” onpage 10When you customize views for an application, the views must correspond to theconfiguration file called organization.orgmodel.

Example: View configuration file for IBM Initiate Master DataService applications

When you customize views for an application, the views that you use in yourHTML file must refer to the views that are defined in the mdm-views.xml file.

This XML file is located in the Java Resources\src directory in the project in yourdevelopment environment.

viewName attribute

For example, the Individual domain sample contains a file calledAtlantisSearchFormDemo.html that includes the Search Form widget shown below.The viewName attribute refers to a Person Search view:<div title="Search Form" class="noBorder noPadding"dojoType="mdm.widgets.SearchForm" title="Search Form" region="left"mdmSuccess="updateSearchResults" splitter="true" style="width: 20%"eventscope="searchform" mdmError="errorOnSearch" objectType="Person"viewName="Person Search"></div>

Attributes and fields

The Person Search view is defined in the mdm-views.xml file. The following excerptfrom the XML file shows that a view definition has two basic components:attributes and fields. These components are identified by the tagging with the samenames, <attribute> and <field>.


<view objectType="Person" name="Person Search" label="Person View"><attributes>

<attribute ref="givenName" label="First Name"><fields>

<field ref="givenName" label="First Name" /></fields>

</attribute><attribute ref="surname" label="Surname">

<fields><field ref="surname" label="Surname" />

</fields></attribute><attribute ref="gender" label="Gender">

<fields><field ref="gender" label="Gender" />

</fields></attribute><attribute ref="address" label="Address">

<fields><field ref="line1" label="Address Line One" /><field ref="line2" label="Address Line Two" /><field ref="city" label="City" /><field ref="postalCode" label="Postal Code" />

</fields></attribute>

</attributes></view>

In the above example, the view definition for the Person Search form is configuredwith the following items:v first (given) namev surnamev genderv an address containing a first and second address line, city, and postal code

Attribute identifiers

In this example, an address is an attribute that contains four fields: line1, line2,city, and postalCode. Here is the address excerpt:<attribute ref="address" label="Address">

<fields><field ref="line1" label="Address Line One" /><field ref="line2" label="Address Line Two" /><field ref="city" label="City" /><field ref="postalCode" label="Postal Code" />


The ref identifier on any attribute or field should match a corresponding mappingname within the mdm-mapping.xml file. The label identifier specifies the text labelthat displays next to the field in the view. You can customize the attributes andfields in a view definition for your businesses needs, as long as all attributes andfields defined in a view have a corresponding definition in the mdm-mapping.xmlfile.


Related tasks:“Customizing the domain sample view configuration file” on page 7You can change the settings in the view configuration file to customize the valuesfor your own applications.

Example: View configuration file for InfoSphere MDM Serverapplications

When you customize views for an application, the views must correspond to theconfiguration file called organization.orgmodel.

The organization.orgmodel file is located in the Java Resources\src directory inthe project in your development environment.

viewName attribute

Each widget on the Web interface maps to a set of metadata stored in the viewconfiguration file. The following example is from the JSP page in the viewconfiguration file. This excerpt shows that the viewName property is used to link thewidget to the metadata in the view definition file:<div title="Search Form" class="noBorder noPadding"dojoType="mdm.widgets.SearchForm" title="Search Form" region="left"mdmSuccess="updateSearchResults" splitter="true" style="width: 20%"eventscope="searchform" mdmError="errorOnSearch" objectType="Individual"viewName="Individual Search"></div>

Fields and attributes

Each widget on the Web interface displays a collection of fields. This collection offields is referred to in the metadata as a user datatype. The fields within the<userDatatypes> tag are known as user attributes as indicated by the<userAttributes> tags). These concepts are defined within the orgModel. Themapping from the viewName property above is directly related to the name propertyon the <userDatatypes> definition below:<userDatatypes xsi:type="orgmodel:UserObject" sourceId="_k5hyIM_VEeC5GorTm1Nc6w"

name="Individual Search" qualifiedName="MDM Individual::Glossary::IndividualSearch" documentation="" className="IndividualSearch"><userAttributes xsi:type="orgmodel:SimpleUserAttribute"sourceId="_iHJUoM_WEeC5GorTm1Nc6w" name="FirstName" qualifiedName="MDMIndividual::Glossary::Individual Search::FirstName"documentation="" alias="First Name" maxCardinality="1"userAttributeType="String"/><userAttributes xsi:type="orgmodel:SimpleUserAttribute"

sourceId="_0KPGoM_WEeC5GorTm1Nc6w" name="LastName"qualifiedName="MDM Individual::Glossary::Individual Search::LastName"documentation="" alias="Last Name" maxCardinality="1"userAttributeType="String"/><eAnnotations source="uiProperties">

<details key="objectType" value="Individual"/></eAnnotations>

</userDatatypes>

In the example above, the JSP file defines a widget that will pull in its fields fromthe view configuration file using a mapping from the viewName property. The viewconfiguration file defines a userDatatype that has a name property whichcorresponds to the viewName property, which in this example is Individual Search.

The userDatatype contains two userAttributes, FirstName and LastName, whichrepresent the fields that are displayed in the widget.


Related tasks:“Customizing the domain sample view configuration file” on page 7You can change the settings in the view configuration file to customize the valuesfor your own applications.

Mapping the domain sample to the application view definitionThe attributes and fields from the underlying domain must correspond toattributes and fields that are used in the view definitions.

About this task

To map the domain to the view definition:

Procedure1. In your MDM application project, edit the mappings file:

Option Description

IBM Initiate Master Data Service 1. Open the mappings directory.

2. Edit the mdm-mappings.xml file so that thevalues in the file correspond to the viewsfor your application.


1. Open the /mapping/individual/searchdirectory.

2. Edit the request and response XSL filesso that the values in the XSL filescorrespond to the views for yourapplication. The request file isJsonToRequest.xsl. The response file isResponseToJson.xsl.

2. Save and close the files.Related reference:“Example: Mapping definitions for IBM Initiate Master Data Service applications”When you customize the mappings for an application, the mappings mustcorrespond to attributes and fields within the mdm-mappings.xml file, located in themappings directory.“Example: Mapping definitions for InfoSphere MDM Server applications” on page14When you customize mappings for an application, the mappings must correspondto the data mappings within multiple XSL files, located in the Java Resources\srcdirectory.

Example: Mapping definitions for IBM Initiate Master DataService applications

When you customize the mappings for an application, the mappings mustcorrespond to attributes and fields within the mdm-mappings.xml file, located in themappings directory.


Attributes for the Individual entity type

The Individual domain sample contains mappings for an underlying IBM InitiateMaster Data Service entity type called Individual. This entity type contains thefollowing definition within the IBM Initiate Master Data Service data model:

Table 1. Attribute and segment definitions mappings for the Individual entity type. Individualdomain sample contains the Individual entity type, with attribute and segment definitionsmapping to the IBM Initiate Master Data Service data model

Attribute code Segment code Description

LGLNAME MEMNAME Legal name

MAIDENNAME MEMNAME Maiden name

BIRTHDT MEMATTR Date of birth

DEATHDT MEMATTR Date of death

GENDER MEMATTR Gender

MARSTAT MEMATTR Marital status

RACE MEMATTR Race

HOMEPHONE MEMPHONE Home phone number

BUSPHONE MEMPHONE Business phone number

MOBPHONE MEMPHONE Mobile phone number

OTHERPHONE MEMPHONE Other phone number

HOMEADDR MEMADDR Home address

BUSADDR MEMADDR Business address

SSN MEMIDENT Social security number

IDN MEMIDENT Other identifiers

To use all of these attributes in an application, map all the attributes in themdm-mappings.xml file. The mdm-mappings.xml file that is supplied with theIndividual domain sample already includes these fields mapped for convenience.

Note: There is a similar mapping file for the Organization domain sample.

Sample attribute mapping

One example of mapping attributes is shown below in the mapping for thelegalName attribute:<attribute name="legalName" grouped="true">

<fields><field name="surName" attrCode="LGLNAME" fldName="onmlast" type="STRING"length="30" /><field name="middleName" attrCode="LGLNAME" fldName="onmmiddle" type="STRING"length="30" /><field name="givenName" attrCode="LGLNAME" fldName="onmfirst" type="STRING"length="30" />


To map an attribute:1. Declare the attribute2. Specify a name for the attribute


3. Specify if the attribute is grouped. A grouped attribute display its fields in aview that are indented underneath a group attribute label that is defined in theview.

For example, a map for the legalName attribute would appear as follows:<attribute name="legalName" grouped="true"> ... </attribute>

This attribute mapping specifies that the reference name in the mdm-views.xml filefor the attribute is legalName, and that the fields contained within the attributeshould be grouped.

Declare fields in an attribute

Within the <attribute> element, declare the fields that you want to map:1. Specify a name for the field using the field name tag.2. Specify the underlying attribute code using the attrCode tag.3. Specify the underlying field name using the fldName tag.

For example, using the legalName attribute example, the fields are as follows:<fields>

<field name="surName" attrCode="LGLNAME" fldName="onmlast" type="STRING"length="30" /><field name="middleName" attrCode="LGLNAME" fldName="onmmiddle" type="STRING"length="30" /><field name="givenName" attrCode="LGLNAME" fldName="onmfirst" type="STRING"length="30" />

</fields>

After an attribute and its fields are mapped in the mdm-mappings.xml file, you canreference the attribute in a view inside of the mdm-views.xml file. One example ofthis is the search results view definition file that is contained in the sampledomain:<view objectType="Individual" name="IndividualSearchResults"

label="Individual Search Results"><attributes>

<attribute ref="legalName" label="Name"><fields><field ref="givenName" label="First Name" /><field ref="surName" label="Last Name" /></fields>

</attribute><attribute ref="homeAddress" label="Address">

<fields><field ref="line1" label="Address Line One" /><field ref="city" label="City" /><field ref="state" label="State" optionCode="STATE"/>


</attributes></view>

More specifically, in the above view definition, the bold section shows thecomponents of the referenced attribute:v The <attribute> element contains a ref identifier with a value of legalName

attribute. The ref identifier refers to the attribute definition in themdm-mappings.xml file.

v The <attribute> element also contains a label identifier to specify the text labelthat displays above the contained fields.


v The nested <field> elements specify the fields within the legalName attributethat display within the view. For example, the fields givenName and surNamedisplay for legalName).

v Each <field> element contains a ref identifier, which refers to the fielddefinition in the mdm-mappings.xml file.

v Each <field> element also has a label identifier to specify the text label thatdisplays above the specified field value in the view.

Related tasks:“Mapping the domain sample to the application view definition” on page 11The attributes and fields from the underlying domain must correspond toattributes and fields that are used in the view definitions.

Example: Mapping definitions for InfoSphere MDM Serverapplications

When you customize mappings for an application, the mappings must correspondto the data mappings within multiple XSL files, located in the Java Resources\srcdirectory.

Data mapping files

The Individual domain sample contains default mappings to the InfoSphere MDMServer Party domain. You can customize these mappings to pull in data from otherInfoSphere MDM Server services from any domain. Using the Individual searchexample, the data mappings are defined by two XSL files in the/mappings/individual/search directory:

XSL file Description

JsonToRequest.xsl The request file. This file contains themappings that are used when the searchrequest is sent to InfoSphere MDM Server.

ResponseToJson.xsl The response file. This file contains themapping that are used when the searchresults are returned from InfoSphere MDMServer.

There is a similar mapping file for the Organization domain sample.

Sample mapping

The following excerpt illustrates that the XSL files will be used to define themappings in the Individual domain sample since the objectType property in the JSPpage is set to Individual:<div title="Search Form" class="noBorder noPadding"dojoType="mdm.widgets.SearchForm" title="Search Form" region="left"mdmSuccess="updateSearchResults" splitter="true" style="width: 20%"eventscope="searchform" mdmError="errorOnSearch" objectType="Individual"viewName="Individual Search"></div>

This excerpt indicates that the code will look in the mappings/indiviudal directory,and since this is a search form, the code will also look in the mappings/individual/search directory.


Request XSL file

The JsontoRequest.xsl file contains the definition of the contents of the searchtransaction that is sent to InfoSphere MDM Server. The request XSL file populatesthe TCRMPersonSearchBObj business object and maps the FirstName attribute to theInfoSphere MDM Server GivenNameOne attribute, as follows:<TCRMPersonSearchBObj><GivenNameOne><xsl:value-of select="./FirstName"/></GivenNameOne><LastName><xsl:value-of select="./LastName"/></LastName><InquiryLevel>1</InquiryLevel></TCRMPersonSearchBObj>

The toolkit uses a REST interface to:v Receive the data from the user interface in the JavaScript Object Notation (JSON)

data interchange formatv Run an XSL transform on the JSON formatted data to convert the data into the

XML format, which is required by the MDM server web service

Response XSL file

The ResponseToJson.xsl file contains the mapping definitions for how the resultset of a search transaction is displayed in the Web application. The followingexcerpt illustrates how an enumeration of TCRMPersonSearchResultBoBJ businessobjects are expected, and how the PnGivenNameOne attribute from InfoSphere MDMServer is mapped to the FirstName attribute:<xsl:for-each select="//TCRMPersonSearchResultBObj">

{"objectType": "Individual","identifier": "<xsl:value-of select="PartyId"/>","FirstName": "<xsl:value-of select="PnGivenNameOne" />","LastName": "<xsl:value-of select="PnLastName" />"}<xsl:if test="position() < last()">,</xsl:if>

</xsl:for-each>

Related tasks:“Mapping the domain sample to the application view definition” on page 11The attributes and fields from the underlying domain must correspond toattributes and fields that are used in the view definitions.


Chapter 4. Deploying applications

The method that you use to deploy your applications depends on where yourapplication server resides and the type of application server that you are using.

About this task

To deploy an application, follow these high-level steps:

Procedure1. Select a deployment strategy2. Create any necessary files, such as an enterprise application project.3. Test the application in your development environment.4. Deploy the project or file.5. Test the application in your production environment.

Deployment strategiesThe method that you use to deploy your applications depends on where yourapplication server resides and the type of application server that you are using.

You can:v Deploy the dynamic web project within Eclipse, Rational Application Developer

(RAD), or Rational Software Architect (RSA). Use this strategy to test theapplication in your development environment.

v Deploy the web project by embedding the project in an EAR file. You do this bycreating an enterprise application project. Use this strategy when yourapplication server requires applications to be bundled in an EAR file.

v Export a WAR or EAR file. Use this strategy to install the file on a remote webserver that is not defined within RSA.

Deploying a dynamic web projectYou can deploy the dynamic web project within Eclipse, Rational ApplicationDeveloper (RAD), or Rational Software Architect (RSA).

About this task

Use this deployment strategy to test the application.

Procedure1. Open your development environment.2. In the Servers view in the J2EE perspective, identify the server instance that

you want to deploy the dynamic web project to. If you do not have a serverinstance that you want to use, define a server instance.

3. Start the server instance.4. Add the MDM application plugin project to the server.

a. In the lower-right pane, right-click on the server definition.b. Select Add projects.


Creating an enterprise application projectSome application servers require that you use an enterprise application project toembed the web application. WebSphere Application Server (WAS) is an example ofone type of application server that has this requirement.

About this task

To create an enterprise application project:

Procedure1. Open your development environment.2. Select File > New > Enterprise Application Project to start the New EAR

Application Project wizard.3. In the Project name text box, type a name for your project.4. In the Target runtime drop-down, ensure that WebSphere Application Server

v7.0 is selected.5. From the EAR version drop-down, you must specify 1.4 and click Next. This

version is required by the MDM application toolkit.6. From the list of Java EE module dependencies, select your web application

project and click Finish to complete the wizard.7. For WAS, you must modify the deployment descriptor in the enterprise

application project to ensure that your application uses PARENT_LAST classloading.a. Navigate to the META-INF directory and open the application.xml file.b. Select the Deployment tab.c. In the Applications list, select the web application project that you specified

in the previous step.d. Ensure that the Classloader mode is set to PARENT_LAST.e. Save and close the application.xml file.

These steps create WebSphere specific files in the META-INF/ibmconfig directory.Related concepts:“System requirements for InfoSphere MDM Application Plugin” on page 3Before you install the toolkit plugin, ensure that your environment meets thesystem requirements.

Exporting an artifact fileYou can export a WAR or EAR file to deploy your application on a server that isnot defined in your development environment.

About this task

Procedure1. Open your development environment.2. Select File > Export and choose either WAR file or EAR file.

What to do next

Install the artifact file on your application server.


Verifying deployed applicationsAfter you deploy the application on to your application server, test that theapplication is configured properly and is a usable MDM application.

About this task

To verify your new application, access the application from a Web browser.

Procedure1. Open a Web browser and go to one of the following locations:

v If your MDM server is on your local computer:http://localhost:<port_number>/<project_name>

v If your MDM server is on a separate computer from your developmentenvironment:http://<hostname>:<port_number>/<project_name>

where:v <hostname> is the host name of the MDM server that you are using.v <port_number> is the number of the port on the MDM server that you are

using.v <project_name> is the name of the MDM project that you created.You should see the MDM application that you created.

2. Use some of the features or widgets that you implemented to test that youhave configured your application correctly and can connect to the MDM server.For example, the Individual domain sample includes search form, search results,and search summary details. You can search for a record and ensure that thenumber of returned records is accurate and that the data is correct. Also ensurethat the content displays properly. For example that the navigation on the left,and a larger content area is on the right. Yes, you would then need to installthem on the relevant test server

Chapter 4. Deploying applications 19

Legal Statement

Licensed Materials – Property of IBM

© Copyright IBM Corporation, 1995, 2011. US Government Users Restricted Rights- Use, duplication or disclosure restricted by GSA ADP Schedule Contract withIBM Corp. IBM, the IBM logo, InfoSphere, Initiate, and Initiate Master Data Serviceare trademarks of IBM Corp., registered in many jurisdictions worldwide. Java andall Java-based trademarks and logos are trademarks or registered trademarks ofOracle and/or its affiliates. Other product and service names might be trademarksof IBM, or other companies. This Program is licensed under the terms of thelicense agreement accompanying the Program. This license agreement may beeither located in a Program directory folder or library identified as "License" or"Non-IBM License", if applicable, or provided as a printed license agreement.Please read this agreement carefully before using the Program. By using theProgram, you agree to these terms.


Notices and trademarks

This information was developed for products and services offered in the U.S.A.

Notices

IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785 U.S.A.

For license inquiries regarding double-byte character set (DBCS) information,contact the IBM Intellectual Property Department in your country or sendinquiries, in writing, to:

Intellectual Property LicensingLegal and Intellectual Property LawIBM Japan Ltd.1623-14, Shimotsuruma, Yamato-shiKanagawa 242-8502 Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of express orimplied warranties in certain transactions, therefore, this statement may not applyto you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM Web sites are provided forconvenience only and do not in any manner serve as an endorsement of those Web


sites. The materials at those Web sites are not part of the materials for this IBMproduct and use of those Web sites is at your own risk.

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who wish to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM CorporationJ46A/G4555 Bailey AvenueSan Jose, CA 95141-1003 U.S.A.

Such information may be available, subject to appropriate terms and conditions,including in some cases, payment of a fee.

The licensed program described in this document and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement or any equivalent agreementbetween us.

Any performance data contained herein was determined in a controlledenvironment. Therefore, the results obtained in other operating environments mayvary significantly. Some measurements may have been made on development-levelsystems and there is no guarantee that these measurements will be the same ongenerally available systems. Furthermore, some measurements may have beenestimated through extrapolation. Actual results may vary. Users of this documentshould verify the applicable data for their specific environment.

Information concerning non-IBM products was obtained from the suppliers ofthose products, their published announcements or other publicly available sources.IBM has not tested those products and cannot confirm the accuracy ofperformance, compatibility or any other claims related to non-IBM products.Questions on the capabilities of non-IBM products should be addressed to thesuppliers of those products.

All statements regarding IBM's future direction or intent are subject to change orwithdrawal without notice, and represent goals and objectives only.

This information is for planning purposes only. The information herein is subject tochange before the products described become available.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, whichillustrate programming techniques on various operating platforms. You may copy,modify, and distribute these sample programs in any form without payment to


IBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingplatform for which the sample programs are written. These examples have notbeen thoroughly tested under all conditions. IBM, therefore, cannot guarantee orimply reliability, serviceability, or function of these programs. The sampleprograms are provided "AS IS", without warranty of any kind. IBM shall not beliable for any damages arising out of your use of the sample programs.

Each copy or any portion of these sample programs or any derivative work, mustinclude a copyright notice as follows:

© (your company name) (year). Portions of this code are derived from IBM Corp.Sample Programs. © Copyright IBM Corp. _enter the year or years_. All rightsreserved.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

Trademarks

IBM, the IBM logo, and ibm.com are trademarks or registered trademarks ofInternational Business Machines Corp., registered in many jurisdictions worldwide.

Other product and service names might be trademarks of IBM or other companies.

A current list of IBM trademarks is available on the web at "Copyright andtrademark information" at www.ibm.com/legal/copytrade.shtml.

The following terms are trademarks or registered trademarks of other companies:

Adobe is a registered trademark of Adobe Systems Incorporated in the UnitedStates, and/or other countries.

Linux is a registered trademark of Linus Torvalds in the United States, othercountries, or both.

Microsoft, Windows, and Windows NT are trademarks of Microsoft Corporation inthe United States, other countries, or both.

UNIX is a registered trademark of The Open Group in the United States and othercountries.

Java and all Java-based trademarks and logos are trademarks or registeredtrademarks of Oracle and/or its affiliates.

Notices and trademarks 25

http://www.ibm.com/legal/copytrade.shtml

Index

AApplication Development Toolkit

plugin overview 1application projects

creating 5directories 6

Bbenefits, plugin 1

Cconfiguring

master data management servers 6creating

InfoSphere MDM applicationproject 5

customer supportcontacting 29

customizingdomain samples 7view configuration files 8

Ddeployable artifact files

exporting 18deployed applications

testing 19verifying 19

development environmentssupported 1, 3

directoriesInfoSphere MDM application

project 6Dojo widgets 1domain samples

customizing 7mappings 11view configuration files 8

overview 1project files 6

EEAR files

creating 18exporting 18

Eclipse 1toolkit installation 3

enterprise application projectcreating 18

examplesmapping

InfoSphere MDM Server 14Initiate Master Data Service 12

view configuration filesInfoSphere MDM Server 10

examples (continued)view configuration files (continued)

Initiate Master Data Service 8exporting

deployable artifact files 18

Ffeatures

toolkit 1

IIDEs

supported 1InfoSphere MDM Server

example, mapping 14examples, view configuration files 10

Initiate Master Data Serviceexample, mapping 12examples, view configuration files 8

installingMDM application toolkit plugin 3overview 3system requirements 3

Llegal notices 23

Mmapping

example, Initiate Master DataService 12

example, MDM Server 14

Ooverview

application developer plugin 1benefits 1features 1installing 3

Pplugin

benefits 1features 1overview 1

RRational Application Developer (RAD)

development environments 1toolkit installation 3

Rational Software Architect (RSA)development environments 1toolkit installation 3

Ssoftware services

contacting 29support

customer 29system requirements 3

Ttoolkit

MDM Application Development 1trademarks

list of 23

Vview configuration files 7

customizing 8examples

InfoSphere MDM Server 10Initiate Master Data Service 8

view definitionsmappings with domain sample 11

WWAR files

exporting 18Web Application Server

deployment descriptor 18web applications

creating 5widget library 1

XXSL files

JsonToRequest.xsl 11, 14ResponseToJson.xsl 11, 14


Contacting IBM

You can contact IBM for customer support, software services, product information,and general information. You also can provide feedback to IBM about productsand documentation.

The following table lists resources for customer support, software services, training,and product and solutions information.

Table 2. IBM resources

Resource Description and location

IBM Support Portal You can customize support information bychoosing the products and the topics thatinterest you at www.ibm.com/support/entry/portal/Overview/Software/Information_Management/IBMInitiate_Master_Data_Service

Software services You can find information about software, IT,and business consulting services, on thesolutions site at www.ibm.com/businesssolutions/

My IBM You can manage links to IBM web sites andinformation that meet your specific technicalsupport needs by creating an account on theMy IBM site at www.ibm.com/account/

Training and certification You can learn about technical training andeducation services designed for individuals,companies, and public organizations toacquire, maintain, and optimize their ITskills at http://www.ibm.com/software/sw-training/

IBM representatives You can contact an IBM representative tolearn about solutions atwww.ibm.com/connect/ibm/us/en/

Providing feedback

The following table describes how to provide feedback to IBM about products andproduct documentation.

Table 3. Providing feedback to IBM

Type of feedback Action

Product feedback You can provide general product feedbackthrough the Consumability Survey atwww.ibm.com/software/data/info/consumability-survey


http://www.ibm.com/support/entry/portal/Overview/Software/Information_Management/IBM_Initiate_Master_Data_Service




http://www.ibm.com/businesssolutions/

http://www.ibm.com/businesssolutions/

http://www.ibm.com/account/

http://www.ibm.com/software/sw-training/

http://www.ibm.com/software/sw-training/

http://www.ibm.com/connect/ibm/us/en/

http://www.ibm.com/software/data/info/consumability-survey/

http://www.ibm.com/software/data/info/consumability-survey/

Table 3. Providing feedback to IBM (continued)

Type of feedback Action

Documentation feedback To comment on the information center, clickthe Feedback link on the top right side ofany topic in the information center. You canalso send comments about PDF file books,the information center, or any otherdocumentation in the following ways:

v Online reader comment form:www.ibm.com/software/data/rcf/

v E-mail: [email protected]


http://www.ibm.com/software/data/rcf/

��

Printed in USA

GI13-2634-00

app tool kit

Documents