Connectors - Actions

When building your applications you would often be making use of a variety of services like Trello, Twilio, SendGrid, etc. that provide APIs to use their functionality. You also have Databases like MySQL, MongoDB, Ms SQL, Oracle and so on that can be used to fetch data and bind it to your forms as per your scenario. You can configure these connectors and customize them further for each app. Let us understand how to bind these connectors.

Add Configured Connectors

Now that you want to make use of these configured Connectors in your Apps, you can add them from the App Builder > Connectors. Click +Add to select your connector from the list of Connectors.

Select the one that you need to use in your App and click Continue. Depending upon the type of connector you need, select the Custom Database Connectors or Ready Third Party Connectors, or the Custom API Connector.

Custom Database Connectors

  • If you are adding a Custom Database Connector from the list, select the Configured connector and click Continue. For the selected Connector, you would have multiple queries configured as required. Select the query that is needed.

  • Select the Connected account and click Continue.

  • Further configure the connector with the necessary inputs like Dynamic values, response transformation, and transformation key and click Finish.

  • The DB Connector is added to your App. You can now use it to bind data.

Ready Third Party Connector and Custom API Connectors

  • If you are adding a Ready Third Party Connector or a Custom API Connector from the list, select the Connector and click Continue.

  • For the selected Connector, you would have multiple functions configured. Select the necessary function from the list and click Continue.

  • Select the Connected account and click Continue.

  • Further configure the connector with the necessary inputs like Dynamic values, response transformation, and transformation key and click Finish.

  • The Third Party Connector is added to your App. You can now use it to bind data.

The same process would be followed for the Custom API Connectors as well.

Adding a New Custom DB Connector

In case you do not have a DB connector configured you can add it from the App Builder as well. Under Custom DB Connectors, click + icon to add a new DB connector.

You would be taken to the Studio Console > Connectors page. Click + Connector to select the connector from the available DB Connectors.

Select the DB connector from the list and click Add. You can now configure the specific connectors. For more information on each of them, select the respective/required connector and click ‘i’ to understand the further process.

Adding a Custom API Connector

In case you do not have a Ready Third Party connector configured you can add it from the App Builder as well. Under Ready Third Party Connectors, click + icon to add a new connector.

You would be taken to the Studio Console > Connectors page.

Click + Connector > Pick Category, select RESTAPI, and click Add.

Here you can now configure your custom connectors. When configuring custom API connectors you would have to select the appropriate authentication method depending upon the one provided by the REST API that you are planning to use.

  • To configure the Connector, add a self-explanatory category name and an appropriate icon.

  • Select the authentication method. You can choose from API Key, OAuth v2, Basic Auth, and No Auth. Refer to the respective authentication method articles for more details.

  • Depending upon the method you would then configure the authentication scheme wherein you would have to provide the configuration string parameters like host, URL, port and so on depending upon the type of authentication scheme.

  • Test the Connection and remove any configuration error to proceed.

  • Once successful click to Save and Finish. Now the Custom API Connector is ready and configured for use. You can then select it from the list

To use it in your App, you can now select it from the list under App Builder.

  • Under Custom API connectors, select the respective API and click Continue.

  • Select from the available configured actions or functions.

  • Select the connected Account and configure the connector as per the specific API and functions and click Finish.

The connector is now available under the App builder > Connectors. You can select it from here and use it as required to Bind Data.

Edit Connector

Once you add the connectors to your App, you can use them to bind data and fetch data from the tables or collections. You can pass parameters to the connectors dynamically from your Apps and customize it further as required depending upon your use case or requirement.

You can make changes or edit the connector in the Builder like the parameters you are sending, the configured account changes, transforming data, and so on. Simply click to select the Connector and it can then be modified as required.

Delete Connector

From the list of connectors added to your App under the App Builder, you can remove or delete the connector. Hover over the connector to click the cross icon to remove the connector. The API connector is deleted from the list.

Bind Data

You can bind the data from these connectors to your controls like Tablegrid control, Detail view control, List controls, and even some other input controls as per your scenario.

To bind data to the select controls, click Bind Data. From the list of available resources select Connectors. From the list of available connectors, select the one that you want to use and also select the columns from the connector to fetch data. Click Save.

You can also remove the existing Connector that is bound to the control. Click Remove.

remove connector

For more information on using Bind Data using Connectors refer to this article here.