...

• Playbooks and/or Components: Exported into a TCX file from the Playbooks editor.

• Playbook Apps (one of the methods below):

  • Published using Release within the ThreatConnect Sandbox environment. The released package can be downloaded from the App Builder interface as a TCX file.

  • Packaged using the ‘tcpackage’ command from your development environment if you’ve elected to develop outside of the platform.

• Runtime Apps: Packaged using the ‘tcpackage’ command from your development environment.

...

A summarized version of your display name without spaces (use _ as a substitute if necessary) should be used in package naming (internal name, file name). The release major version of your integration should be included in your package name at the end (such as v2.0.1). For example, if your display name is “Awesome ThreatMonitor ES”, you might use “awesome_threatmonitor_es_v2.0.1” as your technical package name.v2” as your technical package name.

The version of your integration is stored within the install.json file as the programVersion field. When using the in-platform App Builder, the install.json is managed for you behind the scenes based on the values you specify within the UI. When packaging using ‘tcpackage’ outside of the platform, your package name will be automatically generated for you based on the value of programVersion.

Version Changes

When changing the version of your integration, this should be done with the following guidelines and consequences in mind:

• Major Versions

  • Changes to the Major version indicates that a breaking change has been made that will break existing implementations.

  • When updating a major version within a package outside of the platform, you must update the following fields:

    • programVersion in install.json

    • app_version in tcex.json (with the major version only)

• Minor Versions

  • Changes to the Minor version indicates that significant changes have been made but nothing that breaks existing implementations.

  • When updating a minor version within a package outside of the platform, you must update the following fields:

    • programVersion in install.json

• Release Version

  • Changes to the Release version indicates that minor bug fixes or small enhancements have been made.

  • When updating a release version within a package outside of the platform, you must update the following fields:

    • programVersion in install.json

Package Delivery

The following guidelines should be used when delivering an integration for the ThreatConnect Platform:

...