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

NumberOfRefreshThreads (Integer)

Determines the number of threads used while indexing Jira Software documents. The default and recommended value is 2.

BatchSize (Integer)

Number of items to retrieve with each call to the web service. The default and recommended value is 100.

WebServiceEndpointUrl (String)

The point of contact on the Coveo Master server where a Jira Software webhook can send information to. When you have a particular setup that requires a specific endpoint, use this parameter to completely override the default web service endpoint URL (http://[CoveoMasterServer]/jira/CoveoCrawler/JiraWebHook). CES appends /JiraWebhook to the end of the parameter value. 

Example: When you change the WebServiceEndpointURL value to http://111.111.111.111, your webhook must use this URL: http://111.111.111.111/JiraWebhook (see Creating a Jira Software Webhook).

WebServiceEndpointName (String)

Name of the CES Jira Software web service endpoint for Jira Software webhooks. The default value is CoveoCrawler. When you have more than one Jira Software V2 source using the live monitoring feature, change the value of this parameter to replace the CoveoCrawler part of the default web service endpoint URL (http://[CoveoMasterServer]/jira/CoveoCrawler/JiraWebHook).

Examples:

• When you change the WebServiceEndpointName value to CoveoCrawler1, the web service endpoint URL that you specify in the Jira Software webhook becomes http://[CoveoMasterServer]/jira/CoveoCrawler1/JiraWebHook

• When you change the WebServiceEndpointName value to SecondCoveoCrawler, the web service endpoint URL that you specify in the Jira Software webhook becomes http://[CoveoMasterServer]/jira/SecondCoveoCrawler/JiraWebHook.

WebServiceEndpointUseHttps (Boolean) CES 7.0.7183+ (November 2014)

Whether the exposed secured endpoint uses an https connection between the Jira Software webhook and the crawler endpoint. The default value is false. Change the value to true when you want to make the endpoint web service endpoint secured by HTTPS.

Example: When the parameter value is set to true, the web service endpoint URL uses an https connection (https://[CoveoMasterServer]/jira/CoveoCrawler/JiraWebHook).

RetrieveThumbnails (Boolean)

Whether to retrieve thumbnails of attachments. The default value is true. However, it is not recommended to use this parameter if it does not add value to your search interface. Retrieving thumbnails takes disk space and can slow down source indexing time depending on your source size.

WebInterfaceRootUrl (String)

The URL to the Jira Software web interface containing /browse. Use that parameter when your clickable URL does not work.

Note: All item URLs must be in the http://[MyJiraServer]:[port]/browse/[ItemKey] form to work.

UseKerberosAuthentication (Boolean) Security provider CES 7.0.7711+ (June 2015)

Whether to use Kerberos authentication. The default value is false. Set it to true when crawling a Kerberos setup.

ServicePrincipalNames (String) Security provider CES 7.0.7711+ (June 2015)

The custom server principal name (SPN) to use with the Kerberos authentication. The SPN is almost always in the following format: HTTP/server.name@server.domain. If the domain name is not contained in the SPN, the connector uses the user domain, which may be wrong. Use this parameter when the crawling user identity used is not on the same domain as the Jira Software server.

Example: You use user@domain.com as the user identity to crawl http://jira.dev.domain.com.

Notes:

• This parameter is only used when the UseKerberosAuthentication parameter value is true.

• Make sure the user identity exists in both Jira Software and AD.

• When you get the following error:

  The Kerberos Authentication failed for user 'userIdentity' with the SPN 'HTTP/ServerName'.

  it means the user identity and/or the SPN are wrong.

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

To modify hidden Jira Software V2 source parameters

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

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