Configuration file format
This section provides an overview of configuration files. For example, it explains the configuration categories (sections) within the file and the required format for the configuration parameters that the file contains.
For more information about the configuration parameters, see Command-and-syntax-reference.
Overview of the configuration files format
A configuration file is a text file that contains processing options for one or more apply requests. The parameters in each configuration file are organized into sections.
Sample configuration file for a Db2 mainframe target, Sample configuration file for Db2 LUW, and Sample configuration file for Oracle show examples of a configuration file. A configuration file contains the following elements:
- Section names indicate the configuration categories that are included in the file. The [Startup] section (StartUp-parameters) is the only required configuration section. For more information about specifying section names, see Sections-in-configuration-files.
- Parameters specify processing options for the request. Each parameter must appear in the appropriate section of the configuration file. For more information about specifying parameters, see Format-of-configuration-parameters.
- Comments can provide information about the configuration file and its uses. For more information about including comments in a configuration file, see Comments-in-configuration-files.
- Conflict Resolution rules are special sets of configuration parameters that describe how to handle the conflict situations that can occur during apply processing. For more information about conflict resolution rules, see Conflict-resolution.
Lines of input in the configuration file can be up to 1024 bytes long. BMC Software recommends that any parameters, section names, or conflict resolution rules should be complete on one line of the file.
If you need to 'split' or 'wrap' one logical line of configuration information onto multiple physical lines, use the plus sign (+) as the last character on a line and continue the configuration information in column 1 of the next line. High-speed Apply Engine appends any characters (including spaces) onto the end of the previous line. For example, when Db2 objects have long names the BMC AMI Log Master for Db2 product can generate High-speed Apply Engine object mapping rules on multiple lines by using the plus sign as the last character in column 72.
Sample configuration file for a Db2 mainframe target
/StartUp/
FileName=USER14.MIGRATE.LLOG.CNTL
InputType=LogicalLog
/LogicalLog/
UpdateColumn=CHANGED
Qualify=CHANGED
SQLType=MIGRATE
/Bind/
PackagePrefix=APTK
PlanPrefix=APT
BindOwner=DB2ADM1
FreeOption=ALL
Library=APTDBRM
Disp=SHR
/ObjectMap/
SourceTable=HR.PAYROLL
TargetTable=ACC1Q.PAYROLL
SourceColumn=NAME
TargetColumn=SURNAME
SourceColumn=HIREDAT
TargetColumn=DATE
SourceColumn=SALARY
TargetColumn=RATE
/TemporaryFiles/
STORCLAS=TEMP
/Agent/
MaxAgents=30
/Restart/
RestartType=New
/AnyConflict/
Code=NEGATIVE
Action=ABORT
Code=POSITIVE
Action=WARN
Code=MULTIPLEROWS
Action=WARN
Code=NOROWS
Action=WARN
Code=TIMEOUT
Action=RETRY
Code=SQLWARN0
Action=WARN
Code=SQLWARN1
Action=WARN
Code=SQLWARN2
Action=WARN
Code=SQLWARN3
Action=WARN
Code=SQLWARN4
Action=WARN
Code=SQLWARN5
Action=WARN
Code=SQLWARN6
Action=WARN
Code=SQLWARN7
Action=WARN
Code=SQLWARN8
Action=WARN
Code=SQLWARN9
Action=WARN
Code=SQLWARNA
Action=WARN
/Conflict/
RetryLimit=COUNT
RetryValue=2
/ConflictFile/
FileNameModel=&SYSUID..BMCAPT.&REQUESTID..D&DATE..T&TIME.
SingleFile=NO
SPACE=TRACK
SpacePri=15
SpaceSec=5
DISP=NEW
/ObjectCluster/
Cluster=HUMANRES
Table=HR.*
Cluster=ACC1Q
Table=ACC.JAN
Table=ACC.FEB
Table=ACC.MAR
Cluster=ACC2Q
Table=ACC.APR
Table=ACC.MAY
Table=ACC.JUN
Sample configuration file for Db2 LUW
UserID=hstr
Password=hstr
Filename=test.sql
Dbmstype=DB2
Database=Webserver
[DisplayOutput]
FileName=DB2UDBDisplay.txt
[ErrorOutput]
FileName=DB2UDBError.txt
[Agent]
MaxAgents=10
[AnyConflict]
Code=Negative
Action=abort
Code=Positive
Action=Warn
Code=Multiplerows
Action=Warn
Code=Norows
Action=Warn
Sample configuration file for Oracle
Login=user14/pwora@Ora10
FileName=ora10_update.sql
[Agent]
MaxAgents=8
[Conflict]
RetryLimit=count
RetryValue=2
RetryFail=terminate
[ConflictFile]
FileNameModel=BMCAPE.&REQUESTID..&DBSERVER..D&DATE..T&TIME.
SingleFile=NO
[AnyConflict]
Code=TIMEOUT
Action=RETRY
[Restart]
RestartType=New
[DisplayOutput]
FileName=apedisplay.txt
[ErrorOutput]
FileName=apeerror.txt
This section contains the following topics: