ESOA toolkit basics

The Enterprise Service Oriented Architecture (ESOA) Toolkit generates an API for both Java™ and web service developers. Which API you use to develop your applications is determined by your particular network environment.

Java and web service methods enable you to:

  • Search and retrieve member and relationship data (memsearch, memget, relsearch, relget)
  • Edit, add, and delete member and relationship data (memput, memputqual, relput, memdelete, memundelete, reldelete, memdrop)
  • Compare and score member data (memcompare, memscore)
  • Merge and unmerge member data (memmerge, memunmerge)
  • Undo recent put, merge, and delete record operations using audrecno (memundo)
  • Set entity management priority during edit and add operations

If your interest is in the RESTful services, skip to RESTful services.

The Enterprise Service Oriented Architecture (ESOA) Toolkit is

  • A Java application programming interface (API) generator
  • A SOAP-based web service generator
  • A REST-based web service

The Enterprise Service Oriented Architecture (ESOA) Toolkit generates an API in both Java and Web Service forms; the REST web service is not generated. The operations available in the generated Java API and generated web service API are the same; you can accomplish the same things in both APIs. REST web services support all the operations that the two generated APIs support with a few exceptions. The following operations are supported:

  • Search and retrieve member and relationship data
  • Edit, add, and delete member and relationship data (these operations for relationship data are not supported for RESTful web services)
  • Compare and score member data
  • Merge and unmerge member records

The Java API is intended to be easier to use than our existing Java SDK, but it is not a complete replacement. There are some things you can do with the existing SDK that you cannot do with the generated API, such as operations on attribute history and tasks.

The RESTful web service also supports operations pertaining to:

  • Member, entity, attribute, and field labels
  • Member attribute order
  • Member, entity, and attribute display templates
  • Member and entity default composite views
  • Create standard or custom tasks
  • Search, get, and update tasks

Refer to RESTful services for more information about the REST service.

This document often refers to the paths in the InfoSphere® MDM Workbench project, using variables for actual paths.

A path such as \<workspace>\<project_name>\client\ might refer to C:\Documents and Settings\jdoe\MyWorkspace\Alpha\client, where the <workspace> denotes the workspace path selected when you started InfoSphere MDM Workbench, and <project_name> denotes the project name within InfoSphere MDM Workbench.