5.6 Indexer Services (Core Content Server)

5.6.1 CANCEL_SEARCH_INDEX

Service that cancels the current indexing session.

Location: IdcHomeDir/resources/core/templates/std_services.htm

5.6.2 CONTROL_SEARCH_INDEX

Service that updates or rebuilds the search index. Updates and rebuilds are performed automatically in a background thread.

Location: IdcHomeDir/resources/core/templates/std_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)

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.

• 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. This is useful because the indexer should not be running when the Verity database is being optimized and in some configurations it is important to optimize the Verity collection on a regularly scheduled basis. Verity is an add-on product available for purchase for use with Content Server.

• 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
  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
  

5.6.3 GET_FILE

Service that returns a specific rendition of a content item revision to a browser. A copy of the file is retrieved without performing a checkout.

• Given a dID or a dDocName and a RevisionSelectionMethod parameter, the service determines the file name of a particular rendition of the revision and returns that file to the client.

• The most likely errors are some form of mismatched parameters or a request for a revision or rendition that does not exist.

  Note:

  It is recommended that dDocName be included in all requests for content items where the requester knows the dDocName. Error messages in the Content Server assume that it is present, as do other features such as forms.

Access Level: Read, Scriptable (33)

Queries Executed:

• QdocInfo

• QlatestIdByName

• QlatestReleasedIDByName

Location: IdcHomeDir/resources/core/templates/std_services.htm

Additional Required Service Parameters

• dID: The generated content item revision ID.

  • If dID is not specified, dDocName and RevisionSelectionMethod must specified.

  • A rendition of the revision of the content item with this ID is returned, if it exists, and the RevisionSelectionMethod parameter does not exist or has the value Specific.

• dDocName: The Content ID for the content item.

  • If dDocName is not present, dID must be present and RevisionSelectionMethod must not be present.

  • If RevisionSelectionMethod is present, a rendition of a revision of the content item with this name is returned, if it exists. If RevisionSelectionMethod is not present, dDocName is used in error messages.

  • Optional Service Parameters

• allowInterrupt: If set to 1 (true), this suppresses an error if the user cancels the file download.

• RevisionSelectionMethod: The revision selection method.

  • If present, dDocName must be present. The value of this variable is the method used to compute a dID from the specified dDocName. Its value can be Specific, Latest, or LatestReleased.

  • If the value is Specific, the dDocName is ignored, and dID is required and is used to get a rendition. If the value is Latest, the latest revision of the content item is used to compute the dID. If the value is LatestReleased, the latest released revision of the content item is used to compute the dID.

• Rendition: The content item rendition. This parameter specifies the rendition of the content item and can be set to Primary, Web, or Alternate. If Rendition is not present, it defaults to Primary.

  • If the value is Primary, the primary rendition of the selected revision is returned.

  • If the value is Web, the Web-viewable rendition of the selected revision is returned.

  • If the value is Alternate, the alternate rendition of the selected revision is returned.

• IsXml: When set to true or 1, returns the XML data island which is present in some HCSP, HCST, and HCSF pages. It returns the data island that is wrappered inside the std_html_form_xml_wrapper include, which can be modified to pass additional information if desired.

Results

• Response Template: null (Only the requested file is returned.)

Used By

• Applets: Configuration Manager

• Resource Includes:

  • doc_file_get_copy

  • doc_odma_select_get

  • download_form_fields

  • email_docinfo_body_by_id

  • email_docinfo_body_by_name

  • legacy_workflow_in_queue_table

  • subscription_info_cell

  • subscription_info_cells

  • wf_in_queue_display

  • wf_review_cannot_view_msg

• Templates:

  • CHECKOUT_OK (chkook.htm)

  • DOWNLOAD_OK (dwnldok.htm)

  • QUERY_NOTIFICATION (query_notification_mail.htm)

  • REDIRECTION_FILE_TEMPLATE (redirectionfile_template.htm)

  • REV_HISTORY (rev_history.htm)

  • SELECTDOC_OK (slctdcok.htm)

  • WORKFLOW_REVIEW_FORM (workflow_review_form.htm)

  • WORKFLOW_REVIEW_FRAMES (workflow_review_frames.htm)

• Other: SoapCustom:Wsdl:GetFile:Services

Example

• IdcCommand command file format:

  # Retrieve a web-viewable revision
  IdcService=GET_FILE
  dDocName=corporatereport
  RevisionSelectionMethod=LatestReleased
  Rendition=Web
  

• HDA format:

  @Properties LocalData
  IdcService=GET_FILE
  dID=54321
  @end
  

5.6.4 START_SEARCH_INDEX

Service that updates or rebuilds the search index. This service is asynchronous and the action is performed in a background thread. This service can only be executed in the context of the Content Server and only completes successfully if a connection is made to the Content Server.

Location: IdcHomeDir/resources/core/templates/std_services.htm

Optional Service Parameters

• IsRebuild: Sets the scope of the indexing process.

  • 1 (true): The Indexer performs a complete rebuild of the search index. 0 (false): The Indexer performs an incremental update of the search index.

  • Default is 0 (false).

Example

• IdcCommand command file format:

  # Rebuild the entire search index
  IdcService=START_SEARCH_INDEX
  IsRebuild=true
  

• HDA format (rebuild the search index).