Documentation AEM as a Cloud Service User Guide

Connect AEM Forms as a Cloud Service with Adobe Acrobat Sign integrate-adobe-sign-with-aem-forms

Last update: Wed Apr 03 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

Intermediate
Admin
User

Version

Article link

AEM 6.5

Click here

AEM as a Cloud Service

This article

Adobe Acrobat Sign enables e-signature workflows for Adaptive Forms and AEM Workflows. 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
Connect AEM Forms with Adobe Acrobat Sign Solutions for Government

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 configure the Adobe Sign Cloud Service in your Forms as a Cloud Service Author and Publish instances:

Prerequisites to connect AEM Forms with Adobe Acrobat Sign prerequisites-for-adobe-sign

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

An active Adobe Acrobat Sign developer account.
An Adobe Acrobat Sign API application.
Credentials (Client ID and Client Secret) of Adobe Acrobat Sign API application.
(Only for Government ID-based authentication) Enable the authentication method for Government ID authentication.

Connect AEM Forms Author and publish instances with Adobe Acrobat Sign configure-adobe-sign-with-aem-forms

After prerequisites are in place, perform the following steps to configure Adobe Acrobat Sign with AEM Forms on the Author instances.

On AEM Forms author instance, navigate to Tools > General > Configuration Browser.
On the Configuration Browser page, select Create.
In the Create Configuration dialog, specify a Title for the configuration, enable Cloud Configurations, and select Create. It creates a configuration container to store Cloud Services. Ensure that the folder name does not contain any space.

Navigate to Tools > Cloud Services > Adobe Acrobat Sign and open the configuration container you created in the previous step.

note note
NOTE
When you create an Adaptive Form, specify the container name in the Configuration Container field.

On the configuration page, select Create to create Adobe Acrobat Sign configuration in AEM Forms.
In the General tab of the Create Adobe Acrobat 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.
Now you can Select solution to select Adobe Acrobat Sign.
Copy the URL present 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. Select Next.

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.

Configure OAuth settings for the Adobe Acrobat Sign application:
1. Open a browser window and sign in to your Adobe Acrobat Sign developer account.
2. Select the application configured for AEM Forms, and select Configure OAuth for Application.
3. In the Redirect URL box, add the URL copied in a previous step (Step 8) and click Save.
4. Enable the following Scope for the Adobe Acrobat Sign application and click Save.
- aggrement_read
- aggrement_write
- aggrement_send
- widget_read
- widget_write
- workflow_read
For step-by-step information to configure OAuth settings for an Adobe Acrobat Sign application and obtain the keys, see Configure oAuth settings for the application developer documentation.
Go back to the Create Adobe Acrobat 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 Acrobat Sign application you created in the previous step.
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.
Select Connect to Adobe Acrobat 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 your developer account, 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.
Select Create to create the Adobe Acrobat Sign configuration.
Select the configuration and click Publish, select the configuration, and click Publish. It replicates the configuration to corresponding publish environments.
Repeat all the above steps on your developer, stage, and production instances (whichever left) to complete configuring Adobe Acrobat Sign with AEM Forms for your environment.

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

NOTE

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

Troubleshooting resolve-config-error

When you connect Adobe Acrobat Sign with AEM Forms and find an error Unable to authorize access because the client configuration is invalid: invalid_request as shown in the image below. You resolve this by following the steps given below:

Configuration error

Copy the URL present in your current browser window to a notepad and remove the part /ui#/aem from the URL.
Open a browser window and sign in to your Adobe Acrobat Sign developer account.
Select the application configured for AEM Forms, and select Configure OAuth for Application.
In the Redirect URL box, add the URL copied in a previous step and click Save.

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 Sign Government Workflow

AEM Forms as a Cloud Service provides development, stage, and production environments. You can start with connecting your development environment for with Adobe Acrobat Sign Solutions for Government and connect the stage and production environments later.

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

Before you start connecting AEM Forms with Adobe Acrobat Sign Solution, ensure that your Adobe Acrobat Sign Solutions for Government account is provisioned.

Connect AEM Forms as a Cloud Service with Adobe Acrobat Sign Solutions for Government connect-adobe-acrobat-sign-for-government

Create a redirect URL for your AEM instance

On the Forms as a Cloud Service author instance, navigate to Tools > General > Configuration Browser.
On the Configuration Browser page, select Create.
In the Create Configuration dialog, specify a Title for the configuration, enable Cloud Configurations, and select Create. It creates a configuration container to store Cloud Services. Ensure that the folder name does not contain any space.
Navigate to Tools > 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.
On the configuration page, select Create to create Adobe Acrobat Sign configuration in AEM Forms.
Copy the URL of your current browser window to a notepad and remove /ui#/aem 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).

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 allow you to 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

aggrement_read
aggrement_write
aggrement_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

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.
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.
In the Settings tab of the Create Adobe Sign Configuration page, for the Select solution option, select Adobe Acrobat Sign Solutions for Government.
In the Email filed, specify the email address associated with your Adobe Acrobat Sign Solutions for Government account.

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.

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].
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.
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 your developer account, 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.
Select Create to create the configuration.
Select the configuration and click Publish, select the configuration, and click Publish. It replicates the configuration to the corresponding publish environments.
Repeat all the above steps on your developer, stage, and production instances (whichever left) to complete configuring Adobe Acrobat Sign Solutions for Government with AEM Forms for your environment.

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 Acrobat Sign scheduler to sync the signing status configure-adobe-sign-scheduler-to-sync-the-signing-status

AEM Forms as a Cloud Service, provides a scheduler service that checks the status of signers at defined intervals. The scenarios in which you configure the scheduler service:

If you use Submit the form (after every recipient completes signing ceremony) to sign a document, the form is submitted only after all signers have signed the form.
If you use the Sign Step in an AEM Workflow to sign a document, the sign step waits for all the signers to sign the document, before proceeding to the next step of the workflow.

By default, the Adobe Acrobat Sign Scheduler services checks (polls) signer response after every 24 hours. You can change the default interval for your environment.

To change the default interval, specify a cron expression for the sign.status.exp property of the Adobe Acrobat Sign Configuration Service configuration.

For example, to run the configuration service daily at 00:00 am, set the sign.status.exp property of the Adobe Acrobat Sign Configuration Service configuration to specify 0 0 0 1/1 * ? *. The following JSON file displays the sample to run the configuration service daily at 00:00 am:

{
  "sign.status.exp":"0 0 0 1/1 * ? *"
}

To set values of a configuration, Generate OSGi Configurations using the AEM SDK, and deploy the configuration to your Cloud Service instance.

recommendation-more-help

fbcff2a9-b6fe-4574-b04a-21e75df764ab