Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# Enabling the Runtime Access to AsyncAPI Specification

Follow the steps to enable accessing a specification over a server URL.

1. In the `be-engine.tra` file located at `BE_HOME/bin`, set the following server properties:

   Field | Description
   --- | ---
   `be.engine.api.spec.enable` | Set to true to enable an HTTP endpoint to generate and serve the AsyncAPI specification at run time By default, it is `false`.
   `be.engine.http.ping.port` | Specify the port number. The generated specification is displayed on the specified port. The default port is `8180`. When multiple engines are running on the same host, specify a range for port numbers to use the next port in line when a port is not available. For example:
       be.engine.http.ping.port=8180-8185
   When a single port is specified, the default port range is considered as the next 10 ports from the specified port number.

2. This step is required if you start the TIBCO BusinessEvents engine from TIBCO BusinessEvents Studio to access a runtime specification.

   In TIBCO BusinessEvents Studio, set the server properties, `be.engine.api.spec.enable` and `be.engine.http.ping.port`, in either of the following ways:

   - In the Run Configurations window, provide the start up property file, see Adding and Working with Launch (Debug or Run) Configurations.

   - In the project CDD, add the server properties in the Properties section on the Cluster tab.

What to do next

For accessing the AsyncAPI specification of your TIBCO BusinessEvents application at run time, see Accessing AsyncAPI Specification at Run Time.

Did you find this helpful?

YesNo
Great!
Thanks for taking the time to give us some feedback.
Sorry about that

Why wasn't this helpful? (check all that apply)

Could not find what I was looking for
Instructions confusing or unclear
Instructions did not work

Want to tell us more?

Please select at least one option or provide details about the issue!!

Error occurred while submitting feedback.

Error2 occurred while submitting feedback.

TIBCO BusinessEvents® Enterprise Edition

Copyright © 2004-2024. Cloud Software Group, Inc. All Rights Reserved.