Oracle GoldenGate Microservices Roles

This topic provides a comprehensive list of roles required for performing different tasks in Oracle GoldenGate Microservices Architecture.

Table 16-1 Oracle GoldenGate Microservices Architecture Roles and Tasks

Admin Client	Role ID	REST API Endpoint	Description
`ADD CHECKPOINTTABLE`	Administrator	Manage Checkpoint Tables	Creates a checkpoint table in a database.
`ADD CREDENTIALS`	Administrator	Create User	Create User credentials for use by the Admin Client.
`ADD DISTPATH`	Administrator	Create a new Oracle GoldenGate Distribution Path	Creates a distribution path.
`ADD ENCRYPTIONPROFILE`	Administrator	Create Encryption Profile	Create an encryption profile for trail encryption/decryption.
`ADD EXTRACT`	Administrator	Create Extract	Creates an Extract group.
`ADD EXTTRAIL`	Administrator	Create Trail	Adds a local trail to the Oracle GoldenGate configuration.
`ADD HEARTBEATTABLE`	Administrator	Create Heartbeat Table	Add a heartbeat table to the database
`ADD MASTERKEY`	Administrator	Create Version	Adds a master encryption key to a master encryption key wallet.
`ADD PROCEDURETRANDATA`	Administrator	Manage Procedural Supplemental Logging	Enables procedure-level supplemental logging.
`ADD PROFILE`	Administrator	Create Configuration Value	Create a profile for managed processes.
`ADD RECVPATH`	Administrator	Create a new Oracle GoldenGate Collector Path	Creates a target-initiated distribution path in Receiver Service.
`ADD REPLICAT`	Administrator	Create Replicat	Adds a Replicat group.
`ADD SCHEMATRANDATA`	Administrator	Manage Schema Supplemental Logging	Enables schema-level supplemental logging.
`ADD TRANDATA`	Administrator	Manage Table Supplemental Logging	Enables table-level supplemental logging.
`ALTER CREDENTIALS`	Administrator	Update User	Alter User credentials for use by the Admin Client.
`ALTER CREDENTIALSTORE`	Administrator	Replace Alias	Changes the contents of a credentials store.
`ALTER DISTPATH`	Administrator	Update an existing distribution path.	Changes the attributes of a distribution path.
`ALTER ENCRYPTIONPROFILE`	Administrator	Replace Encryption Profile	Alter an encryption profile for trail encryption/decryption.
`ALTER EXTRACT`	Administrator	Update Extract	Changes attributes of an Extract group.
`ALTER EXTTRAIL`	Administrator	Update Trail	Changes attributes of a local trail.
`ALTER HEARTBEATTABLE`	Administrator	Update Heartbeat Table	Alter a heartbeat table in the database
`ALTER RECVPATH`	Administrator	Update an existing Oracle GoldenGate Collector Path	Changes the attributes of a target-initiated distribution path in Receiver Service.
`ALTER REPLICAT`	Administrator	Update Replicat	Changes attributes of a Replicat group.
`CLEANUP CHECKPOINTTABLE`	User	Manage Checkpoint Tables	Removes checkpoint records that are no longer needed.
`CLEANUP EXTRACT`	User	Issue Command	Deletes run history for an Extract group.
`CLEANUP REPLICAT`	User	Issue Command	Deletes run history of a Replicat group.
`CLEAR INSTANTIATION CSN`	Administrator	Manage Instantiation CSN	Clear the instantiation CSN on a target table.
`CONNECT`	User	Validate	Connect to an Oracle GoldenGate Service Manager
`DBLOGIN USERIDALIAS`	User	Validate	Logs the session into a database so that other commands that affect the database can be issued.
`DELETE CHECKPOINTTABLE`	Administrator	Manage Checkpoint Tables	Removes a checkpoint table from a database.
`DELETE CREDENTIALS`	Administrator	Delete User	Remove Oracle GoldenGate user login credentials from the Admin Client.
`DELETE CREDENTIALSTORE`	Administrator	Delete Alias	Deletes the wallet that serves as a credentials store.
`DELETE DISTPATH`	Administrator	Delete an existing Oracle GoldenGate Distribution Path	Deletes a distribution path.
`DELETE ENCRYPTIONPROFILE`	Administrator	Delete Encryption Profile	Remove an encryption profile.
`DELETE EXTRACT`	Administrator	Delete Extract	Deletes an Extract group.
`DELETE EXTTRAIL`	Administrator	Delete Trail	Removes a local trail from the Oracle GoldenGate configuration.
`DELETE HEARTBEATENTRY`	Administrator	Delete Process Heartbeat Records	Delete heartbeat table entries from the database
`DELETE HEARTBEATTABLE`	Administrator	Delete Heartbeat Table	Delete a heartbeat table from the database
`DELETE MASTERKEY`	Administrator	Delete Version	Marks a master encryption key for deletion.
`DELETE PROCEDURETRANDATA`	Administrator	Manage Procedural Supplemental Logging	Disables procedure-level supplemental logging.
`DELETE PROFILE`	Administrator	Manage Instantiation CSN	Remove a managed process profile.
`DELETE RECVPATH`	Administrator	Delete Configuration Value	Deletes a target-initiated distribution path in Receiver Service.
`DELETE REPLICAT`	Administrator	Delete Replicat	Deletes a Replicat group.
`DELETE SCHEMATRANDATA`	Administrator	Manage Schema Supplemental Logging	Disables schema-level supplemental logging.
`DELETE TRANDATA`	Administrator	Manage Table Supplemental Logging	Disables table-level supplemental logging.
`DISABLE SERVICE`	Administrator	Update Service Properties	Disable the specified Oracle GoldenGate services.
`ENABLE SERVICE`	Administrator	Update Service Properties	Enable the specified Oracle GoldenGate services.
`ENCRYPT PASSWORD`	User	Encrypt Data	Encrypt a password that is used in an Oracle GoldenGate parameter file or command.
`FLUSH SEQUENCE`	User	Execute Command	Updates an Oracle sequence so that initial redo records are available at the time that Extract starts capturing transaction data.
`HEALTH DEPLOYMENT`	User	Service Health Summary	Display the health of the specified Oracle GoldenGate deployments.
`INFO ALL`	User	Retrieve Extract + Retrieve Replicat	Displays status and lag for all Oracle GoldenGate processes on a system.
`INFO CHECKPOINTTABLE`	User	Manage Checkpoint Tables	Returns information about one or more checkpoint tables.
`INFO CREDENTIALSTORE`	User	List Domain Aliases and List Domains	Returns information about a credentials store.
`INFO DISTPATH`	User	Retrieve an existing Oracle GoldenGate Distribution Path Information	Returns information about distribution path(s).
`INFO ENCRYPTIONPROFILE`	User	Retrieve Encryption Profile	Returns information about encryption profiles.
`INFO ER`	User	Retrieve Extract and Retrieve Replicat	Returns information about the specified wildcarded groups.
`INFO EXTRACT`	User	Issue Command	Returns information about an Extract group.
`INFO EXTTRAIL`	User	Retrieve Trail	Returns information about a local trail.
`INFO HEARTBEATTABLE`	User	Retrieve Heartbeat Table	Describe a heartbeat table in the database
`INFO MASTERKEY`	User	List Versions	Returns information about master encryption keys.
`INFO PARAM`	User	Retrieve Parameter Info	Displays parameter definition information.
`INFO PROCEDURETRANDATA`	User	Manage Procedural Supplemental Logging	Returns information about the state of procedure-level supplemental logging.
`INFO PROFILE`	User	Retrieve Configuration Value	Returns information about managed process profiles.
`INFO RECVPATH`	User	Retrieve an existing Oracle GoldenGate Receiver Service Path Information	Returns information about target-initiated distribution path(s) in Receiver Service.
`INFO REPLICAT`	User	Issue Command	Returns information about a Replicat group.
`INFO SCHEMATRANDATA`	User	Manage Schema Supplemental Logging	Returns information about the state of schema-level supplemental logging.
`INFO TRANDATA`	User	Manage Table Supplemental Logging	Returns information about the state of table-level supplemental logging.
`KILL ER`	Operator	`KILL EXTRACT` + `KILL REPLICAT`	Forcibly terminate the specified wildcarded groups.
`KILL EXTRACT`	Operator	Issue Command	Forcibly terminates the run of an Extract group.
`KILL REPLICAT`	Operator	Update Replicat	Forcibly terminates a Replicat group.
`LAG ER`	User	`LAG EXTRACT` + `LAG REPLICAT`	Returns lag information about the specified wildcarded groups.
`LAG EXTRACT`	User	Issue Command	Returns information about Extract lag.
`LAG REPLICAT`	User	Issue Command	Returns information about Replicat lag.
`LIST TABLES`	User	Retrieve Database Tables	Lists the tables in the database with names that match the input specification.
`MININGDBLOGIN USERIDALIAS`	User	Validate	Specifies the credentials of the User that an Oracle GoldenGate process uses to log into an Oracle mining database.
`PURGE EXTTRAIL`	Administrator	Update Version	Removes files related to a local trail from the file system.
`REGISTER EXTRACT`	Administrator	Create Extract	Registers an Extract group with the database.
`REGISTER REPLICAT`	Administrator	Create Replicat	Registers a Replicat group with the database.
`RENEW MASTERKEY`	Administrator	Create Version	Adds a new version of a master encryption key.
`RESTART DEPLOYMENT`	Administrator	Update a Deployment	Restart the specified Oracle GoldenGate deployments.
`RESTART ER`	Operator	Issue Command	Stops, then starts the specified wildcarded groups.
`RESTART EXTRACT`	Operator	Issue Command	Stops, then starts an Extract group.
`RESTART REPLICAT`	Operator	Issue Command	Stops, then starts a Replicat group.
`RESTART SERVICE`	Administrator	Update Service Properties	Restart the specified Oracle GoldenGate services.
`SEND ER`	User	`SEND EXTRACT` + `SEND REPLICAT`	Sends instructions to, or returns information about, the specified wildcarded groups.
`SEND EXTRACT`	User	Issue Command	Sends instructions to, or returns information about, a running Extract group.
`SEND REPLICAT`	User	Issue Command	Sends instructions to, or returns information about, a running Replicat group.
`START DEPLOYMENT`	Administrator	Update a Deployment	Start the specified Oracle GoldenGate deployments.
`START DISTPATH`	Operator	Update an existing distribution path.	Starts a distribution path.
`START ER`	Operator	Issue Command	Starts the specified wildcarded groups.
`START EXTRACT`	Operator	Issue Command	Starts an Extract group.
`START RECVPATH`	Operator	Update an existing Oracle GoldenGate Collector Path	Starts a target-initiated distribution path in Receiver Service.
`START REPLICAT`	Operator	Issue Command	Starts a Replicat group.
`START SERVICE`	Administrator	Update Service Properties	Start the specified Oracle GoldenGate services.
`STATS DISTPATH`	User	Retrieve an existing Oracle GoldenGate Distribution Path Statistics	Returns statistics for a distribution path.
`STATS ER`	User	Retrieve Report - Extract + Retrieve Report- Replicat	Returns processing statistics for the specified wildcarded groups.
`STATS EXTRACT`	User	Issue Command	Returns processing statistics for an Extract group.
`STATS RECVPATH`	User	Retrieve an existing Oracle GoldenGate Receiver Service Path Stats	Returns statistics for a target-initiated distribution path in Receiver Service.
`STATS REPLICAT`	User	Issue Command	Returns processing statistics for a Replicat group.
`STATUS DEPLOYMENT`	User	Service Health Details	Display status of the specified Oracle GoldenGate deployments.
`STATUS ER`	User	`STATUS EXTRACT` + `STATUS REPLICAT`	Returns the state of the specified wildcarded groups.
`STATUS EXTRACT`	User	Issue Command	Returns the state of an Extract group.
`STATUS REPLICAT`	User	Retrieve Status	Returns the state of a Replicat group.
`STATUS SERVICE`	User	Retrieve Service	Display status of the specified Oracle GoldenGate services.
`STOP DEPLOYMENT`	Administrator	Update a Deployment	Stop the specified Oracle GoldenGate deployments.
`STOP DISTPATH`	Operator	Update an existing distribution path.	Stops a distribution path.
`STOP ER`	Operator	Issue Command	Stops the specified wildcarded groups.
`STOP EXTRACT`	Operator	Issue Command	Stops an Extract group.
`STOP RECVPATH`	Operator	Update an existing Oracle GoldenGate Collector Path	Stops a target-initiated distribution path in Receiver Service.
`STOP REPLICAT`	Operator	Issue Command	Stops a Replicat group.
`STOP SERVICE`	Administrator	Update Service Properties	Stop the specified Oracle GoldenGate services.
`SYNCHRONIZE REPLICAT`	Administrator	Issue Command	Returns all threads of a coordinated Replicat to a uniform start point after an unclean shutdown of the Replicat process.
`UNDELETE MASTERKEY VERSION`	Administrator	Update Version	Changes the state of a master encryption key from being marked as deleted to marked as available.
`UNREGISTER EXTRACT`	Administrator	(Part of Delete Extract)	Unregisters an Extract group from the database.
`UPGRADE CHECKPOINTTABLE`	Administrator	Manage Checkpoint Tables	Adds a supplemental checkpoint table when upgrading Oracle GoldenGate from version 11.2.1.0.0 or earlier.
`UPGRADE HEARTBEATTABLE`	Administrator	Update Heartbeat Table	Alters heartbeat tables to track Extract restart position.
`VALIDATE ENCRYPTIONPROFILE`	Administrator	Validate Encryption Profile	Validates that data can be encrypted with the given profile.
`VERSIONS`	User	Execute Command	Displays information about the operating system and database.
`VIEW DISCARD`	User	Retrieve Report	Displays the discard file that is generated by Extract or Replicat.
`VIEW ENCKEYS`	User	Retrieve Configuration File	Retrieves the contents of a configuration file containing the `ENCKEYS` value.
`VIEW GLOBALS`	User	Retrieve Configuration File	Displays the contents of the GLOBALS parameter file in read-only mode on-screen.
`VIEW MESSAGES`	User	Retrieve Messages	Displays the Oracle GoldenGate message log (`ggserr.log` file).
`VIEW PARAMS`	User	Retrieve Configuration File	Displays the contents of a parameter file in read-only mode on-screen.
`VIEW REPORT`	User	Retrieve Report	Displays the process report that is generated by Extract or Replicat.