Deploying i2 Analyze with the i2 Connect gateway

This guide walks you through how to deploy i2 Analyze with the i2 Connect gateway only. To deploy i2 Analyze with the Information Store and the i2 Connect gateway, follow this guide.

Prerequisites

Before you start, ensure that you have:

installed i2 Analyze, and
defined a schema to model the data.

License acknowledgement

Open the license_acknowledgement file in your i2 Analyze directory.
Set the value to ACCEPT. It should now look like this:
```
LIC_AGREEMENT = ACCEPT
```

Configuration

Create the configuration directory

In your i2 Analyze directory, navigate to toolkit\examples\configurations\daod-opal.
Copy the configuration directory to the toolkit directory. This provides a starting point for a deployment that includes only the i2 Connect gateway.

Specify the credentials for deployment

Using a text editor, open the toolkit\configuration\environment\credentials.properties file.
Specify a user name and password to use for the Solr indexes in the solr.user-name and solr.password properties.
Enter the password to encrypt LTPA tokens in the ltpakeys.password property.
Save and close the file.

Command access control

To gain access to certain features, including the ability to use Postman to reload the connector when making schema changes, you need to copy and modify some files in the i2 Analyze deployment:

Navigate to the toolkit\configuration\examples\security-schema directory and copy the file named example-command-access-control.xml.
Navigate to the toolkit\configuration\fragments\opal-services\WEB-INF\classes directory and paste the file from the previous step.
Open the DiscoServerSettingsCommon.properties file and add the name of file you just copied to the CommandAccessControlResource field, including the .xml extension.
Save and close the properties file.

Configure the schema

To test your schema and use it in Analyst's Notebook before deploying a connector, you can configure it as a gateway schema. The steps below describe this process.

Copy your schema and charting schemes to the toolkit\configuration\fragments\common\WEB-INF\classes directory.
In the same directory, open the ApolloServerSettingsMandatory.properties file. By default, the gateway schema and charting scheme properties look like the following:
```
Gateway.External.SchemaResource=
Gateway.External.ChartingSchemesResource=
```
Note: The default schema short name is External. For this example, we will change that short name to NYPD-Complaints. You may choose to use a different short name as you wish. The schema short name will appear in the labels of items on a chart in Analyst's Notebook.

Update the schema and charting scheme properties to point to your schema files as follows:
```
Gateway.NYPD-Complaints.SchemaResource=schema-filename.xml
Gateway.NYPD-Complaints.ChartingSchemesResource=charting-schemes-filename.xml
```

Configure the security schema

All i2 Analyze deployments require a security schema, which defines the level of access users have to the data in the system. You can learn about the i2 Analyze security model in the product documentation but, for the purpose of this guide, follow the steps below to use an example security schema.

Copy example-dynamic-security-schema.xml from toolkit\configuration\examples\security-schema to the toolkit\configuration\fragments\common\WEB-INF\classes directory.
Update the ApolloServerSettingsMandatory.properties file in the same directory to point to the security schema by setting the following property:
```
DynamicSecuritySchemaResource=example-dynamic-security-schema.xml
```

Generate the default configuration

For the purposes of this guide, only a basic configuration is required, so you can use the default.

Open the toolkit\scripts directory in a command prompt.
To configure the environment with default property values, run:
```
setup -t generateDefaults
```

Deployment

Open the toolkit\scripts directory in a command prompt.
To deploy i2 Analyze with the configuration you have just created, run:
```
setup -t deploy
```
To add an example user whose name and password are both "Jenny", run:
```
setup -t ensureExampleUserRegistry
```
To start i2 Analyze, run:
```
setup -t startLiberty
```

You can now connect Analyst's Notebook to i2 Analyze. The output of the start command includes the URL to use for the i2 Analyze server.

This is the best time to test the schema you created in the previous step (or the existing schema, if you're using the example one). In Analyst's Notebook, create items on the chart to visualize the i2 Analyze schema by using the Gateway palette. You should also test the different charting schemes and see what labels appear and how they are formatted.

If you want to make changes to the schema and its associated charting schemes, you can run through the schema design guide again.

To deploy the updated schema and charting scheme, you will need to update the i2 Analyze connectors configuration and reload the i2 Connect gateway.

Navigate to i2analyze\toolkit\scripts in your console and run:
```
setup -t updateConnectorsConfiguration
```
Open a web browser and navigate to <i2-Analyze-URL>/admin#/connectors, where <i2-Analyze-URL> is the URL used to access your i2 Analyze deployment. For example, http://localhost:9082/opaldaod/admin#/connectors.

Note: For more information about the Admin Console, refer to i2 Analyze Server Admin Console.
If you are prompted to log in, enter the credentials for your default user. If you added an example user, the username and the password will be Jenny.
Click Reload gateway to enact your changes to the topology.

Note: For other ways to reload the i2 Connect gateway, see Modifying and testing.

Note: You must perform these steps for every iteration of your schema and charting scheme design, or the changes will not take effect.

Note: You will need to perform these steps for every iteration of your schema and charting scheme design, otherwise the changes will not take effect

You now have a running i2 Analyze deployment. If you are happy with your schema, you can now deploy a connector.

Alternatively, to use the schema with the Information Store in an i2 Analyze deployment that includes both the Information Store and the i2 Connect gateway, you can continue with this guide.