compatibleProductVersion

Use the compatibleProductVersion parameter in your extension's spec.json file to indicate which versions of Cognos Analytics the extension supports.

If an extension using the compatibleProductVersion setting is uploaded to a version of Cognos Analytics that does not meet the version criteria, after a System Administrator or Tenant Administrator subsequently logs in or refreshes their browser, they are notified by a message in the alert banner.

Attributes

The compatibleProductVersion parameter uses these attributes:

  • min - the earliest version of Cognos Analytics in which the extension is supported

  • max - the latest version of Cognos Analytics in which the extension is supported

  • both min and max - indicates the range of versions in which the extension is supported

For example, in the following snippet, the compatibleProductVersion parameter specifies a range of supported versions between release 11.1.7 and release 11.2.2:

compatibleProductVersions: {
     min: '"11.1.7",
     max:  "11.2.2" // (and/or)
}

Global context vs individual context

You can configure compatibleProductVersion in two contexts:

  • Global context: Every extension is subject to the compatibleProductVersion setting. The compatibleProductVersion setting appears at the root of the spec.json file, before the extensions array.

    For example, red box 1 in Figure 1: spec.json file with compatibleProductVersion settings contains a compatibleProductVersion setting applied to all extensions.

  • Individual context: An individual extension is subject to your supported-versions declaration. The compatibleProductVersion setting appears in the extensions array.

    For example, red boxes 2 and 3 in Figure 1: spec.json file with compatibleProductVersion settings contain compatibleProductVersion settings applied to a single extension.

Example spec.json file

The following spec.json file contains both global and individual compatibleProductVersion settings.

In this fictional example, the extension is uploaded to Cognos Analytics version 11.2.4.

Figure 1. spec.json file with compatibleProductVersion settings
spec.json file

Process for checking the version compatibility

Note: When a compatibleProductVersion setting appears in both global and individual contexts, it must pass both version criteria checks in order for the extension to be supported in the current version of Cognos Analytics.
When the extension above is uploaded, Cognos Analytics checks the version compatibility in the following order:
  1. Check the global compatibleProductVersion setting (see box 1):
    1. min value = 11.2.0, which is less than 11.2.4. Result=Pass
    2. max value = 11.2.5, which is greater than 11.2.4. Result=Pass

      Result: Both values in the global compatibleProductVersion setting passed the compatibility check. Therefore, there is not a global constraint that all extensions are not supported. Because the global compatibility check passed, proceed to step 2, the individual compatibility checks.

  2. Check the individual compatibleProductVersion settings:
    1. Check the setting for myExtension1 (see box 2):
      1. min value = 11.2.0, which is less than 11.2.4. Result=Pass
      2. max value = 11.2.2, which is less than 11.2.4. Result=Fail

      Result: Both values in this individual compatibleProductVersion setting did not pass the compatibility check. Therefore, the extension myExtension1 is not supported in Cognos Analytics release 11.2.4.

    2. Check the setting for myExtension2 (see box 3):
      1. min value = 11.2.3, which is less than 11.2.4. Result=Pass
      2. max value = 11.2.5, which is greater than 11.2.4. Result=Pass

      Result: Both values in this individual compatibleProductVersion setting passed the compatibility check. Therefore, the extension myExtension2 is supported in Cognos Analytics release 11.2.4.