TurnOffRTIFromProcess function

Syntax

TurnOffRTIFromProcess(search definition,batch_program)

Description

Use the TurnOffRTIFromProcess function to disable real-time indexing for a specified search definition. The specified application batch program calls this function when the document count exceeds the threshold specified on the Configure Real Time Indexing page. Similar to the TurnOffRTI function, this function also disables real time indexing for other search definitions that have common trigger records.

When you use the TurnOffRTI function, the system checks for the calling application batch program name and validates before turning off real-time indexing for the specified search definition. However, when you use the TurnOffRTIFromProcess function, you can specify the calling application batch program as the second argument, but validation is not performed.

Note:

Before you use this function, you must ensure that the application batch programs associated with a search definition are configured on the Configure Real Time Indexing page.

Parameters

Parameter Description

search definition

Specify the search definition for which you want to disable real time indexing as a String value.

batch_program

Specify an application batch program associated with the search definition as a String value, which calls the TurnOffRTIFromProcess function.

Returns

A return code as an integer.

Return Code Description

1

Real time indexing is successfully disabled for the specified search definition and other search definitions that have common trigger records.

2

Batch jobs are not configured for the specified search definition.

3

SQL execution failed.

4

Real time indexing is not enabled for the search definition or the search definition is not deployed.

5

Illegal arguments are passed to API call.

6

Trigger records are not found for the specified search definition.

8

Batch job is not configured for real time indexing switch.

Example

Local integer &x = TurnOffRTIFromProcess("EP_AP_VOUCHERS", "FS_STREAMLN");
If (&x = 1) Then
   WinMessage("Successfully turned off RTI for SD EP_AP_VOUCHERS", 0);
End-If;

Related Topics