Change Capture Specification File

The Change Capture specification file contains user‑defined JSON data that specifies which classes should be included in the change capture.

The following is an example of a Change Capture specification file for two classes.

{
  "IncludeClassList": [
    {
      "name" : "BankModelSchema::Bank"
    },
  {
      "name" : "BankModelSchema:Customer",
      "recursiveSubclasses" : true
    }
  ]
}

The configuration consists of a top‑level object which contains the configuration elements. The currently available configuration elements are described in the following sections.

IncludeClassList

The IncludeClassList section contains the Class Include Configuration Entries that are the classes to include in the change capture.

There is no limit on the number of Class Include Configuration Entries you can specify.

If the IncludeClassList section is unspecified or it does not contain any valid Class Include Configuration Entries, exception 8651 (Jade Change Capture must be configured to capture at least one class) is raised.

Class Include Configuration Entry

The Class Include Configuration Entry values are listed in the following table.

Value Required? Description
name Yes

Specifies the name of the class to include. The name value format is <schema‑name>::<class‑name>.

This value is mandatory for a Class Include Configuration Entry. If it is not specified or the name does not match an existing class, the entry will be invalid.

recursiveSubclasses No

Specifies whether subclasses of this class should also be included recursively; that is, all subclasses of this class, the subclasses of those classes, and so on.

This does not include subclasses existing within another schema or subschema copies of this class. This value is optional and if unspecified, defaults to false.