Product DocsMenu

Coveo Platform 7.0 >
Administrator Help > Connectors > Lithium Connector > Modifying Hidden Source Parameters

Modifying Hidden Lithium Source Parameters

The Add Source and Source: ... General pages of the Administration Tool present the parameters with which you can configure the connector for most Lithium setups. More advanced and more rarely used parameters are hidden. You can 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. Consider changing values of hidden parameters when you encounter issues.

The following list describes the advanced hidden parameters available with Lithium sources. The parameter type (integer, string…) appears between parentheses following the parameter name.

RestApiUrlCES 7.0.9434+ (September 2018)

If you use a reverse proxy, your REST API might not reside at your community root URL. You must therefore add the RestApiUrl hidden parameter to specify the URL address at which your REST API resides.

Note: Lithium does not recommend using a reverse proxy (see Reverse proxy and Lithium communities while logged in with a Lithium account).

BasicAuthenticationUsername (String)
BasicAuthenticationPassword (String)

The user name and password to use when the Lithium community is secured with basic (http) authentication.

FetchMessageTags (Boolean)

Indicates whether to fetch the tags associated with the messages. The default is true.

FetchMessageAttachments (Boolean) CES 7.0.8996– (June 2017)

Indicates whether to fetch the attachments associated with the messages. The default is true.

Note: Setting this parameter to true requires one more API call per message.

FetchUsers (Boolean) CES 7.0.8996– (June 2017)

Indicates whether to fetch users. The default is false.

Notes:

  • You can index users only when indexing an entire community. If you only index a community subset such as a category or a board, you cannot index users

  • On a large Lithium community, indexing the users may take a significant amount of time.

ApiVersion (String) CES 7.0.8996– (June 2017)

The version of the Lithium REST API to use: vx, vc, or v1. The default is v1.

LoginPageUrl (String)

The login page URL to use when the community uses form authentication. You can get this URL by attempting to access the Lithium community while you are not yet logged in.

Example: https://community.lithium.com/t5/user/userloginpage

LoginFieldName (String)

The name of the form authentication login field. The default is login. Inspect the login page to find the <input... name="login" ...> tag for the user name field and copy the value of its name attribute to put in this parameter.

PasswordFieldName (String)

The name of the form authentication password field. The default is password. Inspect the login page to find the <input... name="password" ...> tag for the password field and copy the value of its name attribute to put in this parameter.

AuthenticationFormId (String)

The form authentication ID to use. The default is form. Inspect the login page to find the <form ... id="form" name="form"> tag and copy the value of its id attribute to put in this parameter.

AdditionalFormParameters (String)

When needed, a list of additional form authentication parameters formatted as follows:

'param1=value1;param2=value2'

UseFormAuthenticationToFetchAttachments (Boolean)

Whether to use form authentication to fetch attachments. The default is false.

IndexMessageHasEmbeddedImage (Boolean) CES 7.09093+ (September 2017)

Whether to set a metadata value indicating that the message has at least one embedded image. The default is false.

Note: Setting this parameter to true requires one more API call per message.

IndexMessageHasEmbeddedVideo (Boolean) CES 7.0.9093+ (September 2017)

Whether to set a metadata value indicating that the message has at least one embedded video. The default is false.

Note: Setting this parameter to true requires one more API call per message.

ItemTypesToIndex (String) CES 7.0.9093+ (September 2017)

The item types to index. The default is empty, which indexes all item types (see Searchable content types).

You can select specific items types to index by entering the desired types separated by semicolons.

Example: community;category;board;thread;message;attachment;user

NumberOfRetries (Integer) CES 7.0.9093+ (September 2017)

The number of retries allowed when a web request fails. The default is 3.

PageSize (Integer) CES 7.0.9093+ (September 2017)

The number of items returned for an API call. The default is 50, the upper limit is 100.

Note: Since this parameter can reduce performance or increase the number of API calls significantly, you should only modify this parameter when advised to do so by the (missing or bad snippet) team.

Use the following procedure only when you want to modify one or more of the above hidden source parameters.

To modify hidden Lithium source parameters

  1. Refer to Adding an Explicit Connector Parameter to add one or more Lithium hidden source parameters.

  2. For a new Lithium source, access the Add Source page of the Administration Tool to modify the value of the newly added advanced parameter:

    1. Select Index > Sources and Collections.

    2. Under Collections, select the collection in which you want to add the source.

    3. Under Sources, click Add.

    4. In the Add Source page, edit the newly added advanced parameter value.

  3. For an existing Lithium source, access the Source: ... General page of the Administration Tool to modify the value of the newly added advanced parameter:

    1. Select Index > Sources and Collections.

    2. Under Collections, select the collection containing the source you want to modify.

    3. Under Sources, click the existing Lithium source in which you want to modify the newly added advanced parameter.

    4. In the Source: ... General page, edit the newly added advanced parameter value.

  4. Rebuild your Lithium source to apply the changes to the parameters (see Applying an Action to a Collection or a Source).

People who viewed this topic also viewed