About this task
Before running batch reports, ensure that run the following setup steps.
Procedure
- The software needed to run batch reports is contained in
a package included in the HCL Workload Automation installation
image. If you plan to run batch reports from within a scheduled job,
extract the package file on one of the operating systems listed in Product Requirements.
Because the native UNIX™ tar utility does not support long
file names, if you are extracting the files on AIX®, Solaris,
or HP-UX systems, ensure that the latest GNU version of tar (gtar) is installed to extract the files
successfully.
Note:
- Make sure you run the following commands in the directory where you extracted the files:
- On UNIX™
-
chmod -R +x *
chown -R username *
- On Windows™
- Make sure HCL Workload Automation is
installed.
setown -u username *
- On z/OS
-
chmod -R +x *
chown -R username *
where username
is the user that will run the reports.
- If you plan to schedule jobs that run batch reports, the system where you extract the package
must be accessible as network file system from an HCL Workload Automation for Z defined in the local scheduling
environment.
-
Configure the template file
.\config\common.properties
as follows.
Note: For z/OS operating systems only, to configure the
.\config\common.properties
file it is required that you copy the file on your local
workstation in binary mode, make the required changes, and copy back the
common.properties
file to the
.\config
directory in binary mode.
Changes are effective immediately.
-
Specify the information required to connect to the database where the historical data are
stored.
-
Set the date and time format, including the time zone. The file
.\config\timezone.txt
contains a list of time zones supported by HCL Workload Automation and the information on how
to set them. The time zone names are case sensitive.
-
Make available the report output on the URL specified in ContextRootUrl field. This is
an example of configuration settings:
######################################################################
# HTTP Server information
######################################################################
#Specify the context root where the report will be available
#To leverage this possibility it needs to specify in the report output dir
#the directory that is referred by your HTTP Server with this contect root
ContextRootUrl=http://myserver/reportoutput
In this case make sure that the output_report_dir specified when running the batch reports
command points to the same directory specified in the ContextRootUrl field.
-
Send the report output using a mail. This is an example of configuration settings:
######################################################################
# Email Server configuration
######################################################################
PARAM_SendReportByEmail=true
#SMTP server
mail.smtp.host=myhost.mydomain.com
#IMAP provider
mail.imap.socketFactory.fallback=false
mail.imap.port=993
mail.imap.socketFactory.port=993
#POP3 provider
mail.pop3.socketFactory.fallback=false
mail.pop3.port=995
mail.pop3.socketFactory.port=995
######################################################################
# Email properties
######################################################################
PARAM_EmailFrom=user1@your_company.com
PARAM_EmailTo=user2@your_company.com,user3@your_company.com
PARAM_EmailCC=user4@your_company.com
PARAM_EmailBCC=user5@your_company.com
PARAM_EmailSubject=Test send report by email
PARAM_EmailBody=This is the report attached
An explanation of all the customizable fields is contained in the template file.
Results
If you plan to run Workstation Workload Runtime reports, ensure that the file system where
database is installed has enough free space. If a shortage of disk space occurs, an SQL exception
similar to the following example is triggered:
DB2 SQL error: SQLCODE: -968, SQLSTATE: 57011