Process Ramp

Topics:

Use the following REST call to schedule processing ramp data for a specific subject and batchId, governed by the various batch options. This call will return status when the request is scheduled. The processing is carried out by the server subsequently.

The HTTP PUT request accepts the parameters listed and described in the following table.

Parameter

Type

Description and Values

batchId

string

Batch to execute.

subject

string

Subject to process as part of the batch.

sourceName

string

Restrict the source system to participate in the batch.

batchType

string

Mode corresponding to the batch_type:

  • UPSERT (default)
  • INSERT_ONLY
  • REPLACE_SELECTED
  • REPLACE_ALL
  • DELETE

The following table provides the batch options (sub directives) for the process ramp service and the corresponding batch_options column in os_ramp_control.

Name

Type

Description and Values

dataTransferMode

string

Overrides the default data transfer mode runtime configuration setting.

  • JPA (default)

    Database neutral.

  • NATIVE_SQL

    High performance, bulk database-specific. Currently supported for SQL Server and PostgreSQL.

Note: NATIVE_SQL generates a runtime error for unsupported databases.

changeDetection

string

Determines whether or not to eliminate duplicates from further processing (data quality operations).

  • ENFORCE (default)

    Eliminates the duplicates.

  • IGNORE

    Guarantees processing of all records in a batch. Useful at certain times for error recovery.

Note: ChangeDetection = IGNORE replaces batch option FORCE_REPROCESS.

upsertNullHandling

(previously addUpdateNullHandling)

string

UPSERT only. Governs how to handle missing values on an update.

  • PRESERVE (default)
  • OVERRIDE

truncateBeforeInsert

boolean

Truncate data before an INSERT_ONLY operation. Used for a full replacement of the data set. Applies only to transactional subjects.

  • FALSE (default)
  • TRUE

Note: Is an error unless loadType is INSERT_ONLY.

Example:

PUT https://localhost:9514/server/api/v1/server/processRamp.v4?batchId=8&batchType=UPSERT&changeDetection=ENFORCE&dataTransferMode=JPA&subject=

Facility&truncateBeforeInsert=FALSE&upsertNullHandling=PRESERVE

-- response --

{
  "status": "OK",
  "code": 0,
  "message": "Loaded Facility from Ramp. (batch=8, instructions={\n  \"loadType\": \"MERGE\",\n
  \"truncateTablePolicy\": \"NO_TRUNCATE\",\n  \"addUpdateNullHandling\": \"PRESERVE\",\n   
  \"duplicateRecordPolicy\": \"IGNORE\",\n  \"dataTransferMode\": \"JPA\"\n}, sourceName=null",
  "developerMessage": null,
  "responseType": "com.ibi.omni.rest.support.ServiceOperationDto",
  "response": {
    "service": "DataProcessing",
    "operation": "processRamp",
    "code": 0,
  "message": "Loaded Facility from Ramp. (batch=8, instructions={\n  \"loadType\":  \"MERGE\",\n 
  \"truncateTablePolicy\": \"NO_TRUNCATE\",\n  \"addUpdateNullHandling\": \"PRESERVE\",\n  
  \"duplicateRecordPolicy\": \"IGNORE\",\n  \"dataTransferMode\": \"JPA\"\n}, sourceName=null",
   "start": 1574115854275,
   "end": 1574115854341
  },
  "exception": null}

Error Codes

  • 400 – Error in Subject or Planning failure. See message for more information.