HCL Workload Automation, Version 9.4

Job definition for IBM Cognos reports

Job definition properties and JSDL examples for IBM Cognos reports.

For more information about creating jobs using the various supported product interfaces, see Defining a job.

Table 1 describes the required and optional attributes for the definition of jobs to run IBM Cognos reports, together with a description of each attribute.

Table 1. Required and optional attributes for the definition of jobs running IBM Cognos reports.
Attribute	Description/value	Required
Namespace	The IBM Cognos namespace to log on to. It contains the IBM Cognos objects, such as groups, roles, data sources, distribution lists, and contacts. You do not have to specify this value if: You specified it in the Cognos JobExecutor .properties file. You set the true value for the Allow anonymous access? property in the IBM Cognos Configuration > Local Configuration > Security > Authentication > Cognos window.
UserName	The user to use when logging on to the namespace.	✓ You do not have to specify this value if: You specified it in the Cognos JobExecutor .properties file. You set the true value for the Allow anonymous access? property in the IBM Cognos Configuration > Local Configuration > Security > Authentication > Cognos window.
password	The password of the authorized user. It is encrypted when you submit the job. You do not have to specify this value if: You specified it in the Cognos JobExecutor .properties file. You set the true value for the Allow anonymous access? property in the IBM Cognos Configuration > Local Configuration > Security > Authentication > Cognos window.
serverAddress	The host name or TCP/IP address of the IBM Cognos server you want to connect to. You do not have to specify this value if: You specified it in the Cognos JobExecutor .properties file. You set the true value for the Allow anonymous access? property in the IBM Cognos Configuration > Local Configuration > Security > Authentication > Cognos window.
port	The port to use for the connection. The default value is 9300. If you select Use SSL, the default is 9334. For detailed information, see the IBM Cognos documentation. You do not have to specify this value if: You specified it in the Cognos JobExecutor .properties file. You set the true value for the Allow anonymous access? property in the IBM Cognos Configuration > Local Configuration > Security > Authentication > Cognos window.
SslCheck	Specify it to use SSL connection security to communicate with the IBM Cognos server. If you do not specify it the communication is HTTP.
reportPath	The path to the report that you want to run.	✓
parametersValues	The list of parameters to associate to the job. When you specify parameters that can have multiple values, use -Value: as separator. For example, you can write as follows: `Rome-Value:Paris` Parameters of type date, time, and time stamp, must be specified using a specific syntax. See Specifying the parameter format for date, time, and time stamp. Values for parameters that require parameterized filters must be specified using the procedure described in Specifying parameterized filters.
outputFile	The fully qualified path where you want to save the report. The path must exist and you must have the permission to write in it. The report is saved with the extension corresponding to the format you specified. HCL Workload Automation saves, in the path you specify, the report with its content. You must specify at least the path or an email address for the delivery options otherwise you receive an error message when you save the job definition.
formatTypes	The format in which you want to generate the report. For reports, supported formats are: CSV Excel 2002 Excel 2007 HTML HTML Fragment HTML Web Archive PDF XML For interactive reports and views of interactive reports you can use only the HTML format. Even if, for a view of an interactive report, you select a format different from HTML, the product saves the output in HTML format when the job runs. The default value is HTML.
emailGroup	The delivery options for the IBM Cognos report. If you did not insert a value for the Output file attribute, you must enter at least an email address. The email delivery status does not impact the job completion status. To, Cc, Bcc The email addresses to which you want to send the report. Address the message by typing at least an email address in one of the address fields, To, Cc (carbon copy), or Bcc (blind carbon copy). To specify multiple addresses divide them by using commas. Subject The subject of the email. Body The body of the email.

The following example shows the job definition for an IBM Cognos report with only the required attributes specified:

$JOBS
NC125152#COGNOS_ONLY_REQUIRED_FIELDS
 TASK
    <?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl="http://www.abc.com/xmlns/prod/scheduling/1.0/jsdl"
 xmlns:jsdlcognos="http://www.abc.com/xmlns/prod/scheduling/1.0/jsdlcognos" name="COGNOS">
  <jsdl:application name="cognos">
    <jsdlcognos:cognos>
			<jsdlcognos:CognosParameters>
				<jsdlcognos:CognosPanel>
					<jsdlcognos:credentialsGroup>
						<jsdlcognos:namespace/>
						<jsdlcognos:userName/>
						<jsdlcognos:password/>
					</jsdlcognos:credentialsGroup>
					<jsdlcognos:serverConnectionGroup>
						    <jsdlcognos:serverAddress/>
						    <jsdlcognos:port/>
						    <jsdlcognos:CheckSSLGroup/>
					</jsdlcognos:serverConnectionGroup>
					     <jsdlcognos:reportGroup>
						     <jsdlcognos:ReportPathGroup>
							     <jsdlcognos:reportPath>
                        Address Report - Path:/content/package[@name='tws4apps']
                        /report[@name='Address Report']
                    </jsdlcognos:reportPath>
						     </jsdlcognos:ReportPathGroup>
						    <jsdlcognos:outputFile>C:\outputFile</jsdlcognos:outputFile>
						     <jsdlcognos:formatTypes>PDF</jsdlcognos:formatTypes>
					</jsdlcognos:reportGroup>
				</jsdlcognos:CognosPanel>
				<jsdlcognos:OptionPanel>
					<jsdlcognos:emailGroup>
						    <jsdlcognos:toAddress/>
						    <jsdlcognos:ccAddress/>
						    <jsdlcognos:bccAddress/>
						    <jsdlcognos:subject/>
						   <jsdlcognos:body/>
					</jsdlcognos:emailGroup>
				</jsdlcognos:OptionPanel>
			</jsdlcognos:CognosParameters>
		</jsdlcognos:cognos>
  </jsdl:application>
