1/13

Contents

List of Tables

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 GGSCI Commands

• Manager commands
  • INFO MANAGER
  • SEND MANAGER
  • START MANAGER
  • STATUS MANAGER
  • STOP MANAGER
• Extract commands
  • ADD EXTRACT
  • ALTER EXTRACT
  • CLEANUP EXTRACT
  • DELETE EXTRACT
  • INFO EXTRACT
  • KILL EXTRACT
  • LAG EXTRACT
  • SEND EXTRACT
  • START EXTRACT
  • STATUS EXTRACT
  • STOP EXTRACT
• Replicat commands
  • ADD REPLICAT
  • ALTER REPLICAT
  • CLEANUP REPLICAT
  • DELETE REPLICAT
  • INFO REPLICAT
  • KILL REPLICAT
  • LAG REPLICAT
  • SEND REPLICAT
  • START REPLICAT
  • STATUS REPLICAT
  • STOP REPLICAT
• ER commands
• Logger commands
  • ADD LOGGER
  • ALTER LOGGER
  • DELETE LOGGER
  • INFO LOGGER
  • SEND LOGGER
  • START LOGGER
  • STATUS LOGGER
  • STOP LOGGER
• Trail commands
  • ADD EXTTRAIL
  • ADD RMTTRAIL
  • ALTER EXTTRAIL
  • ALTER RMTTRAIL
  • DELETE EXTTRAIL
  • DELETE RMTTRAIL
  • INFO EXTTRAIL
  • INFO RMTTRAIL
• Database commands
  • CAPTURE TABLEDEFS
  • ENCRYPT PASSWORD
  • INFO DDLDEFS
  • INFO FILES
• Audit trail commands
  • ADD ATCONFIG
  • ALTER ATCONFIG
  • DELETE ATCONFIG
  • INFO ATCONFIG
  • STATUS AUDITTRAIL
• Remote checkpoint commands
  • ADD REMOTECHKPT
  • DELETE REMOTECHKPT
  • INFO REMOTECHKPT
• TMF commands
  • REFRESHTMFINFO
  • TMFDUMPAGE
  • TMFDUMPINFO
  • TMFDUMPTABLEENTRIES
  • TMFREFRESHINTERVAL
  • TMFTRAILINFO
• Coordinator commands
  • ADD COORDINATOR
  • ALTER COORDINATOR
  • DELETE COORDINATOR
  • INFO COORDINATOR
  • SEND COORDINATOR
  • START COORDINATOR
  • STATUS COORDINATOR
  • STOP COORDINATOR
• Process commands
  • SEND PROCESS
• Marker commands
  • ADD MARKER
  • INFO MARKER
• Programs commands
  • BIND PROGRAMS
  • INFO PROGRAMS
  • LINK PROGRAMS
• Report commands
  • SEND REPORT
  • VIEW REPORT
• Syncfile commands
  • ADD SYNCFILE
  • ALTER SYNCFILE
  • DELETE SYNCFILE
  • INFO SYNCFILE
  • KILL SYNCFILE
  • START SYNCFILE
  • STATUS SYNCFILE
  • STOP SYNCFILE
• Miscellaneous commands
  • ! command
  • ENV
  • FC
  • HELP
  • HISTORY
  • INFO ALL
  • LOG
  • LOG STOP
  • OBEY
  • EDIT PARAMS
  • VIEW PARAMS
  • SYSTEM
  • VIEW GGSEVT

2 Oracle GoldenGate Parameters

• Parameter Summaries
  • GLOBALS Parameters Summary
  • Manager Parameters Summary
  • Logger Parameters Summary
  • CHGNOTE Parameters Summary
  • Extract Parameters Summary
  • Replicat Parameters Summary
  • Coordinator Parameters Summary
  • Syncfile Parameters Summary
