crawler.form_interaction.pre_crawl.[groupId].encrypted.[urlParameterKey]

Specifies an encrypted form parameter for pre-crawl authentication.

Key: crawler.form_interaction.pre_crawl.[groupId].encrypted.[urlParameterKey]
Type: ConfigPassword
Can be set in: collection.cfg

Description

Specifies a form parameter for pre-crawl authentication. Form parameters set using this option will be stored within the collection configuration in an encrypted form and also be obfuscated when viewing the parameter in the administration interface.

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

crawler.form_interaction.pre_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 groupId value common across all settings that make up the rule.

Default Value

None.

Examples

Specify the crawler to process the 2nd form of the https://www.example.com/login page with an encrypted password parameter.

crawler.form_interaction.pre_crawl.1.url=https://www.example.com/login
crawler.form_interaction.pre_crawl.1.form_number=2
crawler.form_interaction.pre_crawl.1.encrypted.password=ENCRYPTED:AV/mN4XBeymvW1yXi/Xu5tPoznug3zk98qDyYIPbGM0x93ZrFA==

⚠ Caveats

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

© 2015- Squiz Pty Ltd