How to configure a DBES API in vConnect (with release manager)?

vConnect
,
2

how-to

Below are the steps to be followed for configuring a DBES API in vConnect in vahana app which is with release manager:

  1. Create your DB procedure/function which you need to configure in vConnect
  2. Go to Vahana developer portal
  3. Select the application on which you want to configure the API
  4. Go to vConnect of that application
  5. Click on “Recent APIs”
  6. Go to “API Management”
  7. Click on “Add New API”
  8. Enter below details on the form:
  • API Type: Select “Database” radio button
  • API Name: Enter a relevant & unique API name (It should not match name of existing API)
  • QUERY-TIMEOUT(in seconds): It is kept as 5 by-default but you need to keep it as per the expected response of your Database procedure/function/query. If the DB query is not executed within the time mentioned in this field, then the API & it’s service will give timeout error.
  • Description: Enter a relevant description for the API for future reference & to understand the purpose of this API
  • DB Definition Id: Select the appropriate DB connection# from the drop-down
    Once you select the DB Connection, another field will show
  • Execution Type: Select “Function” or “Procedure” or “Query” which you want to configure
  • Function/Procedure Name: Based on selection in “Execution Type” you will either view “Function Name” or “Procedure Name” field. Select the relevant function/procedure you want to configure.
    Upon selection of the Function/Procedure/Query Name, vahana will fetch the input/output parameters (if any) for the selected Function/Procedure/Query.
  • Logs Required: this is kept as checked by-default assuming that you would want logs to be generated for this API. Uncheck it in case you do not want the logs to be generated.
  • Connection Pool: This is kept as checked by-default assuming that you would want it to be a part of the connection pool.
  1. Click on “Save” button
  2. Your API will be created and you will be redirected back to “API Management” Screen
  3. Go to Vahana developer portal
  4. Click on “Release Manager”
  5. Sync the environment on which the API is created.

#NOTE: In order to be able to create a DBES API, you will need to have a Database connection setup in vConnect.
Steps to create a DB Connection are available on below link:
https://community.vahanacloud.com/t/how-to-create-a-db-connection/461?u=vivekbhardwaj

3 Likes