• ABORTDUPERRWINDOW
• ADD DEFINE
• ALLOCFILES
• ALTFILERESOLVE | NOALTFILERESOLVE
• ALTINPUT
• ASSUMETARGETDEFS
• AUDITING
• AUDITREPS | NOAUDITREPS
• AUDITRETRYDELAY
• AUDSERVCACHEBLOCKS
• AUDSERVCPU
• AUDSERVPARAM
• AUDSERVPREFIX
• AUDSERVPROCESS
• AUDSERVPROGRAM
• AUTORESTART
• AUTOSTART
• BACKUPCPU
• BEGIN
• BULKIOLOAD | NOBULKIOLOAD
• CHECKINTERVAL
• CHECKMINUTES
• CHECKPARAMS
• CHECKPOINTSECS
• CHECKUNIQUEKEY | NOCHECKUIQUEKEY
• CLEANUPSAVECOUNT
• COBOLUSEREXIT
• COLMATCH
• COMMENT
• COMPRESSDELETES | NOCOMPRESSDELETES
• CONVERTALLFLOATSTOIEEE | NOCONVERTALLFLOATSTOIEEE
• CONVERTALLFLOATSTOTDM | NOCONVERTALLFLOATSTOTDM
• COORDINATOR
• CPU
• CUSEREXIT
• DEBUGONSTACKCHECK
• DECRYPTTRAIL
• DICTIONARY
• DISCARDFILE
• DISCARDROLLOVER
• DISKTHRESHOLD | NODISKTHRESHOLD
• DISPLAYFILEREFRESHES
• DISPLAYTRAILSWITCH | NODISPLAYTRAILSWITCH
• DOWNCRITICAL
• DOWNREPORT
• DUP
• DUPONLYAFTEREVENT
• DUPPROCESS
• DYNAMICPARTITIONS
• DYNAMICPORTLIST
• DYNAMICPORTREASSIGNDELAY
• EMBEDDEDMACROS | NOEMBEDDEDMACROS
• EMSLOG
• ENCRYPTTRAIL | NOENCRYPTTRAIL
• END
• ENTRYSEQUPDATES
• EOFDELAY | EOFDELAYCSECS
• ERREPLYTIMEOUT
• ERROR59ROLLOVER
• ETNEWFORMAT | ETOLDFORMAT
• EVENT
• EXCLUDEFILE
• EXCLUDEGGSTRANSRECS | INCLUDEGGSTRANSRECS
• EXCLUDESUFFIXCHAR
• EXPANDDDL
• EXTFILE
• EXTRACT
• EXTTRAIL
• FASTIO
• FASTPOSITION | NOFASTPOSITION
• FASTREADS | NOFASTREADS
• FETCHCOMPS | FETCHLASTIMAGE
• FILE
• FILE | TABLE
• FILEAGEDAYS
• FILEEXCLUDE
• FILEOPWARNING
• FILERESOLVE
• FILLSHORTRECS | NOFILLSHORTRECS
• FILTERVIEW | NOFILTERVIEW
• FLUSHCHECKPOINT | NOFLUSHCHECKPOINT
• FLUSHSECS | FLUSHCSECS
• FORCESTOPDELAY
• FORCEUSESYSKEY | NOFORCEUSESYSKEY
• FORMATASCII | NOFORMATASCII
• FORMATLOCAL
• FORMATSQL | NOFORMATSQL
• FORMATXML
• FUNCTIONSTACKSIZE
• GETALTKEYS | IGNOREALTKEYS
• GETAPPLOPS | IGNOREAPPLOPS
• GETAUXTRAILS | IGNOREAUXTRAILS
• GETCOMPS | IGNORECOMPS
• GETCREATES | IGNORECREATES
• GETDEFAULTS
• GETDELETES | IGNOREDELETES
• GETENV
• GETFILEOPS | IGNOREFILEOPS
• GETINSERTS | IGNOREINSERTS
• GETMARKERS | IGNOREMARKERS
• GETNETCHANGES | IGNORENETCHANGES
• GETNETWORKALTFILENAMES | IGNORENETWORKALTFILENAMES
• GETNEWCOLUMNS | IGNORENEWCOLUMNS
• GETPARTONLYPURGEDATAS | IGNOREPARTONLYPURGEDATAS
• GETPURGES | IGNOREPURGES
• GETPURGEDATAS | IGNOREPURGEDATAS
• GETRENAMES | IGNORERENAMES
• GETREPLICATES | IGNOREREPLICATES
• GETROLLBACKS | IGNOREROLLBACKS
• GETUPDATEAFTERS | IGNOREUPDATEAFTERS
• GETUPDATEBEFORES | IGNOREUPDATEBEFORES
• GETUPDATES | IGNOREUPDATES
• GROUPTRANSOPS
• HANDLECOLLISIONS | NOHANDLECOLLISIONS
• HEARTBEAT
• HOMETERM
• HOMETERMMESSAGES
• HOST
• IGNOREPARAMERROR
• IGNORETMFDUMPS
• INCLUDE
• INCLUDESOURCEAPPINFO | EXCLUDESOURCEAPPINFO
• INSERTALLRECORDS | NOINSERTALLRECORDS
• INSERTDELETES | NOINSERTDELETES
• INSERTMISSINGUPDATES | NOINSERTMISSINGUPDATES
• INSERTUPDATES | NOINSERTUPDATES
• IPINTERFACE
• LAGCRITICAL
• LAGINFO
• LAGREPORT
• LAGSTATS
• LIMITRECS
• LIST | NOLIST
• LOG
• LOGFILESBEHIND | LOGFILESBEHINDINFO
• LOGFILEOPENS
• LOGGERFILENUM
• LOGGERFLUSHRECS
• LOGGERFLUSHSECS | LOGGERFLUSHCSECS
• LOGGERTIMEOUTSECS
• LOGGGSCICOMMANDS
• LOGON
• MACRO
• MACROCHAR
• MANAGERREQUIRED
• MAP
• MAPEXCLUDE
• MAXABENDRESTARTS
• MAXDISCARDRECS
• MAXETCHECKPOINTSECS
• MAXTRANSMEM
• MAXTRANSOPS
• MAXWILDCARDENTRIES
• NETWORKCHECKPOINTS
• NOTSTOPPABLE
• NUMEXTRACTS
• NUMFILES
• OBEY
• OLDGROUPNAMING
• OMITAUDITGAPCHECK
• OPENTIMEOUT | OPENTIMEOUTMINUTES
• OPENWARNINGS
• OVERRIDEDUPS | NOOVERRIDEDUPS
• PARTMAP
• PARAMCHECK
• PASSTHRU | NOPASSTHRU
• PORT
• POSITIONFIRSTRECORD
• PRIORITY
• PURGEDATAALTFILES | NOPURGEDATAALTFILE
• PURGEOLDEXTRACTS for Extract and Replicat
• PURGEOLDEXTRACTS for Manager
• PURGEOLDTASKS
• PURGERESTORE | NOPURGERESTORE
• READER
• READTHRULOCKS | NOREADTHRULOCKS
• RECEIVEQWARN
• RENAMEBUMPDELAY
• REPERROR
• REPLACEBADCHAR
• REPLACEBADNUM
• REPLICAT
• REPNEWCOLUMNS | NOREPNEWCOLUMNS
• REPORT
• REPORTCOUNT
• REPORTFILEEXTENTS
• REPORTROLLOVER
• REPORTTMFEXCEPTIONS
• REPSQLLOG
• RESTARTCOLLISIONS | NORESTARTCOLLISIONS
• RESTARTINTERVAL
• RESTORE | NORESTORE
• RETRYDELAY
• RETRYERR
• REVERSEWINDOWSECS | REVERSEWINDOWCSECS
• RMTBATCH
• RMTFILE
• RMTHOST
• RMTHOSTALT
• RMTTASK
• RMTTRAIL
• ROLLOVER
• SETENV
• SHORTREADDELAY
• SOURCEDEFS
• SOURCEISFILE | SOURCEISTABLE
• SPECIALRUN
• SQLFORMATDISCARDFILE
• SQLFORMATDISCARDROLLOVER
• STATOPTIONS
• SUPPRESSALLALTERMESSAGES | NOSUPPRESSALLALTERMESSAGES
• SUPPRESSALTERMESSAGES | NOSUPPRESSALTERMESSAGES
• SUPPRESSFETCHCOMPRESSEDDISCARDS | NOSUPPRESSFETCHCOMPRESSEDDISCARDS
• SUPPRESSFILEOPMESSAGES | NOSUPPRESSFILEOPMESSAGES
• SUPPRESSMARKERMESSAGES
• SWAPVOL
• SYNCFILE
• SYSKEYCONVERT
• TABLE
• TABLEEXCLUDE
• TALUSEREXIT
• TCPBUFSIZE
• TCPFLUSHBYTES
• TCPIPPROCESSNAME
• TCPIPSWITCHERRS
• TCPSOURCETIMER | NOTCPSOURCETIMER
• THRESHOLD | NOTHRESHOLD
• TMFDUMPAGE
• TMFDUMPTABLEENTRIES
• TMFEXCEPTIONS | NOTMFEXCEPTIONS
• TMFREFRESHINTERVAL
• TMFTRAILTRACE
• TRACE
• TRACEALLOPENS
• TRACECLOSES
• TRACEOPENS
• TRACEPROCESSIOS
• TRACESTATS
• UPDATEDELETES | NOUPDATEDELETES
• UPDATEINSERTS | NOUPDATEINSERTS
• UPREPORT
• VERBOSE
• VERSIONERR
• WAITFILEEVENT
• WARNRATE
• Y2KCENTURYADJUSTMENT | NOY2KCENTURYADJUSTMENT

