2.2.4.4 ContentSourceInternal

  • Article

The ContentSourceInternal type represents the properties and status information for a content source.

 <s:complexType name="ContentSourceInternal">
   <s:sequence>
     <s:element name="id" type="s:int"/>
     <s:element name="systemCreated" type="s:boolean"/>
     <s:element name="type" type="s:int"/>
     <s:element name="name" type="s:string" minOccurs="0"/>
     <s:element name="wssCrawlStyle" type="s:int"/>
     <s:element name="metadata" type="s:string" minOccurs="0"/>
     <s:element name="followDirectories" type="s:boolean"/>
     <s:element name="pageDepth" type="s:int"/>
     <s:element name="siteDepth" type="s:int"/>
     <s:element name="startAddresses" type="tns:ArrayOfString" minOccurs="0"/>
     <s:element name="throttleStart" type="s:int"/>
     <s:element name="throttleDuration" type="s:int"/>
     <s:element name="fullCrawlTrigger" type="s:base64Binary" minOccurs="0"/>
     <s:element name="incCrawlTrigger" type="s:base64Binary" minOccurs="0"/>
     <s:element name="nextIncCrawlStart" type="s:dateTime"/>
     <s:element name="nextFullCrawlStart" type="s:dateTime"/>
     <s:element name="incScheduleDescription" type="s:string" minOccurs="0"/>
     <s:element name="fullScheduleDescription" type="s:string" minOccurs="0"/>
     <s:element name="dynamic" type="tns:ContentSourceDynamicPropsInternal" minOccurs="0"/>
   </s:sequence>
 </s:complexType>

id: The content source identifier. The identifier MUST be greater than 0.

systemCreated: Specifies whether the content source was created automatically by the system or if the protocol client created it using this protocol. MUST be one of the following values.

Value

Meaning

True

The content source was automatically created after server installation.

False

The content source was created by the protocol client using this protocol.

type: The content source type. MUST be one of the following values.

Value

Meaning

0

Web sites

1

Sites

2

Lotus Notes database

3

File shares

4

Exchange public folders

5

Custom

6

Business Data Connectivity (BDC)

name: The content source name. MUST be present, and the length of the name MUST be greater than 0 characters and less than or equal to 255 characters.

wssCrawlStyle: The scope of start addresses. MUST be one of the following values.

Value

Meaning

0

All Web applications pointed to by the start addresses are to be crawled.

1

Only sites pointed to by the start addresses are to be crawled.

metadata: An arbitrary custom string that the protocol client associated with the content source. If present, the length MUST be less than 1024 characters. The utilization of the metadata string depends on the protocol client implementation details.

followDirectories: Specifies how items are discovered by the crawler during the crawl. MUST be one of the following values.

Value

Meaning

true

Items are discovered through folder links.

false

Items are discovered through hyperlinks.

pageDepth: The maximum number of page hops allowed when this content source is crawled. The number MUST be greater than or equal to 0. If there is no limit, the number MUST be 2147483647.

siteDepth: The maximum number of host hops allowed when this content source is crawled. The number MUST be greater than or equal to 0. If there is no limit, the number MUST be 2147483647.

startAddresses: An array of zero or more start addresses. This element MUST be present. Each element in the array MUST contain a single URL or UNC path of a start address, and the length MUST be less than 2048 characters.

throttleStart: This element is unused. throttleStart SHOULD contain 0 and MUST be ignored by the protocol server.

throttleDuration: This element is unused. throttleDuration SHOULD contain 0 and MUST be ignored by the protocol server.

fullCrawlTrigger: If this element is present, it MUST contain a trigger as defined in [MS-TSCH], section 2.4.2.11 for the full crawl schedule. If this element is not present, it means that the trigger is not defined.

incCrawlTrigger: If this element is present, it MUST contain a trigger as defined in [MS-TSCH], 2.4.2.11 for the incremental crawl schedule. If this element is not present, it means that the trigger is not defined.

nextIncCrawlStart: The start time of the next scheduled incremental crawl. If there is no incremental crawl scheduled, this element MUST contain the value 9999-12-31T23:59:59.9999999.

nextFullCrawlStart: The start time of the next scheduled full crawl. If there is no full crawl scheduled, this element MUST contain the value 9999-12-31T23:59:59.9999999.

incScheduleDescription: The text description for an incremental crawl schedule. If the incCrawlTrigger element is present, this element MUST also be present. If the incCrawlTrigger element is not present, this element MUST NOT be present.

fullScheduleDescription: The text description for a full crawl schedule. If the fullCrawlTrigger element is present, this element MUST be also be present. If the fullCrawlTrigger element is not present, this element MUST NOT be present.

dynamic: This element MUST be present and MUST contain the content source status information as specified in section 2.2.4.2.