Microapps

Integrate Adobe Sign

Deploy the AdobeSign integration to quickly and securely make every agreement and approval digital.

With Citrix Adobe Sign Integration users can perform the following actions:

  • Send a template and upload agreements to recipients for signature.
  • List of Adobe Sign agreements waiting for a user’s signature. Users can sign the agreement from Citrix Workspace.
  • List sent Adobe Sign agreements for signature. Users can also cancel a sent agreement.
  • List completed Adobe Sign agreements with details. Users can also share received agreements.
  • List canceled Adobe Sign agreements with details.
  • Manage and edit template agreements.

We want your feedback! Please provide feedback for this integration template as you use it. For any issues, our team will also monitor our dedicated forum on a daily basis.

For comprehensive details about the microapps, see Use Adobe Sign microapps.

Review prerequisites

After you set up this integration with Adobe Sign, you will need these artifacts to add the integration in Citrix Workspace Microapps:

  • Base URL: https://api.in1.adobesign.com/
  • Adobe Sign Group ID: This Group id represents your user group id for your admin account.
  • Agreements per user: This is the number of agreements to store per user in the cache. The maximum value is 100. We recommend 15–30 agreements per user.
  • Authorization URL: https://{HostName}.com/public/oauth
  • Token URL: https://{HostName}.com/oauth/token
  • Refresh token URL: https://{HostName}.com/oauth/refresh
  • Scope: user_read:self user_write:self user_login:self agreement_read:self agreement_write:self agreement_send:self application_write:self library_write:self
  • Client ID: The client ID is the string representing client registration information unique to the authorization server.
  • Client secret: The client secret is a unique string issued when setting up the target application integration.
  • Relay state: NONE
  • Request rate limiting: 500 request per second
  • Request timeout: 120

Note

It is recommended that you always use OAuth 2.0 as your service authentication method where available. OAuth 2.0 ensures that your integration meets the maximum-security compliance with your configured microapp.

Create service account

The integration requires regular access to your Adobe Sign instance. We recommend creating a dedicated user account. This account must be an Adobe Sign administrator account with Full administrator privileges.

To set up a new account, see Create a free Adobe Sign account.

Enable APIs

There is no API limitation mentioned in Adobe Sign. Adobe Sign transaction limits are mentioned in the following link: https://helpx.adobe.com/in/sign/using/transaction-limits.html. Plans can be chosen according to your requirements.

Configure the OAuth client app

Configure the OAuth client to write data back through the integration. For more information about working with Adobe Sign, see Get started guide (Adobe Sign).

  1. Log in to the Adobe Sign Admin account: https://secure.echosign.com/public/login
  2. Select Account and select API Applications under the section Adobe Sign APIs.
  3. Select Create and create two new Apps.
  4. For the first app, paste the redirect URLs in the Redirect Uri field.

    • https://{yourmicroappserverurl}.us.iws.cloud.com/app/api/auth/serviceAction/callback
    • https://{yourmicroappserverurl}.us.iws.cloud.com/admin/api/gwsc/auth/serverContext
  5. Select and choose the OAuth Configure option and enable all the scopes with modifier as Group.
  6. Repeat the same for the second OAuth app.
  7. Collect the Client Id and Client secret details from both OAuth apps and save them for future use. You use these values for Service Authentication and Service Action Authentication while configuring the integration.

Configure group and get Group Id