</jsdl:jobDefinition>
 RECOVERY STOP

The following example shows the job definition for an IBM Cognos report with all the attributes specified:

$JOBS
NC125152#REPFOREUROPEBUSINESS COGNOS_ALL_FIELDS
 TASK
    <?xml version="1.0" encoding="UTF-8"?>
<jsdl:jobDefinition xmlns:jsdl="http://www.abc.com/xmlns/prod/scheduling/1.0/jsdl"
 xmlns:jsdlcognos="http://www.abc.com/xmlns/prod/scheduling/1.0/jsdlcognos" name="COGNOS">
  <jsdl:application name="cognos">
    <jsdlcognos:cognos>
			<jsdlcognos:CognosParameters>
				<jsdlcognos:CognosPanel>
					<jsdlcognos:credentialsGroup>
						<jsdlcognos:namespace>NTLM</jsdlcognos:namespace>
						<jsdlcognos:userName>Administrator</jsdlcognos:userName>
						<jsdlcognos:password>{aes}SgB6gmS+3xj0Yq2QsINVOtsNCeZIIsMwt08kwO6ZCR4=
              </jsdlcognos:password>
					</jsdlcognos:credentialsGroup>
					<jsdlcognos:serverConnectionGroup>
						<jsdlcognos:serverAddress>nc112006</jsdlcognos:serverAddress>
						<jsdlcognos:port>9300</jsdlcognos:port>
						<jsdlcognos:CheckSSLGroup>
							<jsdlcognos:SslCheck/>
						</jsdlcognos:CheckSSLGroup>
					</jsdlcognos:serverConnectionGroup>
					<jsdlcognos:reportGroup>
						<jsdlcognos:ReportPathGroup>
							<jsdlcognos:reportPath>date and time report - in values -
                    Path:/content/package[@name='cognosTime']/interactiveReport
                    [@name='date and time report - in values']
                </jsdlcognos:reportPath>
						</jsdlcognos:ReportPathGroup>
						<jsdlcognos:parametersValues>
							<jsdlcognos:parametersValue key="Date prompt">Between 2012-02-03 and 2012-04-15
                </jsdlcognos:parametersValue>
							<jsdlcognos:parametersValue key="Time prompt">-Value:01:00:00-Value:01:01:01
                </jsdlcognos:parametersValue>
							<jsdlcognos:parametersValue key="Date and time prompt">
                 2012-02-03 15:05:00-Value:2012-02-03T16:01:00-Value:2012-02-03T16:00:00
                </jsdlcognos:parametersValue>
						</jsdlcognos:parametersValues>
						<jsdlcognos:outputFile>C:\Cognos reports\ReportForEuropeBusiness
             </jsdlcognos:outputFile>
						<jsdlcognos:formatTypes>HTML</jsdlcognos:formatTypes>
					</jsdlcognos:reportGroup>
				</jsdlcognos:CognosPanel>
				<jsdlcognos:OptionPanel>
					<jsdlcognos:emailGroup>
						<jsdlcognos:toAddress>gsg@it.abc.com,igg@it.im.com</jsdlcognos:toAddress>
						<jsdlcognos:ccAddress>ibf@it.abc.com</jsdlcognos:ccAddress>
						<jsdlcognos:bccAddress>igg@it.abc.com</jsdlcognos:bccAddress>
						<jsdlcognos:subject>Report from Cognos</jsdlcognos:subject>
						<jsdlcognos:body>Report generated by Cognos:</jsdlcognos:body>
					</jsdlcognos:emailGroup>
				</jsdlcognos:OptionPanel>
			</jsdlcognos:CognosParameters>
		</jsdlcognos:cognos>
  </jsdl:application>
</jsdl:jobDefinition>
 RECOVERY STOP