Product DocsMenu

Coveo Platform 7.0 >
Administrator Help > Connectors > Shared Connector Topics > Adding an Explicit Connector Parameter

Adding an Explicit Connector Parameter

Connector parameters applying to all sources indexed using this connector are called explicit parameters.

When you create or configure a source, the Coveo Enterprise Search (CES) 7.0 Administration Tool presents parameters with which you can configure the connector for most setups. For many connectors, more advanced and more rarely used parameters also exist but are hidden by default. CES then uses the default value associated with each of these hidden parameters.

You can however choose to make one or more of these parameters appear in the Add Source and Source: ... General pages of the Administration Tool so that you can change their default value.

Refer to the documentation of each connector to get the description of available hidden parameters:

To add an explicit connector parameter

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

  2. Select Configuration > Connectors.

  3. In the list on the Connectors page, select the connector for which you want to show advanced hidden parameters.

  4. In the Parameters section of the selected connector page, click Add Parameter for each hidden parameter that you want to modify.

    Note: The Add Parameter button is present only when hidden parameters are available for the selected connector.

  5. In the Modify the parameters of the connector page:

    1. In the Type list, select the parameter type as specified in the parameter description.

    2. In the Name box, type the parameter name exactly as it appears in the parameter description. Parameter names are case sensitive.

    3. In the Default Value box, enter the default value specified in the parameter description.

      Important: Do not set the value that you want to use for a specific source. The value that you enter here will be used for all sources defined using this connector so it must be set to the recommended default value. You will be able to change the value for each source later, in the Add Source and Source: ... General pages of the Administration Tool.

    4. In the Label box, enter the label that you want to see for this parameter.

      Example: To easily link the label to the hidden parameter, you can simply use the parameter name, and if applicable, insert spaces between concatenated words. For the BatchSize hidden parameter, enter Batch Size for the label.

      Note: To create multilingual labels and quick help messages, use the following syntax: <@ln>text</@>, where ln is replaced by the language initials—the languages of the Administration Tool are English (en) and French (fr).

      Example: <@fr>Chemin d'accès du fichier de configuration</@><@en>Configuration File Path</@> is a label which is displayed differently in the French and English versions of the Administration Tool.

      Tip: The language of the Administration Tool can be modified by pressing the following key combination: Ctrl+Alt+Page Up.

    5. Optionally, in Quick Help, enter the help text that you want to see for this parameter when clicking the question mark button that will appear beside the parameter value.

      Tip: Copy and paste key elements of the parameter description.

    6. When Predefined values is selected in the Type parameter, in the Value box that appears, enter the parameter values that you want to see available in the drop-down parameter that will appear in the Administration Tool interface. Enter one value per line. The entered values must exactly match the values listed in the hidden parameter description.

    7. Select the Optional parameter check box when you want to identify this parameter as an optional parameter. When cleared, CES does not allow you to save changes when the parameter is empty. This parameter does not appear for Boolean and Predefined values parameter types.

    8. Select the Sensitive information check box for password or other sensitive parameter so that, in the Administration Tool pages where the parameter appears, the typed characters appear as dots to mask them. This parameter appears only for the String type.

      Example: When you select the Sensitive information check box for a parameter, the characters typed appear as follows in the text box:

    9. Select the Validate as an email address check box when you want CES to validate that the text string that a user enters in this parameter respects the format of a valid email address. This parameter appears only for the String type.

    10. In the Maximum length box, enter the maximum number of characters for the string. This parameter appears only for the String type. When you enter 0, the length of the string is not limited.

    11. Click Save.

  6. Back in the Connector page, click Apply Changes.

    The hidden parameter now appears in the Add Source and Source: ... General pages of the Administration Tool for the selected source. You can change the parameter value from these pages. Refer to the documentation for each connector for details.

Note: When you want to modify a hidden source parameter, you must first delete it, and then redefine it with the modified values.

People who viewed this topic also viewed