Modifying Hidden Liferay 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 Liferay 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 Liferay sources. The parameter type (integer, string,…) appears between parentheses following the parameter name.

PluginUrl (String) CES 7.0.8047+ (December 2015)

(For Liferay 6.1 only) The URL of the Coveo Liferay 6.1 plugin. The default value is null.

Example: [[LiferayServer:Port]]/CESLiferayConnector-portlet/api/axis/Plugin_CES_LiferayConnectorService

WebServiceBatchSize (Integer)

Number of items to fetch per request made to the Liferay portal. The default value is 300. The minimum value is 1. A small value forces the connector to make small but frequent queries to Liferay. A larger value leads to larger and less frequent queries.

CacheLifeSpan (Integer) OBSOLETE CES 7.0.8047– (December 2015)

The connector keeps a local cache of all the Liferay users. This way the connector doesn't have to retrieve all users from Liferay on every full or Incremental refresh run. This parameter controls the amount of time (in minutes) this user cache will remain valid. When this delay expires, all users will be fetched again, instead of being taken out of the cache. The default value is 480 minutes (8 hours).

The amount of time (in minutes) the user cache that exists within the crawler lives. When this delay expires, all users will be fetched again, instead of being taken out of the cache. The default value is 480 minutes (8 hours).

BlogPortletId (String)
CalendarPortletId (String)
DocumentLibraryPortletId (String)
MessageBoardPortletId (String)
WikiPortletId (String)

These parameters tell the connector what is the ID of the portlet to use when creating clickable URIs for the different types of items. You must set these parameters only if your Liferay portal does not use the default values.

Example: BlogPortletId determines which portlet is used to present blogs. The default ID value is 33 for this portlet.

Note: You can find this information in the Liferay Control Panel. Under Portal, click Plugins Configuration. In the list of plugins that appears, click the desired plugin to see its information, including the Plugin ID (the information you must put in these parameters).

Languages (String)

The comma-separated list of languages to consider when retrieving Web Content. One item is returned per language. The parameter is empty by default and considers only the default portal language. Enter a * to specify all languages.

Example: en_US,fr_FR,de_DE,it_IT,ja_JP,es_ES

Note: You can find possible languages in the Liferay Control Panel. Under Portal, click Portal Settings. In the menu on the right, click Display Settings. Look in the Available Languages field for possible values.

SiteMinderFormLoginAction (String)

This parameter, along with the SiteMinderFormLoginPage parameter, is only required when Liferay resides inside a SiteMinder secure realm. These parameters enable the connector to authenticate with SiteMinder in order to gain access to the Liferay server so it can retrieve the content to index. This parameter contains the POST action that will be sent to the SiteMinder authentication form (login.fcc).

Example: USER=username&PASSWORD=password&SMAUTHREASON=0&TARGET=https%3a%2f%2fliferayportal

Note: The POST action contains four parameters: USER, PASSWORD, SMAUTHREASON, and TARGET. USER and PASSWORD are the credentials to authenticate to SiteMinder. SMAUTHREASON is always equal to zero. The TARGET parameter is the secure resource you want to access, in this case the Liferay portal URL (https://liferayportal), and must be properly escaped.

SiteMinderFormLoginPage (String)

This parameter is the URL of the SiteMinder authentication form (login.fcc).

Example: https://www.acme.com/siteminderagent/forms/login.fcc

Note: Ask your SiteMinder administrator for the URL of the authentication form.

NumberOfRefreshThreads (Integer)

This determines the number of threads that simultaneously crawl the Liferay portal. The default value is 2.

WebId (String)

This parameter determines which company to index. A company is associated with a WebId.

Note: You can find this ID in the Liferay Control Panel. Under Server, click Portal Instances, and then Web Id. There is a maximum of 1 ID per source. The default value is an empty string, which corresponds to the first WebId encountered.

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

To modify hidden Liferay source parameters

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

2. For a new Liferay 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 Liferay 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 Liferay 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 Liferay source to apply the changes to the parameters (see Applying an Action to a Collection or a Source).