TurnOffRTI function
Syntax
TurnOffRTI(search definition)Description
Use the TurnOffRTI function to disable real time indexing for a specified search definition when the document count exceeds the threshold specified on the Configure Real Time Indexing page. Additionally, this function 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.
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. |
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 = TurnOffRTI("EP_AP_VOUCHERS");
WinMessage(&x, 0);