DocumentationAEM 6.5User Guide

Integrate Adobe Sign with AEM Forms integrate-adobe-sign-with-aem-forms

Last update: Tue Dec 12 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Adobe recommends using the modern and extensible data capture Core Componentsfor creating new Adaptive Formsor adding Adaptive Forms to AEM Sites pages. These components represent a significant advancement in Adaptive Forms creation, ensuring impressive user experiences. This article describes older approach to author Adaptive Forms using foundation components.

Version
Article link
AEM as a Cloud Service
Click here
AEM 6.5
This article

Adobe Sign enables e-signature workflows for adaptive forms. E-signatures improve workflows to process documents for legal, sales, payroll, human resource management, and many more areas.

In a typical Adobe Acrobat Sign and Adaptive Forms scenario, a user fills an Adaptive Form to apply for a service. For example, a credit card application and a citizen benefits form. When a user fills, submits, and signs the application form, the form is sent to the service provider for further action. Service provider reviews the application and uses Adobe Acrobat Sign to mark the application approved. AEM Forms supports both Adobe Acrobat Sign and Adobe Acrobat Sign Solutions for Government. Depending on your license and requirements, you can integrate or connect AEM Forms with either of the solution:

Connect AEM Forms with Adobe Acrobat Sign adobe-sign

To connect AEM Forms with Adobe Acrobat Sign, set up the software and accounts listed in the prerequisites section, and connect Adobe Sign to your all the AEM Forms Author and Publish instances:

Prerequisites prerequisites

You require the following to integrate Adobe Sign with AEM Forms:

Configure Adobe Sign with AEM Forms configure-adobe-sign-with-aem-forms

After prerequisites are in place, perform the following steps to configure Adobe Sign with AEM Forms on the Author instance:

  1. On AEM Forms author instance, navigate to Tools hammer > General > Configuration Browser.

  2. On the Configuration Browser page, select Create.

  3. In the Create Configuration dialog, specify a Title for the configuration, enable Cloud Configurations, and select Create. It creates a configuration container.

  4. Navigate to Tools hammer > Cloud Services > Adobe Sign and select the configuration container you created in the above step.

    note note
    NOTE
    You can either execute steps 1-4 to create a configuration container and create an Adobe Sign configuration in the container or use the existing global folder in Tools hammer > Cloud Services > Adobe Sign. If you create the configuration in the new configuration container, ensure to specify the container name in the Configuration Container field when you create an Adaptive Form.
    note note
    NOTE
    Ensure that the URL of the Cloud Services Configuration Page starts with HTTPS. If not, enable SSL for AEM Forms server.

  5. On the configuration page, tap Create to create Adobe Sign configuration in AEM Forms.

  6. In the General tab of the Create Adobe Sign Configuration page, specify a Name for the configuration and tap Next. You can optionally specify a title and browse to select a thumbnail for the configuration.

  7. Now you can Select solution to select Adobe Acrobat Sign.

    Adobe Acrobat Sign Solutions

  8. Copy the URL in your current browser window to a notepad and remove the part /ui#/aem from the URL. The modified URL is then required to configure Adobe Acrobat Sign application with AEM Forms, in a later step. Tap Next.

  9. In the Settings tab,

    • the OAuth URL field contains the default URL which includes the Adobe Sign database shard. The format of the URL is:

      https://<shard>/public/oauth/v2

      For example:
      https://secure.na1.echosign.com/public/oauth/v2

    • the Access token URL field contains the default URL which includes the Adobe Sign database shard. The format of the URL is:

      https://<shard>/oauth/v2/token

      For example:
      https://api.na1.echosign.com/oauth/v2/token

    where:

    na1 refers to the default database shard. You can modify the value for the database shard. Ensure that the Adobe Acrobat Sign Cloud Configurations point to the correct Shard.

    note note
    NOTE
    • Keep the Create Adobe Acrobat Sign Configuration page open. Do not close it. You can retrieve Client Id and Client Secret after configuring OAuth settings for the Adobe Acrobat Sign application as described in upcoming steps.
    • After logging in your Adobe Sign account,navigate to Acrobat Sign API > API Information > REST API Methods Documentation > OAuth Access Token to access information related to Adobe Sign OAuth URL and Access Token URL.

  10. Configure OAuth settings for the Adobe Sign application:

    1. Open a browser window and sign in to the Adobe Sign developer account.

    2. Select the application configured for AEM Forms, and select Configure OAuth for Application.

    3. Copy the Client ID and Client Secret to a notepad.

    4. In the Redirect URL box, add the HTTPS URL copied in the previous step.

    5. Enable the following OAuth settings for the Adobe Sign application and click Save.

    • agreement_read
    • agreement_write
    • agreement_send
    • widget_write
    • workflow_read

    For step-by-step information to configure OAuth settings for an Adobe Sign application and obtain the keys, see Configure oAuth settings for the application developer documentation.

    OAuth Config

  11. Go back to the Create Adobe Sign Configuration page. In the Settings tab, specify the Client ID (also referred to as Application ID) and Client Secret. Use the Client ID and Client Secret of Adobe Sign application created for AEM Forms.

  12. Select the Enable Adobe Sign for attachments also option to append files attached to an adaptive form to the corresponding Adobe Sign document sent for signing.

  13. Select Connect to Adobe Sign. When prompted for credentials, provide username and password of the account used while creating Adobe Sign application.

    Adobe Acrobat Sign Cloud Configuration Success

  14. Tap Create to create the Adobe Sign configuration.

  15. Open AEM Web Console. The URL is https://'[server]:[port]'/system/console/configMgr

  16. Open Forms Common Configuration Service.

  17. In the Allow field, select All users - All the users, anonymous or logged in, can preview attachments, verify and sign forms, and click Save. Author instance is configured to use Adobe Sign.

  18. Publish the configuration.

  19. Use replication to create identical configuration on corresponding publish instances.