3 Collector Parameters

• Collector Parameters
• QSAM Configuration Parameters

4 Field Conversion Functions

• Overview of Functions
  • Function Syntax
  • Function Summaries
• BINARY
• CASE
• COLSTAT
• COLTEST
• COMPUTE
• CONVERTFLOAT
• DATE
• DATEDIFF
• DATENOW
• EVAL
• GETENV
• GETVAL
• HIGHVAL | LOWVAL
• IF
• NUMBIN
• NUMSTR
• RANGE
• STRCAT
• STRCMP
• STREQ
• STREXT
• STRFIND
• STRLEN
• STRLTRIM
• STRNCAT
• STRNCMP
• STRNUM
• STRRTRIM
• STRSUB
• STRTRIM
• STRUP
• TOKEN
• VALONEOF

5 DEFGEN Arguments

• Argument summary
• EXCLUDESYSTEM | INCLUDESYSTEM
• EXPANDDDL
• NCHARCOMPATIBILITY
• RECORDNAMEPROMPTING

6 DDLGEN Arguments

• Run-time arguments
• Template parameters
• OMITNULL | INCLUDENULL
• OMITNOTNULL | INCLUDENOTNULL
• OMITREDEFS | INCLUDEREDEFS
• OMITCOMMENTS | INCLUDECOMMENTS
• USESAMENULLS

