Enabling the DB Service for an Organization with the API

You can set up hybrid connectivity between TIBCO Flogo® apps and on-premise or private cloud databases using the Flogo Database connector design-time service or DB Service. DB Service is a singleton user app you run for an organization. It enables the activities of an app Database connector to be connected to your on-premise or private cloud database through the TIBCO Cloud™ Integration - Hybrid Agent. The database service is accessible only by the users that belong to the selected organization.

Use the API to enable the DB Service for a specific organization. Note that you must configure a separate TIBCO Cloud™ Integration - Hybrid Agent specifically for use by the DB Service before enabling the service. Hybrid agents configured for other services cannot be used for the DB Service. See Installing, Configuring, and Running the Hybrid Agent.

Note: If there are no Hybrid Agents configured for the Organization and you attempt to enable the DB Service using the API, the following warning message is generated: Please enable hybrid proxy first.

Note: An access key is optional when using the Hybrid Agent. If no Access key is provided, a system key is used.

Note: A single TIBCO Cloud Integration - Hybrid Agent configured without a custom access key can be used for multiple services, such as the Execution History, Flow tester, or DB services. If a TIBCO Cloud Integration - Hybrid Agent is configured with your access key to establish hybrid connectivity to your on-premises resources, you must configure a separate agent for each service.

To enable the DB Service you need the following:

Subscription Locator — The Subscription Locator of the Organization you want to access. To find Subscription Locators for your organizations use the GET /v1/userinfo method to return a list of all of the organizations for your OAuth Token with their Subscription Locators. You can use 0 as the Subscription Locator for the organization that owns the OAuth token.

Use the POST /v1/subscriptions/{subscriptionLocator}/dbservice method to enable the DB Service for a specific organization.
This is an asynchronous call.
Use the GET /v1/subscriptions/{subscriptionLocator}/dbservice to return the status of the DB Service.

Role Requirements

Admins can enable the DB service for their organization.
Users cannot enable the DB service for their organization.
Read-only users cannot enable the DB service for their organization.

Enabling the DB Service for an Organization with the API

Role Requirements

Related Topics