Enabling or Disabling Smart Engine with the API

Use the API to enable or disable the TIBCO BusinessWorks Smart Engine for an app instance.

Considerations for using Smart Engine:

• Supported only for TIBCO BusinessWorks apps.

To enable or disable Smart Engine 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.

• App ID — ID of the app to be accessed, which can be retrieved using the GET /v1/subscriptions/{subscriptionLocator}/apps method.

• App Instance ID — ID of the app instance to be accessed, which can be retrieved using the GET /v1/subscriptions/{subscriptionLocator}/apps/{appId}/instances method.

1. Use the POST ​/v1​/subscriptions​/{subscriptionLocator}​/apps​/{appId}​/instances​/{instanceId}​/bw​/smartengine method to enable Smart Engine for an app instance.
2. Include the subscriptionLocator of the organization where Smart Engine is being enabled.
3. Set the optional enableAppStatistics parameter to true to include statistics for the specified app instance.
4. Use the DELETE ​/v1​/subscriptions​/{subscriptionLocator}​/apps​/{appId}​/instances​/{instanceId}​/bw​/smartengine method to disable Smart Engine for anapp instance.
5. Include the subscriptionLocator of the organization where Smart Engine is being enabled.

App Statistics

The TIBCO BusinessWorks engine collects three types of statistics for an app, app job metrics, process statistics, and execution statistics. Enabling statistics adds to performance overhead. You can enable or disable statistics for an app instance using the enableAppStatistics parameter on the Enable Smart Engine API method: POST ​/v1​/subscriptions​/{subscriptionLocator}​/apps​/{appId}​/instances​/{instanceId}​/bw​/smartengine

See Smart Engine Reports for details on the data collected.

Related Topics

Monitoring Apps with the TIBCO Cloud™ Integration API

Reporting with the TIBCO Cloud™ Integration API Using TIBCO BusinessWorks Smart Engine