docServicePipeline

A document service pipeline is a list of document service instances that are invoked in the order of the list. The same instance can be assigned to different pipelines, but it cannot be assigned twice in the same pipeline. You can have multiple pipeline definitions; for example, one pipeline could be used globally and another pipeline used for certain sources. An instance does not need to be in a pipeline.

Object Type

Creatable

Object Key

NAME

Object Key Command Syntax

--NAME=object_name

-n object_name

State Properties

None

Supported Operations

create
createAll
delete
deleteAll
deleteList
export
exportAll
exportList
getAllObjectKeys
update
updateAll

Administration GUI Page

Global Settings - Document Services - Create or Edit Document Service Pipeline

XML Description

The <search:docServicePipelines> element describes the document service pipelines:

<search:docServicePipelines>
   <search:docServicePipeline>
      <search:name>
      <search:description>
      <search:assignedSources> 
         <search:assignedSource> 
      <search:serviceInstances> 
         <search:serviceInstance>

Element Descriptions 

<search:docServicePipelines>

Describes all document service pipelines. It contains one or more <search:docServicePipeline> elements, each defining a document service pipeline.

<search:docServicePipeline>

Describes a document service pipeline. It contains these elements:

<search:name> 
<search:description> 
<search:assignedSources> 
<search:serviceInstances> 
<search:name>

Contains the name of the document service pipeline.

<search:description>

Contains a description of the pipeline.

<search:assignedSources>

Contains one or more <search:assignedSource> element, each describing a source that the document service pipeline is assigned to. (Read only)

<search:assignedSource>

Contains the name of a source crawled using this pipeline. (Read only)

<search:serviceInstances>

Contains one or more <search:serviceInstance> elements, each describing an existing document service instance to be invoked by the document service pipeline.

<search:serviceInstance>

Contains the name of an existing document service instance to be invoked by the document service pipeline.

Example

This XML document describes a document service pipeline:

<?xml version="1.0" encoding="UTF-8"?>
<search:config productVersion="11.2.1.0.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:docServicePipelines>
      <search:docServicePipeline>
         <search:name>My pipeline</search:name>
         <search:description>
            My document service pipeline
         </search:description>
         <search:assignedSources>
            <search:assignedSource>
               this_web_source
            </search:assignedSource>
            <search:assignedSource>
               that_web_source
            </search:assignedSource>
         </search:assignedSources>
         <search:serviceInstances>
            <search:serviceInstance>
               My web service instance
         </search:serviceInstance>
         </search:serviceInstances>
      </search:docServicePipeline>
   </search:docServicePipelines>
</search:config>