Release notes - i2 Analyst's Notebook SDK 10.0.2

The following new and updated features are available in this release:

You can install Analyst's Notebook SDK on any machine that matches the Analyst's Notebook system requirements. To use Analyst's Notebook SDK to develop and build plug-ins for Analyst's Notebook effectively, be aware that the SDK is provided in two distinct parts: the main SDK, and the addendum that enables interaction with i2 Analyze and Analyst's Notebook Premium.

Note: Administrator privileges are required to install Analyst's Notebook SDK.

The installer for Analyst's Notebook SDK works on a per-user basis. The documentation is available to all users, but the samples are installed only for the user who ran the installer. If another user needs to use the SDK on the same computer, they must use the Install Sample Material tool to duplicate the sample content.

1. Close all open applications.
2. Extract the product files from your downloaded distribution.
3. Browse to the top level of the folder structure, and run Setup.exe.
4. Follow the prompts to complete the installation.

The following commands are added to the Start menu:

i2 Analyst's Notebook Premium SDK Addendum enables the development of Analyst's Notebook plug-ins that can interact with i2 Analyze records on charts and in the Information Store. It can be applied to a system with an existing installation of i2 Analyst's Notebook SDK 10.0.1.

The i2 Analyst's Notebook SDK installation includes a ZIP file that contains folders named Samples and Documentation. You can find the file alongside the documentation in your installation. By default, its location is C:\Program Files\i2 Analyst's Notebook 10 SDK\Resources\en-US\Documentation\Premium Addendum.zip.

After you extract it, you can put the contents of the Samples folder wherever you would normally store Visual Studio development projects. The sample projects require either Microsoft Visual Studio 2017 with .NET Framework version 4.7.2, or Microsoft Visual Studio 2019 with .NET Framework version 4.8.

The documentation, which describes the samples and the new API, is in HTML format and best viewed when hosted on a web server. The simplest approach is to use your existing i2 Analyze server:

1. Copy the Documentation folder from Premium Addendum.zip to the server where the i2 Analyze deployment toolkit is installed. Put the Documentation folder in the toolkit\configuration\fragments\opal-services folder, alongside the existing WEB-INF folder.

   Note: "Documentation" forms part of the URL for the API documentation. To change the URL, rename the copied folder before you complete the next steps.

2. On the i2 Analyze server, open a command prompt and navigate to the toolkit\scripts folder in the deployment toolkit.

3. Enter the following commands in sequence to redeploy and restart the i2 Analyze server with the new API documentation:

   setup -t stopLiberty
   setup -t deployLiberty
   setup -t startLiberty

After the server restarts, you can read the documentation at http[s]://<host_name>/opal/Documentation, where <host_name> is the fully qualified name of the i2 Analyze server, and Documentation might be different if you changed the directory name in Step 1.

Note: i2 products are supported on hardware virtualization environments that run any of the operating systems that are listed in the detailed system requirements. When you run in a virtual environment, any issues that i2 can replicate in a supported operating system are addressed by using the standard support policy. Trial editions of i2 Analyst's Notebook cannot be run in virtualized environments.

Note: Microsoft Edge Webview2 is available from https://developer.microsoft.com/en-us/microsoft-edge/webview2/. You must install it by choosing the option to Install as administrator.

i2 supports this product on the following regional versions of the supported operating systems:

i2 products support unicode data.

The following languages are supported:

³ Help available in English only.