Edit a Source JSON Configuration: [SourceName] - Panel

The source configuration in JSON format contains source parameters in key-value pairs. While many of the parameters can be configured through the administration console user interface, others such as rarely used parameters or new parameters that are not yet editable through the user interface, can only by changed or added in the JSON configuration.

When you have the required privileges, you can use the Edit a Source JSON Configuration: [SourceName] panel to review specific aspects of the source configuration.

You use the Edit a Source JSON Configuration: [SourceName] panel to customize the source only to perform documented changes or when instructed to do so by Coveo Support. You should be a developer or, at least, understand the JSON syntax to attempt to change the source JSON configuration.

  • All members that can edit a source can also see and edit the source configuration in JSON format (see Required Privileges).

  • All JSON source configurations (not the data) are backed up.

  • When two changes occur simultaneously (one in the Edit a [SourceType]: [SourceName] panel and the other in the Edit a Source JSON Configuration: [SourceName] panel), changes are merged if possible, and if not, changes in the Edit a [SourceType]: [SourceName] panel) have priority over the ones made in the JSON configuration.

  • For obvious security reasons, sensitive data is NOT shown in the JSON configuration.

Access the “JSON” Panel

  1. If not already done, log in to your Coveo Cloud organization with a user that is a member of a group with the required privileges to manage sources (see Required Privileges).

  2. In the main menu on the left, under Content, select Sources.

  3. In the Sources page, click the row of the desired source.

  4. In the Action bar, click More, and then select Edit JSON.

Edit the JSON Configuration

  • Before making any changes to the JSON configuration, always copy and save the whole original configuration somewhere to ensure you can revert your changes if something goes wrong.

  • Changes to the following parameters are not saved if done in the [SourceName] - JSON panel:

    • id

    • owner

    • crawlerInstanceType

    • pushEnabled

  • Make changes to the JSON configuration only for documented changes or when you are instructed to do so by Coveo Support.

  1. In the Edit a Source JSON Configuration: [SourceName] panel, when you know the section in which you want to make changes, select it (see Access the JSON Panel and Show Only One Configuration Section).

  2. When you know the parameter or value that you want to change, you can search it to more easily locate it in the configuration (see Search for a Keyword).

  3. Make the changes in the JSON configuration box based on examples or information you receive from Coveo Support (see Source JSON Modification Examples).

    As you make modifications, when the format is not valid JSON, several features indicate what and why it is invalid, including the following message that appears at the bottom of the JSON configuration box:

    The JSON configuration is syntactically invalid.

    In the configuration below, a comma should not be there at the end of line 27.

    ac8-source_json_config_error1

  4. Document your changes (see Add Notes About Your Changes).

  5. When you are done and the JSON is valid:

    • Click Save to save and close the panel.

      • Clicking Save defers the source rebuild operation, which is necessary to apply changes to the indexed items. Therefore, if you made changes that will affect the indexed items, it is recommended to rather use the Save and Rebuild option (see Save and Rebuild). However, if you are sure that your changes will not affect the indexed items in any way, such as changes relative to the source credentials, you may click Save to avoid an irrelevant rebuild operation. Since a source with several millions of items may take weeks to rebuild, choosing the Save option when possible prevents stressing the Coveo Cloud and system server resources.

      • If you change fields or mappings and do not rebuild the source, the changes will apply only to new source items following a source refresh.

      OR

    • Click Save and Rebuild if you are ready to rebuild your source to make changes effective.

  6. If you clicked Save, back in the Sources page, under the source Status column, click Start required rebuild when you are ready or wait for the next scheduled source rebuild to make the changes effective.

  7. Validate that the changes perform as expected.

Show Only One Configuration Section

The JSON configuration can be pretty long. It is divided into several sections. By default, All sections appear in the JSON configuration box, but you can choose to show only one section at a time to more easily find what you are looking for.

  • In the Edit a Source JSON Configuration: [SourceName] panel, select the section to display (see Access the JSON Panel):

    • All

    • Configuration: lists source parameters, item configuration, permissions, and address patterns which are used to retrieve items from a system.

      More advanced and more rarely used parameters (known as hidden parameters) are listed in the tab but are absent from the source configuration panel. You can thus only add or modify hidden parameters in the Configuration tab (see Add a Hidden Source Parameter).

    • Mappings: lists all definitions that map content (metadata or a specific value) to a Coveo index field (fieldName parameter) for each source item (see Edit the Mappings of a Source: [SourceName]).

    • Objects (Only for Salesforce sources): lists all Salesforce objects and fields selected to be contained in the source (see Understanding the JSON Salesforce Objects Section).

    • Pre-conversion extensions/Post-conversion extensions: lists all extensions (pre-conversion / post-conversion) that are applied on the source (if any) (see Extensions - Page).

    The default is All.

    When you want to change only a parameter value, select the Configuration tab to only see the source parameters.

Search for a Keyword

The JSON configuration can be pretty long. Therefore, you can use the implemented search feature to easily find source configuration elements such as parameters names and values.

  1. In the Edit a Source JSON Configuration: [SourceName] panel, when you want to search the whole JSON configuration, ensure that All is selected in the Display section drop-down (see Access the JSON Panel and Show Only One Configuration Section).

  2. In the JSON configuration box, fill the Search box with the desired keyword(s):

    1. Click anywhere in the JSON configuration box.

    2. Press Ctrl-F (Windows) or cmd-F (Mac).

    3. In the Search field that appears at the top of the JSON configuration box, type the desired keyword(s), and press Enter.

    OR

    In the JSON configuration box, select the keyword(s) you want to search, and then press Ctrl-F (Windows) or cmd-F (Mac).

    The selected keyword(s) automatically appears in the Search box

  3. Press Enter.

    When present, the keyword occurrences are highlighted with a yellow background. The box content scrolls when needed to ensure the first keyword occurrence is visible.

  4. Repeat steps 1 and 2 to automatically scroll in the JSON configuration box to review the other keyword occurrences.

The search feature also supports regular expressions (regex).

Add Notes About Your Changes

Making changes through the JSON configuration provides flexibility, but changes are not necessarily visible in the administration console user interface.

In the Edit a Source JSON Configuration: [SourceName] panel, it is a best practice to use the Change notes box to log change information such as Who made What changes When and Why, to help you or your colleagues remember or to be aware of the changes (see Access the JSON Panel).

To answer the who, what, when, and why questions:

2016-03-08 MBaker: Change RequestsTimeoutInSeconds from 60 to 300 to minimize timeouts on slow systems.