Specifies a form parameter for in-crawl authentication. Form parameters set using this option will be stored within the data source configuration in an encrypted form and also be obfuscated when viewing the parameter in the administration dashboard, or by viewing the configuration file directly on disk.

This setting should be used to pass any sensitive form parameters such as passwords and API keys.

crawler.form_interaction.in_crawl.[groupId].cleartext.[urlParameterKey] can be used to to specify the non-sensitive form parameters.

Encrypted values can also be generated using the admin API.

Once the value has been encrypted it is not possible to view the original value and any changes will require you to set the value again (rather than edit it).

The web crawler decrypts the values before passing them to the specified form.

Configuration parameters for a rule are grouped using a [GROUP_ID] value common across all settings that make up the rule (group ID must be a number).

This setting is used in conjunction with the crawler.form_interaction.in_crawl.[groupId].url_pattern key.

Setting the key

Set this configuration key in the search package or data source configuration.

Use the configuration key editor to add or edit the crawler.form_interaction.in_crawl.[groupId].encrypted.[urlParameterKey] key, and set the value. This can be set to any valid ConfigPassword value.

Default value

None. No in_crawl encrypted values are configured by default.


Specify the crawler to process pages with a form action of with an encrypted password parameter.



Please note: The characters = (equals) and . (period) are not permitted within the urlParameterKey.