Services Integration Framework Guide

10.4

Back Next

RegisterCustomIndex

A RegisterCustomIndex request registers user-defined indexes in the repository.

Some batch processes drop and re-create indexes based on the repository information. If you do not register custom indexes, the batch processes might drop them.

Request Parameters

The RegisterCustomIndex request contains the following parameters:

TableName: Name of the repository table.
RowidColList: A list of row ID column values that have custom indexes.
MDM Hub
ignores leading and trailing spaces in the row ID column. Separate each row ID column value with the tilde (~) character.
IndexType: Optional. Type of index to be registered. The IndexType parameter uses one of the following index types:
FK. A foreign key index.
PK. A primary key index.
NI. A non-unique key index.
UI. A unique key index.; Create and register only the non-unique type indexes. Default is NI.

Response Fields

The RegisterCustomIndex request returns the following fields:

InteractionId: An identifier for the request.
Message: A brief message about the status of the request.
RetCode: A return code for the interaction.

Usage Example

The following code sample registers a custom index:

SiperianClient sipClient = SiperianClient.newSiperianClient(new File( context.getTestPTTStartDir() + "siperian-client.properties" ) );
 RegisterCustomIndexRequest req = new RegisterCustomIndexRequest();
 req.setTableName(jobContext.getTableName());        // table name
 req.setRowidColList("SVR1.DA~SVR1.DB");              // column list
 RegisterCustomIndexResponse executed = (RegisterCustomIndexResponse) sipClient.process( req );
 String errMessage = executed.getMessage();
 int rc = executed.getRetCode();

Rename Saved Search

Table of Contents

Services Integration Framework Guide

Services Integration Framework Guide

RegisterCustomIndex

RegisterCustomIndex

Request Parameters

Response Fields

Usage Example