Enabling or Disabling the TIBCO Flogo® Flow Tester for an Organization with the API
Use the API to enable or disable the Flogo Flow tester for apps that connect to on-premises systems for an organization.
Considerations for using the Flow Tester with apps that connect to on-premises systems:
- Only users with an Admin Role can enable or disable the Flow Tester service.
- Configure a Hybrid Agent without an access key. The agent does not have to be running. See Installing, Configuring, and Running the Hybrid Agent.Note: To test on-premises apps in Flow Tester, you must download the latest TIBCO Cloud Integration - Hybrid Agent from the TIBCO Cloud Integration User Interface. Using an Agent downloaded before the January 2022 release of TIBCO Cloud Integration generates a Connect file not found error when starting the Agent.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.Note: If there are no Hybrid Agents configured for the Organization and you attempt to enable the Flow Tester using the API, the following warning message is generated:
Please enable hybrid proxy first
. - Enable the Using on-premises services option on the Launch Configuration dialog in the TIBCO Cloud™ Integration user interface before running the Flow tester. See Configuring a Launch Configuration.
- Supported only for Flogo apps.
To enable or disable the Flow Tester 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}/flogotester
method to enable the Flow Tester for an organization. This is an asynchronous call. - Include the
subscriptionLocator
of the organization where the Flow Tester is being enabled. - Use the
DELETE /v1/subscriptions/{subscriptionLocator}/flogotester
method to disable the Flow Tester for an organization. This is an asynchronous call. - Include the
subscriptionLocator
of the organization where the Flow Tester is being enabled. - Use the
GET/v1/subscriptions/{subscriptionLocator}/flogotester
method to request the status of the Flow Testerr for the selected organization.
Related Topics
Managing an Organization with the TIBCO Cloud™ Integration API
Viewing TIBCO Flogo® Flow Tester Status for an Organization with the API