Open topic with navigation

TIBCO BusinessEvents® Enterprise Edition 6.3.1

# AsyncAPI Specification Support

TIBCO BusinessEvents supports the industry-adopted AsyncAPI specification, which allows an interaction between event-driven, APIs-based applications in a consistent and standard manner. The AsyncAPI specification is a machine-readable format for defining the message exchange patterns as per consumers for event-driven APIs and works over any protocol. See AsyncAPI documentation for details.

You can export your TIBCO BusinessEvents project using the AsyncAPI specification that can be consumed by another TIBCO BusinessEvents project or a third-party product in a different ecosystem and generate resources.

TIBCO BusinessEvents can parse an imported AsyncAPI specification and create the required project artifacts based on its contents: the concepts, events (with or without payload), channels, destinations, and shared resources.

In TIBCO BusinessEvents, property-based configurations artifacts for Kafka, shared resources for HTTP and both for JMS channels can be exported and imported by using the AsyncAPI specification. For Kafka and JMS channels, there must be a one-to-one mapping between channel destination and topic, queue.

Note: The following artifact fields are not supported when a TIBCO BusinessEvents project is exported by using an AsyncAPI Specification:

- Concept TTL and Event TTL
- Channel SSL section
- SSL fields
- Pageflow type for HTTP Channel
- Description field for a channel, destination, event, and shared connection

The following artifact fields are not supported when a TIBCO BusinessEvents project is imported by using an AsyncAPI Specification:

- Third-party specification having object type as array. The array property in Event is not supported.

- oneOf section in AsyncAPI message definition

- Event Payload that consists 'XML Element Reference' type under 'Complex Element'

- Nested properties

- When a project has an Event payload with multiple contained and referenced concepts, the import operation does not create all referenced or contained concepts if the x-ConceptPath and x-event-payload type tags are excluded from the exported specification.

For details about the supported versions, see the Readme.txt file available at the TIBCO BusinessEvents® Enterprise Edition Product Documentation page.

Subtopics

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.