Write Your Own

If none of the existing extensions satisfies your requirements, you can write your own extension. Here are a few steps you can take before starting:

  • Review the Resilient Extensions page to determine which type of extension you need.
  • Understand the data you need from the Resilient platform, and the actions or decisions to be made based on the results.
  • Determine whether to use the Resilient integration server. If writing in Python, this is the preferred method and the Resilient Circuits framework can simplify your development.
  • If you have access to extensions that are similar to the one you wish to create, use that extension as a template to save time.
  • Consider sharing your integration with the larger IBM Resilient community at the IBM Security App Exchange.
  • Consider sharing your source code with others in the IBM Resilient Community Apps repository on GitHub.
  • Publishing Extensions

    Technology Partners and IBMers can submit Resilient extensions to the IBM Security App Exchange portal and/or IBM Resilient Community Apps repository on GitHub.

    Content posted on the IBM Security App Exchange goes through a validation process, as all applications and content extensions are reviewed by IBM Resilient quality teams.

    You will be asked to provide a set of material, along with your extension code. Please see below for the type of material you will be asked to provide. You will also need to package and sign your content. Once you have gathered this material, you can request access to the IBM Security App Exchange portal to submit this material and schedule a validation test.

    Your Extension

    The extension must be supplied as a ZIP file. Typically this just contains an installable Python package, such as the packages created by resilient-circuits codegen. These can include all the required Resilient platform extensions:

    • Code for Functions or Custom Actions
    • Rules, Phases and Tasks
    • Scripts and Workflows
    • Custom Fields and Data Tables

    Application Information

    • Application Version/Release/Modification Numbers
    • Short Description
    • Long Description
    • Minimum supported Resilient platform version
    • Support Email or URL
    • Indicate if your extension requires Internet access
    • Indicate if your extension contains encryption functionality or cryptography

    Application Documentation

    • Documentation
      (PDF or URL link to user documentation for your extension)
    • Graphics
      • 100*100 px .png – Your Company Logo
      • 200*72   px .png – Your Extension Logo
      • Screenshots to show your extension displays in Resilient (min 1280*720 px png or jpg)
    • Optional: Brief Video

    Legal

    • Application License (click-through for end-users to download the extension). Typically this is the Apache or MIT open-source license.
    • Business Partner Agreement (signed by you). This legal document provides the ability for IBM to post your extension on the IBM Security Exchange.

    Test information

    Please provide as much information as possible to enable the validation engineers to effectively test your extension. Useful test information typically includes:

    • Good user documentation!
    • Credentials for cloud access to your software (preferred), or instructions to configure your software for on-premise testing.
    • Test cases that cover all the significant functionality.
    • Walk-through each of the use cases of your Resilient extension and show the resulting screens with data.

    See the Reference page for a list of communities and documentation.