Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This article describes the setup process that an administrator should follow to integrate a KB with AdobeSign. To use Adobe Sign for contract management and other eSigning requirements, see Manage Documents with Adobe Sign. To set up AdobeSign, you must complete the Integration wizard, as well as have an existing AdobeSign account.

...

Info
titlePrerequisites

You need an Adobe Sign developer or production account that has been configured with the correct web settings to allow private messaging and user-specified routing order, and has all the users you want to add. 

Prepare Adobe Sign Account

This setup assumes that you already have an Adobe Sign production account that has been configured with the correct web settings to allow private messaging and user-specified routing order, and has all the users you want to add.

First, create the application in Adobe Sign:

  1. Log in to the your Adobe Sign account at the Adobe Sign Login Page and follow their instructions to create a new API application.
    1. Add a name and a display name, and then select a domain. If you plan to use Adobe Sign internally only, select the Customer domain.
    2. Click Save. The application appears in the list.
  2. Select the application and click Configure OAuth for Application.
    API Application setup window showing OAuth configuration buttonImage Added
  3. In Redirect URI, enter: https://adobesign.agiloft.com/extension/as/signrp
  4. Enable all of the scopes listed, set the Modifier to account, and click Save. If you prefer to limit access to specific group membership, select group instead of account for the Modifier.
  5. Open the Adobe application settings for viewing while you configure the knowledgebase integration, taking note of the Application ID and Client Secret string values. You need these values later in the setup. 
Warning

After you create the API application, do not change the values. If you need to make changes, delete the application and create a new one. Editing an existing application often produces errors, and might prevent you from using it at all.

Now, before moving on, if you created your application in the Partner domain in step 1, we recommend that you certify your application. This makes sure you have have full and unlimited access to the account features. The certification status is visible at the bottom of the View/Edit screen of the application.

Certification Status: UNCERTIFIED messageImage Added

If the account is uncertified, you must enable these options:

  1. Select Account > Account Settings > Security Settings.
  2. Ensure that these options are both selected under the API heading:
    • Allow Uncertified partner applications to access data from this account
    • Allow users who aren't account administrators to develop applications that use the Adobe Sign API

Register Account with Agiloft

Follow the process below to set up AdobeSignAdobe Sign in Agiloft.

  1. Navigate to the Setup gear icon and click Integration. Look under the Adobe Sign heading.
  2. Click Configure and proceed to step 3. However, if the button is labeled Deploy:
      1. Click Deploy to deploy the Adobe Sign configuration elements to the KB.
      2. Click OK on the message that appears. The system adds all the necessary configuration elements, which may take a few minutes. When complete, proceed to step 3.
  3. In the Adobe Sign wizard, select an Email field from the People table. For example, you might use the Email field for the user's primary email, or a dedicated Email field like Adobe Sign Sending Account. This is used to identify the sender . The field determines and determine whether you send agreements from a single account or multiple accounts.Image Removed
  4. Anchor
    registeraccount
    registeraccount
    Click Register a New Account. This opens the Adobe Sign Licensing Portal in Agiloft.

...

  1. On the main Account screen, select the account type. Adobe Sign Developer accounts can be created specifically for testing purposes. When creating a testing account, register a separate account from the main account you intend to use for production.

...

  1. We recommend first creating the Developer account for testing, as this can be changed to a Production account when testing is complete. For more information about moving from a Developer account to a Production account,

...

  1. see Transition to Production Environment.
    • Development accounts are used for testing. Documents produced by this account type include watermarks and are not intended for actual production use. 
    • Production accounts are used in live environments

...

    • Image Added
  1. Enter the account email address. Your Adobe Sign account email address must be unique to the current KB due to requirements in licensing. If you enter an email address already being used in another KB, you receive an error message and are unable integrate your account. It is best to use an admin or system account for this address rather than an end user account.

...

