ui.modern.related-document-fetch.[relatedDocumentKey].depth

Background

This option can be used to cause a 'related' related-document-fetch to be repeated a number of times, avoiding the need to manually specify a number of settings.

Related document keys will be suffixed by a number (from zero to the configured depth) representing the distance from the original result.

Please be aware that related document lookups can become slow if many are performed for a request.

Setting the key

Set this configuration key in the results page (preferred) or search package configuration.

Use the configuration key editor to add or edit the ui.modern.related-document-fetch.[relatedDocumentKey].depth key, and set the value. This can be set to any valid Integer value.

Default value

None

Examples

Given a setting of:

ui.modern.related-document-fetch.earlierMessage.type=related:previousMessage:previousMessageUrl

Adding

ui.modern.related-document-fetch.earlierMessage.depth=5

Causes the effective configuration to be equivalent to the following

ui.modern.related-document-fetch.earlierMessage0.type=related:previousMessage:previousMessageUrl
ui.modern.related-document-fetch.earlierMessage1.type=related:earlierMessage0:previousMessageUrl
ui.modern.related-document-fetch.earlierMessage2.type=related:earlierMessage1:previousMessageUrl
ui.modern.related-document-fetch.earlierMessage3.type=related:earlierMessage2:previousMessageUrl
ui.modern.related-document-fetch.earlierMessage4.type=related:earlierMessage3:previousMessageUrl
ui.modern.related-document-fetch.earlierMessage5.type=related:earlierMessage4:previousMessageUrl