Configure the Cognos Reporting Task

Configuration is needed for this report task before it can be used.

Configure Red Hat OpenShift with your report user credentials

Before you configure a report task, the user authentication credentials to use to access your Cognos® server for the report must be added to Red Hat® OpenShift®. These credential values are provided in the following parameters that must be added as key and value pairs to the ftm-serviceengine-tasks-secret secret in Red Hat OpenShift.

Namespace ID, which is the ID of the Cognos authentication namespace.
Username used to log on to the Cognos server.
User password used to log on to the Cognos server.
Alternative credentials used to log on to the Cognos server. Surround the credentials in the XML elements that are needed by the Cognos authentication provider that is being used. This parameter is required only when Cognos is configured to use an authentication provider that expects credentials other than the combination of namespace, username, and password.

If these values were already added to the secret, you do not need to add them again.

To add parameters to the Red Hat OpenShift secret, do the following steps:

Determine what names you want to use for the keys for the report parameters. You can use any word with alphanumeric characters for a key. For example, you might use the following key and value pairs for the report parameters.
```
cognosnamespaceid=CognosNS
cognosusername=Administrator
cognosuserpass=mypass
cognosaltcredentials=<ID>myuser</ID><password>ADFJWF230FJWWEFLJW#(@#*</password><SSO_PROVIDER>http://example.com</SSO_PROVIDER>
```
If you have more than one report server that you are using to run the Services Framework report tasks, you need a unique set of user credential keys for each server. For example, you can add an identifier as part the key names, such as cognosnamespaceidserv1 and cognosnamespaceidserv2.
Use the Red Hat OpenShift Container Platform to open the ftm-serviceengine-tasks-secret secret.
Edit the secret to add your key and value pairs in the Value field for the key secret.properties. The format for the key and value pairs is key=value.
The key names that you added to the secret must be specified in the configuration for the report tasks that use Cognos.

Task parameters

To configure the Cognos reporting task, go to the configuration page in the Services Framework user interface and select the New Task Configuration link. The following table shows the information that is needed to configure this report task.

