Understanding Real Time Indexing in FSCM
Real Time Indexing (RTI) uses DirectTransfer to transmit search data directly from PeopleSoft batch servers to the search engine. Indexing is performed in near real-time by sending the data as soon as it is saved.
For additional information about DirectTransfer, see PeopleSoft PeopleTools, Search Technology, Administering PeopleSoft Search Framework and Using Direct Transfer.
For additional information about configuring Real Time Indexing, see PeopleTools, Development Tools, Search Technology, Administering PeopleSoft Search Framework, Using Real Time Indexing.
High volume batch updates (for search definitions enabled for RTI) can cause a sudden spike in the number of entries to process in the RTI staging table added by the database trigger. This can cause high database table fragmentation and potentially decrease overall system performance.
If you have large-volume batch updates, the RTI process should be temporarily turned off and when the batch is complete, perform catch-up updates to indexed data via incremental indexing before resuming RTI.
RTI switch enables the application to turn OFF RTI before initializing high-volume batch programs. When indicated, RTI resumes by the incremental indexing process for a specific search definition.
Note: Oracle's PeopleSoft recommends that you do not change the Configure Batch switch without a complete understanding of how it works, because batch processes must be specifically coded to reference the RTI Switch.
For additional information about RTI Switch, see My Oracle Support (MOS), PeopleSoft Search and Insights Home Page, document 2205540.1.
PeopleSoft certifies delivered search definitions that you can implement for RTI. PeopleSoft Applications Development plans to certify more search definitions for RTI in future images.
RTI can be used on these Search Definitions when the minimum tools release is in effect for the respective Update Image.
Warning! PeopleSoft recommends that you do not implement RTI for other delivered search definitions. PeopleSoft FSCM does not certify RTI for search definitions other than those listed in this table.
|
FSCM Update Image |
Minimum PeopleTools Release |
Search Definition |
|---|---|---|
|
41 |
8.59.03 |
EP_CS_CLAUSES |
|
41 |
8.59.03 |
EP_CS_SECTIONS |
|
41 |
8.59.06 |
EP_OM_CUSTOMER |
|
41 |
8.59.03 |
EP_PC_PROJ_GENERAL |
|
41 |
8.59.03 |
EP_IN_BU_ITEM |
|
42** |
8.59.06 |
EP_GM_AWARDS |
|
42* |
8.59.06 |
EP_AP_VENDOR |
|
42* |
8.59.06 |
EP_AP_VOUCHERS |
|
42* |
8.59.09 |
EP_PO_REQUISITIONS |
|
42* |
8.59.05 |
EP_PV_MASTERITEMVENDOR_SD |
|
42* |
8.59.05 |
EP_PV_MASTERITEM_SD |
|
42 |
8.59.06 |
EP_SS_EVENTS |
|
43 |
8.59.06 |
EP_AM_ASSET |
|
43 |
8.59.04 |
EP_WM_SRCH_WORK_ORDERS |
|
43 |
8.59.04 |
EP_WM_SRCH_WO_ASSETS |
|
43* |
8.59.06 |
EP_PO_CONTRACTS |
|
43* |
8.59.06 |
EP_PO_PURCHASE_ORDERS |
|
43* |
8.59.06 |
EP_PO_RECEIPTS |
|
44* |
8.59.09 |
EP_EX_REPORT |
|
44 |
8.59.11 |
EP_EX_SRCH_RISK_EXCP_KIB |
|
44 |
8.59.11 |
EP_EX_SRCH_EMP_EXCP_KIB |
|
44 |
8.59.11 |
EP_EX_SRCH_PERF_OPR_KIB |
|
45* |
8.59.06 |
EP_AP_PAYMENTS |
|
45* |
8.59.09 |
EP_AP_VENDOR_CONVER |
|
45 |
8.59.11 |
EP_CS_DOC_ADHOC |
|
45* |
8.59.11 |
EP_CS_DOC_CONTRACTS |
|
45* |
8.59.11 |
EP_CS_DOC_PURCHORDRS |
|
45* |
8.59.11 |
EP_CS_DOC_SOURCING |
|
46* |
8.59.09 |
EP_BI_BILLING |
|
46* |
8.59.09 |
EP_BI_HDR_KIB |
|
46 |
8.59.13 |
EP_CA_CONTRACTS |
|
46 |
8.59.13 |
EP_CA_HDR_KIB |
|
46 |
8.59.09 |
EP_AP_PAYMENTS_KIB |
|
47 |
8.59.09 |
EP_AR_PAYMENTS |
|
47 |
8.59.09 |
EP_AR_ITEMS |
|
47 |
8.59.09 |
EP_AR_ITEM_ACT_COLL_KIB |
|
47 |
8.59.09 |
EP_AR_PAYMENTS |
|
47 |
8.59.09 |
EP_AR_PMT_ENTRY |
|
47 |
8.59.09 |
EP_GL_JOURNAL |
|
47 |
8.59.13 |
EP_GL_JOURNAL_KIB |
|
48 |
8.59.13 |
EP_PC_PROJ_REQUEST_FL |
|
48 |
8.59.13 |
EP_SCP_AUC_CATALOG_SD |
|
48 |
8.59.13 |
EP_SCP_CONTENT_SD |
|
49 |
8.59.13 |
EP_PO_POA_KIB |
|
50 |
8.59.13 |
EP_GL_KK_EXCEPTIONS_KIB |
|
50 |
8.59.13 |
EP_GL_KK_ACTIVITY_LOG_KIB |
|
50 |
8.59.13 |
EP_PO_RECEIPTS_KIB |
|
50 |
8.59.13 |
EP_PO_CONTRACT_KIB |
Note: When a search definition is mapped to a component, the Keyword Search page displays a message that indicates when RTI is enabled for that component.
Note: * These search definitions require application update bugs available through the most current update image. You must have these updates and the required PeopleTools release version to configure RTI. If you are on the correct PeopleTools patch and wish to use selective adoption to access only RTI related bugs, search for tracking group "Real Time Indexing for Tools 8.59 or above".
** If you are on MSSQL, Tools 8.59-07 is required for this index.
Note: Search definitions that are enabled for RTI prior to PeopleTools 8.59.10 are not certified for multiple languages. RTI only indexes changes made in the base language. When your system upgrades to PeopleTools 8.59.10 or higher, any index that is certified for use (in the table above), is certified for multiple language situations. Re-indexing may be required to pick up language changes made with RTI before 8.59.10.
Follow these steps to enable Real Time Indexes.
Verify that your index is current by running a full or incremental build.
This allows a baseline index for RTI to add records.
Enable RTI on the search definition using the Configure Real Time Indexing page (PeopleTools, Search Framework, Real Time Indexing, Configure Real Time Indexing).
Enter the search definition (from the list above) in the filter box and select Search.
Select the correct search definition by selecting the row in the grid.
Select the Enable check box.
If the Configure Batch check box is already selected, a list of selected Batch jobs for RTI enabled transactions are displayed.
Use the Document Count field to set a minimum threshold beyond which RTI is disabled for the selected trigger records. Use the Honor Batch Switch to decide which processes (batch programs) honor the RTI batch switch.
Note: PeopleSoft Applications delivers a list of batch jobs that disables RTI if the number of records to be processed adversely affects RTI performance. These batch jobs are added to the Configure RTI page. Based on system demands, administrators can set a minimum threshold to determine when the batch job disables RTI.
Select Save.
Download the trigger SQL for your database environment using the Trigger SQL link.
MSS, DB2, and Oracle are supported.
Note: When you click the link, trigger SQL is generated for each supported database. Depending on your browser, click Cancel if you do not have this database and the next database SQL is generated.
Some browsers open three tabs with the SQL in them. Close the one that are not applicable.
Provide the trigger to your database administrator to apply to the database and have them bounce all process schedulers.
Warning! Any time a change is made to the RTI configuration using the Configure Real Time Indexing page, or using PeopleCode in the application class, and whether or not a new trigger is generated and applied, the process scheduler must be restarted. If you do not restart the process scheduler, real time indexing may not pick up the changes and could fail to index your data.
The following is a list of Search Definitions excluded from Real Time Indexing by FSCM Applications.
These search definitions have been analyzed and are considered incompatible with RTI for various reasons. Some of those reasons are:
The search definition is only updated via batch jobs; no online updates are permitted.
The search definition is based on uploads from external sources.
Online updates are not made.
High volumes or bulk inserts make it impossible for RTI to 'catch up'.
Regular, incremental indexing should always be used.
For some analytics, aggregation needs to occur that needs other records not involved in the trigger.
This complexity makes it difficult for the RTI to process.
Excluded Search Definitions are:
AP_SDN_ADDRESS
AP_SDN_AKA_NAME
EP_AM_METRIC_KIB
EP_AR_CUST_AGING_KIB
EP_AR_CUST_HIST_KIB
EP_CA_GM_PROJRES_INSIGHT
EP_CS_CWB_ADHOC
EP_CS_CWB_AUC
EP_CS_CWB_CONTRACT
EP_CS_CWB_PO
EP_FO_CUSTOMER_CONTACT
EP_FO_CUSTOMER_SEARCH
EP_FO_PEOPLE_MATCH
EP_FO_PEOPLE_SEARCH
EP_FO_SERVICE_ORDERS
EP_GL_LEDGER_KIB
EP_GL_ACT_BUDG_LEDG_KIB
EP_IN_ONHAND_KIB
EP_OM_CUST_BILLTO
EP_OM_CUST_SHIPTO
EP_OM_CUST_SOLDTO
EP_OM_PROD_CATLG_CUST
EP_OM_PROD_CATLG_SYS
EP_OM_PROD_CATLG_UPC
EP_OM_PROD_CATLG_UPN
EP_OM_PROD_CATLG_UPNCUST
EP_OM_PROD_NOCATLG_CUST
EP_OM_PROD_NOCATLG_SYS
EP_OM_PROD_NOCATLG_UPC
EP_OM_PROD_NOCATLG_UPN
EP_OM_PROD_NOCATLG_UPNCUST
EP_PC_PROJ_RES_KIB
EP_PV_EXPRESSITEMS_SD
EP_RS_SERVICE_ORDERS
EP_RS_SRCH_RESOURCES
EP_WM_WO_RESOURCES_KIB
EP_WM_SRCH_ASSETS
EP_WM_SRCH_TECHNICIANS
Note: This list may include other search definitions at a later date. As mentioned above, Oracle's PeopleSoft recommends that you implement only certified search definitions for RTI.