Legacy Update: Get back online, activate, and install updates on your legacy Windows PC

This download is required as a part of a quick engineering fix (QFE) to ease the functionality provided by the QFE so that administrators do not have to write code to create crawl rules for indexing Forms Authentication/Cookie-protected Web sites in Microsoft Office SharePoint Server 2007.

This download is required as a part of a quick engineering fix (QFE) that will soon be released. The download is needed to ease the functionality provided by the QFE so that administrators do not have to write code to create crawl rules for indexing Forms Authentication/Cookie-protected websites.

Files

Status: Deleted This download is no longer available on microsoft.com. The downloads below are archives provided by the Internet Archive Wayback Machine from the Microsoft Download Center prior to May 2015.

• This download works with the following Office programs:
  
  
  • Microsoft Office SharePoint Server 2007 Standard and Enterprise
  
  
  • Microsoft Office SharePoint Server for Search 2007 Standard and Enterprise
  
  

The administrator input is provided by the use of a command line tool. The input is in the form of an XML file that resembles the following XML file:

<rules ssp="SharedServices1">

<rule>
<path>https://host/*</path>
<type>FORMS</type>
<auth_url>https://host/login.aspx?redirect=%2f</auth_url>
<login_type>post</login_type>
<error_pages>
<error_page>login.aspx</error_page>
</error_pages>
<parameters>
<param name="..." public = "true">...</param>
</parameters>
</rule>

<rule>
<path>https://host2/*</path>
<type>COOKIE</type>
<error_pages>
<error_page>login.aspx</error_page>
</error_pages>
<cookies >
<cookie>[name]=[value]</cookie>
</cookies>
</rule>

</rules>

Notes about the XML file

• path: The URL path for which this crawl rule applies, including wild cards.


• type: The type of authentication. This command has the following values:
  
  
  
  • FORMS
  
  
  • COOKIE
  
  
  
  


• error_pages: The list of URLs that signifies that the crawler needs to provide input.


• error_page: A URL that the crawler can be redirected to. This is the page a user would be redirected to if they didn't have the right credentials.

The following notes apply only to a rule of the type "FORM":

• auth_url: This is the URL where the crawler is expected to send a POST method to get a forms cookie. If you "view the source" on the forms login page, this is the POST URL. This command applies only to forms-based authentication.


• login_type: This determines whether the crawler has to do a POST method on the auth_url.


• parameters: These are the parameters that are provided in the POST method. This command applies only to forms-based authentication.


• param: These are the name-value pairs of the parameters that the crawler would add to the POST method. These can be seen when you "view the source" on the forms login page. This command applies only to forms-based authentication.


• public: If this value is not present, the parameter specified will be encrypted and stored in the search system. For encrypted parameters, the size limit is 1,024 characters. If you specify public = "true", the parameter will not be encrypted before storing in the search system. Also, the parameters size limit increases to 4,096 characters.

The following note applies only to a rule of the type "COOKIE":

• cookies: A list of cookies that the crawler is supposed to append to the HTTP request header.


• cookie: The cookie to append.

• addrule.exe
  This command displays the following help text:
  
  • Usage: addrule.exe <xml file>
  
  The structure of the input file is specified in the instructions provided with this hotfix.



• addrule.exe input xml file
  This command will add the crawl rule based on the XML file. These rules will be added to the end of their current set of crawl rules. The administrator can later change the order by using the user interface.
  
  If the XML file is malformed, an error message may be displayed.