Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added note regarding SharePoint_Online source type.

...

Once you started your workers, you can create a source to crawl (see Managing the On-Premises Crawling Module Using the REST API). For now, a configuration UI in the Coveo Cloud V2 administration console is available for File and Database sources only (see Creating a File or Database Source). If you want to index a different source type, you must use the Coveo Cloud V2 Platform API (see Creating a Source Using the Source API).

Info
iconfalse
titleNote

For now, these procedures do not take into account the option you have to index the permissions corresponding to your secured content. If you want to index secured content and take access permissions into account, contact the Coveo Support team.

...

In the request body, beside providing an adequate value for the the basic properties listed above, make sure to  replace  <["URL", "URL"]>  with the addresses to crawl (see Basic Properties).

JIRA

Info
iconfalse
titleNote

Depending on the content you want to index, you might need to download the Coveo Plugin for Atlassian JIRA before creating a JIRA source (see Installing the Coveo Plugin for Atlassian JIRA).

...

In the request body, beside providing an adequate value for the the basic properties listed above, make sure to (see Basic Properties):

  • Replace <SERVER_URL> with the address of your JIRA server.

    Info
    iconfalse
    titleExample

    http://MyJiraServer:8080/

  • Indicate true or false for:
    • indexAttachments, which determines whether binary files attached to an issue should be indexed. Attachments are indexed with the same level and sets of their parent issue.
    • indexComments, which determines whether comments on an issue should be indexed. Comments are indexed with the same level and sets of their parent issue. When permissions on the comments are supported, if a comment is restricted to a group or a project role, an additional set with the group or the role is added.
    • indexWorkLogs, which determines whether time entry on a issue should be indexed. Work logs are indexed with the same level and sets of their parent issue. If a work log is restricted to a group or a project role, an additional set with the group or the role is added.
    • supportCommentPermissions, which determines whether only users allowed to see a comment in JIRA can also see it in their search results. If this property value is true, an issue and its comments are indexed as separate items, leading to lower search relevance. If the value is false, the issue and its comments are indexed as one item, allowing to find an item via either an issue or its comments. However, there are no restrictions on users seeing comments on an issue.

...

In the request body, beside providing an adequate value for the the basic properties listed above, make sure to (see Basic Properties):

  • Replace <INSTANCE_URL> with the address of your Jive server.

    Info
    iconfalse
    titleExample

    https://myjiveserver.mycompany.com

  • Enter a value for the following properties  if you wish to leverage the corresponding feature or customization. If not, indicate null.

...

In the request body, beside providing an adequate value for the the basic properties listed above, make sure to (see Basic Properties):

  • For connectionString, replace < Driver=DRIVER;Server=SERVERNAME;Database=DBNAME;Uid=@uid;Pwd=@pwd;> with the connection string used to connect to the database.  

    Info
    titleNotes
    • The connection string syntax differs from one database type to another. Refer to the appropriate documentation for the format of the connection string specific to your database (see Connection Strings). 

    • The same connection string can be used for different sources. However, there can only be one connection string per source. 

    • Specify the exact name of the desired driver. Refer to the list of available drivers, depending on the driver type you select using the ForceX86 property below (see Viewing the Available Drivers for an ODBC Source).

    • You can hide the password and the user ID in the connection string (see CES 7.0  Replacing the Identity in Database Connection Strings  documentation).

  •  Indicatetrue for a 32-bit driver and false for a 64-bit driver for the ForceX86 property, as it determines which drive type should be used.

    Info
    titleNote

    The driver type you choose must match the type of the driver you specified in your connection string.

  • Provide an XML configuration file with the desired content, mappings, allowed users, etc. to enable Coveo to retrieve and copy the data from record fields to Coveo default and standard source fields (see Example of a Configuration File). This configuration file must however be base64-encoded for your JSON source configuration to be valid. Use the Base64 Encode and Decode online tool, and then replace <Base64EncodedContent> with the encoded output.
  • For DriverType, specify which type of driver provides access to the database. 

  • For ItemType, replace <COMMA,SEPARATED,VALUES> with the Mapping type values from your XML configuration file above. These values are the table or object names to retrieve and must be separated by commas. 

...

Code Block
{
  "name": "<SourceDisplayName>",
  "sourceVisibility": "<SHARED|SECURED|PRIVATE>",
  "sourceType": "SHAREPOINT_ONLINE",
  "pushEnabled": true,
  "onPremisesEnabled": true,
  "urls": <["URL", "URL"]>,
  "AuthenticationType": "WindowsClassic|WindowsUnderClaims|SpOnlineNative|SpOnlineFederated|AdfsUnderClaims",
  "crawlScope": "WebApplication|SiteCollection|WebAndSubWebs|List",
  "username": "<User>",
  "password": "<Password>"
}
Info
iconfalse
titleNote

Although your SharePoint instance is of the on-premises type, you must enter SHAREPOINT_ONLINE as the sourceType value. This value refers to the version 2 of the SharePoint connector developed by Coveo, and this connector is used both for cloud and on-premises instances.


In the request body, beside providing an adequate value for the the basic properties listed above, make sure to (see Basic Properties):

  • Replace  <["URL", "URL"]>  with the addresses to crawl

    Info
    iconfalse
    titleExample

    https://mycompany.sharepoint.com

  • Select the appropriate AuthenticationType value from the following:

    ValueDescription
    WindowsClassicDefault Microsoft NTLM authentication mode.
    WindowsUnderClaimsWindows authentication mode under claims.
    SpOnlineNativeAuthentication for Sharepoint Online Native.
    SpOnlineFederatedAuthentication for Sharepoint Single Sign-On using trusted identity providers (ADFS).
    AdfsUnderClaimsAuthentication for Trusted Security Providers.
  • Select the appropriate CrawlScope value for the content type that you want to include in relation with the source URL your specified:

    ValueContent to Index
    WebApplicationAll site collections of the specified web application.
    SiteCollectionAll websites of the specified site collection.
    WebAndSubWebsThe specified website and its sub webs only.
    ListThe specified list or document library only.

...

In the request body, beside providing an adequate value for the the basic properties listed above, make sure to (see Basic Properties):

  • Replace  <["URL", "URL"]>  with the addresses to crawl.

  • Provide the value of the user-agent HTTP header to use as userAgent. This is the identifier used when downloading web pages. Default is  Mozilla/5.0 (Windows NT 6.1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/27.0.1453.110 Safari/537.36.

  • Indicate true or false for enableJavaScript, which determines whether JavaScript should be evaluated and rendered before indexation. This option is useful when you want to index the dynamically rendered content of crawled pages. However, activating this option has a significant impact on the crawling performance.

  • Provide a JSON scraping configuration to use as scrapingConfiguration or leave the quotations marks empty (see Web Scraping Configuration).

...

In the request body, beside providing an adequate value for the the basic properties listed above, make sure to replace  <http://www.example.com>  with the addresses to crawl. (see Basic Properties).

File

You can also create a File source using the Coveo Cloud V2 administration console. However, if you must create a File source via an API call, you can use the following configuration.

...

In the request body, beside providing an adequate value for the the basic properties listed above, make sure to (see Basic Properties):

  • Replace <file://Path/To/Shared/Folder> with the address to crawl.

  • Indicate true or false for:

    • expandMailArchives, which determines whether the content of mail archives (.pst) should be indexed. Default value is false.
    • indexSharePermissions, which determines whether share and NTFS permissions should be taken into account and applied in Coveo Cloud V2 (see Share and NTFS Permissions on a File Server).

      Info
      iconfalse
      titleNote

      If you want to take permssions into account, contact the Coveo Support team.

...