reCAPTCHA Functionality System Options
List of System Options related to reCAPTCHA functionality:
- EnableReCaptcha
- AllowedReCaptchaVersions
- ReCaptchaApiUrl
- ReCaptchaVerifyUrl
- ReCaptchaVersionThreeScore
- ReCaptchaVersionThreeSecretKey
- ReCaptchaVersionThreeSiteKey
- ReCaptchaVersionTwoSecretKey
- ReCaptchaVersionTwoSiteKey
EnableReCaptcha
| Initial Build | 2017.01.23 |
| Module | Admin |
| Current Setting Type | Check Box |
Use this system option to enable or disable the reCAPTCHA functionality. Before enabling this system option, you should make sure all the related system options are configured correctly. The default for this option is false.
Note: The user must create the Secret and Site keys and then they need to enable it by configuring the system options listed in the Enabling reCAPTCHA Functionality for eWeb topic.
Current Setting
The current setting for EnableReCaptcha is used as follows:
Values: This system option can be set to true (selected check box) or false (cleared check box).
- true—Enable reCAPTCHA functionality
- false— Disable reCAPTCHA functionality
Default Value: false
Fields
This system option includes the following fields:
Description: This field gives the description of the system option, including its use and default value.
Important! Do not modify the following fields after the system option is first created. Changing these fields after they have been used can invalidate existing data.
Category: This field sets the category (usually the module) where the system option is used.
Type: The Type field determines the display type of the Current setting field (check box, drop-down list, or text box).
Values: The values field indicates the allowed values for the Current setting field.
Availability
Each system option includes the following availability settings:
Entity Level Option?: Select this check box to make this system option available on an entity level.
Visible To External Systems?: Select this check box to make this system option available in xWeb.
AllowedReCaptchaVersions
| Initial Build | 2017.01.23 |
| Module | Admin |
| Current Setting Type | Drop Down List |
Use this system option to set the version of the reCAPTCHA functionality. There are two options available currently for selection. The default for this option is empty.
Note: With the system option EnableReCaptcha set to true, if the admin user does not set the AllowedReCaptchaVersions system option and it remains empty, then the eWeb forms where reCAPTCHA functionality is implemented will display the Error Rendering reCAPTCHA message while the customer attempts to access or use eWeb.
Current Setting
The current setting for AllowedReCaptchaVersions is used as follows:
Values: This system option can be set to reCAPTCHA version V2 or V3.
- V2—The reCAPTCHA widget will appear on the page, which requires the user to select the checkbox indicating the user is not a robot. This will either pass the user immediately or challenge them to validate by asking to select specified objects or images to check whether they are human and not bot.
- V3— For this version option, no manual input is required by the user for verification. This version option is controlled by Google API, which verifies the user based on the behavior history of the user’s actions, and then the Google API scores between “0” to “1” to validate whether it is a human or a robot attempting to access. This allows the admin user to determine at what score the eWeb user would be considered a human or bot.
Default Value: empty
Fields
This system option includes the following fields:
Description: This field gives the description of the system option, including its use and default value.
Important! Do not modify the following fields after the system option is first created. Changing these fields after they have been used can invalidate existing data.
Category: This field sets the category (usually the module) where the system option is used.
Type: The Type field determines the display type of the Current setting field (check box, drop-down list, or text box).
Values: The values field indicates the allowed values for the Current setting field.
Availability
Each system option includes the following availability settings:
Entity Level Option?: Select this check box to make this system option available on an entity level.
Visible To External Systems?: Select this check box to make this system option available in xWeb.
ReCaptchaApiUrl
| Initial Build | 2017.01.23 |
| Module | Admin |
| Current Setting Type | Text Box |
Use this system option to specify the URL (Google API to implement reCAPTCHA) for setting the reCAPTCHA functionality. The default for this option is: https://www.google.com/recaptcha/api.js
Current Setting
The current setting for ReCaptchaApiUrl is used as follows:
Default Value: https://www.google.com/recaptcha/api.js
Important: Do not modify the above-mentioned value for this system option.
Fields
This system option includes the following fields:
Description: This field gives the description of the system option, including its use and default value.
Important! Do not modify the following fields after the system option is first created. Changing these fields after they have been used can invalidate existing data.
Category: This field sets the category (usually the module) where the system option is used.
Type: The Type field determines the display type of the Current setting field (check box, drop-down list, or text box).
Values: The values field indicates the allowed values for the Current setting field.
Availability
Each system option includes the following availability settings:
Entity Level Option?: Select this check box to make this system option available on an entity level.
Visible To External Systems?: Select this check box to make this system option available in xWeb.
ReCaptchaVerifyUrl
| Initial Build | 2017.01.23 |
| Module | Admin |
| Current Setting Type | Text Box |
Use this system option to specify the Google API URL to verify the reCAPTCHA. The default for this option is: https://www.google.com/recaptcha/api/siteverify
Current Setting
The current setting for ReCaptchaVerifyUrl is used as follows:
Default Value: https://www.google.com/recaptcha/api/siteverify
Important: Do not modify the above-mentioned value for this system option.
Fields
This system option includes the following fields:
Description: This field gives the description of the system option, including its use and default value.
Important! Do not modify the following fields after the system option is first created. Changing these fields after they have been used can invalidate existing data.
Category: This field sets the category (usually the module) where the system option is used.
Type: The Type field determines the display type of the Current setting field (check box, drop-down list, or text box).
Values: The values field indicates the allowed values for the Current setting field.
Availability
Each system option includes the following availability settings:
Entity Level Option?: Select this check box to make this system option available on an entity level.
Visible To External Systems?: Select this check box to make this system option available in xWeb.
ReCaptchaVersionThreeScore
| Initial Build | 2017.01.23 |
| Module | Admin |
| Current Setting Type | Text Box |
Use this system option to specify the maximum score allowed to detect a bot. This applies to the version three reCAPTCHA only. The Google API scores between “0” to “1” to verify whether actions are performed by human or robot. This allows the admin user to determine at what score the user would be considered a human or a bot. Any value near 1.0 is considered as a good traffic and value less than set value is a suspicious traffic. The default for this option is 0.5.
Current Setting
The current setting for ReCaptchaVersionThreeScore is used as follows:
Values: This system option can be set to a maximum score allowed to detect a bot using the Current Setting field.
Default Value: 0.5
Fields
This system option includes the following fields:
Description: This field gives the description of the system option, including its use and default value.
Important! Do not modify the following fields after the system option is first created. Changing these fields after they have been used can invalidate existing data.
Category: This field sets the category (usually the module) where the system option is used.
Type: The Type field determines the display type of the Current setting field (check box, drop-down list, or text box).
Values: The values field indicates the allowed values for the Current setting field.
Availability
Each system option includes the following availability settings:
Entity Level Option?: Select this check box to make this system option available on an entity level.
Visible To External Systems?: Select this check box to make this system option available in xWeb.
ReCaptchaVersionThreeSecretKey
| Initial Build | 2017.01.23 |
| Module | Admin |
| Current Setting Type | Text Box |
Use this system option to specify the version three secret key used by Google API to implement the reCAPTCHA functionality. The default for this option is empty.
To generate the site and secret key for reCAPTCHA, refer the topic Creating the Site and Secret Keys for Versions V2 and V3.
Current Setting
The current setting for ReCaptchaVersionThreeSecretKey is used as follows:
Values: This system option can be set to a valid Secret key.
Default Value: empty
Fields
This system option includes the following fields:
Description: This field gives the description of the system option, including its use and default value.
Important! Do not modify the following fields after the system option is first created. Changing these fields after they have been used can invalidate existing data.
Category: This field sets the category (usually the module) where the system option is used.
Type: The Type field determines the display type of the Current setting field (check box, drop-down list, or text box).
Values: The values field indicates the allowed values for the Current setting field.
Availability
Each system option includes the following availability settings:
Entity Level Option?: Select this check box to make this system option available on an entity level.
Visible To External Systems?: Select this check box to make this system option available in xWeb.
ReCaptchaVersionThreeSiteKey
| Initial Build | 2017.01.23 |
| Module | Admin |
| Current Setting Type | Text Box |
Use this system option to specify the version three site key used by Google API to implement the reCAPTCHA functionality. The default for this option is empty.
To generate the site and secret key for reCAPTCHA, refer the topic Creating the Site and Secret Keys for Versions V2 and V3.
Current Setting
The current setting for ReCaptchaVersionThreeSiteKey is used as follows:
Values: This system option can be set to a valid Site key.
Default Value: empty
Fields
This system option includes the following fields:
Description: This field gives the description of the system option, including its use and default value.
Important! Do not modify the following fields after the system option is first created. Changing these fields after they have been used can invalidate existing data.
Category: This field sets the category (usually the module) where the system option is used.
Type: The Type field determines the display type of the Current setting field (check box, drop-down list, or text box).
Values: The values field indicates the allowed values for the Current setting field.
Availability
Each system option includes the following availability settings:
Entity Level Option?: Select this check box to make this system option available on an entity level.
Visible To External Systems?: Select this check box to make this system option available in xWeb.
ReCaptchaVersionTwoSecretKey
| Initial Build | 2017.01.23 |
| Module | Admin |
| Current Setting Type | Text Box |
Use this system option to specify the version two secret key used by Google API to implement the reCAPTCHA functionality. The default for this option is empty.
To generate the site and secret key for reCAPTCHA, refer the topic Creating the Site and Secret Keys for Versions V2 and V3.
Current Setting
The current setting for ReCaptchaVersionTwoSecretKey is used as follows:
Values: This system option can be set to a valid Secret key.
Default Value: empty
Fields
This system option includes the following fields:
Description: This field gives the description of the system option, including its use and default value.
Important! Do not modify the following fields after the system option is first created. Changing these fields after they have been used can invalidate existing data.
Category: This field sets the category (usually the module) where the system option is used.
Type: The Type field determines the display type of the Current setting field (check box, drop-down list, or text box).
Values: The values field indicates the allowed values for the Current setting field.
Availability
Each system option includes the following availability settings:
Entity Level Option?: Select this check box to make this system option available on an entity level.
Visible To External Systems?: Select this check box to make this system option available in xWeb.
ReCaptchaVersionTwoSiteKey
| Initial Build | 2017.01.23 |
| Module | Admin |
| Current Setting Type | Text Box |
Use this system option to specify the version two site key used by Google API to implement the reCAPTCHA functionality. The default for this option is empty.
To generate the site and secret key for reCAPTCHA, refer the topic Creating the Site and Secret Keys for Versions V2 and V3.
Current Setting
The current setting for ReCaptchaVersionTwoSiteKey is used as follows:
Values: This system option can be set to a valid Site key.
Default Value: empty
Fields
This system option includes the following fields:
Description: This field gives the description of the system option, including its use and default value.
Important! Do not modify the following fields after the system option is first created. Changing these fields after they have been used can invalidate existing data.
Category: This field sets the category (usually the module) where the system option is used.
Type: The Type field determines the display type of the Current setting field (check box, drop-down list, or text box).
Values: The values field indicates the allowed values for the Current setting field.
Availability
Each system option includes the following availability settings:
Entity Level Option?: Select this check box to make this system option available on an entity level.
Visible To External Systems?: Select this check box to make this system option available in xWeb.