Services Integration Framework Guide

10.4

Back Next

GenerateConstraints

The GenerateConstraints API generates missing constraints for a table. Use the GenerateConstraints API to create indexes after you use the RegisterCustomIndex to register an index that does not physically exist.

Request Parameters

The GenerateConstraints request contains the following parameters:

TableName: Specifies the base object table name. Required.
Scope: Specifies the scope of the constraints of the request. Required. Scope can be one of the following values:

FK. Foreign keys.
NI. Non-unique indexes.
PK. Primary keys.
UI. Unique indexes.
UK. Unique keys.
NP. Keys that are not primary keys.
NK. Keys that are not foreign keys.
ALL. All constraints.
AbortOnFail: If true, specifies that the job stops when it fails. Required.
SetFkDisabled: If true, sets the foreign keys to disabled. Required.
Analyze: Required.

Response Fields

The GenerateConstraints API returns the following fields:

InteractionId: Contains the interaction ID.
Message: Contains a message regarding the status of the request.
RetCode: Contains the return code.

Usage Example

The following example runs the GenerateConstraints batch job on the C_CUSTOMER base object:

SiperianClient sipClient = SiperianClient.newSiperianClient(new File( context.getTestPTTStartDir() + "siperian-client.properties" ) );
 GenerateConstraintsRequest req = new GenerateConstraintsRequest();
 req.setTableName(jobContext.getTableName());        // table name. e.g. C_CUSTOMER
 req.setScope("ALL");
 req.setAbortOnFail(true);
 req.setSetFkDisabled(false);
 req.setAnalyze(false);
 GenerateConstraintsResponse executed = (GenerateConstraintsResponse) 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

GenerateConstraints

GenerateConstraints

Request Parameters

Response Fields

Usage Example