Connect your AEM Forms environment with hCaptcha® :headding-anchor:connect-your-forms-environment-with-hcaptcha-service

This feature is under Early Adopter Program. You can write to aem-forms-ea@adobe.com from your official email id to join the early adopter program and request access to the capability.

CAPTCHA (Completely Automated Public Turing test to tell Computers and Humans Apart) is a program commonly used in online transactions to distinguish between humans and automated programs or bots. It poses a challenge and evaluates user response to determine if it’s a human or a bot interacting with the site. It prevents the user to proceed if the test fails and helps make online transactions secure by keeping bots from posting spam or malicious purposes.

AEM Forms as a Cloud Service supports the following CAPTCHA solutions:

Integrate AEM Forms environment with hCaptcha Captcha

hCaptcha® service protects your forms from bots, spam, and automated abuse. It poses a checkbox widget challenge and evaluates the user response to determine if it’s a human or a bot interacting with the form. It prevents the user to proceed if the test fails and helps make online transactions secure by keeping bots from posting spam or malicious activities.

AEM Forms as a Cloud Service supports hCaptcha® in Adaptive Forms Core Components. You can use it to present a checkbox widget challenge on form submission.

Prerequisites to integrate AEM Forms environment with hCaptcha® :headding-anchor:prerequisite

To configure hCaptcha® with AEM Forms, you need to obtain the hCaptcha® sitekey and secret key from the hCaptcha® website.

Steps to configure hCaptcha® :headding-anchor:steps-to-configure-hcaptcha

  1. Create a Configuration Container on your AEM Forms as a Cloud Service environment. A Configuration Container holds Cloud Configurations used to connect AEM to external services. To create and configure a Configuration Container to connect your AEM Forms environment with hCaptcha®:

    1. Open your AEM Forms as a Cloud Service instance.

    2. Go to Tools > General > Configuration Browser.

    3. In the Configuration Browser, you can select an existing folder or create a folder. You can create a folder and enable the Cloud Configurations option for it or enable the Cloud Configurations option for an existing folder:

      • To create a folder and enable the Cloud Configurations option for it:

        1. In the Configuration Browser, click Create.
        2. In the Create Configuration dialog, specify a name, title, and select the Cloud Configurations option.
        3. Click Create.
      • To enable the Cloud Configurations option for an existing folder:

        1. In the Configuration Browser, select the folder and select Properties.
        2. In the Configuration Properties dialog, enable Cloud Configurations.
        3. Select Save & Close to save the configuration and exit the dialog.
  2. Configure the Cloud Service:

    1. On your AEM author instance, go to tools-1 > Cloud Services and select hCaptcha®.
      hCaptcha in ui

    2. Select a Configuration Container, created or updated, as described in the previous section. Select Create.
      Configuration hCaptcha

    3. Specify Title, Name, Site Key, and Secret Key for hCaptcha® service obtained in prerequisite. Select Create.

      Configure the Cloud Service to connect your AEM Forms environment with hCaptcha

NOTE
Users need not to modify Client-side JavaScript validation URL and Server-side validation URL as they are already prefilled for hCaptcha® validation. For some countries, the endpoints may differ, visit hCaptcha® FAQs for more information.

Once the hCAPTCHA service is configured, it is available for use in an Adaptive Form.

Use hCaptcha® in an Adaptive Form{#using-hCaptcha®-foundation-components}

  1. Open your AEM Forms as a Cloud Service instance.

  2. Go to Forms > Forms and Documents.

  3. Select an Adaptive Form and select Properties. For the Configuration Container option, select the Configuration Container that contains the Cloud Configuration that connects AEM Forms with hCaptcha®, and select Save & Close.

    If you do not have such a Configuration Container, see section Connect your AEM Forms environment with hCaptcha® to learn how to create a Configuration Container.

    Select Configuration Container

  4. Select an Adaptive Form and select Edit. The Adaptive Form opens in Adaptive Forms Editor.

  5. From the component browser, drag-drop the Captcha component onto the Adaptive Form.

  6. Select the Captcha component and click on properties Properties icon icon. It opens the properties dialog.

    alt text

    Specify the following properties:

    • Title: Specify the title for your Captcha component, you can identify a form component easily with its unique name both in the form and in the rule editor.

    • Validation Message: Provide a validation message for your Captcha validation on form submission.

    • Validate Captcha: You can select one of the options to validate Captcha:

      • At form Submission
      • On a user action.
    • Captcha Service: Select your Captcha service, here you select hCaptcha® service.

    • Captcha Configuration: Select a Cloud Configuration configured for hCaptcha®.

      note note
      NOTE
      You can have multiple Cloud Configurations in your environment for a similar purpose. So, choose the service carefully. If no service is listed, see Connect your AEM Forms environment with hCaptcha® to learn how to create a Cloud Service that connects your AEM Forms environment with hCaptcha® service.
    • Error Message: Provide the error message to display to the user when the Captcha submission fails.

    • Captcha Size: You select the display size of the hCaptcha® challenge dialog. Use the Compact option to display a small sized and the Normal option to display a relatively large-size hCaptcha® challenge dialog or Invisible to validate hCaptcha® without explicitly rendering the checkbox widget on the user interface.

  7. Select Done.

Now, only legitimate forms, in which the form filler successfully clears the challenge posed by the hCaptcha® service are allowed for the form submission.

hCaptcha® is a registered trademark of Intuition Machines, Inc.

Frequently Asked Questions

  • Q: Can I use more than one Captcha component in an Adaptive Form?
  • Ans: Using more than one Captcha component in an Adaptive Form is not supported. Also, it is not recommended to use a Captcha component in a fragment or a panel marked for lazy loading.

See Also :headding-anchor:see-also

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab