Go to main content
1/21
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Information
Conventions
Part I Understanding Oracle GoldenGate for Big Data
1
Understanding the Java Adapter and Oracle GoldenGate for Big Data
1.1
Overview
1.1.1
Oracle GoldenGate Features
1.1.2
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 Java Adapter 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 Java Adapter
2.1
Oracle GoldenGate VAM Message Capture
2.1.1
Message Capture Configuration Options
2.1.2
Typical Configuration
2.2
Oracle GoldenGate Java Delivery
2.3
Delivery Configuration Options
3
Configuring Logging
3.1
Oracle GoldenGate Java Adapter Default Logging
3.1.1
Default Implementation Type
3.1.2
Default Message Logging
3.1.3
Log File Name
3.1.4
Logging Problems
3.2
Recommended Logging Settings
3.2.1
Changing to the Recommended Logging Type
Part II Capturing JMS Messages
4
Configuring Message Capture
4.1
Configuring the VAM Extract
4.1.1
Adding the Extract
4.1.2
Configuring the Extract Parameters
4.1.3
Configuring Message Capture
4.2
Connecting and Retrieving the Messages
4.2.1
Connecting to JMS
4.2.2
Retrieving Messages
4.2.3
Completing the Transaction
5
Parsing the Message
5.1
Parsing Overview
5.1.1
Parser Types
5.1.2
Source and Target Data Definitions
5.1.3
Required Data
5.1.3.1
Transaction Identifier
5.1.3.2
Sequence Identifier
5.1.3.3
Timestamp
5.1.3.4
Table Name
5.1.3.5
Operation Type
5.1.3.6
Column Data
5.1.4
Optional Data
5.1.4.1
Transaction Indicator
5.1.4.2
Transaction Name
5.1.4.3
Transaction Owner
5.2
Fixed Width Parsing
5.2.1
Header
5.2.1.1
Specifying Compound Table Names
5.2.1.2
Specifying timestamp Formats
5.2.1.3
Specifying the Function
5.2.2
Header and Record Data Type Translation
5.2.3
Key identification
5.2.4
Using a Source Definition File
5.3
Delimited Parsing
5.3.1
Metadata Columns
5.3.2
Parsing Properties
5.3.2.1
Properties to Describe Delimiters
5.3.2.2
Properties to Describe Values
5.3.2.3
Properties to Describe Date and Time
5.3.3
Parsing Steps
5.4
XML Parsing
5.4.1
Styles of XML
5.4.2
XML Parsing Rules
5.4.3
XPath Expressions
5.4.3.1
Supported Constructs:
5.4.3.2
Supported Expressions
5.4.3.3
Obtaining Data Values
5.4.4
Other Value Expressions
5.4.5
Transaction Rules
5.4.6
Operation Rules
5.4.7
Column Rules
5.4.8
Overall Rules Example
5.5
Source Definitions Generation Utility
6
Message Capture Properties
6.1
Logging and Connection Properties
6.1.1
Logging Properties
6.1.1.1
gg.log
6.1.1.2
gg.log.level
6.1.1.3
gg.log.file
6.1.1.4
gg.log.classpath
6.1.2
JMS Connection Properties
6.1.2.1
jvm.boot options
6.1.2.2
jms.report.output
6.1.2.3
jms.report.time
6.1.2.4
jms.report.records
6.1.2.5
jms.id
6.1.2.6
jms.destination
6.1.2.7
jms.connectionFactory
6.1.2.8
jms.user, jms.password
6.1.3
JNDI Properties
6.2
Parser Properties
6.2.1
Setting the Type of Parser
6.2.1.1
parser.type
6.2.2
Fixed Parser Properties
6.2.2.1
fixed.schematype
6.2.2.2
fixed.sourcedefs
6.2.2.3
fixed.copybook
6.2.2.4
fixed.header
6.2.2.5
fixed.seqid
6.2.2.6
fixed.timestamp
6.2.2.7
fixed.timestamp.format
6.2.2.8
fixed.txid
6.2.2.9
fixed.txowner
6.2.2.10
fixed.txname
6.2.2.11
fixed.optype
6.2.2.12
fixed.optype.insertval
6.2.2.13
fixed.optype.updateval
6.2.2.14
fixed.optype.deleteval
6.2.2.15
fixed.table
6.2.2.16
fixed.schema
6.2.2.17
fixed.txind
6.2.2.18
fixed.txind.beginval
6.2.2.19
fixed.txind.middleval
6.2.2.20
fixed.txind.endval
6.2.2.21
fixed.txind.wholeval
6.2.3
Delimited Parser Properties
6.2.3.1
delim.sourcedefs
6.2.3.2
delim.header
6.2.3.3
delim.seqid
6.2.3.4
delim.timestamp
6.2.3.5
delim.timestamp.format
6.2.3.6
delim.txid
6.2.3.7
delim.txowner
6.2.3.8
delim.txname
6.2.3.9
delim.optype
6.2.3.10
delim.optype.insertval
6.2.3.11
delim.optype.updateval
6.2.3.12
delim.optype.deleteval
6.2.3.13
delim.schemaandtable
6.2.3.14
delim.schema
6.2.3.15
delim.table
6.2.3.16
delim.txind
6.2.3.17
delim.txind.beginval
6.2.3.18
delim.txind.middleval
6.2.3.19
delim.txind.endval
6.2.3.20
delim.txind.wholeval
6.2.3.21
delim.fielddelim
6.2.3.22
delim.linedelim
6.2.3.23
delim.quote
6.2.3.24
delim.nullindicator
6.2.3.25
delim.fielddelim.escaped
6.2.3.26
delim.linedelim.escaped
6.2.3.27
delim.quote.escaped
6.2.3.28
delim.nullindicator.escaped
6.2.3.29
delim.hasbefores
6.2.3.30
delim.hasnames
6.2.3.31
delim.afterfirst
6.2.3.32
delim.isgrouped
6.2.3.33
delim.dateformat | delim.dateformat.
table
| delim.dateform.table.column
6.2.4
XML Parser Properties
6.2.4.1
xml.sourcedefs
6.2.4.2
xml.rules
6.2.4.3
rulename
.type
6.2.4.4
rulename
.match
6.2.4.5
rulename
.subrules
6.2.4.6
txrule
.timestamp
6.2.4.7
txrule
.timestamp.format
6.2.4.8
txrule
.seqid
6.2.4.9
txrule
.txid
6.2.4.10
txrule
.txowner
6.2.4.11
txrule
.txname
6.2.4.12
oprule
.timestamp
6.2.4.13
oprule
.timestamp.format
6.2.4.14
oprule
.seqid
6.2.4.15
oprule
.txid
6.2.4.16
oprule
.txowner
6.2.4.17
oprule
.txname
6.2.4.18
oprule
.schemandtable
6.2.4.19
oprule
.schema
6.2.4.20
oprule
.table
6.2.4.21
oprule
.optype
6.2.4.22
oprule
.optype.insertval
6.2.4.23
oprule
.optype.updateval
6.2.4.24
oprule
.optype.deleteval
6.2.4.25
oprule
.txind
6.2.4.26
oprule
.txind.beginval
6.2.4.27
oprule
.txind.middleval
6.2.4.28
oprule
.txind.endval
6.2.4.29
oprule
.txind.wholeval
6.2.4.30
colrule
.name
6.2.4.31
colrule
.index
6.2.4.32
colrule
.value
6.2.4.33
colrule
.isnull
6.2.4.34
colrule
.ismissing
6.2.4.35
colrule
.before.value
6.2.4.36
colrule
.before.isnull
6.2.4.37
colrule
.before.ismissing
6.2.4.38
colrule
.after.value
6.2.4.39
colrule
.after.isnull
6.2.4.40
colrule
.after.ismissing
Part III Oracle GoldenGate Java Delivery
7
Configuring Java Delivery
7.1
Configuring the JRE in the Properties File
7.2
Configuring Oracle GoldenGate for Java Delivery
7.2.1
Configuring a Replicat for Java Delivery
7.3
Configuring the Java Handlers
8
Running Java Delivery
8.1
Starting the Application
8.1.1
Starting Using Replicat
8.2
Restarting the Java Delivery
8.2.1
Restarting Java Delivery in Replicat
9
Configuring Event Handlers
9.1
Specifying Event Handlers
9.2
JMS Handler
9.3
File Handler
9.4
Custom Handlers
9.5
Formatting the Output
9.6
Reporting
10
Java Delivery Properties
10.1
Common Properties
10.1.1
Logging Properties
10.1.1.1
gg.log
10.1.1.2
gg.log.level
10.1.1.3
gg.log.file
10.1.1.4
gg.log.classpath
10.1.2
JVM Boot Options
10.1.2.1
jvm.bootoptions
10.2
Delivery Properties
10.2.1
General Properties
10.2.1.1
goldengate.userexit.writers
10.2.1.2
goldengate.userexit.chkptprefix
10.2.1.3
goldengate.userexit.nochkpt
10.2.1.4
goldengate.userexit.usetargetcols
10.2.2
Statistics and Reporting
10.2.2.1
jvm
.stats.display
10.2.2.2
jvm
.stats.full
10.2.2.3
jvm
.stats.time |
jvm
.stats.numrecs
10.3
Java Application Properties
10.3.1
Properties for All Handlers
10.3.1.1
gg.handlerlist
10.3.1.2
gg.handler.
name
.type
10.3.2
Properties for Formatted Output
10.3.2.1
gg.handler.
name
.format
10.3.2.2
gg.handler.
name
.includeTables
10.3.2.3
gg.handler.
name
.excludeTables
10.3.2.4
gg.handler.
name
.mode, gg.handler.
name
.format.mode
10.3.3
Properties for CSV and Fixed Format Output
10.3.3.1
gg.handler.
name
.format.delim
10.3.3.2
gg.handler.
name
.format.quote
10.3.3.3
gg.handler.
name
.format.metacols
10.3.3.4
gg.handler.
name
.format.missingColumnChar
10.3.3.5
gg.handler.
name
.format.presentColumnChar
10.3.3.6
gg.handler.
name
.format.nullColumnChar
10.3.3.7
gg.handler.
name
.format.beginTxChar
10.3.3.8
gg.handler.
name
.format.middleTxChar
10.3.3.9
gg.handler.
name
.format.endTxChar
10.3.3.10
gg.handler.
name
.format.wholeTxChar
10.3.3.11
gg.handler.
name
.format.insertChar
10.3.3.12
gg.handler.
name
.format.updateChar
10.3.3.13
gg.handler.
name
.format.deleteChar
10.3.3.14
gg.handler.
name
.format.truncateChar
10.3.3.15
gg.handler.
name
.format.endOfLine
10.3.3.16
gg.handler.
name
.format.justify
10.3.3.17
gg.handler.
name
.format.includeBefores
10.3.4
File Writer Properties
10.3.4.1
gg.handler.
name
.file
10.3.4.2
gg.handler.
name
.append
10.3.4.3
gg.handler.
name
.rolloverSize
10.3.5
JMS Handler Properties
10.3.5.1
Standard JMS Settings
10.3.5.1.1
gg.handler.
name
.destination
10.3.5.1.2
gg.handler.
name
.user
10.3.5.1.3
gg.handler.
name
.password
10.3.5.1.4
gg.handler.
name
.queueOrTopic
10.3.5.1.5
gg.handler.
name
.persistent
10.3.5.1.6
gg.handler.
name
.priority
10.3.5.1.7
gg.handler.
name
.timeToLive
10.3.5.1.8
gg.handler.
name
.connectionFactory
10.3.5.1.9
gg.handler.
name
.useJndi
10.3.5.1.10
gg.handler.
name
.connectionUrl
10.3.5.1.11
gg.handler.
name
.connectionFactoryClass
10.3.5.1.12
gg.handler.
name
.localTX
10.3.5.1.13
gg.handlerlist.nop
10.3.5.1.14
gg.handler.
name
.physicalDestination
10.3.5.2
Group Transaction Properties
10.3.6
JNDI Properties
10.3.7
General Properties
10.3.7.1
gg.classpath
10.3.7.2
gg.report.time
10.3.7.3
gg.binaryencoding
10.3.8
Java Delivery Transaction Grouping
11
Developing Custom Filters, Formatters, and Handlers
11.1
Filtering Events
11.2
Custom Formatting
11.2.1
Coding a Custom Formatter in Java
11.2.2
Using a Velocity Template
11.3
Coding a Custom Handler in Java
11.4
Additional Resources
Part IV Troubleshooting the Oracle GoldenGate Adapters
12
Troubleshooting the Java Adapters
12.1
Checking for Errors
12.2
Reporting Issues
A
List of Included Examples
B
Customizing Logging
Scripting on this page enhances content navigation, but does not change the content in any way.