IBM QRadar 7.4.0 Application Framework Guide IBM Note Before you use this information and the product that it supports, read the information in “Notices” on page 141. Product information © Copyright International Business Machines Corporation 2016, 2020. US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp. Contents Chapter 1. QRadar® app framework version 1......................................................... 1 What's new for the application framework in QRadar V.7.4.0....................................................................1 QRadar apps ................................................................................................................................................1 QRadar app development overview ............................................................................................................2 GUI application framework fundamentals..................................................................................................3 App file structure..........................................................................................................................................7 Application manifest structure...............................................................................................................7 Source dependencies...........................................................................................................................10 Installing Node.js as a source dependency.........................................................................................11 Manifest object types.................................................................................................................................11 Areas type.............................................................................................................................................11 REST method type................................................................................................................................12 Dashboard items type.......................................................................................................................... 13 Configuration pages type..................................................................................................................... 14 GUI Action type.................................................................................................................................... 15 Page scripts type.................................................................................................................................. 17 Metadata providers type...................................................................................................................... 17 Resource bundles type.........................................................................................................................18 Developer options type........................................................................................................................ 19 Resources type.....................................................................................................................................20 Fragments type.....................................................................................................................................20 Custom columns type...........................................................................................................................21 Services type........................................................................................................................................ 22 Environment variables type................................................................................................................. 27 The Hello World sample app..................................................................................................................... 28 New tab example..................................................................................................................................30 QRadar App Editor .................................................................................................................................... 32 What's new in the QRadar App Editor..................................................................................................33 Known issues........................................................................................................................................33 Installing the QRadar App Editor......................................................................................................... 34 Starting the QRadar App Editor............................................................................................................35 Editing apps in the editor..................................................................................................................... 37 Software development kit overview..........................................................................................................38 Optimize app memory usage............................................................................................................... 39 Installing the SDK...................................................................................................................................... 40 Use Python 2.7 in your app .......................................................................................................................40 Creating your development environment................................................................................................. 41 Developing apps in Eclipse.................................................................................................................. 42 Installing Python 2.7.9 on OSX............................................................................................................ 43 Packaging and deploying your app...................................................................................................... 44 Running your application locally..........................................................................................................45 OAuth app authorization with QRadar ......................................................................................................45 Enhancing security in app authorization by using the App Authorization Manager........................... 46 OAuth bearer token.............................................................................................................................. 46 Encryption and secure data storage in app development ....................................................................... 48 Multitenancy support for apps.................................................................................................................. 49 Creating an extension from your app........................................................................................................ 50 Adding multiple apps in an extension..................................................................................................51 QRadar content extensions..................................................................................................................52 Extensions management......................................................................................................................54 Sample apps.............................................................................................................................................. 54 iii Dashboard item example..................................................................................................................... 55 Page script / toolbar button example.................................................................................................. 58 Passing context-specific information to a page script........................................................................ 63 Context-specific metadata provider example..................................................................................... 65 Add right-click functionality.................................................................................................................67 Custom fragments example.................................................................................................................69 Custom column example..................................................................................................................... 71 Named service sample app..................................................................................................................73 Named services......................................................................................................................................... 75 Services type........................................................................................................................................ 77 Named service sample app..................................................................................................................81 Support functions...................................................................................................................................... 83 QRadar Python helper library functions....................................................................................................85 Jinja2 templates.......................................................................................................................................