More
Product news
Community
Support
Settings
Cookie preferences

AI agent context: a documentation index for this site is available at /llms.txt. A markdown version of this page is also available by appending .md to this page URL.

Home
Coveo Platform

Implementation guide
Index content

Connector directory

Amazon S3 source
Box Business source
Catalog source
Confluence Cloud source
Confluence Data Center source

Install the plugin

Database source

XML configuration reference
Further customization

Dropbox Business source
File system source
Google Drive source

Performance leading practices
Create a Google Cloud Console project and service account
Authorize the service account
JSON modification
Index handpicked shared drives only

GraphQL API source

Concepts
Source configuration reference
Permission configuration reference
Troubleshooting

Jira Software Cloud source

Map Jira Software custom fields

Jira Software Data Center source

Install the plugin
Map Jira Software custom fields

Khoros Community source

JSON modification

Microsoft Dynamics 365 source

Coveo, Dynamics, and security
Enable auditing of Dynamics 365 entities

Push source

Push API

Usage example
Tutorials

1: Manage public content
2: Manage secured content
3: Use batch calls

Manage items

Add or update an item
Delete an item
Delete old items
Manage batches of items
Item data

The data property
The compressedBinaryData property
The compressedBinaryDataFileId property
Embedded documents

Item metadata

Standard metadata
Custom metadata

Item permissions

Simplified permission model
Complete permission model

The parentId property

Manage security identities

Add or update a security identity
Add or update an alias
Disable a security identity
Disable old security identities
Manage batches of security identities
Security identity definition
User alias definition

Create a file container
The orderingId parameter
Manage the Push source
Processing delay
Limits
Reference

Troubleshooting

REST API source

Concepts
Source configuration reference
Permission configuration reference
Examples
Tutorial
Troubleshooting

RSS source

JSON modification

Salesforce source
SAP source

Concepts
Source configuration reference
Permission configuration reference
Troubleshooting

ServiceNow source

Ignoring domain information

SharePoint Online source

Performance leading practices

Index unapproved items

Create a SharePoint Online crawling account with permissions
Support Microsoft 365 user email aliases
Index metadata from a "Person or Group" column
JSON modification
Tag sites with the CoveoSiteFilter managed property
Troubleshooting

SharePoint Server source

Crawling account permissions
Using Okta as a trusted identity provider

Sitecore source
Sitemap source

Web scraping configuration
Index XML sitemap metadata
Index HTML page metadata
JSON modification
Troubleshooting

Slack source

Create a Slack connector bot

Web source

Populate a field with meta tag content
Web scraping configuration
JSON modification
Crawler directives
Index Salesforce Sites
Index an InSided Community
Troubleshooting

YouTube source
Zendesk source
Connector building best practices

Manage sources

Source credentials leading practices
Custom login sequence
Index metadata

View the metadata of a source
Manage source mappings

Mapping rule syntax reference
Add or edit a body mapping

Interpret item body as an HTML item

Manage fields

About dictionary fields
About the Facet Generator
Create fields with the API
"Sys" legacy prefix

Item identifier and duplicates

Content security
Source updates

Refresh, rescan, and rebuild

Extensions
Source JSON configuration

JSON modification options
Define source permissions
Objects section

Content retrieval methods
Optical character recognition
File type handling
Indexing restriction
Source API

Create a basic public Web source
Create a Push source
Get source detailed information
Manage the mapping configuration of a source
Mapping definition examples
Possible sourceType values
Possible crawlerInstanceType values

Browse content

Review item properties

Review indexing logs

Source logs (API)

Indexing pipeline extensions

Indexing pipeline
Tools overview
Extension overview
Manage extensions
Apply extensions
JSON configuration use cases
Extensions API

Document object Python API reference
Condition syntax reference
Python modules available to extensions
Extension parameters
Extension actionOnError
Supported character sets
Extension script samples

Inspect all metadata values
Update the printable and clickable URIs
Modify date
Reject items
Modify source item permissions
Modify item bodies
Modify item language

Extension state
Use vault parameters in your extension
Create an extension with the API
Log messages from an extension
Test strategies and good practices

Upload a data stream for an extension test

Manage security identities and content access issues

Security identities and item permissions

Basic secured search
Group and granted security identities
Security identity relationships
Security identity cache and provider
Typical secured search
Permission sets
Permission levels

Security identities
Security Cache API

Create a security identity provider for a secured Push source
Get the status of a security identity provider
About the Email Security Provider
List security identities

Index API

View the effective permissions of an item

Crawling module

Deployment
Requirements
Install the Crawling Module

Silent install

Manage the Crawling Module

Number of workers
REST API reference
Scale up your deployment

Source creation

Source creation via API

Pre-push extensions

Extension script examples

Dump the current input JSON
Modify metadata
Add item data
Upload large item data
Use external modules
Modify item permissions

Maestro settings
Additional configuration
About logs
Monitoring
Release notes

Release notes of 2024
Release notes of 2023

Indexing capacity management
Reference

Index self-optimization process
Source item types
Supported file formats
Supported languages
IPs to allowlist
Multi-index organizations
Crawling speed

Build a search UI
Tune relevance
Monitor and measure your data
Leverage AI and ML
Manage an organization
Manage customer service solutions
Knowledge Hub
Coveo CLI
Coveo REST APIs
Searching with Coveo

Solutions and integrations

Coveo for Adobe
Coveo for Agentforce
Coveo for Commerce
Coveo for Contentful
Coveo for Optimizely
Coveo In-Product Experience (IPX)
Coveo for Salesforce
Coveo for ServiceNow
Coveo for Sitecore
Coveo for Zendesk

Security
Compliance
Services
Product entitlements
Coveo product news
Deprecations
Supported browsers
Glossary
Log in to Coveo for the first time

Coveo Platform

Index content

Crawling module

Pre-push extensions

Extension script examples

Pre-push extension script examples

Pre-push extension script examples

This is for:

Developer System Administrator

The articles in this section present examples of pre-push extension scripts.

Dump the current input JSON
Modify metadata
Add item data
Upload large item data
Use external modules
Modify item permissions

Is this article useful?

You can close this window or leave a comment below.

Can you tell us more about your experience today?

Comments (optional)

Leave your email address if you'd like us to get back to you.

Email (optional)

Please provide a valid email address.

The Coveo Privacy Policy applies.

Need help with our product? Please open a support case for expert assistance. Use this feedback option to comment on the article only.

Is this article useful?

You can close this window or leave a comment below.

Can you tell us more about your experience today?

Comments (optional)

Leave your email address if you'd like us to get back to you.

Email (optional)

Please provide a valid email address.

The Coveo Privacy Policy applies.

Need help with our product? Please open a support case for expert assistance. Use this feedback option to comment on the article only.

Make every experience relevant with Coveo

Contact us Get a free trial

View as Markdown

View as Markdown
Open in ChatGPT
Open in Claude

In this article