+
+

Using Anypoint Studio to Configure DocuSign Connector 1.0 - Mule 4

Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files.

To add and configure a connector in Studio:

When you run the connector, you can view the app log to check for problems in real time, as described in View the App Log.

If you are new to configuring connectors in Studio, see Using Anypoint Studio to Configure a Connector. If, after reading this topic, you need additional information about the connector fields, refer to the DocuSign Connector Reference.

Create a Mule Project

In Studio, create a new Mule project in which to add and configure the connector:

  1. In Studio, select File > New > Mule Project.

  2. Enter a name for your Mule project and click Finish.

Add the Connector to Your Mule Project

Add Anypoint Connector for DocuSign (DocuSign Connector) to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s pom.xml file:

  1. In the Mule Palette view, click (X) Search in Exchange.

  2. In the Add Dependencies to Project window, type docusign in the search field.

  3. Click DocuSign Connector in Available modules.

  4. Click Add.

  5. Click Finish.

Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace.

Configure a Source

A source initiates a flow when a specified condition is met. You can configure one of these sources to use with DocuSign Connector:

  • HTTP Listener
    Initiates a flow each time it receives a request on the configured host and port

  • Scheduler
    Initiates a flow when a time-based condition is met

For example, to configure an HTTP Listener source, follow these steps:

  1. In the Mule Palette view, select HTTP > Listener.

  2. Drag Listener to the Studio canvas.

  3. On the Listener configuration screen, optionally change the value of the Display Name field.

  4. Specify a value for the Path field.

  5. Click the plus sign (+) next to the Connector configuration field to configure a global element that can be used by all instances of the HTTP Listener source in the app.

  6. On the General tab, specify the connection information for the connector.

  7. On the TLS tab, optionally specify the TLS information for the connector.

  8. On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.

  9. Click Test Connection to confirm that Mule can connect with the specified server.

  10. Click OK.

Add a Connector Operation to the Flow

When you add a connector operation to your flow, you are specifying an action for that connector to perform.

To add an operation for DocuSign Connector, follow these steps:

  1. In the Mule Palette view, select DocuSign and then select the desired operation.

  2. Drag the operation onto the Studio canvas to the right of the source.

Configure a Global Element for the Connector

When you configure a connector, configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target DocuSign system. DocuSign Connector supports Authorization Connection Provider (Implicit Grant) authentication and OAuth Connection Provider (Authorization Code Grant) authentication.

To configure the global element for DocuSign Connector, follow these steps:

  1. Select the operation in the Studio canvas.

  2. In the configuration screen for the operation, click the plus sign (+) next to the Connector configuration field to access the global element configuration fields.

  3. On the General tab, in Connection, select the authentication method to configure:

    You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, refer to Anypoint Connector Configuration.

  4. On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.

  5. Click Test Connection to confirm that Mule can connect with the specified server.

  6. Click OK.

Authorization Connection Provider (Implicit Grant)

  1. Enter the following information on the General tab of the Global Element Properties screen to configure Authorization Connection Provider (Implicit Grant):

    Field User Action

    Name

    Configuration name.

    Base Uri

    Parameter base URI for each instance or tenant.

    Authorization

    Authorization for the connection type.

    The following screenshot shows an example of configuring the General tab for Authorization Connection Provider (Implicit Grant):

    General tab for Authorization Connection Provider (Implicit Grant) authentication
  2. On the Advanced tab, optionally change the default values of the Response timeout, Response timeout unit, Streaming type, and Expiration policy fields.

    The following screenshot shows an example of configuring the Advanced tab for Authorization Connection Provider (Implicit Grant):

    Advanced tab for Authorization Connection Provider (Implicit Grant) authentication

OAuth Connection Provider (Authorization Code Grant)

  1. Enter the following information on the General tab of the Global Element Properties screen to configure OAuth Connection Provider (Authorization Code Grant):

    Field User Action

    Name

    Configuration name.

    Consumer key

    OAuth consumer key as registered with the service provider.

    Consumer secret

    OAuth consumer secret as registered with the service provider.

    Listener config

    HTTP configuration used to create the listener that receives the access token callback endpoint.

    Callback path

    Path of the access token callback endpoint.

    Authorize path

    Path of the local HTTP endpoint that triggers the OAuth dance.

    The following screenshot shows an example of configuring the General tab for OAuth Connection Provider (Authorization Code Grant):

    General tab for OAuth Connection Provider (Authorization Code Grant) authentication
  2. On the Advanced tab, optionally change the default values of the Response timeout, Response timeout unit, Streaming type, and Expiration policy fields.

    The following screenshot shows an example of configuring the Advanced tab for OAuth Connection Provider (Authorization Code Grant):

    Advanced tab for OAuth Connection Provider (Authorization Code Grant) authentication

Configure Additional Connector Fields

After you configure a global element for DocuSign Connector, configure the other required fields for the connector. The required fields vary depending on which connector operation you use.

View the App Log

To check for problems, you can view the app log as follows:

  • If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window.

  • If you’re running the app using Mule from the command line, the app log output is visible in your OS console.

Unless the log file path is customized in the app’s log file (log4j2.xml), you can also view the app log in the default location MULE_HOME/logs/<app-name>.log.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub
Submit your feedback!
Share your thoughts to help us build the best documentation experience for you!
Take our latest survey!