• An active Bridge agent. Refer here to install and configure Bridge.
  

• Create the necessary Credentials for the applications to be connected by DB Engine.

For more details about the DB Engine module in Bridge, the keys, and its description click here.

Builder View

For associating a DB Task to a Circuit:

1. In Builder View, drag and drop the DB Engine state from the left pane into your Circuit or click the required DB Engine state in your Circuit.

2. Under the Configuration tab, update the common state field attributes.

3. The Bridge ID field should capture the details of the Bridge to be used for this task. Click and select the required Bridge from the drop-down list.  

4. Under Add Configuration, in Credential Name field, click and select the credential from the dropdown list. The Credential IDs of all the credentials created for the DB Engine module type will be displayed in the list.

5. Under Query Message, fill in the following fields:
   

1. Database - Enter the name of the connecting database in which the query has to be executed.
   

2. Query - Enter the query that has to be executed in the database.
   

3. Port - Enter the port in which the MySQL server is running. The default port is 3306.
   

4. Query Timeout - Specify the time limit (in seconds), within which the query must be executed.
   

5. Host - Enter the hostname of the machine in which the database query has to be executed. Enter the hostname as localhost, if the query is executed on the same Bridge-installed machine.
   

6. Database Type - Select the database type from the dropdown list.
   

7. Connection Timeout - Specify the time limit (in seconds), within which the connection to the specified server must be made.
   

6. For error handling, you have the option to choose and configure error handling settings. To learn more, check Error Handling in Circuit states.
   
7. The the Input/Output tab has to be filled with the Input Path, Output Path, and Result Path. To learn more about I/O paths, click here.        

Code view

In Code View, the JSON to configure the DB Engine state to pass a query and retrieve data from a database table is given below:

"Add User in Legacy Database": {
   "type": "db_engine",
   "next": "End",
   "bridge_id": "bridge-employee onboarding",
   "payload": {
  	   "credential_id": "db_cred_2",
           "query": "INSERT INTO user_record values('John Mathew', 'john.mathew@zylkermail.com','CA');",
 	   "query_timeout": 100,
  	   "host": "localhost",
  	   "database_type": "MySQL",
  	   "connection_timeout": 100,
 	   "port": 3306,
	   "database_name": "user_db"
  }
}