7 MEASFLS and MEASRPT Parameters

• MEASFLS Parameter Reference
  • DURATION
  • FILE
  • FILEMEGABYTES
  • GETSYSTEMUTILS
  • GETTMFDETAIL
  • INTERVAL
  • MAXFILESPERMEAS
  • MEASFILES
  • PURGEMEASFILES
  • START
  • STOP
  • WILDCARD
• MEASRPT Parameter Reference
  • AVGCOMPRESSEDBYTES
  • DEFAULTEXCLUDES
  • DURATION
  • EXCLUDEALTKEYS
  • EXCLUDEFILE
  • EXCLUDEPROGRAM
  • EXCLUDETANDEMFILES
  • FILEDETAIL
  • GETAUDITED
  • GETENSCRIBE
  • GETNONAUDITED
  • GETSQL
  • GETTMFDETAIL
  • INCLUDEFILE
  • INCLUDEPROGRAM
  • INTERVAL
  • LISTLIMIT
  • MAXSTATPROGS
  • MEASFH
  • MEASFILES
  • MAXSTATFILES
  • MAXSTATPROGS
  • PROGDETAIL
  • PROGSTATS
  • REPORTRATE
  • RETENTION
  • START
  • STOP
  • SUPPRESSZEROTOTALS

8 User Exit Functions

• Function summary
• EXIT_CALL_RESULT
• EXIT_CALL_TYPE
• EXIT_PARAMS
• EXIT_REC_BUF
• Calling environment functions
• COMPRESS_RECORD | COMPRESS_RECORD2
• DECOMPRESS_RECORD | DECOMPRESS_RECORD2
• FETCH_CURRENT_RECORD
• FETCH_CURRENT_RECORD_WITH_LOCK
• GET_ALTKEY_INFO
• GET_COLUMN_INDEX
• GET_COLUMN_NAME
• GET_ENV_VALUE
• GET_EXITPARAM_VALUE
• GET_EXTRBA
• GET_EXTSEQNO
• GET_FILENAME
• GET_FOPEN_NUM
• GET_NUM_COLUMNS
• GET_RECORD | GET_RECORD2
• GET_RECORD_LENGTH | GET_RECORD_LENGTH2
• GET_SYSKEY_LENGTH
• GET_TRANSACTION_IND
• GET_USER_TOKEN_VALUE
• GGS_EMSMESSAGE
• GGS_REPORTMESSAGE
• SET_TARGET_RECORD2
• SET_TARGET_RECORD_LENGTH2

9 Event Error and Warning Messages