After you have determined your account type, proceed in the Adobe Sign Licensing Portal that appears after clicking Register a New Account:

  1. Confirm Use OAuth2.0 Type 2 is set to Yes.
  2. Verify

  3. On the main Account screen, select whether the account is either Development (for testing) or Production (for a live environment). Note that documents produced by a Development account have watermarks. Selecting Production also adds the 'Notify when Number of Available Agreements is less than' field, which is explained below. 
    Image Removed
  4. Choose either to link an existing Adobe Sign account or to create a new one.

    If you select "I already have an Adobe Sign account":

    First, verify

    your server URL. In

    a separate

    your browser tab or window

    , go

    still logged in to

    the , log in with the email and password for your Adobe Sign account, and

    Adobe Sign

    Login Page

    , copy the domain name from the address bar, including the .com in the address. For example, your domain might be something like example.adobesign.com.

  5. Go back to the Account screen in
    Companyname
    Agiloft and ensure that the server URL you copied matches the URL in the "Adobe Sign account server URL" field. If it doesn't, replace the old URL with the one you just copied .
  6. If you are creating a Production account, choose to use agreements purchased through Adobe. Then, pause here and go complete the steps to Use Your Existing Adobe Sign Account with Agiloft
  7. Enter the remaining account details on the Account screen in
    Companyname
    .
  8. Proceed to step 4.
  9. If you select "I want to create a new Adobe Sign account", enter an email address for
    Companyname
    notifications. If you are creating a Production account, you can enter a number in the "Notify When Number of Available Agreements is Less Than" field. This field notifies you via email when that condition is met. We recommend using an admin account for this address, and it may be the same as your Adobe Sign account email address.
  10. For new Adobe Sign accounts, select Use OAuth2.0 Type 2.
  11. step 8.
  12. Enter the Application ID and Client Secret.
  13. Enter the name and company information you want to show on your Complete the other required fields with the information you want to display on agreements. Remember that if you plan to use a single shared account, the name you enter here is shown on all agreements sent from 
    Companyname
    from Agiloft.
  14. Accept the Adobe Sign terms and conditions.

  15. Click Save and Click Save and close the account screen. 
  16. If you selected to use an existing Adobe Sign account in step 2, proceed to the Grant Access to the Account section. If you selected to create a new Adobe Sign account in step 2, click Manage Account and follow the substeps below, and then proceed to the Grant Access to the Account section.
    1. In a separate browser tab or window, go to the Adobe Sign Login Page.
    2. Enter the email and password for your Adobe Sign account. These are the credentials you chose a few moments ago when you set up your account in 
      Companyname
      .
    3. When you log in, follow the given instructions to check your email and verify your account.
    4. After your account is verified, go to your account page and copy the server URL from the address bar, which includes everything up to and including the ".com" in the address. For example, your sever URL might be something like https://agiloftdev.na3.echosign.com.
      Image Removed
    5. Go back to the Account screen in 
      Companyname
      , click Edit, and replace the default server URL in the Adobe Sign Account Server URL field with your server URL. Then, replace echosign with adobesign. For example, https://agiloftdev.na3.echosign.com becomes https://agiloftdev.na3.adobesign.com.
    6. Click Save and then close the Account screen.

...

Finally, return to the main Agiloft browser window, which should still be on the Adobe Sign setup wizard.

  1. Back in the Agiloft Adobe Sign setupIn the Adobe Sign wizard, click Proceed with Account Setup.

  2. In the Knowledge Base Server URL field, enter the first part of the URL in your current address bar. This is usually something like https://companyname.agiloft.com. Do not include a slash (/) at the end of the URL.

  3. Click Grant Access to Adobe Sign Connect. This opens the Adobe Sign page where you can log in and grant access to the knowledgebase using your Adobe Sign credentials. 

    Note

    If you receive an error message in

    Companyname
    that your account is not authorized or similar, check your settings and try to reconnect. 

  4. For new accounts, you might need to click an email verification link if you didn't previously verify your account. Otherwise, if the login attempt is unsuccessful for any reason, navigate back to your

    Companyname
    KB, click Grant Access to Adobe Sign Connect, and enter your Adobe Sign credentials again. 

  5. Click Log in to Adobe Sign and then click Allow Access.
  6. Once the connection has been successfully established, return to the KB and click Grant Access again. Make sure the Access Granted field says Yes. At this point, you can add or edit Adobe Sign agreement actions and corresponding action buttons if necessary. For more information, see Add Adobe Sign Actions to Other Tables.
  7. Click Save.

...

Once you have an Adobe Sign account,  log log in at Sign In to Adobe Sign and complete the following steps to ensure certain settings are enabled.

  1. In the Adobe Sign Account menu, select Account > Account > Account Settings > Send Settings Settings.
  2. If you want to use additional recipient roles like delegators and acceptors, select the appropriate values under Allowed Recipient Roles.
  3. Under Private Messages to Recipients, select "Allow senders to include a private message to each of the recipients."
    Allow private messages in Adobe Sign settings
  4. Under Signing Order, select "Recipients will sign in any order," "Allow senders to select signing order," and "Allow senders to specify hybrid routing order."
  5. Click Save.

...

Adobe Sign accounts on the Adobe Sign EU1 instance in Europe have eIDAS compliant Qualified Timestamps applied by default. If your organization isn't based in Europe, but you need your signatures to be e-IDAS compliant, make sure that digital signatures are enabled in Adobe Sign under  under Account > Account Settings > Digital Signatures. For more information, refer to the Adobe Sign documentation about eIDAS and configuring digital signatures.

...

With Adobe Sign, you can customize the eSignature process to reflect your own branding. For instructions, see the Adobe Sign article about adding branding to your account.

Add Adobe Sign Actions to Other Tables

