Modifying a deployed i2 Analyze schema

i2 Analyze supports a limited set of changes to the schema in a deployment. The changes that you can make, and the procedure for making them, vary slightly depending on which i2 data stores and services are in the deployment.

About this task

After you deploy i2 Analyze, you can generally make additive changes to the schema, but not destructive ones. For example, you can add new item types, and add new property types to existing item types, but you cannot remove types from the schema. For more information about the permitted changes that you can make, see Permitted i2 Analyze schema changes.

Destructive schema changes include removing item types or property types. Removing types can result in stores with data that is not valid according to the schema. To make destructive changes to the schema, you must remove any data from the system and re-create any databases. For more information about performing destructive schema changes, or replacing the schema, see Replacing the i2 Analyze schema and the charting scheme.

Procedure

The following steps describe how to make small changes to the schema in a production deployment of i2 Analyze.

If the deployment contains only the Analysis Repository, then you can use Schema Designer to modify the schema. You do not need to follow any of the other steps in this procedure.
Instead, see the IBM i2 Analyze Schema Designer documentation.

If your deployment contains both the Information Store and Analysis Repository data stores, you must address the Information Store first.

Locate the XML file that contains the schema for the i2 Analyze deployment, and load it into Schema Designer.
Make your changes to the schema and the associated charting schemes, and then save the file.

Note: In this mode, Schema Designer does not validate whether your changes are compatible with the deployed schema. Validation takes place when you apply the changes to your deployment.
If your deployment contains the Information Store, run the following commands on the Liberty server to update the database and application to conform to the updated schema.
```
setup -t stopLiberty
setup -t updateInformationStoreSchema
setup -t deployLiberty
setup -t startLiberty
```
The command recognizes that you modified the schema, determines whether the changes are valid for a running Information Store, and then applies them to the store. If the changes are not valid, the command displays messages to explain the problems.
Note: If you customized the Information Store creation process by specifying createdatabase="false" in the topology file and running the scripts yourself, this command works in the same way. Execution stops so that you can customize the changes to the Information Store. After you apply the changes, you can run the task again to complete the process.
If your deployment of i2 Analyze includes the Analysis Repository, run the deploy task to update it with the modified schema:
```
setup -t stop
setup -t deploy -s onyx-server
setup -t start
```
If the command to update the Information Store ran successfully, this command will succeed too. The set of valid changes for the Information Store is a subset of the valid changes for the Analysis Repository.

What to do next

Because you can make only additive changes to a schema that you modify through this procedure, it is not mandatory to change other parts of your deployment. However, to take full advantage of your additions, consider the following complementary changes.

To enable the Information Store to ingest data for the new item types and property types, modify your ingestion artifacts. See Information Store data ingestion.
If your deployment uses the Information Store with the Opal services and you are defining the property values of merged i2 Analyze records, you must update your merged property values definition views. See Define how property values of merged records are calculated.
If your deployment uses the Opal services and you want users to see the new types in quick search filters, edit the configuration file that controls them. See Setting up search results filtering.