Available properties

The following table describes the properties that are available and the operations that each property supports.

Table 1. DSU runtime properties
Property name Description Valid for operations
baseSchema The database schema name for the FTM database.

The default value is FTM.

 Import, Export, Delete, Validate
busRulesLoad Indicates whether the configuration data that is being imported is related to Business Rules. This property does not apply to operations that manage the base Business Rules configuration data.
Valid values are shown in the following list:
  • true
  • false - This value is the default.
 Import, Export, Delete
busRulesSchema The database schema name for Business Rules. This property does not apply to operations that manage the base Business Rules configuration data.

The default value is RULES.

 Import, Export, Delete
clientId Specifies which partners are to be exported. It is a comma-separated list of the specific partner IDs. Export
createNewRelease Specifies whether a new Business Rules release must be created. This property is used only if releaseId is not specified. When it is set to true, a new release is created. When it is set to false, the most recent release in edit mode is used. If no such release can be found, the importer exits with a message that describes the problem.
Valid values are shown in the following list:
  • true - This value is the default.
  • false
 Import
csvLogFileDelimiter Specifies the character that is used to separate the values that are written to the CSV log files.

This property is used only if generateCSVLogFiles is true.

 Import, Export, Delete, Validate
csvLogFileLocation The directory that the CSV log files are written to.

This property is used only if generateCSVLogFiles is true.

 Import, Export, Delete, Validate
dbConnectId The user ID used to connect to the FTM database. If this property is not specified, the user ID logged on to the computer that is running the DSU is used to access the database. Import, Export, Delete, Validate
dbConnectPwd The password for the user ID used to access the FTM database. If this property is not specified, the password of the user that is logged on to the computer that is running the DSU is used to access the database.

This property is used only if dbConnectId has a value.

 Import, Export, Delete, Validate
dbDriverName The name of the Db2® driver. Import, Export, Delete, Validate
dbEnableSSL Enables a secured connection between the DSU and the database manager (Db2). When set to true, it requires the configuration of the following parameters: dbEnableSSL, dbKeyStore, dbKeyStorePassword, dbKeyStoreFormat, dbTrustStore, dbTrustStorePassword, dbTrustStoreFormat.
Valid values are shown in the following list:
  • true
  • false - This value is the default.
 Import, Export, Delete, Validate
dbKeyStore The full path and file name, including the file extension, of the keystore file.

This property is used only if dbEnableSSL is true.

 Import, Export, Delete, Validate
dbKeyStoreFormat The format of the keystore file.

This property is used only if dbEnableSSL is true.

 Import, Export, Delete, Validate
dbKeyStorePassword Password for the keystore.

This property is used only if dbEnableSSL is true.

 Import, Export, Delete, Validate
dbTrustStore The full path and file name, including the file extension, of the truststore file. It is usually the same file as the keystore file.

This property is used only if dbEnableSSL is true.

 Import, Export, Delete, Validate
dbTrustStoreFormat The format of the truststore file.

This property is used only if dbEnableSSL is true.

 Import, Export, Delete, Validate
dbTrustStorePassword Password for the truststore.

This property is used only if dbEnableSSL is true.

 Import, Export, Delete, Validate
dbUrl Uniform resource locator (URL) for the FTM database. Import, Export, Delete, Validate
deleteRelease Indicates whether the Business Rules configuration data is to be deleted. This property does not apply to operations that manage the base Business Rules configuration data.
Valid values are shown in the following list:
  • true - This value is the default.
  • false
 Delete
determineOrder Indicates whether the database table relational configuration is used to determine the order in which to process the tables listed in the cross-reference workbook. Using the database table relational configuration eliminates foreign key constraint failures.
Valid values are shown in the following list:
  • true
  • false - This value is the default.
 Import
enableAudit Indicates whether auditing at the summary level for inserting, updating, and deleting is enabled.
Valid values are shown in the following list:
  • true
  • false - This value is the default.
 Import, Export, Delete, Validate
enableAuditDelete Indicates whether auditing at the summary level for deleting is enabled.
Valid values are shown in the following list:
  • true
  • false - This value is the default.
 Import
enableAuditInsert Indicates whether auditing at the detail level for each field of each record that is being inserted into the database is enabled.
Valid values are shown in the following list:
  • true
  • false - This value is the default.
 Import
enableAuditUpdate Indicates whether auditing at the detail level for each field of each record that is being updated in the database is enabled.
Valid values are shown in the following list:
  • true - This value is the default.
  • false
 Import
enableTrace Indicates whether tracing is enabled.
Valid values are shown in the following list:
  • true - This value is the default.
  • false
 Import, Export, Delete, Validate
environmentName The name of the Business Rules environment. This property does not apply to operations that manage the base Business Rules configuration data. Import, Export, Delete
exportSimpleName Specifies whether only the base outRulesFilesName property is used when the workbook files are named.
Valid values are shown in the following list:
  • true
  • false - This value is the default.
 Export
