Setting up and running the DSU

The DSU is provided for all FTM offerings except for the ones in the following list.
  • Base FTM

It has some software and hardware requirements that must be met before it can run.

The following sections describe the requirements, how to download and install the files to run the DSU, and the syntax for running the DSU commands.

Requirements

The DSU has the following requirements.
Db2® client software
This client software is a prerequisite that must be installed on the same computer as the DSU. The DSU uses the client to connect to the FTM database.
Memory requirements
The physical memory on the computer where the DSU is run must accommodate both the operating system and the memory that the DSU allocates. By default, the 64-bit version of the DSU allocates four gigabytes (4 Gb) of memory when it starts.
Notes:
  • A 64-bit Java™ Runtime Environment (JRE) is provided to use for this function. To get the JRE for your operating system, download the appropriate FTM JRE fix pack from IBM® Fix Central.
  • To use the DSU, the operating system on the computer must support running 64-bit applications.

Get the DSU files

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. Download the DSU files to a computer that you can access the database from.

The command file is in the following location.
  • For the 64-bit version, the directory is /share/artifacts/tools/common/dsu/cmd64

You must also get the 64-bit Java Runtime Environment (JRE). A 64-bit Java Runtime Environment (JRE) is provided to use for this function. To get the JRE for your operating system, download the appropriate FTM JRE fix pack from IBM Fix Central.

On your local computer, create a directory that is called dsu and switch into it. Then, download the DSU artifacts to this local directory. The following table shows the DSU subdirectories and which artifacts provide the files that go into the subdirectory.
Table 1. DSU subdirectory structure
DSU subdirectory name Source of the files for this subdirectory
dsu/cmd64 The tools artifacts for Common Services.
dsu/cmd64/_jvm64 The FTM JRE fix pack.
dsu/lib The tools artifacts for Common Services.
dsu/properties The configuration artifacts with the DSU properties files for the payment schemes that you want to use.
dsu/xls The configuration artifacts with the DSU workbook files for the payment schemes that you want to use.
The data setup utility has command files for the following operating systems.
  • For the Windows operating system, the command file is DSU64.bat
  • For AIX® or Linux®, the command file is DSU64.sh

Add the DSU directory to the PATH system variable

To be able to run the DSU from a command prompt in any directory, add the directory for the DSU command file to the PATH system variable. If the DSU directory is not added to the system path, the complete path and command file name must be used to run the utility.

Run the DSU

The command to run the data setup utility has the following format. 
DSU64 <operation> <properties file> <options> {overrideable properties}
The parameters for the DSU commands are shown in the following list.
<operation>
This parameter represents the operation to be done. The operations are shown in the following list.
  • import
  • export
  • validate
  • delete
<properties file>
This parameter represents the name of the properties file to use for the operation.
<options>
This parameter represents one or more options for the DSU command. The options are shown in the following list:
-pass=passphrase
When an encrypted properties file is being used, the passphrase that was used to encrypt the file is needed. Use this option to provide the passphrase to the DSU.
-klen=keyLength
When an encrypted properties file is being used, the key length that was used to encrypt the file is needed. Use this option to provide the key length to the DSU.
-mode=mode
When an encrypted properties file is being used, the mode that was used to encrypt the file is needed. Use this option to provide the mode to the DSU.
-pad=paddingtype
When an encrypted properties file is being used, the padding type that was used to encrypt the file is needed. Use this option to provide the padding type to the DSU.
{overrideable properties}
This optional parameter represents a list of properties whose values you want to override. Specify each property to be overridden as a name and value pair with the following format.
propertyname=newvalue
Use a space to separate the different property name and value pairs. On the Windows operating system, the property and its value must be specified inside quotation marks. As many as seven configuration properties can be specified for the command.

Examples of running the DSU command

The following examples use the properties files that import and export the configuration data for the Common Services base component.

The following example command shows how to start an import operation for the configuration data.
DSU64 import ProductImport.properties
The following example command shows how to start an import operation for the configuration data that uses an encrypted properties file.
DSU64 import ProductImport.properties -pass=myPassPhrase -mode=ECB -pad=PKCS5Padding
The following example command shows how to start an export operation for the configuration data that overrides the exportSimpleName property.
DSU64 export ProductExport.properties exportSimpleName=true
The following example command shows how to start an export operation for the configuration data that overrides the exportSimpleName property on the Windows operating system.
DSU64 export ProductExport.properties "exportSimpleName=true"