Overview

The ThreatConnect® TcEx App Framework is a comprehensive development toolkit that provides a wide range of commonly used Classes and Methods specifically designed for writing ThreatConnect Exchange Apps. This powerful Framework aims to streamline the app development process, enabling developers to create robust and feature-rich Apps with ease.

This documentation serves as a detailed guide to the TcEx Framework, providing a comprehensive view of its capabilities and functionality. It includes informative overviews of various Apps to help developers understand core concepts and underlying functionality. The Building Apps: QuickStart section is recommended for developers starting their first App development, as it offers step-by-step instructions and guidance.

Each documentation section provides a thorough description of an App's core functionality. It explores the inner workings of the Framework, offering insights and best practices for leveraging its capabilities effectively. Code references throughout the documentation serve as valuable resources for developers seeking detailed information and clarification on specific implementation details.

The documentation covers two major versions of TcEx: 3 and 4. TcEx version 4 is the recommended version, providing enhanced features and improved compatibility. To ensure optimal compatibility and support, it is advised to use TcEx version 4 alongside ThreatConnect version 7.2 or newer.

Starting in TcEx 4, the functionality of the CLI has been separated into the tcex-cli project. With this change, there is no need to install the TcEx Framework globally anymore. Instead, developers only need to install the tcex-cli project to get started with the CLI tool.

To install the tcex-cli project, you can use pip as follows:

pip install tcex-cli

For developers using TcEx 2, a separate documentation resource is available at https://docs.threatconnect.com/en/latest/tcex/tcex.html. This resource caters specifically to the needs of TcEx 2 users, providing guidance and reference materials for their development endeavors.

ℹ️

TcEx version 4 requires ThreatConnect version 7.2 or greater and Python version 3.11.

ThreatConnect® is a registered trademark of ThreatConnect, Inc.
TC Exchange™ is a trademark of ThreatConnect, Inc.
Python® is a registered trademark of the Python Software Foundation.