About cookies on this site Our websites require some cookies to function properly (required). In addition, other cookies may be used with your consent to analyze site usage, improve the user experience and for advertising. For more information, please review your options. By visiting our website, you agree to our processing of information as described in IBM’sprivacy statement. To provide a smooth navigation, your cookie preferences will be shared across the IBM web domains listed here.
Release Notes
Abstract
IBM i2 Analyst's Notebook SDK Release Notes
Content
IBM® i2® Analyst's Notebook® SDK 8.9.7 is available. This document addresses compatibility, installation, and other getting-started issues.
Contents
Description
You can use IBM i2 Analyst's Notebook SDK to extend the technology and functionality available in IBM i2 Analyst's Notebook. You can seamlessly integrate Analyst's Notebook with your applications, and make your own custom analysis tools that complement and extend the powerful capabilities of Analyst's Notebook.
Version 8.9.7 of Analyst's Notebook SDK provides developers with programmatic control over the new grouping function in the Analyst's Notebook application. The new version also adds similar support for a handful of other features that are related to the appearance of chart items.
A new document, IBM i2 Analyst's Notebook SDK Addendum, provides detailed information about all aspects of the new functionality available in version 8.9.7.
Important: IBM i2 intelligence analysis software at version 8.9 is not compatible with earlier versions of i2 software. Upgrading directly is not supported. To install IBM i2 software at version 8.9, you must uninstall all of your existing i2 software, and then install the new versions.
The program or programs that are covered by these release notes are designated for use by developers.
Announcement
The Analyst's Notebook SDK 8.9.7 announcement is available.
See the announcement for the following information:
- Detailed product description, including a description of new functionality
- Product-positioning statement
- Packaging and ordering details
- International compatibility information
Release highlights
The following new feature is available in Analyst's Notebook SDK 8.9.7:
- The Analyst's Notebook API gained features that provided finer control over the colors of lines that the application displays in various circumstances. A custom line color can now be set independently of the item type.
System requirements
For information about hardware, software, and international compatibility, see the detailed system requirements.
Documentation
Analyst's Notebook SDK provides an extensive documentation set.
Manuals
The manuals in the documentation set are supplied in PDF format, and are installed to:
CSIDL_PROGRAM_FILES\i2 Analyst's Notebook 8 SDK\Resources\en-US\Documentation
The following manuals exist for Analyst's Notebook SDK:
- IBM i2 Analyst's Notebook SDK Addendum
- IBM i2 Analyst's Notebook SDK Developer Guide: Concepts
- IBM i2 Analyst's Notebook SDK Developer Guide: Tutorials
- IBM i2 Analyst's Notebook SDK Upgrade Guide
The manuals are also available from the Start menu, at .
In addition, there are release notes for both the SDK and the Analyst's Notebook API in the Analyst's Notebook SDK product distribution:
- IBM i2 Analyst's Notebook SDK Release Notes (this document)
- IBM i2 Analyst's Notebook SDK - Analyst's Notebook API Release Notes
Online help
Analyst's Notebook SDK includes the following online documentation:
- SDK online help
-
After you install the SDK, reference information for all controls, classes, interfaces, properties, methods, and events in the API is integrated with Visual Studio 2008.
In case you use a different development environment, the information is also provided as online help, in a stand-alone CHM file. This version is available from the Start menu, in .
- Sample projects help
-
In each sample project folder, there is a shortcut that takes you directly to the help topic for that sample. The topics are also available together in a CHM file at .
- Component category add-in online help
-
A further CHM file contains information about how to use the Component Category Add-in, and descriptions of the available component categories. This help is available through the Visual Basic 6 user interface.
Sample code
Analyst's Notebook SDK includes a comprehensive set of sample code projects. For the default installation location, these projects are available in subfolders at:
CSIDL_LOCAL_APPDATA\i2\Analyst's Notebook 8 SDK\en-US\Sample Projects
The Sample Projects folder can be accessed by using the Start menu under .
Detail about each sample project is available from the shortcut in each sample project subfolder, and from the main IBM i2 Analyst's Notebook SDK Sample Projects online help.
Note: Before you compile a plug-in project, you must complete the Ii2AuthorDescription.GetAuthorDescription method implementation.
Tutorial code
Analyst's Notebook SDK includes a set of projects that accompany Developer Guide: Tutorials. There are two versions of each project available in the corresponding folders: Starter and Completed. You can use the starter projects to work through the tutorials in the guide. The completed projects show the finished code, and can be used outside the context of the guide. For the default installation location, these projects are available in subfolders at:
CSIDL_LOCAL_APPDATA\i2\Analyst's Notebook 8 SDK\language\Tutorials The Tutorials folder can be accessed by using the Start menu under .
Note: Before you compile a plug-in project, you must complete the Ii2AuthorDescription.GetAuthorDescription method implementation.
Note: Some of the projects in the Starter folders do not compile until you work through the steps of the tutorial.
Installation
To install IBM i2 Analyst's Notebook SDK:
- Close all open applications.
- Extract the product files from your downloaded distribution, or insert the product CD into the optical drive.
- Browse to the top level of the folder structure, and run Setup.exe.
- Follow the prompts to complete the installation.
The following shortcuts are added to the Start menu:
| Run the interactive API examples | |
| Install templates and sample projects for more users | |
| Access the product documentation in PDF and CHM format | |
| Go to the Sample Projects folder | |
| Go to the Tutorials folder |
Note: Administrator privileges are required to install Analyst's Notebook SDK.
Per-user installation behavior
The installer for Analyst's Notebook SDK works on a per-user basis. The documentation is available to all users, but the templates, samples, and tutorials are installed only for the user who actually started the installer. If another user needs to use the SDK on the same computer, they must use the Install Sample Material tool to duplicate this content.
Automated and silent installs
To install an IBM i2 product with all of its default settings, but with no need for intervention from the user, you can install the product "silently":
Setup.exe /s /v/quiet
In terms of the installed product, issuing this command has the same effect as double-clicking the file and giving the simplest possible (affirmative) response to every question. However, the user sees no feedback at all about the installation process until the product shortcut is displayed on the Start menu.
To provide the user with a little more information about what is happening to their computer (but still with the default options), you can use /passive instead of /quiet:
Setup.exe /s /v/passive
Using Windows Installer (MSI)
This version of Analyst's Notebook SDK is also available as an MSI package.
Upgrade notes
This version of Analyst's Notebook SDK can be installed and used alongside versions of Analyst's Notebook 6 SDK, but not Analyst's Notebook 7 SDK or previous versions of Analyst's Notebook 8 SDK. If the installer detects an existing installation of the latter, you are prompted to uninstall it before you are able to proceed.
Any projects or customization work that you created with Analyst's Notebook 6 SDK must be upgraded before you can use them in an Analyst's Notebook 8.9 environment. Furthermore, you can augment projects that were created with versions 6 and 7 of the SDK to take advantage of new features in the Analyst's Notebook API. Details of these processes are given in the IBM i2 Analyst's Notebook SDK Upgrade Guide.
Known problems
At the time of publication, the following are known problems with Analyst's Notebook SDK.
- Printing from the API Example Viewer can clip long lines of code
-
When you view an example in the API Example Viewer, you can click Print Example to generate a hardcopy of the code. However, the ends of long lines of code can be absent from the hardcopy. One way to avoid this limitation is to click Copy Example instead, paste the code into a text editor, and print the example from that application.
- Integrated online help ("F1 Help") in Visual Studio 2008 can require extra configuration
-
Installing Analyst's Notebook SDK configures Visual Studio 2008 so that highlighting a term in the editor and pressing F1 displays API documentation for that term in the help viewer. However, settings elsewhere in Visual Studio 2008 can affect this behavior.
If relevant help is not displayed when you press F1, you must change how Visual Studio looks up help content through the settings. Choose either the Try local first or the Try local only option to enable "F1 Help" for Analyst's Notebook SDK.
Copyright statement
© Copyright IBM Corporation 1991, 2014. All rights reserved. For legal information, see http://www.ibm.com/legal/copytrade.shtml.
[{"Product":{"code":"SSXVTH-1","label":"i2 Intelligence Analysis Platform"},"Business Unit":{"code":"BU008","label":"Security"},"Component":"i2 Analyst\u0027s Notebook SDK","Platform":[{"code":"PF033","label":"Windows"}],"Version":"8.9.3;8.9.1;8.9.7","Edition":"","Line of Business":{"code":"","label":""}}]
Was this topic helpful?
Document Information
More support for:
i2 Intelligence Analysis Platform
Software version:
8.9.3, 8.9.1, 8.9.7
Operating system(s):
Windows
Document number:
594805
Modified date:
19 February 2022
UID
swg27041299