After setting up your Adobe Sign account and granting access from an 

Companyname
 knowledgebase, you can make the Adobe Sign agreement action available to specific tables other than the default Adobe Sign tables. This lets you send out Adobe Sign agreements from tables of your choice.

  1. Navigate to Setup > Integration and click Configure under Adobe Sign.
  2. Select a table and click Add Action to open the Adobe Sign Action screen.
  3. Add a name and description for the action.
  4. Select an Attached Document file field from the table that holds the document to be signed.
  5. If desired, select a signature workflow. Signature workflows are used only when a signing order is not defined on the Recipients tab. However, we strongly recommend always using a signing order because it offers more predictable control over agreement behavior. If the signature workflow is left at the default value and no signing order is defined, the agreement is sent to all recipients at the same time. For more information about signing order and signature flow, see Manage Documents with Adobe Sign.
  6. Add any other information to be included in the email to the Adobe Sign recipient.
  7. Click the Recipients tab and configure each option:
    1. Number of Recipients: Indicates the number of recipients to whom agreements are sent. The maximum number of recipients is 9.
    2. Signing Order: Determines the order in which a recipient signs, approves, and delegates. Subsequent recipients do not receive email notifications to interact with the document until previous recipients have completed the action specified by their role.
    3. Role: Determines how the recipient interacts with the document:
      • Signer: Recipient receives the document for signing.
      • Approver: Recipient receives the document for approval but is not required to sign it.
      • Delegate to Approver: Recipient receives the document and may review it, but they cannot otherwise interact with it. They must delegate it to another individual for approval by manually entering the approver's email address. The approver to which they delegate cannot be a party to the current agreement in any role.
      • Delegate to Signer: Recipient receives the document and may review it, but they cannot otherwise interact with it. They must delegate it to another individual for signing by manually entering the signer's email address. The signer to which they delegate cannot be a party to the current agreement in any role.

        Note

        To allow recipients to approve and delegate documents, you must first enable the appropriate options in your Adobe Sign account:

        1. Log in to your account at https://agiloft.na2.echosign.com/public/login.
        2. Go to Account > Account Settings > Send Settings.
        3. Under Allowed Recipient Roles, select the appropriate options.
          Image Removed
        4. Click Save.
    4. Recipient Field: Indicates the linked field to the People table used to identify the recipient.

    5. Message: Provides an optional message to the recipient.
  8. Click Save when complete. The Adobe Sign Agreement action is added to the list of available actions in the table. This also automatically creates an Adobe Sign Agreements tab in the table, which contains a Create Adobe Sign Agreement action button, as well as fields for Adobe Sign Agreements and Adobe Sign Recipients.

Manage Agreements

If you're using a Production account, you can purchase agreements directly through the Adobe Sign wizard in 

Companyname
:

  1. Navigate to Setup > Integration and click Configure under Adobe Sign.
  2. Click Manage Account and go to the Envelopes and Payments tab.
  3. Click Buy Agreements once the Production account has been authenticated. This opens the Adobe Sign payment screen. The current pricing tiers will be displayed at the top.
    Image Removed
  4. Choose a payment method. You can either pay by credit card or by invoice. 
    • If paying by card, add the card details to the fields and click Buy. This processes the purchase through your own card.
    • If paying by direct invoice to 
      Companyname
      , you should have a payment agreement prearranged. Enter a number of agreements and click Buy. 

You can navigate back to this screen at any time to see the current status of your available agreements and payment history.

For more information on agreement pricing, see eSigning Integrations. If you have an existing Adobe Sign Enterprise account, you can also purchase agreements through Adobe and use them in 

Companyname
. For more information on using an existing Adobe Sign account, see Use Your Existing Adobe Sign Account with Agiloft.

Manage Development and Production Environments

Anchor
transition
transition
Transition to Production Environment

A single knowledgebase can be used to both test the Adobe Sign integration in development and then use it in production. Once testing has been completed successfully, perform the following steps to change the account type to Production:

...

This process prevents situations where the user accounts need to be unlocked manually with Adobe Support. If you need to unlock accounts with Adobe Support, see Using Senders with Existing Adobe Sign Accounts.

Retrieve Audit Reports

In 

Companyname
 version 2019_01 and later, you You can automatically retrieve the Adobe Sign Audit Report with the signed document via email. The Audit Report is generated by Adobe Sign and includes details about the document, its creation, its signing status, and transaction information.

...

You can also view the Audit Report from within your Adobe Sign account. For information on the required steps and permission settings to view audit reports, see Adobe's Agreement History and Audit Report help guide.

Further Reading

Now that you have Adobe Sign configured in your KB, consider:

Hide If
displayprintable

Content by Label
showLabelsfalse
max5
spacesPROD
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel = "integrationadobe-sign" and type = "page" and space = currentSpace()
labelsinterface navigating