CANCEL_SEARCH_INDEX CONTROL_SEARCH_INDEX

Core Oracle Content Server Services 4-91

4.5.10 SAVE_TEMPLATE_CONVERSIONS

Service used by the Dynamic Converter to save the conversion template. Location: IdcHomeDirresourcescoretemplatesstd_services.htm

4.6 Indexer Services Core Oracle Content Server

Indexer services are used to control the search index. Frequently used services are marked with an asterisk in the following list. The following services are described in this section: ■ CANCEL_SEARCH_INDEX ■ CONTROL_SEARCH_INDEX ■ GET_FILE ■ START_SEARCH_INDEX

4.6.1 CANCEL_SEARCH_INDEX

Service that cancels the current indexing session. Location: IdcHomeDirresourcescoretemplatesstd_services.htm

4.6.2 CONTROL_SEARCH_INDEX

Service that updates or rebuilds the search index. Updates and rebuilds are performed automatically in a background thread. Location: IdcHomeDirresourcescoretemplatesstd_services.htm ■ This service is called when changes are made to the Automatic Update Cycle and Collection Rebuild Cycle options provided on the Repository Manager: Indexer Tab. ■ The options defined on the Configure Automatic Update Cycle or Configure Collection Rebuild Cycle screen map to these parameters: – Content Items Per Indexer Batch MaxCollectionSize – Content Items Per Checkpoint IndexerCheckpointCount – Indexer Debug Level SearchDebugLevel – Indexer Auto Updates sEnableAutoUpdate Important: Rebuilding the search index is necessary only when you change or add metadata fields. Depending on the quantity and size of your files, this process can take several days. Rebuilding is system-intensive, so you should plan to rebuild during non-peak system usage times. 4-92 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management Additional Required Service Parameters ■ cycleID: The index cycle type: – update: Incrementally updates the index database. – rebuild: The search index is entirely rebuilt, and the old index collection is replaced with a new index collection after the rebuild has successfully completed. ■ action: The action to perform. This entry can be set to these values: – start : Begins the update or rebuild cycle. – cancel : Stops the update or rebuild cycle, and does not permit a future restart. – suspend : Stops the update or rebuild cycle, and permits a future restart. – restart : Restarts the update or rebuild cycle after a suspend was executed. – setConfiguration : Used when enabling or disabling the update cycle. Setting this value enables you to adjust the checkpoint IndexerCheckpointCount, batch size MaxCollectionSize, debug level SearchDebugLevel, and auto update sEnableAutoUpdate options. Additional Optional Service Parameters This service might require these parameters, depending on the action to execute see the following examples. GetCurrentIndexingStatus: Setting this parameter to 1 true returns the status of the indexer cycle: ■ Idle : An indexer cycle is complete. ■ Active : An indexer cycle is currently running. ■ Interrupt : An unexpected event, that abruptly ends the indexing cycle. For example, a power, database, or file system failure. ■ Suspend : The indexing cycle was stopped in a controlled manner. For example, using the Suspend button on the Repository Manager: Indexer Tab. ■ Restart : An interrupted or suspended cycle was started again. If you are restarting after an interrupted cycle, ensure that you have corrected the problem that caused the interrupt to occur. ■ Cancel : The indexing cycle was stopped with no intent to restart. ■ getStatus : Setting this parameter to 1 true returns the indexer settings and status information. ■ PerformProcessConversion : Enables the process conversion when starting or restarting the Indexer rebuild process. – 1 true: The process conversion is performed. – 0 false: The process conversion is not performed. ■ IndexerCheckpointCount : The number of files that go through each indexing state at a time. – You can have multiple batches of files indexed per checkpoint. – To update this entry, the action must be set to setConfiguration. Core Oracle Content Server Services 4-93 ■ MaxCollectionSize : The maximum number of files that the search index processes simultaneously. – The default is 25, which means 25 files are indexed together, then the next 25 files are indexed. – You can change this setting to 1 if you are experiencing problems with the search engine indexing large and complicated files. However, slow system performance can result. – To update this entry, the action must be set to setConfiguration. ■ SearchDebugLevel : The indexer debug level. – The more debug information listed in the server window, the slower the indexing progresses. – To update this entry, the action must be set to setConfiguration. These are the debug levels from the least to the most debug information: ■ none : No information for each file accessed is displayed. ■ verbose : Displays information for each file accessed. Indicates indexed, ignored, or failed. ■ debug : Displays the medium level of information. ■ trace : Displays the lowest level of information. ■ all : Displays the highest level of information. ■ sEnableAutoUpdate : To update this entry, the action must be set to setConfiguration. – 1 true: Automatic update cycles are enabled. – 0 false: Automatic update cycles are enabled. Examples These examples are for controlling the indexer from another process. ■ HDA format to return the defined settings and status information: Properties LocalData IdcService=CONTROL_SEARCH_INDEX getStatus=1 end ■ HDA format to enable the update cycle: Properties LocalData IdcService=CONTROL_SEARCH_INDEX MaxCollectionSize=500 sEnableAutoUpdate=1 cycleID=update action=setConfiguration SearchDebugLevel=none IndexerCheckpointCount=5000 GetCurrentIndexingStatus=1 end ■ HDA format to disable the update cycle: Properties LocalData IdcService=CONTROL_SEARCH_INDEX 4-94 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management MaxCollectionSize=500 sEnableAutoUpdate=0 cycleID=update action=setConfiguration SearchDebugLevel=none IndexerCheckpointCount=5000 GetCurrentIndexingStatus=1 end ■ HDA format to start the Indexer rebuild: Properties LocalData IdcService=CONTROL_SEARCH_INDEX cycleID=rebuild action=start getStatus=1 GetCurrentIndexingStatus=1 PerformProcessConversion=1 end ■ HDA format to cancel the Indexer rebuild: Properties LocalData IdcService=CONTROL_SEARCH_INDEX cycleID=rebuild action=cancel getStatus=1 GetCurrentIndexingStatus=1 end ■ HDA format to suspend the Indexer rebuild: Properties LocalData IdcService=CONTROL_SEARCH_INDEX cycleID=rebuild action=suspend getStatus=1 GetCurrentIndexingStatus=1 end ■ HDA format to restart the Indexer rebuild after being interrupted or suspended: Properties LocalData IdcService=CONTROL_SEARCH_INDEX cycleID=rebuild action=restart getStatus=1 GetCurrentIndexingStatus=1 PerformProcessConversion=1 end

4.6.3 GET_FILE