Enabling the Execution History Service for an Organization with the API

Use the Platform API to enable the Execution History service for a specific organization. Execution History is a log of activities for an execution instance of an app that displays on the Execution History tab of the App Details page for a specific app.

Execution History is enabled by default for TIBCO Cloud™ Integration - Connect apps. See Viewing Execution History for more information.

To enable Execution History 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 Type — Type of app to be included in the API method. App types include flogo, bw, or node. Enabling Execution History is supported for TIBCO BusinessWorks™ Apps and TIBCO Flogo® apps.
Note: Node.js apps are not supported at this time.
A Hybrid Agent configured without a custom access key running a remote TIBCO BusinessWorks App.
Note: To use the Execution History service, 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.

If you have not already done so, configure and start a Hybrid agent.
Use the POST /v1/subscriptions/{subscriptionLocator}/exechist method to enable the Execution History service for a specific organization.
This is an asynchronous call.
Use the GET /v1/subscriptions/{subscriptionLocator}/exechist to return the status of the Execution History Service.

TIBCO BusinessWorks™ Apps

Example of the model for the POST request :

{
    "appType": "bw",
    "dbType": "mysql",
    "dbHost": "10.97.110.185",
    "dbPort": "3306",
    "dbName": "database1",
    "dbUser": "user123",
    "dbPass": "password123"
}

Sending Execution History data to an Oracle database is supported only using proxy mode. For more information on using proxy mode see Configuring a Database for On-Premises TIBCO BusinessWorks™ App Execution History. Use the following model for the POST request:

{
    "appType": "bw",
    "dbType": "proxy",
    "dbHost": "10.97.90.49",
    "dbPort": "8089",
}

Note: In this model, dbHost and dbPort are the IP address and port of the BWCE Mon container respectively and not those of the Oracle Database.

For more information see, Enabling Execution History for TIBCO BusinessWorks™ Apps Running On-premises.

TIBCO Flogo® Apps

Example of the model for the POST request :

{
"dbType":"postgres",
"dbHost":"10.0.0.202",
"dbPort": "5432",
"dbName":"postgres",
"dbUser":"user",
"dbPass":"password123",
"dbMaxOpenConnection":"50"
}

For more information, see Enabling Execution History for Flogo Apps.

SSL Certificates

Uploading SSL certificates when enabling Execution History is supported by uploading the certificate as a base64 encoded string in the POST request.

Considerations

SSL certificates are supported only for TIBCO Flogo® apps.
Sample commands for base64 encoding your certificates:
macOS
```
cat cert.pem | base64
```
Linux
```
cat cert.pem | base64 -w0
```
The API method supports two values for tlsMode in the request model used to upload SSL certificates:
- one-way
- two-way

Sample Model

Use the following model for uploading certificates as an example.

Note: The certificate strings in this example have been trimmed for display purposes and are incomplete.

{
  "dbType": "postgres",
  "dbHost": "<DB_HOST>",
  "dbPort": "<DB_PORT>",
  "dbName": "<DB_NAME>",
  "dbUser": "<DB_USERNAME>",
  "dbPass": "<DB_PASSWORD_HERE>",
  "dbMaxOpenConnection": "33",
  "tlsMode": "two-way",
  "caCert": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVrVENDQTNtZ0F3SUJBZ0lVY0pOTzN6RUp",
  "clientCert": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVDVENDQXZFQ0ZEQlRlc3E1SGoyeGh",
  "clientKey": "LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFb3dJQkFBS0NBUUVBNUdsTjB4"
}

Role Requirements

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