Groups allow you to have separate subsets of users that have access to different Library Documents and different settings. For more information, see Create and manage groups (Adobe Sign.

  1. Log in to the Adobe Sign Admin account: https://secure.echosign.com/public/login
  2. Select Account, and select Groups section.
  3. Select Create New Group to add a new group.
  4. Enter an appropriate name for the group.
  5. Select and choose the Group Setting option to find the Group Id on the configuration page.
  6. Add or import users to the groups.

Add the integration to Citrix Workspace Microapps

Add the Adobe Sign integration to Citrix Workspace Microapps to connect to your application. This delivers out-of-the-box microapps with pre-configured notifications and actions, which are ready to use within your Workspace.

Follow these steps:

  1. From the Microapp Integrations page, select Add New Integration, and Add a new integration from Citrix-provided templates.
  2. Choose the Adobe Sign tile.
  3. Enter a name for the integration.
  4. Enter Connector parameters:

    • Enter Instance Base URL: https://api.in1.adobesign.com/
    • Select an Icon for the integration from the Icon Library, or leave this as the default icon.
    • Enter your Adobe Sign Group ID. For more information, see: Configure group and get Group Id.
    • Enter the Agreements per user. This is the number of agreements to store per user in the cache. The maximum value is 100. We recommend 15–30 agreements per user.
  5. Under Service authentication, select OAuth 2.0 from the Authentication method menu and complete the authentication details. The authentication options are preselected. Ensure that these options are selected as you complete the process. Use the OAuth 2.0 security protocol to generate request/authorization tokens for delegated access. It is recommended that you always use OAuth 2.0 as your service authentication method where available. OAuth 2.0 ensures that your integration meets the maximum-security compliance with your configured microapp.

    1. Select Authorization code from the Grant type menu. This grants a temporary code that the client exchanges for an access token. The code is obtained from the authorization server where you can see the information the client is requesting. Only this grant type enables secure user impersonation. This displays the Callback URL, which you use when registering your application.
    2. Select Request body from the Token authorization menu and Token content Type as URL Encoded Form.
    3. Enter the Refresh token URL: https://{HostName}/oauth/refresh.
    4. Ensure that the following is entered for Scope: user_read:self user_write:self user_login:self agreement_read:self agreement_write:self agreement_send:self application_write:self library_write:self
    5. Enter your Client ID. The client ID is the string representing client registration information unique to the authorization server. You collect this and the secret when you configured the OAuth server. Add the Callback URL you see on the integration configuration page.
    6. Enter your Client secret. The client secret is a unique string issued when setting up the target application integration.
  6. Under Service Action Authentication, enable the Use Separate User Authentication in Actions toggle. Service action authentication authenticates at the service action level. The authentication options are preselected. Ensure that these options are selected as you complete the process.

    1. Select OAuth 2.0 from the Authentication method menu and complete the authentication details.
    2. Select Authorization code from the Grant type menu. This grants a temporary code that the client exchanges for an access token. The code is obtained from the authorization server where you can see the information the client is requesting. Only this grant type enables secure user impersonation. This displays the Callback URL, which you use when registering your application.
    3. Select Request body from the Token authorization menu.
    4. The Authorization URL is prefilled.
    5. The Token URL is prefilled.
    6. Ensure that the following is entered for Scope: user_read:self user_write:self user_login:self agreement_read:self agreement_write:self agreement_send:self application_write:self library_write:self library_read:self
    7. Enter your Client ID. The client ID is the string representing client registration information unique to the authorization server. You collect this and the secret when you configured the OAuth client. Add the Callback URL you see on the integration configuration page.
    8. Enter your Client secret. The client secret is a unique string issued when setting up the target application integration.
  7. Select Save to proceed.
  8. Under OAuth Authorization, select Authorize to log in with your service account. A pop-up appears with a Google login screen.

    1. Enter your Service Account User name and password and select Log in.
    2. Select Accept.

Add redirect action to Open Agreement buttons

Configure this Go to URL action with your host name for the following buttons to enable the Open Agreement button capability for these microapps. This Go to URL configuration redirects users to the specific envelope detail page in DocuSign. Navigate to each button listed below to perform this action:

Microapp Page Button
In progress Agreements Agreement Details Open Agreement
Canceled Agreements Agreement Details(Action) Open Agreement
Canceled Agreements Agreement Details (Notification) Open Agreement
Completed Agreements Agreement Details(Action) Open Agreement
Completed Agreements Agreement Details (Notification) Open Agreement

Follow these steps:

  1. Navigate to the first button listed above, select the button, and select the Actions tab on the right.
  2. In the Add action field, select Go To URL.
  3. In the URL Template field, replace the {Your Adobe Sign Host} portion of the URL with your host name. Find your Adobe Sign host name in your Adobe Sign instance URL following this model: https://{hostname}.in1.adobesign.com/public/login. For example, https://citrixwsi.in1.adobesign.com/public/login.
  4. Now repeat this procedure for the other buttons, replacing the {Your Abobe Sign Host} portion of the URL with your host name.

    Go To URL action

You are now ready to set and run your first data synchronization. For complete information about synchronization rules, synchronization that does not meet its schedule and veto rules, see Synchronize data.

For more details of API endpoints and table entities, see Adobe Sign connector specifications.

Use Adobe Sign microapps

Existing application integrations come with out-of-the-box microapps. Start with these microapps and customize them for your needs.

Send Agreements: Send the template and upload an agreement to recipients for signature.

Notification or Page Use-case workflows
My Template: Item page Provide a list of template agreements available for the user with options to Create and send to users for agreement using the upload option.
Send Agreement: Item page Allows user to send an agreement to recipient using the upload option.
Send Template: Item page Allows user to send template agreements to recipients.

My Received Agreements: Provides a list of Adobe Sign agreements waiting for user’s signature. A user can sign the agreement form

Notification or Page Use-case workflows
New Agreement Received: Item New notification Recipients are notified for all new agreements created.
New Agreement Changed: Item Changed notification Recipients are notified for all new agreements created with an Order By option.
Agreement Reminders: Item Date Reminder notification Recipients are notified of unsigned agreements that are pending for a week.
My Received Agreement: Item page Provides a personalized list of all received agreements.
Agreement Details (Action): Item page Details of a received agreement is shown with options to Sign Agreement and Send To Other Recipient.
Agreement Details (Notification): Item page The details of a received agreement is shown with options to Sign Agreement and Send To Other Recipient.
Share Agreement: Item page Allows recipients to share received agreements with other users.
Sign Agreement: Item page Allows recipients to sign and complete agreements.

In Progress Agreements: List of in-progress Adobe Sign agreements for signature. User can also cancel the sent Agreement.

Notification or Page Use-case workflows
My Sent Agreement: Item page Provides a personalized list of sent agreements.
Agreement Details: Item page Allows users to view detailed information of selected sent agreement with options to Cancel Agreement and Open Agreement.

Completed Agreements: List of completed Adobe Sign agreements and details. User can also Share the received Agreements.

Notification or Page Use-case workflows
Signed Agreement: Item notification Sender of the agreement is notified about signed agreements.
Completed Agreements: Item page Provides a personalized list of completed agreement.
Agreement Details (Action): Item page Allows users to view detailed information of a selected completed agreement with options to Send To Other Recipient and Open Agreement from the action page.
Agreement Details (Notification): Item page Allows users to view detailed information of a selected completed agreement with options to Send To Other Recipient and Open Agreement. from the notification feed.
Share Agreement: Item page Allows recipients to share the received agreements to other users.

Canceled Agreements: List of Canceled Adobe Sign agreements and details.

Notification or Page Use-case workflows
Canceled Agreement: Item notification Recipients of the agreement are notified for Canceled agreements.
Canceled Agreement: Item page Provides a personalized list of canceled agreements.
Agreement Details (Action): Item page Allows users to view detailed information of a selected canceled agreement with the option to Open Agreement.
Agreement Details (Notification): Item page Allows users to view detailed information of a selected canceled agreement with the option to Open Agreement.

Manage Agreements: Manage and edit template agreements.

Notification or Page Use-case workflows
My Template: Item page Provides a personalized list of templates.
Edit Template: Item page Allows users to edit selected templates in Citrix Workspace.
Integrate Adobe Sign