Go to main content
1/32
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
Part I Understanding Oracle GoldenGate Application Adapters
1
Understanding Oracle GoldenGate Adapters
1.1
Oracle GoldenGate Application Adapters Overview
1.1.1
Oracle GoldenGate Integration
1.1.2
Oracle GoldenGate Application Adapter Integration Options
1.1.2.1
Capturing Transactions to a Trail
1.1.2.2
Applying Transactions from a Trail
1.2
Using Oracle GoldenGate Application Adapters Properties
1.2.1
Values in Property Files
1.2.2
Location of Property Files
1.2.3
Using Comments in the Property File
1.2.4
Variables in Property Names
1.3
Oracle GoldenGate Documentation
2
Introducing the File Writer
2.1
Overview of the Adapter for Flat Files
2.2
Typical Configuration
3
Introducing the Java Adapter
3.1
Oracle GoldenGate VAM Message Capture
3.1.1
Message Capture Configuration Options
3.1.2
Typical Configuration
3.2
Oracle GoldenGate Java User Exit
3.2.1
Delivery Configuration Options
3.3
Running with Extract
3.3.1
Extract Configuration
3.3.2
Adding the Extract Process
3.3.3
Extract Grouping
3.4
Running with Replicat
3.4.1
Replicat Configuration
3.4.2
Adding the Replicat Process
3.4.3
Replicat Grouping
3.4.4
Replicat Checkpointing
3.4.5
Unsupported Replicat Features
3.4.6
Mapping Functionality
4
Configuring Logging
4.1
Application Adapters Default Logging
4.1.1
Default Implementation Type
4.1.2
Default Message Logging
4.1.2.1
Logging Problems
4.1.2.2
Log File Name
4.2
Changing the Default Logging
4.2.1
Changing the Logging Type
4.2.2
Changing the Logging Configuration
4.2.3
Enabling Debug
Part II Creating Flat Files
5
Configuring the Flat File Adapter
5.1
Configuring the Adapter for Writing Flat Files
5.1.1
User Exit Extract Parameters
5.1.2
User Exit Properties
5.2
Recommended Data Integration Approach
5.3
Producing Data Files
6
Using the Flat File Adapter
6.1
Working with Control Files
6.2
Working with Statistical Summaries
6.3
Managing Oracle GoldenGate processes
6.4
Trail Recovery Mode
6.5
Locating Error Messages
7
Using Predefined Defaults and Formats
7.1
Overview of Predefined Defaults and Formats
7.1.1
Default Properties
7.1.2
Specifying Consumer Formats
7.2
Siebel Remote Format
7.3
Ab Initio Format
7.4
Netezza Format
7.5
Greenplum Format
7.6
Comma Delimited Format
8
Flat File Properties
8.1
User Exit Properties
8.1.1
Logging Properties
8.1.1.1
goldengate.log.logname
8.1.1.2
goldengate.log.level
8.1.1.3
goldengate.log.tostdout
8.1.1.4
goldengate.log.tofile
8.1.2
General Properties
8.1.2.1
goldengate.flatfilewriter.writers
8.1.2.2
goldengate.userexit.buffertxs
8.1.2.3
goldengate.userexit.chkptprefix
8.1.2.4
goldengate.userexit.chkpt.ontxend
8.1.2.5
goldengate.userexit.datetime.removecolon
8.1.2.6
goldengate.userexit.timestamp
8.1.2.7
goldengate.userexit.datetime.maxlen
8.1.2.8
goldengate.userexit.utf8mode
8.2
File Writer Properties
8.2.1
Output Format Properties
8.2.1.1
writer.mode
8.2.1.2
writer.groupcols
8.2.2
Output File Properties
8.2.2.1
writer.files.onepertable
8.2.2.2
writer.files.oneperopcode
8.2.2.3
writer.files.prefix
8.2.2.4
writer.files.data.rootdir, writer.files.data.ext, writer.files.data.tmpext
8.2.2.5
writer.files.control.use, writer.files.control.rootdir, writer.files.control.ext
8.2.2.6
writer.files.control.delim.chars/code, writer.files.control.eof.chars/code
8.2.2.7
writer.files.formatstring
8.2.2.8
writer.files.data.bom.code
8.2.2.9
writer.files.includeprocessname
8.2.2.10
writer.files.useownerfiles
8.2.3
File Rollover Properties
8.2.3.1
writer.files.data.rollover.time
8.2.3.2
writer.files.data.rollover.size
8.2.3.3
writer.files.data.norecords.timeout
8.2.3.4
writer.files.rolloveronshutdown
8.2.3.5
writer.files.data.rollover.timetype
8.2.3.6
writer.files.data.rollover.multiple
8.2.3.7
writer.files.data.rollover.attime
8.2.3.8
writer.writebuffer.size
8.2.4
Data Content Properties
8.2.4.1
writer.rawchars
8.2.4.2
writer.includebefores
8.2.4.3
writer.afterfirst
8.2.4.4
writer.includecolnames
8.2.4.5
writer.omitvalues
8.2.4.6
writer.diffsonly
8.2.4.7
writer.omitplaceholders
8.2.4.8
Metadata Columns
8.2.4.9
Valid Metadata Columns
8.2.4.10
Using Metadata Columns
8.2.4.11
writer.metacols
8.2.4.12
writer.metacols.metacol_name.fixedlen
8.2.4.13
writer.metacols.metacol_name.column
8.2.4.14
writer.metacols.token_name.novalue.chars | writer.metacols.token_name.novalue.code
8.2.4.15
writer.metacols.metacol_name.fixedjustify
8.2.4.16
writer.metacols.metacol_name.fixedpadchar.chars | writer.metacols.metacol_name.fixedpadchar.code
8.2.4.17
writer.metacols.opcode.insert.chars | writer.metacols.opcode.insert.code
8.2.4.18
writer.metacols.opcode.update.chars | writer.metacols.opcode.update.code
8.2.4.19
writer.metacols.opcode.delete.chars | writer.metacols.opcode.delete.code
8.2.4.20
writer.metacols.opcode.updatepk.chars | writer.metacols.opcode.updatepk.code
8.2.4.21
writer.metacols.txind.begin.chars | writer.metacols.txind.begin.code
8.2.4.22
writer.metacols.txind.middle.chars | writer.metacols.txind.middle.code
8.2.4.23
writer.metacols.txind.end.chars | writer.metacols.txind.end.code
8.2.4.24
writer.metacols.txind.whole.chars | writer.metacols.txind.whole.code
8.2.4.25
writer.metacols.position.format
8.2.4.26
writer.metacols.colname.omit
8.2.4.27
writer.begintx.metacols, writer.endtx.metacols
8.2.5
DSV Specific Properties
8.2.5.1
writer.dsv.nullindicator.chars | writer.dsv.nullindicator.code
8.2.5.2
writer.dsv.fielddelim.chars | writer.dsv.fielddelim.code
8.2.5.3
writer.dsv.linedelim.chars | writer.dsv.linedelim.code
8.2.5.4
writer.dsv.quote.chars | writer.dsv.quote.code
8.2.5.5
writer.dsv.quotes.policy
8.2.5.6
writer.dsv.quotes.datatypes
8.2.5.7
writer.dsv.nullindicator.escaped.chars | writer.dsv.nullindicator.escaped.code
8.2.5.8
writer.dsv.fielddelim.escaped.chars | writer.dsv.fielddelim.escaped.code
8.2.5.9
writer.dsv.linedelim.escaped.chars | writer.dsv.linedelim.escaped.code
8.2.5.10
writer.dsv.quotes.escaped.chars | writer.dsv.quotes.escaped.code
8.2.5.11
writer.dsv.onecolperline
8.2.5.12
writer.dsv.quotealways
8.2.6
LDV Specific Properties
8.2.6.1
writer.ldv.vals.missing.chars | writer.ldv.vals.missing.code
8.2.6.2
writer.ldv.vals.present.chars | writer.ldv.vals.present.code
8.2.6.3
writer.ldv.vals.null.chars | writer.ldv.vals.null.code
8.2.6.4
writer.ldv.lengths.record.mode,writer. ldv.lengths.field.mode
8.2.6.5
writer.ldv.lengths.record.length, writer.ldv.lengths.field.length
8.2.7
Statistics and Reporting
8.2.7.1
writer.statistics.toreportfile
8.2.7.2
writer.statistics.period
8.2.7.3
writer.statistics.time
8.2.7.4
writer.statistics.tosummaryfile
8.2.7.5
writer.statistics.summary.fileformat
8.2.7.6
writer.statistics.overall
8.2.7.7
writer.statistics.summary.delimiter.chars/code, writer.statistics.summary.eol.chars/code
8.2.7.8
writer.statistics.summary.extension
Part III Capturing JMS Messages
9
Configuring Message Capture
9.1
Configuring the VAM Extract
9.1.1
Adding the Extract
9.1.2
Configuring the Extract Parameters
9.1.3
Configuring Message Capture
9.2
Connecting and Retrieving the Messages
9.2.1
Connecting to JMS
9.2.2
Retrieving Messages
9.2.3
Completing the Transaction
10
Parsing the Message
10.1
Parsing Overview
10.1.1
Parser Types
10.1.2
Source and Target Data Definitions
10.1.3
Required Data
10.1.3.1
Transaction Identifier
10.1.3.2
Sequence Identifier
10.1.3.3
Timestamp
10.1.3.4
Table Name
10.1.3.5
Operation Type
10.1.3.6
Column Data
10.1.4
Optional Data
10.1.4.1
Transaction Indicator
10.1.4.2
Transaction Name
10.1.4.3
Transaction Owner
10.2
Fixed Width Parsing
10.2.1
Header
10.2.1.1
Specifying Compound Table Names
10.2.1.2
Specifying timestamp Formats
10.2.1.3
Specifying the Function
10.2.2
Header and Record Data Type Translation
10.2.3
Key identification
10.3
Delimited parsing
10.3.1
Metadata Columns
10.3.2
Parsing Properties
10.3.2.1
Properties to Describe Delimiters
10.3.2.2
Properties to Describe Values
10.3.2.3
Properties to Describe Date and Time
10.3.3
Parsing Steps
10.4
XML Parsing
10.4.1
Styles of XML
10.4.2
XML Parsing Rules
10.4.3
XPath Expressions
10.4.3.1
Supported Constructs:
10.4.3.2
Supported Expressions
10.4.3.3
Obtaining Data Values
10.4.4
Other Value Expressions
10.4.5
Transaction Rules
10.4.6
Operation Rules
10.4.7
Column Rules
10.4.8
Overall Rules Example
10.5
Source definitions Generation Utility
11
Message Capture Properties
11.1
Logging and Connection Properties
11.1.1
Logging Properties
11.1.1.1
gg.log
11.1.1.2
gg.log.level
11.1.1.3
gg.log.file
11.1.1.4
gg.log.classpath
11.1.2
JMS Connection Properties
11.1.2.1
jvm.boot options
11.1.2.2
jms.report.output
11.1.2.3
jms.report.time
11.1.2.4
jms.report.records
11.1.2.5
jms.id
11.1.2.6
jms.destination
11.1.2.7
jms.connectionFactory
11.1.2.8
jms.user, jms.password
11.1.3
JNDI Properties
11.2
Parser Properties
11.2.1
Setting the Type of Parser
11.2.1.1
parser.type
11.2.2
Fixed Parser Properties
11.2.2.1
fixed.schematype
11.2.2.2
fixed.sourcedefs
11.2.2.3
fixed.copybook
11.2.2.4
fixed.header
11.2.2.5
fixed.seqid
11.2.2.6
fixed.timestamp
11.2.2.7
fixed.timestamp.format
11.2.2.8
fixed.txid
11.2.2.9
fixed.txowner
11.2.2.10
fixed.txname
11.2.2.11
fixed.optype
11.2.2.12
fixed.optype.insertval
11.2.2.13
fixed.optype.updateval
11.2.2.14
fixed.optype.deleteval
11.2.2.15
fixed.table
11.2.2.16
fixed.schema
11.2.2.17
fixed.txind
11.2.2.18
fixed.txind.beginval
11.2.2.19
fixed.txind.middleval
11.2.2.20
fixed.txind.endval
11.2.2.21
fixed.txind.wholeval
11.2.3
Delimited Parser Properties
11.2.3.1
delim.sourcedefs
11.2.3.2
delim.header
11.2.3.3
delim.seqid
11.2.3.4
delim.timestamp
11.2.3.5
delim.timestamp.format
11.2.3.6
delim.txid
11.2.3.7
delim.txowner
11.2.3.8
delim.txname
11.2.3.9
delim.optype
11.2.3.10
delim.optype.insertval
11.2.3.11
delim.optype.updateval
11.2.3.12
delim.optype.deleteval
11.2.3.13
delim.schemaandtable
11.2.3.14
delim.schema
11.2.3.15
delim.table
11.2.3.16
delim.txind
11.2.3.17
delim.txind.beginval
11.2.3.18
delim.txind.middleval
11.2.3.19
delim.txind.endval
11.2.3.20
delim.txind.wholeval
11.2.3.21
delim.fielddelim
11.2.3.22
delim.linedelim
11.2.3.23
delim.quote
11.2.3.24
delim.nullindicator
11.2.3.25
delim.fielddelim.escaped
11.2.3.26
delim.linedelim.escaped
11.2.3.27
delim.quote.escaped
11.2.3.28
delim.nullindicator.escaped
11.2.3.29
delim.hasbefores
11.2.3.30
delim.hasnames
11.2.3.31
delim.afterfirst
11.2.3.32
delim.isgrouped
11.2.3.33
delim.dateformat | delim.dateformat.table | delim.dateform.table.column
11.2.4
XML Parser Properties
11.2.4.1
xml.sourcedefs
11.2.4.2
xml.rules
11.2.4.3
rulename.type
11.2.4.4
rulename.match
11.2.4.5
rulename.subrules
11.2.4.6
txrule.timestamp
11.2.4.7
txrule.timestamp.format
11.2.4.8
txrule.seqid
11.2.4.9
txrule.txid
11.2.4.10
txrule.txowner
11.2.4.11
txrule.txname
11.2.4.12
oprule.timestamp
11.2.4.13
oprule.timestamp.format
11.2.4.14
oprule.seqid
11.2.4.15
oprule.txid
11.2.4.16
oprule.txowner
11.2.4.17
oprule.txname
11.2.4.18
oprule.schemandtable
11.2.4.19
oprule.schema
11.2.4.20
oprule.table
11.2.4.21
oprule.optype
11.2.4.22
oprule.optype.insertval
11.2.4.23
oprule.optype.updateval
11.2.4.24
oprule.optype.deleteval
11.2.4.25
oprule.txind
11.2.4.26
oprule.txind.beginval
11.2.4.27
oprule.txind.middleval
11.2.4.28
oprule.txind.endval
11.2.4.29
oprule.txind.wholeval
11.2.4.30
colrule.name
11.2.4.31
colrule.index
11.2.4.32
colrule.value
11.2.4.33
colrule.isnull
11.2.4.34
colrule.ismissing
11.2.4.35
colrule.before.value
11.2.4.36
colrule.before.isnull
11.2.4.37
colrule.before.ismissing
11.2.4.38
colrule.after.value
11.2.4.39
colrule.after.isnull
11.2.4.40
colrule.after.ismissing
Part IV Delivering Java Messages
12
Configuring Message Delivery
12.1
Configure the JRE in the User Exit Properties File
12.2
Configure Extract to Run the User Exit
12.3
Configure the Java Handlers
13
Using the Java User Exit
13.1
Starting the Application
13.2
Restarting the Application at the Beginning of a Trail
14
Configuring Event Handlers
14.1
Specifying Event Handlers
14.2
JMS Handler
14.3
File Handler
14.4
Custom Handlers
14.5
Formatting the Output
14.6
Reporting
15
Message Delivery Properties
15.1
User Exit Properties
15.1.1
Logging Properties
15.1.1.1
gg.log
15.1.1.2
gg.log.level
15.1.1.3
gg.log.file
15.1.1.4
gg.log.classpath
15.1.2
General Properties
15.1.2.1
goldengate.userexit.writers
15.1.2.2
goldengate.userexit.chkptprefix
15.1.2.3
goldengate.userexit.nochkpt
15.1.2.4
goldengate.userexit.usetargetcols
15.1.3
JVM boot Options
15.1.3.1
jvm.bootoptions
15.1.4
Statistics and Reporting
15.1.4.1
jvm.stats.display
15.1.4.2
jvm.stats.full
15.1.4.3
jvm.stats.time | jvm.stats.numrecs
15.2
Java Application Properties
15.2.1
Properties for All Handlers
15.2.1.1
gg.handlerlist
15.2.1.2
gg.handler.name.type
15.2.2
Properties for Formatted Output
15.2.2.1
gg.handler.name.format
15.2.2.2
gg.handler.name.includeTables
15.2.2.3
gg.handler.name.excludeTables
15.2.2.4
gg.handler.name.mode, gg.handler.name.format.mode
15.2.3
Properties for CSV and Fixed Format Output
15.2.3.1
gg.handler.name.format.delim
15.2.3.2
gg.handler.name.format.quote
15.2.3.3
gg.handler.name.format.metacols
15.2.3.4
gg.handler.name.format.missingColumnChar
15.2.3.5
gg.handler.name.format.presentColumnChar
15.2.3.6
gg.handler.name.format.nullColumnChar
15.2.3.7
gg.handler.name.format.beginTxChar
15.2.3.8
gg.handler.name.format.middleTxChar
15.2.3.9
gg.handler.name.format.endTxChar
15.2.3.10
gg.handler.name.format.wholeTxChar
15.2.3.11
gg.handler.name.format.insertChar
15.2.3.12
gg.handler.name.format.updateChar
15.2.3.13
gg.handler.name.format.deleteChar
15.2.3.14
gg.handler.name.format.endOfLine
15.2.3.15
gg.handler.name.format.justify
15.2.3.16
gg.handler.name.format.includeBefores
15.2.4
File Writer Properties
15.2.4.1
gg.handler.name.file
15.2.4.2
gg.handler.name.append
15.2.4.3
gg.handler.name.rolloverSize
15.2.5
JMS Handler Properties
15.2.5.1
Standard JMS Settings
15.2.5.1.1
gg.handler.name.destination
15.2.5.1.2
gg.handler.name.user
15.2.5.1.3
gg.handler.name.password
15.2.5.1.4
gg.handler.name.queueOrTopic
15.2.5.1.5
gg.handler.name.persistent
15.2.5.1.6
gg.handler.name.priority
15.2.5.1.7
gg.handler.name.timeToLive
15.2.5.1.8
gg.handler.name.connectionFactory
15.2.5.1.9
gg.handler.name.useJndi
15.2.5.1.10
gg.handler.name.connectionUrl
15.2.5.1.11
gg.handler.name.connectionFactoryClass
15.2.5.1.12
gg.handler.name.localTX
15.2.5.1.13
gg.handlerlist.nop
15.2.5.2
Group Transaction Properties
15.2.5.2.1
gg.handler.name.minGroupSize
15.2.5.2.2
gg.handler.name.maxGroupSize
15.2.6
JNDI Properties
15.2.7
General Properties
15.2.7.1
gg.classpath
15.2.7.2
gg.report.time
16
Developing Custom Filters, Formatters, and Handlers
16.1
Filtering Events
16.2
Custom Formatting
16.2.1
Using a Velocity Template
16.2.2
Coding a Custom Formatter in Java
16.2.3
Coding a Custom Handler in Java
16.2.4
Coding a Custom Formatter for Java Delivery
16.3
Additional Resources
Part V Troubleshooting the Oracle GoldenGate Adapters
17
Troubleshooting the Flat File Adapter
17.1
Checking Oracle GoldenGate
17.2
Checking the Configuration
17.3
Checking the Log File
17.4
Contacting Oracle Support
18
Troubleshooting the Java Adapters
18.1
Checking for Errors
18.2
Recovering after an Abend
18.3
Reporting Issues
Part VI Appendix
A
Adapter Examples
A.1
List of Included Examples
A.2
Configuring Logging
A.2.1
Example Oracle GoldenGate Java User Exit Defaults
A.2.2
Customizing Logging
Scripting on this page enhances content navigation, but does not change the content in any way.