Integrations - General Integrations Process

Owned by John Hall (Unlicensed)
Last updated: Jul 24, 2020
2 min read

Overview

This document is intended to provide a Developer Partner with an overview of the general process followed when they elect to do an integration with the ThreatConnect Platform. This document is geared towards both the business and technical audience.

General Integration Process

For the most part, each integration will progress through the following steps below. A Technology Partners Agreement must be in place to complete this process:

  1. Introductory Meeting

    1. We’d like to get together for a brief introduction to understand the high-level focus of your organization. We’ll introduce the Developer Partner program and gauge your interest in participating.

  2. Solutions Discovery Meeting

    1. You will provide a brief overview of your core functionality and/or platform. We’d actually like to see your solution.

    2. We will provide an overview of the ThreatConnect Platform and integration options we have available.

    3. We’ll discuss ideas around how your solution could integrate with the ThreatConnect Platform. Either as a part of this meeting or a follow-up, we’ll work with you to select the type of integration you’d like to do first with the ThreatConnect Platform.

  3. Sandbox Access

    1. You will be asked to complete our Sandbox Registration form.

    2. You will be provided with access to our Sandbox Environment to familiarize yourself with our environment and perform hands-on discovery of our platform. This will include access to our API and other development tools in-platform.

  4. Integration Training

    1. Either as a follow-up from the Solutions Discovery Meeting or through communication about your Sandbox Environment experience, your ThreatConnect Solutions Engineer will schedule Integration Training with you to cover the specific integration scenario you’re building.

  5. Solution Design

    1. You are provided with the Solution Design Document template and an example. You should work to complete your design in consultation with your ThreatConnect Solutions Engineer and then return to your Solutions Engineer for review and approval.

  6. Integration Development

    1. Once your Solution Design Document is approved, you will begin your development work for the integration. Unless otherwise discussed, most integrations are one single cycle of work.

    2. You will complete your QA process on your development work.

    3. You will create your User Documentation and Integration Slide/Video (if required).

    4. You will package your deliverable appropriately if applicable.

    5. You will provide all of your completed assets (deliverable package if applicable, documentation, slides/video) to your ThreatConnect Solutions Engineer.

  7. Integration Vetting

    1. Your ThreatConnect Solutions Engineer will review each asset you’ve provided and perform vetting. See the https://threatconnect-techpartners.atlassian.net/wiki/spaces/DP/pages/458968 article for specific details of what this entails.

      1. During this time, you may be asked for changes to your assets. We do our best to capture our expectations in this document to avoid any re-work on your part.

    2. After all assets have been reviewed and approved, your Solutions Engineer will indicate that vetting is complete.

      1. NOTE: At this point, we cannot proceed in the process without a Technology Partners Agreement in place.

  8. Integration Release

    1. You will be asked to clone one of our GitHub repositories and create a pull request from your own GitHub account in order to publish your integration. See the Package Delivery section for details.

    2. Your pull request will be approved by your Solutions Engineer and your integration becomes live on our GitHub page.

  9. Launch Activities

    1. Your primary business contact will work with your ThreatConnect Partner Director to begin go-to-market and sales enablement activities.