Setting up for command line batch reporting
About this task
Before running batch reports you
must run a few setup steps:
- The software needed to run batch reports is contained in a package named
TWSBatchReportCli
, in the TWSBatchReportCli directory.TWSBatchReportCli
can be downloaded from the Passport Advantage page, at the following URL: Product Requirements. If you plan to run batch reports from within a scheduled job, extract the package file on one of the operating systems listed in the System Requirements Document at Dynamic Workload Console Detailed System Requirements.After you extract the package, you will have the following file structure: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™
- Ensure HCL Workload Automation is
installed.
setown -u username *
- 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 a fault-tolerant agent defined in the local scheduling environment.
- Make sure you run the following commands in the directory where you extracted the files:
- If you use an Oracle database, download the JDBC drivers required by your Oracle server version.
- Copy the JDBC drivers in the
report_cli_installation_dir\jars
directory and inreport_cli_installation_dir\ReportEngine\plugins\org.eclipse.birt.report.data.oda.jdbc_4.8.0.v201806261756\drivers
directory. The report CLI automatically discovers the two jar files. - Configure the template file
.\config\common.properties
specifying the following information:- If you use an Oracle database, connect
to the database where the historical data are stored as follows:
- Retrieve the location of the Oracle JDBC drivers. This information is stored in the
com.ibm.tws.webui.oracleJdbcURL property in the file
TWA_homeTWSDATA/usr/servers/engineServer/resources/properties/TWSConfig.properties
on the workstation where the master domain manager is installed.For more information about this file, see Configuring for an Oracle database.
- Specify the location of the Oracle JDBC drivers in the PARAM_DataSourceUrl property
in the
common.properties
file.
- Retrieve the location of the Oracle JDBC drivers. This information is stored in the
com.ibm.tws.webui.oracleJdbcURL property in the file
- 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:
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.###################################################################### # 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
- 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
- If you use an Oracle database, connect
to the database where the historical data are stored as follows:
Note: 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 like
the following is triggered:
DB2 SQL error: SQLCODE: -968, SQLSTATE: 57011