Configuring the FTM URT

The FTM usage report tool (URT) is installed in the /tools/URT directory. The utility itself is implemented in Java™ in the UsageReport.jar file.

The files that you need are provided in the FTM artifacts pod and must be downloaded from the pod. For more information about getting files from the artifacts container for your offering, see Getting the files from the artifacts container for your FTM offering.

The following files are also provided for the usage report tool.
messages.properties
This file provides English language error messages that are used by the utility.
usageReport.properties
This file provides runtime configuration to control the utility. It also identifies the name of the properties file that defines the database connectivity.
dbConnection4DB2.properties
An example connectivity file that can be referenced from usageReport.properties to define the database connection for Db2®.
Note: The properties file used to define the database connection must be encrypted for use with the utility. This encryption is to ensure that the database password is not stored in clear text in the file. For more information about encrypting the properties files, see Encryption of properties files. The main properties file can be optionally encrypted.
The utility has a dependency on other classes from the FTM installation folder and JDBC drivers for the database:
FTM installation classes
install_directory/run/classes/icu4j.jar
install_directory/run/classes/FTMCoreJava.jar
JDBC Drivers for Db2
db2jcc4.jar - JDBC Driver
The URT uses the following properties files:
  1. The main properties file contains properties that are used to control the report output. The main properties file can be optionally encrypted.
  2. The database connection properties file, which is referenced in the main properties file. This properties file contains properties that are exclusively used for the JDBC connection to the database. It must be encrypted. For more information about encrypting properties files, see Encryption of properties files.

Configure the FTM usage report tool properties

The FTM usage report tool can be configured by updating the template that was provided for the main properties file. The name of the main properties file must be usageReport.properties. The database connections property file can have a custom name, which is specified in the dbConnection.properties.filename key in the main properties file.

A template for the main properties file, usageReport.properties, is supplied. It contains the following parameter settings.
report.path.PROD=<PathToReportFileIncludingName>.zip
report.path.TEST=<PathToReportFileIncludingName>.zip
report.path.UNKNOWN=<PathToReportFileIncludingName>.zip
report.start=<yyyy/mm/dd>
report.end=<yyyy/mm/dd>
bank.name=<bank name>
ipd.name=<instance name>
show.sql=<true or false>
dbConnection.properties.filename=<encrypted file>
Edit the template to replace the placeholders with actual values.
report.path.PROD
report.path.TEST
report.path.UNKNOWN
Each deployment type, PROD, TEST, and UNKNOWN, has its own report path parameter. For each of the report path parameters that are provided, the URT generates an individual report if transaction data exists for that deployment type within the specified date range. You must provide at least one of these parameters. The URT can generate reports that differentiate between production, test, or unknown data within the FTM database. The data is categorized in the PRODUCT_INSTANCE table. Historical data might be categorized as unknown in the PRODUCT_INSTANCE table if it existed in the database before you migrated to FTM 4.0.5, Fix Pack 1 or later.
When the Red Hat® OpenShift® instance of your FTM offering is configured, the license.use parameter can be set to the value Production or NonProduction. These values correlate with the values of PROD and TEST that are used in the PRODUCT_INSTANCE database table and by the FTM usage report tool. For example, if the license.use parameter was set to Production, the transaction counts that are recorded in that environment are categorized as PROD in the PRODUCT_INSTANCE database table.
<PathToReportFileIncludingName>
The fully qualified name of the file that is to contain the generated usage report for the specific report path parameter. It must have the extension .zip. Be sure to use different file names if you are generating multiple reports into the same directory. For example, use a different file name when you configure the same directory for at least two of the PROD, TEST, and UNKNOWN deployment types.
report.start=<yyyy/mm/dd>
report.end=<yyyy/mm/dd>
The start and end dates that determine the period for which usage data is to be reported.
<bank name>
The name of your financial institution. This name cannot contain blanks.
<instance name>
Any text string that uniquely identifies the instance of the FTM database. This string cannot contain blanks.
<encrypted file>
The name of the encrypted properties files that are used to create the JDBC database connection. The default file name for the database is shown in the following list.
  • For Db2, dbConnection4DB2.properties.en3

Configure the FTM usage report tool database connectivity

The properties that you specify in a database connection properties file are used to create a JDBC connection to the database. The following sample database connection properties template files are supplied:
  • For Db2, dbConnection4DB2.properties
A database connection properties file has the following property keys.
connection.url=<connection string>
The JDBC database connection string that contains the hostname, port, and database name of the database.

For a Db2 server, the connection string is expected to be in the following format jdbc\:db2\://<hostname>\:<port>/<datasource>.

connection.schema=<schema>
The database schema to be used.
user=<user>
The username to be used to connect to the database.
password=<password>
The password to be used to connect to the database.
For Db2, the following JDBC properties were added to encrypt the user credentials as they are passed to the database server.
securityMechanism=<security mechanism number>
The template contains securityMechanism=9. The value of 9 is com.ibm.db2.jcc.DB2BaseDataSource.ENCRYPTED_USER_AND_PASSWORD_SECURITY.
To use this option, the following configuration changes must be done on the Db2 server:
  • Set the AUTHENTICATION property to SERVER_ENCRYPT.
  • Set the DB2AUTH property to JCC_ENFORCE_SECMEC.
encryptionAlgorithm=<1>
The encryption algorithm that is used by the specified securityMechanism. The supplied template contains a value of 1, which is Data Encryption Standard(DES) with 56-bit encryption. A more secure algorithm is also available. For example, a value of 2 is Advanced Encryption Standard(AES) with 256-bit encryption, but it requires the installation of the IBM® Java Cryptology Extension (JCE) files.
Note: If the chosen securityMechanism does not require encryption, this property needs to be removed or commented out. For example, a value of 3 is com.ibm.db2.jcc.DB2BaseDataSource.CLEAR_TEXT_PASSWORD_SECURITY, which does not use encryption.

For a full list of the supported JDBC properties for Db2, see the IBM Data Server Driver for JDBC and SQLJ topic in the Db2 documentation.

Note: If you connect to Db2 over SSL, and in the nonproduction environment your certificate hostname does not match one of the Db2 instances, you can disable the hostname validation. To do so, follow the steps that are listed.
  • Add sslHostnameValidation=OFF to dbConnection4DB2 properties.
  • Add -Dcom.ibm.db2.jcc.override.sslClientHostnameValidation=OFF to the command that is used to run the tool.