Table 1. Cognos reporting task configuration fields
Field	Description	Example
Task	This field displays a list of all of the registered tasks. Select the name of the Cognos reporting task that was entered during registration.	Generic Cognos Reporting Task
Configuration	Descriptive name for the configuration. This name is used when events in Transaction Server are configured for this task. This field is required and can contain up to 60 characters.	Cognos report generic task for the XYZ report
Description	A detailed description that explains what the configuration does. This field is optional. If entered, it must be 512 characters or less.	Runs the XYZ Cognos report
Activate task	Identifies if the configuration is active. When it is active, the task is available to run the report.	Yes
Process end of day	Run the task when Services Framework is notified to run end of day.	Yes
Process cleanup	Set this value to no because the task does not need to process cleanup.	No
Delete on complete	Identifies if the activity for this task is deleted when it is complete. If set to yes, the activity for this task is deleted when it successfully completes and is not deleted when it has errors or warnings. If set to no, the activity for this task is not deleted when it completes. Note: Deleted task activities do not appear on the task activity page.	Yes
Allow Monitor	Indicates whether Services Framework is to collect performance data for this task configuration.	Yes
Content Manager URL	URL of the Cognos Content Manager.	http://localhost:9300/p2pd/servlet/dispatch
Report Service URL	URL of the Cognos report service.	http://localhost:9300/p2pd/servlet/dispatch
Event Management Service URL	URL for the Cognos event management service. This task creates a Cognos job for the report and schedules it to run. The Cognos event management service is needed to manage the scheduled jobs.	http://localhost:9300/p2pd/servlet/dispatch
Key used for Namespace ID in Red Hat OpenShift secret	The name of the key to use to get the value from the Red Hat OpenShift secret. This field is the key for the ID of the Cognos authentication namespace that is used by this task.	`cognosnamespaceid`
Key used for User Name in Red Hat OpenShift secret	The name of the key to use to get the value from the Red Hat OpenShift secret. This field is the key for the username on the Cognos server to use for this task.	`cognosusername`
Key used for User Password in Red Hat OpenShift secret	The name of the key to use to get the value from the Red Hat OpenShift secret. This field is the key for the password for the user ID for this task.	`cognosuserpass`
Key used for Authentication credentials in Red Hat OpenShift secret	The name of the key to use to get the value from the Red Hat OpenShift secret. This field is the key for the Cognos alternative credentials to use for this task, if needed. Alternative credentials are required when Cognos is configured to use an authentication provider that expects credentials other than the combination of namespace, username, and password.	`cognosaltcredentials`
Report names or search paths	The report names or the full Cognos search paths for the reports to be run. Separate multiple names and search paths with commas.	`/content/package[@name='pkg_name']/report[@name='rpt_name']`
Output format type	The format in which the report output is stored.	The format types available are shown in the following list: PDF XML CSV
Save report output in Cognos Content Store	Indicates whether the report output is saved in the Cognos content store.	Valid values are shown in the following list: True The report output is stored in the Cognos content store. This value is the default. False The report output is not stored in the Cognos content store.
Archive report output	Indicates whether the report output is saved on a local or shared file system. The Cognos server must be configured to write the report output to the disk.	Valid values are shown in the following list: False The report output is not written to the disk. This value is the default. True The report output is written to the disk.
Report view search path	The full search path in the Cognos content store where the report views are created. This parameter has no default value. If no value is configured for this parameter, the report views are created in the same location as the parent report.	To store report views to a separate folder under My Folders, set the path to: CAMID("WBM_Provider:uid=username,o=defaultWIMFileBasedRealm")/folder[@name='My Folders']/folder[@name='Core Report Views']/folder[@name=Generic Report Views']
Archive file system location	Full search path to the file system locations that are defined on the Cognos server. These paths need to be predefined and created on the Cognos server.	/configuration/archiveLocation[@name='Test']
Report output version retention	Indicates how long the report output is kept. This parameter is specified as one of the following values: The number of instances of the report output to keep. The number of days to keep the report output. The number of months to keep the report output.	Example values are shown in the following list: 100 Retains 100 instances of the report output. This number must be a positive integer. P30D Retains the report output for 30 days from its creation date. P1M Retains the report output for 1 month from its creation date. The default is P90D, which is 90 days.
Report run history retention	Indicates how long the report run history is kept. This parameter is specified as one of the following values: The number of instances of the report run history to keep. The number of days to keep the report run history. The number of months to keep the report run history.	Example values are shown in the following list: 100 Retains 100 instances of the report run history. P30D Retains the report run history for 30 days from its creation date. P1M Retains the report run history for 1 month from its creation date. The default is 10 instances of the report run history.
File name pattern	The file name pattern is used to create the name for the file that is used to save the report output. When you specify a file name pattern, ensure that it produces a unique name for each saved report to avoid overwriting previously saved reports. For more information about specifying the file name pattern, see File Naming Patterns for the Cognos Report Tasks.	`%RN%.%DS%.D%DTyyMMdd%.T%DThhmmss%`
Currency code	The ISO 4217 currency code to be used by the report. To use the system default currency, which is stored in the database, set this parameter to SYSTEM.	USD
FTMPUB Schema Name	The Db2® schema name of the public database views.	FTMPUB
FTM Schema Name	The Db2 schema name of the database tables.	FTM
Generic parameters	A list of parameters, which are separated by commas, to pass to the report. Each parameter must be in the following format: parameter_name="value". To specify a comma or a backslash as part of the value, put a backslash character just before the comma or backslash as shown in the examples.	Examples: `paramMisc1="R03, R20",paramCustomerID="1234567"` `parameter="value1\,with a comma"` `parameter="value1 \\ with a back slash"`