Plug-in Documentation

IBM Cognos

Overview

Cognos software includes business intelligence and performance management solutions. The Cognos plug-in for IBM UrbanCode Deploy includes steps to import and export content to and from the Cognos content store.

To add the Cognos plug-in steps to processes, click Reporting > Cognos in the step palette of the process editor.

Compatibility

This release of the IBM UrbanCode Deploy automation plug-in for Cognos was created with the Cognos 10.2 SDK. The Cognos Server V10.2 that was used in testing ran Windows Server 2008 SR2.

This plug-in requires version 6.1 or later of IBM UrbanCode Deploy.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode products.

History

Version 9

Fixed APAR PH03138 Broken classpath in Windows.

Version 8

Added encryption key for input properties.

Version 7.973863

  • RFE 116955 Added functionality to specify a target directory for importing into the content store.
  • Added a checkbox to overwrite deployment specifications.

Version 6.959162

Version 6 changes the password field to a secure encrypted property.

Version 5.940839

Version 5 includes RFE 111369: Deployments will now automatically create non-existing deployment specifications.
Added a Parent Directory property to specify the parent directory of the deployment specification.

Version 4.869051

Added support for property file encryption.

Version 3.786796

Version 3 includes a fix for APAR PI57417. The plug-in now checks the agent settings for acceptance of self-signed certificates.

Version 2.749972

This release includes a fix for APAR PI55878, Import/Export not pulling existing specification for deployments.

Version 1.716381

Initial release.

Steps

Process steps in the Cognos plug-in

Export

Export content from the content store to an archive file in the deployment directory
within your Cognos home.

Input properties for the Export step
Name Type Description Required
Archive Name String The name of the export archive. Do not include the .zip file extension. Yes
Cognos Java Library Directory String The Cognos java library directory. The directory must contain the required JAR files,
including cognosClient.jar and cognos-axis.jar. For example: C:\Program
Files\IBM\cognos\c10_64\sdk\java\lib
Yes
Deployment Spec String Specify the name of an export deployment specification. If this specification
doesnt exist on the Cognos server, it will be created.
Yes
Export Content String Specify the search path of 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
web application.
Yes
Gateway URL String The URL of the Cognos gateway to use to communicate to the dispatcher.
Alternately, specify the URL of the dispatcher itself. For example: http://localhost:9300/p2pd/servlet/dispatch
Yes
IBM Cognos ReportNet Home (CRN_HOME) String The location where Cognos is installed. 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 web application.
Yes
Overwrite Deployment Spec. Boolean Check this box to overwrite the deployment specification if it exists
in the content store.
No
Parent Directory String Provide the search path of the directory that your new or existing deployment
specification exists under. This will default to the root directory /adminFolder.
For example the path /adminFolder/adminFolder[@name=Exports] will specify the
Exports directory under the adminFolder root directory.
No
Password Password The password of the administrator user. (default: ${p:resource/crnPassword}) Yes
UserID String An administrator user ID that is capable of importing/exporting content. Yes

Import

Import content from an archive to the Cognos content store.

Input properties for the Import step
Name Type Description Required
Archive Name String The name of the archive to import. Do not include the .zip file extension. Yes
Cognos Java Library Directory String The Cognos java library directory. The directory must contain the required JAR files,
including cognosClient.jar and cognos-axis.jar. For example: C:\Program
Files\IBM\cognos\c10_64\sdk\java\lib
Yes
Deployment Spec String Specify the name of an import deployment specification. If this specification
doesnt exist on the Cognos server, it will be created.
Yes
Gateway URL String The URL of the Cognos gateway to use to communicate to the dispatcher.
Alternately, specify the URL of the dispatcher itself. For example: http://localhost:9300/p2pd/servlet/dispatch
Yes
IBM Cognos ReportNet Home (CRN_HOME) String The location where Cognos is installed. 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 web application. on the user preferences page.
Yes
Overwrite Deployment Spec. Boolean Check this box to overwrite the deployment specification if it exists
in the content store.
No
Parent Directory String Provide the search path of the directory that your new or existing deployment
specification exists under. This will default to the root directory /adminFolder.
For example the path /adminFolder/adminFolder[@name=Imports] will specify the
Imports directory under the adminFolder root directory.
No
Password Password The password of the administrator user. (default: ${p:resource/crnPassword}) Yes
Target Directory String If this is a new deployment specification, provide the search path of
the directory in the Cognos content store where your artifact will be deployed.
No
UserID String An administrator user ID that is capable of importing/exporting content. Yes