Product DocsMenu

Coveo Platform 7.0 >
Administrator Help > Connectors > PTC Windchill Connector > Configuring and Indexing a PTC Windchill Source

Configuring and Indexing a PTC Windchill Source

A source defines a set of configuration parameters for indexing the content of a specific PTC Windchill site.

To configure and index a PTC Windchill source

  1. On the Coveo server, access the Administration Tool (see Opening the Administration Tool).

  2. Select Index > Sources and Collections.

  3. In the Collections section:

    1. Select an existing collection in which you want to add the new source.

      OR

    2. Click Add to create a new collection (see Adding a Collection).

  4. In the Sources section, click Add.

    The Add Source page that appears is organized in three sections.

  5. In the General Settings section of the Add Source page:

    1. Enter the appropriate value for the following required parameters:

      Name

      A descriptive name of your choice for the connector source.

      Example: PTC Windchill Site

      Source Type

      The connector used by this source. In this case, select Windchill.

      Addresses

      The address of the PTC Windchill site in the form:

      http://[PTCWindchillServer]/Windchill

      where you replace [PTCWindchillServer] by your actual PTC Windchill server host name.

      Fields

      If you defined a PTC Windchill field set, select it (see PTC Windchill Connector Deployment Overview).

      Refresh Schedule

      Time interval at which the index is automatically refreshed to keep the index content up-to-date. By default, the Every day option instructs CES to refresh the source everyday at 12 AM. Because the incremental refresh takes care of maintaining the source up-to-date, you can select a longer interval such as Every Sunday (see What Should Be the Frequency of Source Refresh Schedules?).

      Note: You can create a new or modify an existing source refresh schedule (see Creating or Modifying a Source Schedule).

    2. Review the value for the following parameters that often do not need to be modified:

      Rating

      Change this value only when you want to globally change the ranking associated with all items in this source relative to the rating of other sources (see Understanding Search Results Ranking).

      Example: If this source is for a legacy PLM, you may want to set this parameter to Low, so that in the search interface, results from this source appear later in the list compared to those from other sources.

      Document Types

      Select the custom document type set that you created for this source (see PTC Windchill Connector Deployment Overview). Otherwise, leave Default.

      Active Languages

      If you defined custom active language sets, ensure to select the most appropriate for this source (see Adding and Configuring a Language Set).

  6. In the Specific Connector Parameters & Options section of the Add Source page:

    1. Enter the appropriate value for the following required parameters:

      Application URL

      Enter the URL of the PTC Windchill application used to open search results.

      Example: http://MyWindchillServer/Windchill/app/

      Web Service URL

      Enter the URL to the Coveo plug-in web service.

      Example: http://MyWindchillServer/Windchill/servlet/CoveoWindchillWebService

      Server Certificate Path

      Enter the path of the server X.509 certificate used to connect to the Coveo plug-in web service.

      Example: E:\CES70\CertStore\PTC_Windchill\server.cer

    2. In the Number of Refresh Threads box, consider changing the number of simultaneous connections established with the PTC Windchill site by the connector. The default value is 2. Increasing this value may improve source refresh speed but puts more load on the PTC Windchill server.

    3. In the Mapping File box, leave the default mapping file name (Coveo.CES.CustomCrawlers.Windchill.MappingFile.xml) unless you created a custom mapping file, in which case, enter the full path of your valid mapping file.

    4. Click Add Parameter when you want to show and change the value of hidden source parameters (see Modifying Hidden PTC Windchill Source Parameters).

      Notes:

      • In rare cases, Coveo Support can instruct you to click Add Parameter to enter the name and value of other hidden parameters that can help in troubleshooting issues (see Modifying Hidden PTC Windchill Source Parameters).

      • CES 7.0.7256– (December 2014) The following required parameters must be added manually:

        Parameter name Parameter value example
        ApplicationUrl http://MyWindchillServer/Windchill/app/
        ClientCertificatePath E:\CES70\CertStore\PTC_Windchill\client.cer
        ServerCertificatePath E:\CES70\CertStore\PTC_Windchill\server.cer
        WebServiceUrl http://MyWindchillServer/Windchill/servlet/
        CoveoWindchillWebService

    5. In the Option section, the state of check boxes generally does not need to be changed:

      Index Subfolders

      Check to index all subfolders below the specified starting addresses.

      Index the document's metadata

      When selected, CES indexes all the document metadata, even metadata that are not associated with a field. The orphan metadata are added to the body of the document so that they can be searched using free text queries.

      When cleared (default), only the values of system and custom fields that have the Free Text Queries attribute selected will be searchable without using a field query (see Adding a Field to Search On and What Are Field Queries and Free Text Queries?).

      Example: A document has two metadata:

      • LastEditedBy containing the value Hector Smith

      • Department containing the value RH

      In CES, the custom field CorpDepartment is bound to the metadata Department and its Free Text Queries attribute is selected.

      When the Index the document's metadata option is cleared, searching for RH returns the document because a field is indexing this value. Searching for hector does not return the document because no field is indexing this value.

      When the Index the document's metadata option is selected, searching for hector also returns the document because CES indexed orphan metadata.

      Document's addresses are case-sensitive

      Leave the check box cleared. This parameter needs to be checked only in rare cases for case sensitive systems in which distinct documents may have the same file name but with different casing.

      Generate a cached HTML version of indexed documents

      When you select this check box (recommended), at indexing time CES creates HTML versions of indexed documents and saves them in the unified index. In the search interfaces, users can then more rapidly review the content by clicking the Quick View link to open the HTML version of the item rather than opening the original document with the original application.

      Consider clearing this check box only if you do not want to use Quick View links or to save resources when building the source.

      Open results with cached version

      Leave this check box cleared (recommended) so that in the search interfaces, the main search result link opens the original document with the original application. Consider selecting this check box only when you do not want users to be able to open the original document but only see the HTML version of the document as a Quick View. When this option is selected, you must also select the Generate a cached HTML version of indexed documents check box.

  7. In the Security section of the Add Source page:

    1. In the Security Provider drop-down list, select the PTC Windchill security provider that you created for this source (see Configuring a PTC Windchill Security Provider).

    2. In the Authentication drop-down list, select the PTC Windchill user identity that you created for this source (see PTC Windchill Connector Deployment Overview).

    3. Click Save and Start to save the source configuration and build the source.

  8. Validate that the indexing proceeds without errors: 

    1. In the navigation panel on the left, click Status to monitor the indexing progress.

    2. On the Coveo Master server, open the CES Console to review indexing logs (see Using the CES Console).

People who viewed this topic also viewed