IBM Cognos Planning

https://www.ibm.com/docs/en/cognos-planning
Admin
IBM Cognos Planning is an enterprise planning and analysis solution that enables organizations to...
Tokens:630,868
Snippets:10,537
Trust Score:10
Update:3 months ago
Show doc for...
Tokens:
Raw
### Confirming Setup Script Configuration Settings

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.1?topic=sus-restore-backup-files-sample-databases-oracle-using-scripts

Example output displayed by the setup script during interactive mode, requiring user confirmation before applying changes to the environment.

```text
Please confirm the following settings:
 
Instance Name is ORAINST123
Create the following user accounts and import the data:
	GOSALES
	GOSALESHR
	GOSALESMR
	GOSLAESRT
	GOSALESDW
 
Default tablespace is GOSALES_TS
Temporary tablespace is DEFAULT
Administration User name is sys
 
WARNING: If the users already exist they will be dropped
 
Create a Tablespace named GOSALES_TS
 
Grant select on the GOSALES schemas to GOSALES
Grant select on the GOSALESDW schema to GOSALESDW
 
Continue creating the sample data with these settings?  (Y/N) Default=Y:
```

--------------------------------

### Parameterized URL Examples for Report Studio

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.1?topic=components-starting-report-studio

Examples demonstrating how to start Report Studio, target a specific package, or edit an existing report using URL parameters.

```text
http://localhost/cgi-bin/cognos.cgi?b_action=xts.run&m=portal/launch.xts&ui.gateway=http://localhost/ibmcognos
/cgi-bin/cognos.cgi&ui.tool=ReportStudio&ui.object=/content&ui.action=new
```

```text
http://localhost/cgi-bin/cognos.cgi?b_action=xts.run&m=portal/launch.xts&ui.gateway=http://localhost/ibmcognos
/cgi-bin/cognos.cgi&ui.tool=ReportStudio&ui.object=/content/folder[@name='Samples']/folder[@name='Models']/package[@name='GO Data Warehouse (query)']&ui.action=new
```

```text
http://localhost/cgi-bin/cognos.cgi?b_action=xts.run&m=portal/launch.xts&ui.gateway=http://localhost/ibmcognos
/cgi-bin/cognos.cgi&ui.tool=ReportStudio&ui.object=/content/folder[@name='Samples']/folder[@name='Models']/package[@name='GO Data Warehouse (query)']/folder[@name='Report Studio Report Samples']/report[@name='Health Insurance']&ui.action=edit
```

--------------------------------

### Connection String Examples

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.0?topic=dcp-unable-select-odbc-as-type-data-source-connection

Concrete examples of connection strings for specific database configurations.

```text
^UserID:^?Password:;LOCAL;RB;DSN=DB62SALES;UID=%s;PWD=%s@ASYNC=0
```

```text
;LOCAL;SS;DSN=TESTSERVER
```

--------------------------------

### Starting Event Studio via Parameterized URL

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.1?topic=components-starting-event-studio

Use a standard HTTP GET request to launch Event Studio with specific parameters.

```APIDOC
## GET /cgi-bin/cognos.cgi

### Description
Launches Event Studio using a parameterized URL.

### Parameters
#### Query Parameters
- **b_action** (string) - Required - Set to 'xts.run'
- **m** (string) - Required - Set to 'portal/launch.xts'
- **ui.tool** (string) - Required - Set to 'EventStudio'
- **ui.action** (string) - Required - The action to perform (e.g., 'new', 'run')
- **ui.object** (string) - Optional - The search path or store ID of the object
- **ui.folder** (string) - Optional - The target folder search path or store ID
- **ui.backURL** (string) - Optional - The URI to open after closing the component

### Request Example
http://localhost/cgi-bin/cognos.cgi?b_action=xts.run&m=portal/launch.xts&ui.tool=EventStudio&ui.object=/content/package[@name='GO Sales (analysis)']&ui.action=new
```

--------------------------------

### Starting IBM Cognos Viewer via cognosLaunch

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.1?topic=components-starting-cognos-viewer

Example of using the cognosLaunch method to start IBM Cognos Viewer.

```APIDOC
## cognosLaunch(ui.gateway, ui.tool)

### Description
Invokes the cognosLaunch method to start the IBM Cognos Viewer component.

### Parameters
- **ui.gateway** (string) - Required - The URL of the IBM Cognos gateway.
- **ui.tool** (string) - Required - The tool to launch, set to 'CognosViewer'.
```

--------------------------------

### Command Line Execution Examples

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.1?topic=sus-restore-backup-files-sample-databases-db2-using-scripts

Examples of running the setupGSDB script with specific flags for automated database creation or configuration.

```bash
setupGSDB -createDB -noprompt
```

```bash
setupGSDB -database GSDBY -userid db2admin
```

--------------------------------

### Modify setup script permissions on Linux and UNIX

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.1?topic=sus-restore-backup-files-sample-databases-oracle-using-scripts

Change the file permissions of the setup script to make it executable before running the installation.

