RSS source JSON modification

This is for:

Developer System Administrator

Many source configuration parameters can be set through the user interface. Others, such as rarely used parameters or new parameters that aren’t yet editable through the user interface, can only be configured in the source JSON configuration.

This article explains how to configure RSS source parameters, whether they’re already listed in the JSON or not.

Configuring listed and unlisted parameters

Changing a parameter value in the source JSON configuration | Coveo

If the parameter you want to change is already listed in the parameters section of the source JSON configuration, just modify its value in the JSON configuration.

If the parameter isn’t listed in the parameters section, copy the entire parameter example object from the Reference section below and paste it into the parameters section of the source JSON configuration. Then, modify the value in the JSON configuration, if necessary.

Important

If a parameter has a value attribute that contains sensitive information, set the sensitive attribute to true. Otherwise, the value will appear in clear text in the JSON configuration.
Tip

Document the changes you make to the source JSON configuration in the Change notes area below the JSON configuration. This ensures that you can easily revert to a previous configuration if needed.

Reference

This section provides information on the RSS source parameters that you can only modify through the JSON configuration.

If a JSON configuration parameter isn’t documented in this article, configure it through the user interface instead.

DateFormat (String | Null)

The format to use when parsing date element values in the feed. The format must not include time-zone and offset information.

Important

The default value is null, as the RSS source can automatically recognize and parse most date formats associated with the supported RSS feed formats. Specify a DateFormat value and retry indexing only if the date field value of your indexed items is incorrect.
Example
"DateFormat": {
  "sensitive": false,
  "value": "YYYY-MM-DDThh:mm:ss"
}

IndexRssFeedUrl (Boolean)

Determines whether the RSS feed URL is indexed. The default value is false.

If you set this parameter to true and rebuild, your source content will include an item whose Clickable URI is the Feed URL. The File type value of this item will be rssfeed.

Example
"IndexRssFeedUrl": {
  "sensitive": false,
  "value": "true"
}

UserAgent (String)

This specifies the value of the User-Agent HTTP header that the RSS source uses when requesting the feed. The default value is Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko) (compatible; Coveobot/2.0;+http://www.coveo.com/bot.html).

Example
"UserAgent": {
  "sensitive": false,
  "value": "Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko) (compatible; Coveobot/2.0;+http://www.coveo.com/bot.html)"
}