Using DocuSign with IBM App Connect Enterprise

DocuSign is an electronic signature and document approval application that you can use to send, sign, and manage agreements across multiple devices. IBM® App Connect Enterprise provides a DocuSign Request node, which you can use to connect to DocuSign and issue requests to create, retrieve, update, or delete objects.

1. In the IBM App Connect Enterprise Toolkit, create a flow containing a DocuSign Request node.
2. Select the DocuSign Request node in the flow to show the node properties in the editor.
3. On the Basic tab, click Launch Connector Discovery.
   A window is displayed in which you specify the name of the policy project and vault details to be used during connector discovery.
4. Specify the details of the policy project and vault to be used during connector discovery:
   1. In the Policy Project field, specify the policy project that is used to store the policies that are created during connector discovery.
      Alternatively, you can create a new policy project by clicking New and then specifying the name of the new policy project. Then click Finish.
   2. Specify the vault to be used during connector discovery. By default, credentials that are used during connector discovery are stored in an external directory vault, which is an App Connect Enterprise vault that can be used by any integration server. Alternatively, you can store the credentials in an integration server vault, which is created in the integration server's work directory and can be used only by that specific integration server.
      To specify the vault to be used for storing the credentials, complete the steps in the Using the Connector Discovery wizard section of one of the following topics:

      • Configuring an external directory vault
      • Configuring an integration server vault
   3. In the Vault key field, enter the vault key that is used to access the credentials stored in the vault. The vault key must be at least 8 characters in length.
   4. Optional: By default, the specified vault location and vault key are saved as preferences in the Toolkit so that the values are preset when you launch Connector Discovery. If you do not want the preferences to be saved, deselect Save in vault preferences.
5. Click Launch Discovery to start the Connector Discovery wizard for the DocuSign connector.
   The Connector Discovery window is displayed. If existing DocuSign connections (accounts) are available, a list of those connections is displayed. If no existing connections are available, the status of the DocuSign connector is shown as Not connected.
   • If one or more DocuSign connections (accounts) are available, complete the following steps:
     1. Select the connection that you want to use.
     2. Click the required object type and then select the action that you want to perform on the object. For example, to retrieve documents from DocuSign, click Documents and then Retrieve documents.
   • If no existing connections are available, complete the following steps:
     1. Click the required object type and then select the action that you want to perform on that object. For example, to retrieve documents from DocuSign, click Documents and then Retrieve documents.
     2. Click Connect.
     3. Select the authorization type that you want to use:
        • Provide credentials for App Connect to use (API KEY)
        • Provide credentials for App Connect to use (BASIC OAUTH)
     4. If you selected the API KEY authorization type, enter the following details:
        • Endpoint URL: The URL for the authentication service of your DocuSign instance. For example, in the developer environment, the endpoint URL is account-d.docusign.com, and in the production environment, it is account.docusign.com.
        • Integration key: The integration key to identify your application to DocuSign for communicating with DocuSign APIs.
        • User ID: The user ID used to access your DocuSign account.
        • RSA private key: The RSA private key used to encrypt your token in the JSON Web Token (JWT) authentication flow.
     5. If you selected the BASIC OAUTH authorization type, enter the following details:
        • Endpoint URL: The URL for the authentication service of your DocuSign instance. For example, in the developer environment, the endpoint URL is account-d.docusign.com, and in the production environment, it is account.docusign.com.
        • Client ID: The consumer key that is generated when you create a connected app for App Connect in DocuSign.
        • Client secret: The consumer secret that is generated when you create a connected app for App Connect in DocuSign.
        • Access token: The access token that is generated from the application client ID and client secret.
        • Refresh token: The refresh token that is generated from the application client ID and client secret.

        For more information about obtaining the connection details, see How to use IBM App Connect with DocuSign in the IBM App Connect Enterprise as a Service documentation.

     6. Click Connect.