```bash
chmod u+x setupGSDB.sh
```

--------------------------------

### Parameterized URL Examples for Business Insight Advanced

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.1?topic=components-starting-business-insight-advanced

Examples demonstrating how to start the tool, target a specific package, or edit an existing report using URL parameters.

```text
http://localhost/cgi-bin/cognos.cgi?b_action=xts.run&m=portal/launch.xts&ui.gateway=http://localhost/ibmcognos
/cgi-bin/cognos.cgi&ui.tool=ReportStudio&ui.profile=BUA_standalone&ui.object=/content&ui.action=new
```

```text
http://localhost/cgi-bin/cognos.cgi?b_action=xts.run&m=portal/launch.xts&ui.gateway=http://localhost/ibmcognos
/cgi-bin/cognos.cgi&ui.tool=ReportStudio&ui.profile=BUA_standalone&ui.object=/content/folder[@name='Samples']/folder[@name='Models']/package[@name='GO Data Warehouse (analysis)']&ui.action=new
```

```text
http://localhost/cgi-bin/cognos.cgi?b_action=xts.run&m=portal/launch.xts&ui.gateway=http://localhost/ibmcognos
/cgi-bin/cognos.cgi&ui.tool=ReportStudio&ui.profile=BUA_standalone&ui.object=/content/folder[@name='Samples']/folder[@name='Models']/package[@name='GO Data Warehouse (analysis)']/folder[@name='Business Insight Advanced']/report[@name='Promotion Success']&ui.action=edit
```

--------------------------------

### Interactive Setup Confirmation Output

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.1?topic=sus-restore-backup-files-sample-databases-db2-using-scripts

Displays the summary of configuration settings presented by the setupGSDB script before committing changes.

```text
Please confirm the following settings:
Database Name: GS_DB
Drop and Recreate Database: Y
DPF environment: N
Create a 16k Bufferpool named: GOSALES_BP
Create a 16k Tablespace named: GOSALES_TS
GOSALES Grant users/groups: GOSALES, DB2ADMIN
GOSALESDW Grant users/groups: GOSALESDW, DB2ADMIN
Administration User Name: db2admin
Import the sample data to the following schemas:
GOSALES
GOSALESHR
GOSALESMR
GOSALESRT
GOSALESDW
WARNING: If the database GS_DB already exists it will be dropped
Continue creating the sample data with these settings? (Y/N) Default=Y:
```

--------------------------------

### Create network installation point via command line

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.0?topic=samples-creating-network-installation-point

Execute this command from the uninstall folder to configure the network installation point. Replace 'lang' with the appropriate language code (e.g., de, en, fr, sv).

```bash
uninst.exe -wct "\\server\share\bin\wct\epAnalystFileSysCfg_lang.xml"
```

--------------------------------

### Starting IBM Cognos Viewer via URL

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.1?topic=components-starting-cognos-viewer

Example of using a URL to open a specified report in IBM Cognos Viewer.

```APIDOC
## GET [cognos.cgi]

### Description
Starts IBM Cognos Viewer using a parameterized URL to run a specific report.

### Query Parameters
- **b_action** (string) - Required - Must be set to 'cognosViewer'.
- **ui.object** (string) - Required - The Content Manager search path or store ID of the target object.
- **ui.action** (string) - Required - The action to perform, such as 'run'.
- **run.outputFormat** (string) - Optional - Specifies the output format (CSV, HTML, PDF, singleXLS, XHTML, XLWA, XML).
- **run.outputLocale** (string) - Optional - Specifies the output language (RFC3066 standard).
- **run.prompt** (boolean) - Optional - Specifies whether the report service issues prompts (true/false).
- **run.xslURL** (string) - Optional - URI of an XSL stylesheet to apply to the report.
- **run.outputEncapsulation** (string) - Optional - Specifies how output documents are encapsulated (HTML, URL, URLQueryString, none).
- **asynch.attachmentEncoding** (string) - Optional - Specifies attachment encoding (base64, MIME, MIMECompressed).
- **asynch.primaryWaitThreshold** (integer) - Optional - Max time in seconds for server processing before response.
- **asynch.secondaryWaitThreshold** (integer) - Optional - Max time in seconds for server processing before response.
- **ui.folder** (string) - Optional - The target folder search path or store ID.
- **ui.backURL** (string) - Optional - The URI to open after closing the component.
```

--------------------------------

### Launch Report Studio

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.1?topic=components-starting-report-studio

Initializes Report Studio using the specified gateway URL.

```javascript
cognosLaunch('ui.gateway','http://localhost/ibmcognos
/cgi-bin/cognos.cgi','ui.tool','ReportStudio')
```

--------------------------------

### Logoff Example

Source: https://www.ibm.com/docs/en/cognos-planning/10.2.0?topic=functions-logoff

An example demonstrating how to call the Logoff method on the CognosOfficeAutomationObject.

```text
CognosOfficeAutomationObject.Logoff
```
Tokens:
Raw