Table Of ContentIBM
IBM i2 Enterprise Insight Analysis
Configuring a deployment before going live
Version 2 Release 1
Note
Before using this information and the product it supports, read the information in “Notices” on page 123.
This edition applies to version 2, release 1, modification 6 of IBM i2 Enterprise Insight Analysis (product number
5725-G23) and to all subsequent releases and modifications until otherwise indicated in new editions.
© Copyright IBM Corporation 2014, 2017.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Going live to Enterprise Insight Analysis C o n f i g u r i n. .g . . a . d. d. .i 6 t 2 i o n a l s e c u r i t y
C o ne f i Se g e ucS ruo rc k e At sn a L6l ay3 yz ee r w i t h i 2
users . . . . . . . . . . . . . . . . 1
C o n f i g u r i n g S P N E G O s i n g l e s i g n - o n f o r i 2
M o d i f y i n g .t .h . e . . b . a. s. 1i c d e p l o y m e n t
A n a .l .y . z . e. . . . . . . . . . 7 5
M o d i f y o i nn mg oe ptn eh.t r.e .tp .ier .en1 s v i r
C o n f i g u r i n g X . 5 0 9 c l i e n t c e r t i f i c a t e a u t h e n t i c a t i o n
M o d i f y i . n . g. . t. h. .e . . t . o2 p o l o g y
w i tA hn a .i l.2 y. z. .e . . . . . . . 8 2
M o d i f y i n S g e r tovhpe eer .r I.tp1Bi r0Me s H T T P
C o n f i cg hu r oi. pn. t.g i. .os .ne . sa. r. 9 0
M o d i f y i n g t h . e . . d. 11a t a b a s e c o n f i g u r a t i o n
C o n f i g A u n r ai ln yg zc .eht . h .Oe. 9p 0ai 2l s e a r
M o d i f ey di en. ng. t. i.t a.h .l e .s . c. r. 1 6
C o n f i g A u n r aAi lnnygaz l ety hs ei s i 2R e p o s i t o r y
A d d ie n gd ac mte .aos . r . s . o. u. .r . . 1 8
s ec a.h .r . . . . . . . . . . . . . 1 0 4
A d d i n g a en . . I . n . f . o. r. 1m8 a t i o n S t o r
C o n f i g A u n r ai ln yg zc eht. h. O.e 1 n 0 yi 72x s e a r
A d d Ai nn ga l ay ns . i . s . . R. e. .p1 o9 s i t o r y
M o v i n g a d e p l .o . y . 1m1 6e n t t o o l k i t c o n f i g u r a t i o n
C o n n e c t i n gc e . t s. o . . e. 2x 1t e r n a l d a t a s o u r
R e d e p le os ye itA nt n ig an . l ga. y . n z.id e.21 1 r 7
R e p l a Ac ni na gl y t.z .he . e . s . ic. 2h. 4 e 9m a
C l e a r o i mn g t h.d .ea . t . sa. y . sf. 1tr1 e7 m
C e r a t i An ng a al yn z ei 2 s c h e m a a n d c h a r t i n g
R e m o v i no gm dt ah .te .a . bs. 1ay1 ss7 et se m f r
s c h e. .m . e . s. . . . . . . . . . 5 0
D e p l Ao ny ai. n.l .yg . z . ei . 2. . . . 11 8
S p e c i fA yn i a n l gy z t e h es c i h 2 e m a a n d t h e
B a c k i n g .u . p . . a. . d. .e . p11 l 9 o y m e n t
c h a r t .i .n . g . . s. c. h. .e . m. e. 5 1
B a c k i fn lg i A nune pa li ay2 n.z . e .o 11 fs 9 y s t e m
C o n f i g u r i n g t . h . e. . 5s 2e c u r i t y s c h e m a a n d u s e r s
B a c k i n g A un pa l ay n.z . e .o 1 ns2 yl1 is nt e m i 2
S e c u r i .t . y . . s . c. h. .e . m. a. 5s 3
S e c u r i t y . s . c. h. .e . m. a. 5 3d e f i n i t i o n s
C e r a t i n g a . . s . e . c. u. .r .i 5 t 6 y N so c t h.i .ec .me. as. . . . . . . . . . 1 2 3
S p e c i f y i n g. . a. . .s . e . c5 u8 rTri at dy e . ms. ca. .rh .ke . sm. a. . . . . . . 1 2 5
S e t t i n g d e f. a. .u . l . t . 5 d9 i m e n s i o n v a l u e s
S e t t ei nb gSe A p uph pe lr iW c a t i o n S e r v e r L i b e r t y
p o r f i l e . . s. e. c. .u . r . i . t . y. . 6 0
© C o p y r i g h t I B M C o r p . 2 0 1 4 , 2 0 1 7 i i i
iv Configuring a deployment before going live
Going live to Enterprise Insight Analysis users
After you successfully create an example deployment of i2 Enterprise Insight
Analysis, the next phase is to prepare it for production by customizing it for your
organization. Before your deployment goes live, you must provide it with an i2
Analyze schema and a security schema, and you might decide to add services or
data stores to the base functionality.
Modifying the basic deployment
In the deployment toolkit, you can identify and modify the core components of
your deployment. You can use the toolkit to customize aspects of your
deployment.
Modifying the environment properties
The script in the deployment toolkit that deploys i2 Analyze requires information
about the deployment environment. In the environment properties you can identify
your DB2 location, specify the installation directories that i2 Analyze uses, and
specify the locations that i2 Analyze can store data.
About this task
Each application that is defined in your topology file has an associated folder in
the toolkit\configuration\environment directory that stores information about the
environment that is specific to that application. There are two main files that are
stored for each of your applications:
environment.properties
This file contains the file paths to use with the application. All the
properties in this file must have values that match the environment.
environment-advanced.properties
This file contains additional options about your environment. Although
you can modify the values in this file, you can deploy the application
without making any changes.
The following properties are in the environment.properties file:
db.installation.dir.db2
The installation path of DB2.
db.database.location.dir.db2
The path to the directory at the root of DB2 database file storage.
wlp.home.dir
The installation path for WebSphere Application Server Liberty profile.
Important: On Linux, when you run the deployment script, ensure that
you have permission to read, write, and execute files in these directories.
java.home.dir
The installation path for the IBM Java JDK.
solr.home.dir
The installation path for Apache Solr and Zookeeper.
© Copyright IBM Corp. 2014, 2017 1
Note: This property is only required in a deployment that uses the Opal
services.
apollo.data
The path to a directory where i2 Analyze temporary files are stored.
Procedure
For each application:
1. Using a text editor, open the environment.properties file.
2. Using the preceding descriptions, ensure that the property values match the
deployment environment.
3. Save and close the file.
What to do next
After you update the environment properties, you can either modify other aspects
of the deployment toolkit or redeploy the system to update the deployment with
any changes. For more information about redeploying your system, see “Deploying
i2 Analyze” on page 118.
Modifying the topology
The topology.xml file contains the description of the physical architecture of the
system that you want to deploy. To change the physical architecture of the system,
you must update the topology.xml file and redeploy the system.
About this task
The topology.xml file contains the information that the setup script requires to
identify the prerequisites that are being used, where the system stores information,
and the fragments to combine to create the application.
You can make a number of changes to the topology.xml file. For more information
about the changes that you can make in the topology.xml file, see “The topology”
on page 3.
Procedure
1. Using an XML editor, open toolkit\configuration\environment\topology.xml.
2. Change the values of any attributes to match your environment.
3. Check that the locations that i2 Analyze can store files match your
environment.
Note: Ensure that any paths you set are to locations where the application
server has permission to store files.
4. Save your changes and close topology.xml.
What to do next
After you update the topology file, you can either modify other aspects of the
deployment toolkit or redeploy the system to update the deployment with any
changes. For more information about redeploying your system, see “Deploying i2
Analyze” on page 118.
2 Configuring a deployment before going live
The topology
In the deployment toolkit, the topology file defines the physical architecture of the
finished deployment, and the components that make up the pieces of that
architecture. The topology file contains domain-specific information that you must
provide before deployment can take place.
The topology.xml file contains distinct sections for defining different aspects of a
deployment.
i2-data-sources
A definition of each data source that is available within the deployment.
databases
The names, types, and locations of the databases that i2 Analyze uses to
store data.
applications
The applications that comprise this deployment of i2 Analyze, and the
locations of the application servers on which they are to be installed.
zookeepers and solr-clusters
The Zookeeper hosts and Solr clusters that are used in this deployment.
Data sources:
The topology files that are supplied with each example in the deployment toolkit
contain preconfigured <i2-data-source> elements. You can add additional
<i2-data-source> elements to define other data sources.
The <i2-data-sources> element must contain an <i2-data-source> element for
each data source that the deployment connects to. For example:
<i2-data-sources>
<i2-data-source ar="false" default="false" id="infostore">
<DataSource Version="0" Id="">
<Shape>InfoStore</Shape>
<Name>Information Store</Name>
</DataSource>
</i2-data-source>
</i2-data-sources>
Where:
Attribute Description
id A unique identifier that is used to distinguish this data
source throughout the system.
ar Indicates whether this data source is the Analysis
Repository. This attribute must be set to true for the
Analysis Repository, and to false for any other data source.
default An optional attribute that is used to specify that a different
data source from the Analysis Repository should be marked
as the default searching option within the Intelligence
Portal. To specify a different data source as the default, set
this attribute to true for that data source.
Each <i2-data-source> contains a single <DataSource> element that has two
standard attributes and two child elements.
Going live to Enterprise Insight Analysis users 3
Attribute Description
Id Reserved for future use. The value must be empty in this
version of i2 Analyze.
Version Reserved for future use. The value must be 0 in this version
of i2 Analyze.
Element Description
Shape Specifies the type of structure that the data source uses.
You can specify one of the following values:
v InfoStore
v Repository
v DAOD
Name The name of this data source, which is presented to users.
In addition, for data sources that you connect to using data access on-demand, you
must also specify the following attributes on the <DataSource> element:
Attribute Description
EdrsPresent Indicates whether this data source has an external data
retrieval service.
EdrsGetContextSupported Indicates whether this data source has an external data
retrieval service that supports "get context" operations.
EdrsGetLatestItemsSupported Indicates whether this data source has an external data
retrieval service that supports "get latest items" operations.
SesPresent Indicates whether this data source has a subset exploration
service.
ScsPresent Indicates whether this data source has a subset creation
service.
ScsBrowseSupported Indicates whether this data source has a subset creation
service that supports "browse" (that is, unbound search)
operations.
ScsSearchSupported Indicates whether this data source has a subset creation
service that supports "search" operations.
ScsNetworkSearchSupported Indicates whether this data source has a subset creation
service that supports "network search" operations.
ScsDumbbellSearchSupported Indicates whether this data source has a subset creation
service that supports "dumbbell search" operations.
ScsFilteredSearchSupported Indicates whether this data source has a subset creation
service that supports "filtered search" operations.
4 Configuring a deployment before going live
Databases:
The <databases> element defines each database that i2 Analyze uses to store data.
The <database> elements contain attributes that define information about the
database, and the mechanism that is used to connect to it.
For example:
<database database-type="InfoStore"
dialect="db2" database-name="ISTORE" instance-name="DB""
xa="false" edition="" version="" host-name="host" id="infostore"
port-number="50000" />
Where:
Attribute Description
database-type Identifies the type of the database within i2 Analyze. This can be
one of the following values:
v InfoStore
v WriteStore
v ccConfig
dialect Specifies the type of database engine. This attribute can be set to
one of the following values:
v db2
v sqlserver
v oracle
database-name A name that identifies the database to the database engine.
instance-name The instance name that was specified during installation of your
database engine.
xa Determines whether distributed transactions are enabled for this
database.
edition Identifies the DB2 edition. This can be one of the following values:
v db2aese
v db2awse
v db2wse
v db2ese
v db2exp
v db2expc
v db2consv
version Identifies the DB2 version number.
host-name The host name of the server where the database is located.
id A unique identifier that is used to distinguish this database
throughout the system.
port-number The port on the server to which to send requests for this database.
max-pool-size Sets the maximum number of connections that are allowed in the
connection pool.
Going live to Enterprise Insight Analysis users 5
Applications:
The <applications> element within the topology file describes the location and
structure of the i2 Analyze applications. Each application to deploy on the
application server is described in the child <application> element.
For each application in the deployment, the topology file contains an
<application> element that defines the WAR file and any indexes for that
application.
Indexes
The <lucene-indexes> element defines the Lucene indexes to be used by the
onyx-server application.
At a minimum, the <lucene-indexes> element for the onyx-server application
requires a <lucene-index> child element for the Analysis Repository index.
Attribute Description
id A unique identifier that is used to
distinguish this Lucene index.
main-index-location The location that is used to store the main
index.
alternatives-location The location that is used to store the
alternative term index.
File stores
The <file-stores> element defines the file stores that are used by the opal-server
application. The location attribute specifies the file path to use for each file store.
The other attributes must be left with their default values.
WAR files
The <wars> element contains child <war> elements that define the contents of the i2
Analyze WAR files that are installed on the application server.
Each <war> element has the following attributes:
Attribute Description
target The type of WAR file to create. The following types are available:
v onyx-services-ar
v opal-services-is
v onyx-services-daod
v iBase
v connectorCreator
name The name of the WAR file. By convention, the deployment scripts
expect a directory with the same name to be present.
6 Configuring a deployment before going live
