Omni-Insurance Integration Services User's Guide > OnRamp Operational Details

OnRamp Operational Details

Topics:

This section describes the OnRamp operational details.

Parallelism

The Relational OnRamp will process batches for different top-level subjects concurrently. Multiple batches for the same top-level subject will be processed serially unless Parallel Processing is enabled.

Launching Relational OnRamp Batches

Omni-Insurance supports the following methods of launching an OnRamp batch:

  • Directly updating os_ramp_control.
  • Calling the ProcessRamp web service.

Directly Updating os_ramp_control

You can add a row to os_ramp_control, setting the following columns.

  • batch_id (string). Batch to execute.
  • subject (string). Subject to process as part of the batch.
  • source_name (string). Restrict the impact of the load to records of a specific source system.
  • batch_type (string). Processing mode. [UPSERT, INSERT_ONLY, REPLACE_SELECTED, REPLACE_ALL, DELETE]
  • batch_options (string). Deprecated. Use data_transfer_mode, change_detection, upsert_null_handling, and truncate_before_insert columns, instead.
  • load_type (string). Deprecated.
  • data_transfer_mode (string). [JPA, NATIVE_SQL]. JPA - database neutral, NATIVE_SQL - high-performance database specific. Applies to SQL Server and PostgreSQL only.
  • change_detection (string). [ENFORCE, IGNORE]. ENFORCE - identifies business duplicates and suppresses them from further processing. IGNORE - all records in batch are fully processed (including duplicates). Useful for error recovery.
  • upsert_null_handling (string). [PRESERVE, OVERRIDE]. Governs how to handle missing values on an update (replaces deprecated batch options PRESERVE_ON_NULL and OVERRIDE_ON_NULL). Applies to UPSERT only.
  • truncate_before_insert (string). [FALSE, TRUE]. Applies to INSERT_ONLY mode only. Truncate data before an INSERT_ONLY operation.
  • state (string). Set to READY when batch is fully assembled.
  • active (string). Set to Y to enable the subject/batch to be loaded.

The os_ramp_control can be monitored to follow the status of a ramp batch.

The following are possible values of the state field:

  • PENDING. Indicates the ramp will begin loading.
  • LOADING. Indicates the ramp is being loaded.
  • READY. Load complete and ready for processing.
  • SCHEDULED. Schedules for processing.
  • PROCESSING. Omni-Insurance is currently processing the subject batch.
  • COMPLETE. Omni-Insurance completed processing of the subject batch.
  • FAILED. Processing of the batch has failed.

Note: This information is also available in the RampControl section of the Omni Console.

Invoking the ProcessRamp Web Service

This section describes the ProcessRamp web services that can be used to launch a ramp batch.

V4 Web Service

https://server_host:server_port/server/api/v1/server/processRamp.v4

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.