spec.json description
The spec.json file in an extension defines the additions and deletions the extension makes to the default IBM® Cognos® Analytics user interface. The structure and contents of this file are explained here.The structure and contents that are described here are provisional. They can change in future releases of Cognos Analytics. These changes may not be backward compatible.
Properties
schemaVersion
| Description | Specifies a numeric value for the schema version. Can be 1.0 or 2.0. The default value is 1.0. |
|---|
| Type | String |
|---|
| Required | No |
|---|
| Enum | |
|---|
name
| Description | Specifies the name of the extension. The name can contain alphanumeric characters, underscores (_), and spaces ( ). |
|---|
| Type | String |
|---|
| Required | Yes |
|---|
| Pattern | [a-zA-Z0-9_ ]+$ |
|---|
core
| Type | Boolean |
|---|
| Required | No |
|---|
| Default | false |
|---|
version
compatibleProductVersion
Properties
compatibleProductVersion.min
| Title | MIN |
|---|
| Description | For each extension, specifies the earliest compatible version of Cognos Analytics. |
|---|
| Type | String |
|---|
| Required | No |
|---|
| Min Length | 1 |
|---|
| Pattern | ^(0|[1-9]\d{0,8}).(0|[1-9]\d{0,8}).(0|[1-9]\d{0,8})$ |
|---|
compatibleProductVersion.max
| Title | MAX |
|---|
| Description | For each extension, specifies the most recent compatible version of Cognos Analytics. |
|---|
| Type | String |
|---|
| Required | No |
|---|
| Min Length | 1 |
|---|
| Pattern | ^(0|[1-9]\d{0,8}).(0|[1-9]\d{0,8}).(0|[1-9]\d{0,8})$ |
|---|
extensions
| Description | Contains an array of perspective objects. |
|---|
| Type | Array |
|---|
| Required | Yes |
|---|
| Min Items | 1 |
|---|
extensions.perspective
| Description | Specifies the view that is being extended. The options are the following. |
|---|
| Type | String |
|---|
| Min Length | 1 |
|---|
extensions.compatibleProductVersion
extensions.compatibleProductVersion.min
| Title | MIN |
|---|
| Description | For each extension, specifies the earliest compatible version of Cognos Analytics. |
|---|
| Type | String |
|---|
| Required | No |
|---|
| Min Length | 1 |
|---|
| Pattern | ^(0|[1-9]\d{0,8}).(0|[1-9]\d{0,8}).(0|[1-9]\d{0,8})$ |
|---|
extensions.compatibleProductVersion.max
| Title | MAX |
|---|
| Description | For each extension, specifies the most recent compatible version of Cognos Analytics. |
|---|
| Type | String |
|---|
| Required | No |
|---|
| Min Length | 1 |
|---|
| Pattern | ^(0|[1-9]\d{0,8}).(0|[1-9]\d{0,8}).(0|[1-9]\d{0,8})$ |
|---|
extensions.inherits
extensions.excludeCommon
| Description | Specifies whether view contributions are received from the /common folder. The possible values are false to receive all contributions or true to receive no contributions. Any missing contributions can be added to the extension. |
|---|
| Type | Boolean |
|---|
extensions.features
extensions.features.id
| Description | Specifies the unique identifier of the feature. |
|---|
| Type | String |
|---|
| Min Length | 1 |
|---|
extensions.features.svgImages
extensions.features.excludeItems
| Description | Contains an array of ids of user interface items to exclude. This feature cannot be applied to the common view. |
|---|
| Type | Array |
|---|
extensions.features.excludeFeatures
| Description | Contains an array of ids of user interface features to exclude. This feature cannot be applied to the common view. |
|---|
| Type | Array |
|---|
extensions.features.environment
| Description | Contains an array of user interface elements that are being added. |
|---|
| Type | Array |
|---|
| Description | The unique identifier for the new user interface element. |
|---|
| Type | String |
|---|
| Min Length | 1 |
|---|
| Description | Specifies the title of the new user interface element. |
|---|
| Type | String |
|---|
| Description | Specifies the user interface element type. The possible values are shown here. Button, Menu and MenuItem |
|---|
| Type | String |
|---|
| Min Length | 1 |
|---|
| Description | Specifies the action to be taken when the user interface element is clicked. The available actions are listed here. 1. bi/glass/api/IFrameOpener - Opens a web page, 2. bi/glass/api/ReportOpener - Opens a particular report, 3. bi/glass/api/DashboardOpener - Opens a particular dashboard, 4. bi/glass/api/FolderOpener - Opens a particular folder, 5. v1/ext/<name>/js/controllers/controller_name - Runs the custom controller that is packaged in the extension. The controller is the file js/controllers/controller_name.js. |
|---|
| Type | String |
|---|
| Min Length | 1 |
|---|
| Description | Specifies the text label for the user interface element. This text cannot be localized. |
|---|
| Type | String |
|---|
| Min Length | 1 |
|---|
| Description | Specifies the placement of the user interface element. If the user interface element is a menu or a button, the element is located in the application or navigation bars. The values of containerId corresponding to the button or menu placement are shown in the following list.
- com.ibm.bi.glass.navbarLeadingGroup
- com.ibm.bi.glass.navbarTrailingGroup
- com.ibm.bi.glass.appbarLeadingGroup
- com.ibm.bi.glass.appbarCenterGroup
- com.ibm.bi.glass.appbarTrailingGroup
- com.ibm.bi.glass.common.personalMenu
- com.ibm.bi.glass.common.applicationHelp
- com.ibm.bi.contentApps.listViewMenu
- custom.appbar.trailingGroup.menu
- com.ibm.bi.caHome.navigator
- com.ibm.bi.glass.common
- com.ibm.bi.glass.myContextMenu
- com.ibm.bi.glass.global.menus
- com.ibm.bi.glass.persistentBannerBarCenterGroup
- com.ibm.bi.glass.common.createMenu
- com.ibm.bi.glass.footerLeadingGroup
- com.ibm.bi.glass.common.navmenu
If the user interface element is a menu item, the value of containerId is the id of the menu that contains the menu item. |
|---|
| Type | String |
|---|
| Min Length | 1 |
|---|
| Description | Specifies the user interface element image to be displayed. The path is relative to the image file in the extension zip archive. |
|---|
| Type | String |
|---|
| Description | Specifies a numeric value that determines the placement of the user interface element in the container. A higher value moves up the element in the container. |
|---|
| Type | Number |
|---|
| Description | Contains an array of options to pass to the action controller. The options vary depending on which action controller is used. For the options used by the built-in action controllers, see Using built-in action controllers. |
|---|
| Type | Object |
|---|
| Description | Specifies whether when the button is pressed a second time, the action of the first press is undone. For example, opening and then closing a folder. The value can be true or false. The value must be true for a button that opens a folder. |
|---|
| Type | String |
|---|
| Enum | |
|---|
| Description | Specifies a coach mark. |
|---|
| Type | Object |
|---|
| Description | Specifies the title of the coach mark. |
|---|
| Type | String |
|---|
extensions.features.toolItems.coachMark.contents
| Description | Specifies the contents of the coach mark. |
|---|
| Type | String |
|---|
extensions.features.content
| Description | Contains definitions for a view. |
|---|
| Type | Object |
|---|
extensions.features.content.type
| Description | Contains a link to the JavaScript file to run when this view is invoked. |
|---|
| Type | String |
|---|
| Min Length | 1 |
|---|
| Pattern | ^v1/ext/.+$ |
|---|
extensions.features.content.options
| Description | Contains parameters to be passed to the JavaScript file. |
|---|
| Type | Object |
|---|
extensions.features.cssStyles
| Description | Contains an array of links to .css files to be used for this view. |
|---|
| Type | Array |
|---|
extensions.features.collectionItems
| Description | Contains an array of user interface elements that are being added. |
|---|
| Type | Array |
|---|
extensions.features.collectionItems.id
| Description | Specifies the unique identifier of the user interface element. |
|---|
| Type | String |
|---|
| Min Length | 1 |
|---|
extensions.features.collectionItems.containerId
| Description | Specifies where the user interface element is located. |
|---|
| Type | String |
|---|
| Min Length | 1 |
|---|
extensions.features.collectionItems.label
extensions.features.collectionItems.lensable
extensions.features.collectionContainers
extensions.features.collectionContainers.id
extensions.features.collectionContainers.label
extensions.features.collectionContainers.items
extensions.features.collectionContainers.items.id
extensions.features.collectionContainers.items.label
extensions.features.collectionContainers.items.lensable
extensions.features.collectionContainers.lensable
extensions.features.lensable
extensions.features.actions
extensions.features.actions.id
extensions.features.actions.label
extensions.features.actions.items
extensions.features.actions.items.controller
extensions.features.actions.items.weight
extensions.type
| Description | If the extension is a view, specifies the type. The possible values are login for a sign-in view and home for a home view. This element is only used in schema version 2.0. If it is omitted and schema version 2.0 is specified, then the view is not included in the list of possible default home or sign-in views. |
|---|
| Type | String |
|---|
| Enum | |
|---|
extensions.lensable
| Description | If false, this view is not included in the list of views for which features can be omitted. For more information, see Customizing roles.The default value is true. |
|---|
| Type | Boolean |
|---|
| Default | true |
|---|
| Description | An optional comment. |
|---|
| Type | String |
|---|
extensions.services
extensions.config
extensions.config.requirejs
extensions.config.requirejs.paths
extensions.config.scripts
extensions.config.scripts.path
extensions.config.scripts.weight
extensions.config.styles
extensions.config.styles.path
extensions.config.styles.weight
| Description | An optional comment. |
|---|
| Type | String |
|---|
| Required | No |
|---|