6. Set the required properties in the wizard. For example, specify values for the DocuSign account and Envelopes properties.

   Optionally, you can add conditions for the retrieval of the data, by clicking Add condition and then selecting the property that you want to filter. You can also set properties that specify the maximum number of records to retrieve and the action to be taken if that limit is exceeded.

7. When you have finished specifying the properties in the Connector Discovery wizard, click Save.
   The credentials used for connecting to DocuSign are stored in the vault, and the other connection details are saved in the DocuSign policy. The values of the properties that you set in the wizard are returned to the DocuSign Request node in the IBM App Connect Enterprise Toolkit.
8. When you have finished discovery and saved the property values, exit the Connector Discovery wizard by clicking the Close button (X) or by pressing Alt+F4.
9. Return to editing the DocuSign Request node in the IBM App Connect Enterprise Toolkit.
   The connector properties that were set in the Connector Discovery wizard (in step 6) are now visible on the DocuSign Request node in the property editor. The Basic tab shows the values of the Action and Object properties that you set in the wizard. For example, if you selected Documents > Retrieve documents in the wizard, the following properties are visible on the Basic tab of the node:

   • Action - RETRIEVEALL
   • Object - Documents

   The values of the Action and Object properties are displayed in read-only format. If you want to change these values, you can do so by clicking Launch Connector Discovery again and setting new values in the Connector Discovery wizard.

   The Schema base name property specifies the base name of the schema files that describe the format of the request and response messages that are sent and received from the DocuSign connector. The schema base name is set automatically the first time you run discovery for the node, and it is based on the current flow name and node name. If you set this property manually before running discovery for the first time, the value that you set is used. If you rename the schemas after discovery, you must edit this property so that it matches the schema base name that is used by the renamed schemas in the project. If you change this property after discovery, you must either rename the schema names to match or run discovery again.

   Depending on the action that was selected during discovery, the Connector Discovery wizard generates either a request schema and a response schema, or a response schema only. A request schema is generated only if the selected action and object require a request message. The generated request schema is used for validation of the request message. If the action was RETRIEVE or DELETE, only the response schema is returned by the connector.

   The generated schema files are added to the project and can be used by a Mapping node for transforming input or output data. The full filename of the schema is derived from the schema base name (such as gen/MyMessageFlow.DocuSign_Request), suffixed with either response.schema.json or request.schema.json. You can open the schema by clicking Open request schema or Open response schema.

10. Check that the property settings on the DocuSign Request node are correct and then save the message flow.
11. On the Connection tab of the DocuSign Request node, the Policy property shows the name of the policy that contains the details of the security identity to be used for the connection. The policy has a type of DocuSign. For more information, see DocuSign policy.
12. Optional: Set the Timeout property on the Connection tab to specify the time (in seconds) that the node waits for DocuSign to process the operation.
13. The Filter tab of the DocuSign Request node contains properties that control the way in which the message flow selects data. The initial values of these properties are taken from the property values that were set for the DocuSign connector in the Connector Discovery wizard, including the filter options properties and any conditions that were specified (as described in step 6). If you return to the Connector Discovery wizard later and change the values of any properties (by adding new conditions, for example) those updates are reflected in the properties set on the node.

    The Filter Options properties control which objects are to be operated upon when the DocuSign Request node executes. The Filter Limit properties control the maximum number of items to be retrieved and the action to be taken if the limit is exceeded.

    You can modify the values by clicking Edit next to the value that you want to modify in the Filter Options section, and by changing the property values that have been set in the Filter Limit section.

    The property values can be either text values or ESQL or XPath expressions that are resolved from the contents of the message that is passed to the DocuSign Request node as it runs.

14. On the Request tab, set the Data location property to specify the location in the incoming message tree that contains the object data to be created in DocuSign. This data forms the request that is sent from the DocuSign Request node to the DocuSign system.
15. On the Result tab, set the Output data location property to specify the location in the output message tree that will contain the data of the record that is created in DocuSign.
16. By default, request messages are validated against the request schema that was generated during connector discovery. You can turn off request validation or change the validation settings by using the Validation properties of the DocuSign Request node.
17. Save the message flow.