IBM i2 Analyst's Notebook SDK 8.9.7 Fix Pack 1 Readme

Content

• Download location
• Prerequisites
• Installation information
• List of fixes
• Document change history
• Copyright and trademark information

Download location

IBM i2 Analyst's Notebook SDK 8.9.7 Fix Pack 1 can be downloaded from Fix Central. For more information, see the download document:

https://www.ibm.com/support/pages/node/6226520

Prerequisites

This fix pack can be applied to a system with an existing installation of IBM i2 Analyst's Notebook SDK 8.9.7. 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.

Installation information

The fix pack distribution contains folders named Samples and Documentation. 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:

1. Copy the Documentation folder from this distribution 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

4. 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.

List of fixes

IBM i2 Analyst's Notebook SDK 8.9.7 Fix Pack 1 enables the development of Analyst's Notebook plug-ins that can interact with i2 Analyze records on charts and in the Information Store. The distribution includes a set of API documentation and sample projects that demonstrate some applications of the new functionality:

• The Hosting sample demonstrates hosting an HTML and JavaScript user interface within Analyst's Notebook Premium that has authentication tokens for an i2 Analyze server.
• The SendResultsToHandling sample demonstrates how to receive results from an i2 Analyze results list (Quick Search or Visual Query, for example) and send them for consumption outside Analyst's Notebook Premium.
• The TextMarkup sample demonstrates how to create and read records on the chart, validate values, and make use of the schema from the i2 Analyze server.

Notices

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some jurisdictions do not allow disclaimer of express or implied warranties in certain transactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors. Changes are periodically made to the information herein; these changes will be incorporated in new editions of the publication. IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this publication at any time without notice.

Microsoft, Windows, and Windows Server are trademarks of Microsoft Corporation in the United States, other countries, or both.

Other company, product, or service names may be trademarks or service marks of others.

THIRD-PARTY LICENSE TERMS AND CONDITIONS, NOTICES AND INFORMATION

The license agreement for this product refers you to this file for details concerning terms and conditions applicable to third party software code included in this product, and for certain notices and other information IBM must provide to you under its license to certain software code. The relevant terms and conditions, notices and other information are provided or referenced below. Please note that any non-English version of the licenses below is unofficial and is provided to you for your convenience only. The English version of the licenses below, provided as part of the English version of this file, is the official version.

Notwithstanding the terms and conditions of any other agreement you may have with IBM or any of its related or affiliated entities (collectively "IBM"), the third party software code identified below are "Excluded Components" and are subject to the following terms and conditions:

• The Excluded Components are provided on an "AS IS" basis
• IBM DISCLAIMS ANY AND ALL EXPRESS AND IMPLIED WARRANTIES AND CONDITIONS WITH RESPECT TO THE EXCLUDED COMPONENTS, INCLUDING, BUT NOT LIMITED TO, THE WARRANTY OF NON-INFRINGEMENT OR INTERFERENCE AND THE IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
• IBM will not be liable to you or indemnify you for any claims related to the Excluded Components
• IBM will not be liable for any direct, indirect, incidental, special, exemplary, punitive or consequential damages with respect to the Excluded Components.

Document change history

First Published: 25 June 2020

Copyright and trademark information

IBM, the IBM logo, and ibm.com are trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at http://www.ibm.com/legal/copytrade.shtml.