Now, Adobe Sign is integrated with AEM Forms and ready for use in adaptive forms. To use Adobe Sign service in an adaptive form, specify the configuration container created above in adaptive form properties.

NOTE
To configure the Adobe Sign sandbox, you can follow the same configuration steps as explained in Adobe Sign.

Connect AEM Forms with Adobe Acrobat Sign Solutions for Government adobe-acrobat-sign-for-government

Connecting AEM Forms with Adobe Acrobat Sign Solutions for Government is a multi-step process. It involves:

  • Creating redirect URL for your AEM instances
  • Sharing the redirect URL and scopes with Adobe Sign Solutions for Government team
  • Receiving credentials from Adobe Sign team
  • Using the received credentials to connect AEM Forms with Adobe Acrobat Sign Solutions for Government

adobe-acrobat-sign-govt-workflow

Before you start prerequisites-for-adobe-sign-for-acrobat-sign-for-government

Before you start connecting AEM Forms with Adobe Acrobat Sign Solution,

Connect AEM Forms to Adobe Acrobat Sign Solutions for Government connect-adobe-acrobat-sign-for-government

Create a redirect URL for your AEM instance

  1. On your AEM Forms instance, navigate to Tools hammer > General > Configuration Browser.

  2. On the Configuration Browser page, select Create.

  3. In the Create Configuration dialog, specify a Title for the configuration, enable Cloud Configurations, and select Create. It creates a configuration container. Ensure that the container/folder name does not contain any space.

  4. Navigate to Tools hammer > Cloud Services > Adobe Acrobat Sign and open the configuration container you created in the previous step. When you create an Adaptive Form, specify the container name in the Configuration Container field.

  5. On the configuration page, select Create to create Adobe Acrobat Sign configuration in AEM Forms.

  6. Copy the URL of your current browser window to a notepad from the URL. This URL is referred as re-direct URL. In the next section, you share the re-direct URL and Scopes with Adobe Sign team and request credentials (Client Id and Client Secret).

NOTE
  • A re-direct URL should contain a Top-level domain. For example, https://adobe.com/libs/adobesign/cloudservices/adobesign/createcloudconfigwizard/cloudservices.html/conf/global
  • Do not use a local URL as a re-direct URL. For example, https://localhost:4502/libs/adobesign/cloudservices/adobesign/createcloudconfigwizard/cloudservices.html/conf/global.

Share the redirect URL and scopes with Adobe Sign team and receive credentials

Adobe Acrobat Sign for Government Solutions team requires the re-direct URL and the certain scopes to be enabled for your Adobe Acrobat Sign application (listed below) to generate credentials (Client Id and Client Secret) that let you connect AEM Forms with Adobe Acrobat Sign Solutions for Government.

Share the scopes (listed below) and the re-direct URL created and noted down the last step of previous section with your Adobe Acrobat Sign for Government Solution representative Adobe Professional Services team member.

Scopes

  • agreement_read
  • agreement_write
  • agreement_send
  • widget_read
  • widget_write
  • workflow_read
  • offline_access

