Using Anypoint Studio to Configure Google Sheets Connector - 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, 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, see the Google Sheets Reference.
Create a Mule Project
In Studio, create a new Mule project in which to add and configure the connector:
-
In Studio, select File > New > Mule Project.
-
Enter a name for your Mule project and click Finish.
Add the Connector to Your Mule Project
Add Google Sheets 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:
-
In the Mule Palette view, click (X) Search in Exchange.
-
In Add Modules to Project, type
google sheetsin the search field. -
Click Google Sheets in Available modules.
-
Click Add.
-
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 Google Sheets 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
Text for using HTTP Listener as an input source
For example, to configure an HTTP listener, follow these steps:
-
In the Mule Palette view, select HTTP > Listener.
-
Drag Listener to the Studio canvas.
-
On the Listener configuration screen, optionally change the value of the Display Name field.
-
Specify a value for the Path field.
-
Click the plus sign (+) next to the Connector configuration field to configure a global element that can be used by all instances of HTTP Listener in the app.
-
On the General tab, specify connection information for the connector.
-
On the TLS tab, optionally specify the TLS information for the connector.
-
On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.
-
Click Test Connection to confirm that Mule can connect with the specified server.
-
Click OK.
Add a Connector Operation to the Flow
When you add a connector operation to your flow, you immediately define a specific operation for that connector to perform.
To add an operation for Google Sheets Connector, follow these steps:
-
In the Mule Palette view, select Google Sheets and then select the desired operation.
-
Drag the operation onto the Studio canvas to the right of the input source.
Each Google Sheets operation has its own required fields in Anypoint Studio. For more information, see the Google Sheets Connector Reference.
Configure a Global Element for the Connector
When you configure a connector, it’s best to 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 Google Sheets system. Google Sheets Connector supports OAuth 2.0 authorization.
To configure the global element for Google Sheets Connector, follow these steps:
-
Select the name of the connector in the Studio canvas.
-
In the configuration screen for the operation, click the plus sign (+) next to the Connector configuration field to access the global element configuration fields.
-
On the General tab, configure the authentication for the connection as described in OAuth Authentication.
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, see Anypoint Connector Configuration.
-
On the Advanced tab, optionally specify reconnection information, including a reconnection strategy.
-
Click Test Connection to confirm that Mule can connect with the specified server.
-
Click OK.
OAuth 2.0 Authentication
Enter the following information on the General tab of the Global Element Properties screen to configure OAuth 2.0 Authentication:
| Field | Description |
|---|---|
Consumer key |
Enter a consumer key belonging to your authentication server’s client application. |
Consumer password |
Enter a consumer password belonging to your authentication server’s client application. |
Authorization url |
URL for the OAuth 2.0 authorization, filled in by the connector. |
Access token url |
URL for the access token, filled in by the connector. |
Scopes |
Scopes used by the connector. |
Callback path |
Callback path used during the Oauth dance. |
Authorize path |
Authorize path used during the Oauth dance. |
Object store |
Object store to contain the access tokens created during the authorization. |
Configure Additional Connector Fields
After you configure a global element for Google Sheets Connector, configure the other required fields for the connector, as described in the Google Sheets Connector Reference.
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. You can configure the location of the log path in the app log file log4j2.xml.