Application Framework Development Guide

Note: Use this documentation for maintaining apps built using CentOS, Python 2, and the QRadar App Framework version 1. For newer apps built using Red Hat Universal Base Image (UBI) 8 and Python 3, see the App Framework version 2 documentation. IBM® X-Force® Exchange no longer accepts new apps using App Framework version 1.

• QRadar app framework version 1
  • What’s new for the application framework in QRadar V.7.4.0
  • QRadar apps
  • QRadar app development overview
  • GUI application framework fundamentals
  • App file structure
    • Application manifest structure
    • Source dependencies
    • Installing Node.js as a source dependency
  • Manifest object types
    • Areas type
    • REST method type
    • Dashboard items type
    • Configuration pages type
    • GUI Action type
    • Page scripts type
    • Metadata providers type
    • Resource bundles type
    • Developer options type
    • Resources type
    • Fragments type
    • Custom columns type
    • Services type
    • Environment variables type
  • The Hello World sample app
    • New tab example
  • Software development kit overview
    • Optimize app memory usage
  • Installing the SDK
  • Use Python 2.7 in your app
  • Creating your development environment
    • Developing apps in Eclipse
    • Installing Python 2.7.9 on OSX
    • Packaging and deploying your app
    • Running your application locally
  • OAuth app authorization with QRadar
    • Enhancing security in app authorization by using the App Authorization Manager
    • OAuth bearer token
  • Encryption and secure data storage in app development
  • Multitenancy support for apps
  • Creating an extension from your app
    • Adding multiple apps in an extension
    • QRadar content extensions
    • Extensions management
  • Sample apps
    • Dashboard item example
    • Page script / toolbar button example
      • Page script samples
    • Passing context-specific information to a page script
    • Context-specific metadata provider example
    • Add right-click functionality
    • Custom fragments example
    • Custom column example
    • Named service sample app
  • Named services
    • Services type
    • Named service sample app
  • Support functions
  • QRadar Python helper library functions
  • Jinja2 templates
    • Integrate JavaScript libraries into your template
  • App Framework JavaScript library
  • Communicating with QRadar hosts from Python
  • GUI Application Framework REST API endpoints
  • App logs
    • Adding logging to your app
    • Viewing your app logs
  • Stopping, restarting, and uninstalling an app
  • App upgrades
  • Available user role capabilities
  • App names, GUI action groups, and page IDs
  • Application globalization
    • Globalization of QRadar elements
    • Globalization of application-specific content
  • Custom fragments injection points
  • Custom column injection points
  • Custom actions for CRE responses
    • Defining custom actions
    • Testing your custom action
    • Adding a custom action script to an event rule
    • Custom action REST API endpoints
    • Custom action and QRadar rules
  • Custom AQL functions
    • Custom AQL function fields
    • Custom AQL function utilities
  • Resources

QRadar App Editor documentation