exportVersions Indicates which participant data to export when effective dating is used.
Valid values are shown in the following list:
Active
This value is the default. The participant data is marked as active.
Current
The current version of the participant data.
CurrentPlus
The current version of the participant data plus any future versions.
Discarded
The participant data that is marked as discarded.
Draft
The participant data that is marked as draft.
Latest
The most recent version of the participant data.
 Export
fileCutoffPeriod The value of this property is the number of minutes before a specific deadline. The cutoff period is when file processing stops. This property is used only for Distribution.

The default value is 10.

 Import
generateCSVLogFiles Indicates whether CSV log file generation is enabled.
Valid values are shown in the following list:
  • true
  • false - This value is the default.
 Import, Export, Delete, Validate
inRulesFileName The name of the configuration data workbook to use for this import operation. Import
inspectData Indicates whether to add an extra audit detail record when database update and insert operations are audited. The record contains the database table name, configuration workbook name, and the configuration worksheet name. It is indicated by a 999 in the Attribute Order field. This auditing is primarily used for troubleshooting.
Valid values are shown in the following list:
  • true
  • false - This value is the default.
 Import, Export, Validate
logFileLocation The directory that the log and trace files are written to.

Change this property to ..//cmd64 when you are running the 64-bit version of the data setup utility.

 Import, Export, Delete, Validate
logFilenameTimeBased Controls the format of the log and trace files. When set to true, the general log and trace files have the following naming convention: DSU_operation_YYYYMMDD_HHmmss_SSS where
operation
is the DSU operation that was done
YYYY
is the year
MM
is the month
DD
is the day
HH
is the hour
mm
are minutes
ss
are seconds
SSS
are milliseconds
When set to false, the log files have the following naming convention: DSU_operation_PROP_DATA where
operation
Is the DSU operation that was done.
PROP
Is the name of the properties file, without an extension.
DATA
Is the name data configuration workbook file, without an extension.
Valid values are shown in the following list:
  • true - This value is the default.
  • false
 Import, Export, Delete, Validate
logToConsole Indicates whether console logging is enabled.
Valid values are shown in the following list:
  • true - This value is the default.
  • false
 Import, Export, Delete, Validate
outRulesFileName The file name, including the file extension, of the configuration data workbook to which the exported configuration data is written. The exportSimpleName property controls how the DSU uses this property to create the file name.
When exportSimpleName is set to false, the DSU uses outRulesFileName and the current date and time to create a new workbook file with the following name: Vv.r.m.f_YYYYMMDD_HHmmss_SSS_outRulesFileName where
v
Is the version number of the DSU
r
Is the release number of the DSU
m
Is the modification level of the DSU
f
Is the fix level of the DSU
YYYY
is the year
MM
is the month
DD
is the day
HH
is the hour
mm
are minutes
ss
are seconds
SSS
are milliseconds
outRulesFileName
Is the base file name in this property

When exportSimpleName is true, the DSU creates a new workbook file with the name that is specified in outRulesFileName.

 Export
mapFileName The name of the map workbook to use for this operation. More than one map file can be specified for the import and export operations. When you are configuring multiple map files, use commas to separate the file names and ensure that a corresponding cross-reference workbook is added to the XREFFileName property. Import, Export, Delete, Validate
newConfigurationFile The name, including the path, of a secure or encrypted properties file. If this file is specified, its configuration values override the values from the default properties file. An example of the file name is config.properties.enc. For more information about encrypting properties files, see Encrypting configuration files in Payment Feature Services. Import, Export, Delete, Validate
releaseId The Business Rules release ID. This property does not apply to operations that manage the base Business Rules configuration data. releaseID is used differently for each of the operations that it supports.
The import operation allows data to be imported into either a new or an existing release.
Existing
To import data into or to update an existing Business Rules release, specify the release ID.
New
To create a new Business Rules release, comment out the releaseId property and set the createNewRelease property to true.

To ensure that all of the Business Rules configuration data is imported into the same Business Rules release, the releaseId property in the properties files that are used for the subsequent Business Rules configuration data import operations must be set to the ID of the new release.

The release ID of the newly generated Business Rules release is written to the log file. If the logToConsole runtime property is set to true, the ID is also displayed on the console.

 Import
Specify a release ID to export that specific Business Rules release.

If no release ID is specified, the active Business Rules release with the largest numerical value is exported.

 Export
For the delete operation, a specific release ID must be provided. Delete
runVersion1 This property is deprecated.
Valid values are shown in the following list:
  • true
  • false - This value is the default.
 Import
strictImport Set this property to true to cause the import process to stop when an error is encountered. When it is set to false, the import process continues and errors are only logged.
Valid values are shown in the following list:
  • true
  • false - This value is the default.
 Import
usingXlsxFiles Indicates whether the configuration data is exported by using the XLSX format of Microsoft Excel.
Note: Configuration data worksheets that contain more than 65,536 rows or 256 columns must be stored in the XLSX format.
 Export
valRulesFileName The name of the configuration data workbook to use for this validate operation. Validate
XREFFileName The name of the cross-reference workbook to use for this operation. More than one cross-reference workbook can be specified for the import and export operations. When you are configuring multiple cross-reference workbooks, use commas to separate the file names and ensure that a corresponding map file is added to the mapFileName property. Import, Export, Delete, Validate