Release notes - Analyst's Notebook SDK 9.4.0

A high level overview of the release, listing new features, the system requirements and any known issues.

Note:

This is the last version to support: Windows Server 2012.
The Tutorial guide and supporting materials have been removed.
The templates for Microsoft Visual Studio 2008 have been removed.
The upgrade utility has been removed.

Release highlights

This release is to maintain compatibility with other i2 products that have the same version number.

System Requirements

The following system requirements should be used to ensure that the setup you are running is fully supported. Ensure that existing deployments are upgraded to currently supported versions of all the software required.

Operating systems

To run i2 products, you must ensure that you are using a supported operating system.

The supported operating systems:

Windows 10 Enterprise
Windows 10 Professional
Windows Server 2019 Datacenter Edition
Windows Server 2019 Essentials Edition
Windows Server 2019 Standard Edition
Windows Server 2016 Datacenter Edition
Windows Server 2016 Essentials Edition
Windows Server 2016 Standard Edition
Windows Server 2012 R2 Datacenter Edition
Windows Server 2012 R2 Essentials Edition
Windows Server 2012 R2 Standard Edition

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 can be replicated by i2 in a supported operating system are addressed by using the standard support policy.

Software

To run i2 products, you must ensure that your environment includes the listed prerequisite software. In addition you may need to install companion software to enhance your work flow.

Prerequisites

Runtime Environment


	Minimum version
Microsoft .NET Framework 3.5	SP1
Microsoft .NET Framework 4.7	4.7.2
Microsoft .NET Framework 4.8	4.8

Note:

Both Microsoft .NET Framework 3.5 SP1 and either Microsoft .NET Framework 4.7.2 (or later fix packs) or Microsoft .NET Framework 4.8 are required.
Analyst's Notebook Premium users with third party plug-ins. Chromium Embedded Framework (CEF) version incompatibility can cause errors in third party plug-ins: Within an application process the CEF component is a singleton and as such can only be initialized once. Third party plug-ins that depend on a different version to the version running within the Analyst's Notebook Premium process might experience errors. To avoid these errors, use the same version of CEF contained in Analyst’s Notebook Premium and check whether CEF is already running before starting your plug-in.

Companion Products

i2 Analyst's Notebook (All supported versions)
i2 Analyst's Notebook Premium (All supported versions)

Development Environment

Microsoft Visual Studio 2017
or
Microsoft Visual Studio 2019

Hardware

Ensure that the hardware you are installing onto meets the minimal system requirements. Depending on your environment you may wish to increase these values to improve system performance.

Disk space

At least 2 GB free disk space for installation plus space to store data. This figure does not include disk space that is required for prerequisites. Total disk space requirements depend on number of i2 products to be installed.

Display

Minimum - XGA-capable 1152 x864 high color 16 bit capable graphics card and color monitor
Recommended - SXGA-capable 1280 x 1024 high color 16 bit capable graphics card and color monitor

Memory RAM

Minimum - 2 GB
Recommended - 4 GB

Processor

Minimum - 1.4Ghz processor
Recommended - 2.0Ghz processor

Language support

i2 products are tested on a number of various regional variations of operating systems. In addition they are translated into a number of different languages.

Operating system support

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


Language Group/Language	Language Collection	Support Status
Western Europe and USA	Basic	Supported
Central Europe	Basic	Supported
Baltic	Basic	Supported
Cyrillic	Basic	Supported
Turkic	Basic	Supported
Arabic	Complex Script	Supported
Japanese	East Asian	Supported
Korean	East Asian	Supported
Traditional Chinese	East Asian	Supported
Simplified Chinese	East Asian	Supported
Thai	Complex Script	Unsupported
Vietnamese	Complex Script	Unsupported
Greek	Basic	Unsupported
Hebrew	Complex Script	Unsupported
Indic	Complex Script	Unsupported
Georgian	Complex Script	Unsupported
Armenian	Complex Script	Unsupported
Dhivehi	Complex Script	Unsupported
Galician	Complex Script	Unsupported
Gujararti	Complex Script	Unsupported
Kannada	Complex Script	Unsupported
Krgyz	Complex Script	Unsupported
Mongolian (Cyrillic)	Complex Script	Unsupported
Punjabi	Complex Script	Unsupported
Syriac	Complex Script	Unsupported
Telagu	Complex Script	Unsupported

Data support

i2 products support unicode data.

Download information

Customers who have entitlement can request copies of i2 products.

For more information, see Where can I download the latest i2 products?

Installing the Analyst's Notebook SDK

You can install the Analyst's Notebook SDK on any machine that matches the Analyst's Notebook system requirements. To use the Analyst's Notebook SDK to effectively develop and build plug-ins to Analyst’s Notebook, you should ensure that

Analyst's Notebook SDK is provided in two distinct parts: the main SDK and the addendum that can be used to interact 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 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.

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 are added to the Start menu:


i2 Analyst's Notebook SDK > API Examples Viewer	Run the interactive API examples
i2 Analyst's Notebook SDK > Install Sample Material	Install templates and sample projects for more users
i2 Analyst's Notebook SDK > Documentation	Access the product documentation in PDF and CHM format
i2 Analyst's Notebook SDK > Sample Projects >	Go to the `Sample Projects` folder

Installing the Analyst's Notebook Premium Addendum

i2 Analyst's Notebook Premium SDK Addendum enable the development of Analyst's Notebook plug-ins that can interact with i2 Analyze records on charts and in the Information Store.

The addendum can be applied to a system with an existing installation of i2 Analyst's Notebook SDK 9.4.0. 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.

This fix pack is compatible with i2 Analyze 4.4.0 and Analyst's Notebook Premium 9.4.0.

The i2 Analyst's Notebook SDK installation contains an addendum zip file that contains folders named Samples and Documentation. This compressed folder can be found alongside the documentation in your installation.

For example: C:\Program Files (x86)\i2 Analyst's Notebook 8 SDK\Resources\en-US\Documentation\Premium Addendum.zip

You can put the contents of the Samples folder wherever you would normally store Visual Studio development projects. 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:

Copy the Documentation folder from the 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.
On the i2 Analyze server, open a command prompt and navigate to the toolkit\scripts folder in the deployment toolkit.
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.

Known issues

The following issues are currently reported:

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 Tools > Options > Help > Online settings. Choose either the Try local first or the Try local only option to enable "F1 Help" for Analyst's Notebook SDK.

Inconsistent file paths

Installing Analyst's Notebook SDK creates a number of folders that are marked as '8' instead of '9'. Files in these locations will still be updated to the latest version.