Description
The Cognos Analytics plug-in provides integration with a Cognos Analytics server to automate importing and exporting Cognos store content.
- Overview
- Documentation
- Version history
Quick Info
Product
HCL DevOps Deploy (HCL Launch)
Type
Plug-in
Compatibility
HCL Launch version 7.3.2.8 and later, HCL Deploy version 8.0.1.3 and later, Cognos Analytics 11.1 and later
Created by
HCLSoftware
Website
Published Date
Last Updated
Summary
Usage
Steps
Summary
Cognos software includes business intelligence and performance management solutions. The Cognos Analytics plug-in for DevOps Deploy includes steps to import and export content to and from the Cognos content store.
Installation
See Installing plug-ins in HCL Deploy for installing and removing plug-ins.
History
| Version | Description |
|---|---|
| 1 | Initial release. |
Usage
The IBM Cognos Analytics plug-in contains two steps:
- The Export step exports content from the Cognos content store into a ZIP file. The ZIP file can be found in the *Cognos\_installation\_directory*/deployment directory.
- The Import step imports the content from a ZIP file into the content store. Any existing content with the same name is overwritten and the new content is owned by the specified user. The ZIP file must be in the*Cognos\_installation\_directory*/deployment directory.
Step palette
To access this plug-in in the palette, click Reporting > Cognos Analytics.
Use cases
The following use cases describe simple use of the plug-in export and import functions.
Export
Below are the steps for a typical export process.
- Use the Export step to put content into a ZIP file.
- Copy the ZIP file from the /deployment directory to the agent working directory. You can use a shell command step to perform this step.
- Create a new component version using the ZIP file as the version artifact.
Import
Below are the steps for a typical import process.
- Download component artifacts from the DevOps Deploy server to the agent working directory.
- Use a shell command step to copy the ZIP file to the deployment directory.
- Use the Import step to import the content from the zip archive into the specified Cognos content store.
Steps
IBM Cognos Analytics - Process Steps
Export
Export content from the content store to an archive file in the deployment directory within your Cognos home.
| Name | Type | Description | Required |
|---|---|---|---|
| Archive Name | String | The name of the export archive file. Do not include the .zip file extension. | Yes |
| Cognos Analytics Java Library Directory | String | The Cognos Analytics Java library directory. The directory must contain the required JAR files, including the cognosClient.jar andcognos-axis.jar files. For example: C:\Program Files\IBM\cognos\analytics\sdk\java\lib. | No |
| Deployment Spec | String | The name of an export deployment specification. If this specification does not exist on the Cognos Analytics server, it is created. | Yes |
| Export Content | String | The search path for the content to export. For example: /content/folder/[@name=’Samples’]. The search path is displayed in the properties of any file or folder in the Cognos Analytics web application. | Yes |
| Gateway URL | String | The URL of the Cognos Analytics gateway or dispatcher that is used to communicate with the dispatcher. For example: http://localhost:9300/p2pd/servlet/dispatch | Yes |
| IBM Cognos Analytics Home | String | The URL of the Cognos Analytics server. Do not include a trailing forward slash. | Yes |
| Namespace | String | The user namespace on the Cognos server. You can locate the namespace on the User Preferences page of the Cognos Analytics web application. | Yes |
| Overwrite Deployment Spec. | Boolean | Enable to overwrite the deployment specification if it exists in the content store. | No |
| Parent Directory | String | The search path of the directory that the new or existing deployment specification exists under. The default is the root directory: /adminFolder. For example: if you specify /adminFolder/adminFolder[@name=’Exports’], this indicates that the Exportsdirectory is under the adminFolder root directory. | No |
| Password | Password | The password associated withthe administrator’s user ID. The default is the value in the ${p:resource/crnPassword} property. | Yes |
| UserID | String | The administrator user ID that has import and export privileges. | Yes |
Import
Import content from an archive to the Cognos Analytics content store.
| Name | Type | Description | Required |
|---|---|---|---|
| Archive Name | String | The name of the archive file to import. Do not include the .zip file extension. | Yes |
| Cognos Analytics Java Library Directory | String | The Cognos Analytics Java library directory. The directory must contain the required JAR files, including the cognosClient.jar and cognos-axis.jar files. For example: C:\Program Files\IBM\cognos\analytics\sdk\java\lib. | Yes |
| Deployment Spec | String | The name of an import deployment specification. If this specification does not exist on the Cognos server, it is created. | Yes |
| Gateway URL | String | The URL of the Cognos Analytics gateway or dispatcher used to communicate with the dispatcher. For example: http://localhost:9300/p2pd/servlet/dispatch | Yes |
| IBM Cognos Analytics Home | String | The URL of the Cognos Analytics server. Do not include a trailing forward slash. | Yes |
| Namespace | String | The user namespace. The user namespace is displayed on the User Preferences page of the Cognos Analytics web application. on the user preferences page. | Yes |
| Overwrite Deployment Spec. | Boolean | Enabled to overwrite the deployment specification if it exists in the content store. | No |
| Parent Directory | String | The search path of the directory that your new or existing deployment specification exists under. The default is the root directory: /adminFolder. For example: /adminFolder/adminFolder[@name=’Imports’], indicates to use the Imports directory under the adminFolder root directory. | No |
| Password | Password | The password associated with the administrator’s user ID. The default is the value in the ${p:resource/crnPassword} property. | Yes |
| Target Directory | String | If this is a new deployment specification, provide the search path of the directory in the Cognos Analytics content store where the artifact is deployed. | No |
| User ID | String | The administrator user ID that has import and export privileges. | Yes |
