GET_HIGHLIGHT_INFO GET_SEARCH_RESULTS

Core Oracle Content Server Services 4-125 Additional Required Service Parameters ■ dDocName: The Content ID for the content item. ■ HighlightType: The highlight type: – For PDF, use PdfHighlight. – For HTML, use HtmlHighlight. ■ QueryText: The full-text search expression. ■ SortField: The name of the metadata field to sort on. – Examples: dInDate, dOutDate, alternateFile. – Defaults to DocId. ■ SortOrder: The sort order. Allowed values are ASC ascending and DESC descending. Example IdcService=GET_EXTERNAL_XML_HIGHLIGHT_INFO dDocName=test113 HighlightType=PdfHighlight QueryText=test SortField=dInDate SortOrder=Desc

4.13.5 GET_HIGHLIGHT_INFO

Service that returns PDF or HTML highlight information for a content item. This service is run from the browser interface when you do a full-text search and click the Content ID or thumbnail on the search result page. On the displayed page, the words that you searched for are highlighted. For HTML document the words are bold and for PDF document they are highlighted. The most likely errors are when the content item no longer exists in the system or if the user fails the security check. Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ dDocName: The Content ID for the content item. ■ QueryText: The full-text search expression. ■ SortField: The name of the metadata field to sort on. – Examples: dInDate, dOutDate, alternateFile. – Defaults to DocId. ■ SortOrder: The sort order. Allowed values are ASC ascending and DESC descending. 4-126 Oracle Fusion Middleware Services Reference Guide for Oracle Universal Content Management Optional Service Parameters ■ dWebExtension: The file extension of the web-viewable content. For example, html, pdf, or txt. ■ HighlightType: The highlight type: – For PDF, use PdfHighlight. – For HTML, use HtmlHighlight. Example ■ IdcCommand command file format: IdcService=GET_HIGHLIGHT_INFO dDocName=test_000043 QueryText=service SortField=dInDate SortOrder=Desc ■ HDA format with optional parameters: Properties LocalData IdcService=GET_HIGHLIGHT_INFO dDocName=test_000043 QueryText=service SortField=dInDate SortOrder=Desc HighlightType=HtmlHighlight dWebExtension=html end

4.13.6 GET_SEARCH_RESULTS

Service that returns a list of content items that match specific search criteria. Access Level: Read 1 Calls Subservice: SUB Location: IdcHomeDirresourcescoretemplatesstd_services.htm Additional Required Service Parameters ■ QueryText: The search expression. You can append values for Title, Content ID, and so forth, on the QueryText parameter to refine this service. Optional Service Parameters ■ ResultCount: The number of results to return. Defaults to 25. ■ SearchEngineName: The name of the search engine to be used. The default is the value specified in the configconfig.cfg file. Values can be databasefulltext or database. If set to database or databasefulltext , you must pass SQL in the QueryText parameter, as in this example: dDocTitle like test This is equivalent to the Verity query: dDocTitle substring test Core Oracle Content Server Services 4-127 ■ SortField: The name of the metadata field to sort on. – Examples: dInDate, dDocTitle, Score. – Defaults to dInDate. ■ SortOrder: The sort order. Allowed values are ASC ascending and DESC descending. ■ SortSpec: Enables sorting on more than one field. Set this parameter to the following sequence: sort field sort order sort field sort order... For example, SortSpec=dDocTitle ASC dInDate DESC. ■ StartRow: The row to begin the search results display. For example, if ResultCount=25, setting StartRow=26 displays the second page of results. ■ EndRow: The row to end the search results display. ■ vcrContentType: The name of a searchable content type. The server modifies the query text of the search to limit the results to documents of that type. For example, if the content type specified is one describing a profile, then the query text is modified to limit the documents returned to those whose profile trigger value matches that of the profile. ■ vcrAppendObjectClassInfo: When set to true, the server adds an additional column to the SearchResults ResultSet called vcrObjectClass. This column lists the content type associated with each document in the results. The default is true. Example IdcService=GET_SEARCH_RESULTS QueryText=benefits

4.13.7 GET_SEARCH_RESULTS_FORCELOGIN