The representative generates and shares credentials with you. In the next section, you use the credentials (Client Id and Client Secret) to connect AEM Forms with Adobe Acrobat Sign Solutions for Government.

Use the received credentials to connect AEM Forms with Adobe Acrobat Sign Solutions for Government

  1. Open the re-direct URL in your browser. You created and noted down the re-direct URL in the last step of the create a redirect URL on your AEM instance section.

  2. In the General tab of the Create Adobe Sign Configuration page, specify a Name for the configuration, and select Next. You can optionally specify a Title and browse to select a Thumbnail for the configuration. Click Next.

  3. In the Settings tab of the Create Adobe Sign Configuration page, for the Select solution option, select Adobe Acrobat Sign Solutions for Government.

    Adobe Acrobat Sign Solutions for Government

  4. In the Email field, specify the email address associated with your Adobe Acrobat Sign Solutions for Government account.

  5. In the Settings tab,

    • the OAuth URL field contains the default URL which includes the Adobe Sign database shard. The format of the URL is:

      https://<shard>/api/gateway/adobesignauthservice/api/v1/authorize

      For example:
      https://secure.na1.adobesign.us/api/gateway/adobesignauthservice/api/v1/authorize

    • the Access token URL field contains the default URL which includes the Adobe Sign database shard. The format of the URL is:

      https://<shard>/api/gateway/adobesignauthservice/api/v1/token

      For example:
      https://secure.na1.adobesign.us/api/gateway/adobesignauthservice/api/v1/token

    where:

    na1 refers to the default database shard. You can modify the value for the database shard. Ensure that the Adobe Acrobat Sign Cloud Configurations point to the correct Shard.

    note note
    NOTE
    • After logging in your Adobe Sign account,navigate to Acrobat Sign API > API Information > REST API Methods Documentation > OAuth Access Token to access information related to Adobe Sign oAuth URL and Access Token URL.

  6. Use the credentials shared by Adobe Acrobat Sign for Government Solution representative ([Adobe Professional Services team member]) in the previous section as [Client ID and Client Secret].

  7. Select the Enable Adobe Acrobat Sign for attachments option to append files attached to an Adaptive Form to the corresponding Adobe Acrobat Sign document sent for signing.

  8. Select Connect to Adobe Sign. When prompted for credentials, provide username and password of the account used while creating Adobe Acrobat Sign application. When asked to confirm access for Adobe Acrobat Sign for Government Solutions and , click Allow Access. If the credentials are correct and you allow AEM Forms to access your Adobe Acrobat Sign developer account, a success message similar to the following appears.

    Adobe Acrobat Sign Cloud Configuration Success

    When prompted for credentials, provide username and password of the account used while creating Adobe Acrobat Sign application. When asked to confirm access for your account, and click Allow Access.

  9. Select Create to create the configuration.

  10. Open AEM Web Console. The URL is https://'[server]:[port]'/system/console/configMgr

  11. Open Forms Common Configuration Service.

  12. In the Allow field, select All users - All the users, anonymous or logged in, can preview attachments, verify and sign forms, and click Save. Author instance is configured to use Adobe Sign.

  13. Publish the configuration.

  14. Use replication to create identical configuration on corresponding publish instances.

Now, you can use add Adobe Acrobat Sign fields in an Adaptive Form or AEM Workflow. Ensure that you add the configuration container used for the Cloud Service configuration to all the Adaptive Forms being enabled for Adobe Acrobat Sign. You can specify a configuration container from the properties of an Adaptive Form.

Configure Adobe Sign scheduler to sync the signing status configure-adobe-sign-scheduler-to-sync-the-signing-status

An Adobe Sign enabled adaptive form is submitted only after all the signers complete the signing process. By default, the Adobe Sign Scheduler services is scheduled to check (poll) signer response after every 24 hours. You can change the default interval for your environment. Perform the following steps to change the default interval:

  1. Log in to AEM Forms server with admin credentials and navigate to Tools > Operations > Web Console.

    You can also open the following URL in a browser window:
    https://[localhost]:'port'/system/console/configMgr

  2. Locate and open the Adobe Sign Configuration Service option. Specify a cron expression in the Status Update Scheduler Expression field and click Save. For example, to run the configuration service daily at 00:00 am, specify 0 0 0 1/1 * ? * in the Status Update Scheduler Expression field.

Default interval to sync status of Adobe Sign is now changed.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2