| Oracle® Warehouse Builder Installation and Administration Guide 11g Release 2 (11.2) Part Number E17130-05 |
|
|
PDF · Mobi · ePub |
| Oracle® Warehouse Builder Installation and Administration Guide 11g Release 2 (11.2) Part Number E17130-05 |
|
|
PDF · Mobi · ePub |
This section describes how to start and stop the Control Center Agent (CCA), and how to administer it using the cca_admin utility. The CCA manages deployment and execution of the mappings that are based on Code Templates. CCA is not part of the Control Center service hosted within the Oracle Database.
This section contains the following topics:
See Also:
Chapter 7, "Configuring Repository Browser, Control Center Agent, and Other Components", and specifically section "Configuring Control Center Agent Server-side Logging" if you have your own Oracle Application Server and want to install the CCA there.
Chapter 7, "Configuring Repository Browser, Control Center Agent, and Other Components" for procedures that modify the installation defaults.
This section describes how to start and stop the CCA.
When you invoke the ccastart for the first time, it prompts you to enter a password for the OC4J administrator account. The default user name for this account is oc4jadmin.
WBINS16123To start the CCA:
On UNIX, in the directory OWB_HOME /owb/bin/unix/, run the script ccastart.
On Windows, in the directory OWB_HOME\owb\bin\win32\, run the script ccastart.bat.
WBINS16124To stop the CCA:
On UNIX, in the directory OWB_HOME /owb/bin/unix/, run the script ccashut. This script accepts an optional argument password..
On Windows, in the directory OWB_HOME\owb\bin\win32\, run the script ccashut.bat. This script accepts an optional argument password.
For a representation of architectural structures of this installation, see Figure 1-5, "Control Center Agent Topology".
For procedures that modify installation defaults, see Chapter 7, "Configuring Repository Browser, Control Center Agent, and Other Components".
The cca_admin utility changes Control Center Agent settings dynamically, without the requirement to shut down and subsequently restart the run-time environment. cca_admin commands retrieve the values of various environment attributes, set these to new values, and invoke the operations of JRTAdministratorMBean, introduced in section "JRTAdministratorMBean".
The typical cca_admin session includes the following steps:
Running the cca_admin script, as described in "Starting the cca_admin Utility".
Connecting to an MBeanServer using the connect command described in "connect".
Issuing one or more commands to view or update run-time environment attributes or invoke cca_admin commands described in "cca_admin Commands".
Disconnecting from the server using the command "disconnect" or the command "exit".
The cca_admin tool is delivered as a shell script on Linux or a batch file on Windows.
On UNIX, use the following command:
OWB_HOME /owb/bin/unix/cca_admin
On Windows, use the following command:
OWB_HOME\owb\bin\win32\cca_admin.bat.
Before activating the JRTAdministratorMBean, your can use only the basic commands: help, connect, disconnect, and exit. The full range of commands is available after you connect to an MBean server and start using the JRTAdministratorMBean.
This section provides a complete list of the cca_admin commands as follows:
This command removes all log files that were modified during the specified time range, between startDate and endDate, and returns the total number of files removed. Both parameters are expressed in the format DD-MM-YYYY HH:MM:SS. If the specified startDate is null, no records are deleted. If endDate is null, all log files created after the startDate are purged.
WBINS16127Example 10-1 Using cleanUpJobLogFilesForGivenTimeInterval Command
cleanUpJobLogFilesForGivenTimeInterval 26-12-2008 13:38:56 12-01-2009 22:15:58
This command removes the specified number n, of least recent log files from the system, and returns the number of job log files that are actually removed.
WBINS16129Example 10-2 Using cleanUpNLeastRecentJobLogFiles command
cleanUpNLeastRecentJobLogFiles 10
This command connects the user to MBean server.
The command is of the following form, where host is the computer on which the CCA is located, port is the port number for accessing the CCA, user is the user name for accessing the CCA, password is that user's password, connection_type is one of RMI, OPMN, RMIS, OPMN_RMIS, OPMN_CLUSTER, or OPMN_CLUSTER_RMIS, application_name is the name of the application deployed to OC4J, and instance is the OC4J process that contains the CCA application:
connect host port user password connection_type application_name instance
WBINS16131Example 10-3 Using connect Command
connect localhost 23791 oc4jadmin welcome rmi jrt host
This command disconnects the user from the MBean server.
WBINS16133Example 10-4 Using disconnect Command
disconnect
This command exits the cca_admin shell when it is running in the interactive mode. If the connection to the MBean server is not closed, it first disconnects and then exits cca_admin shell.
WBINS16135Example 10-5 Using exit Command
exit
This command returns a value for the number (integer) MBean attribute CacheJobStatusSize, which controls the maximum number of the job status logs that can be stored by the in-memory job log cache in CCA. The attribute's value is in the range of 1 and 10000, with the default value of 3000.
WBINS16137Example 10-6 Using getCacheJobStatusSize Command
getCacheJobStatusSize 3000
This command returns the value of MBean attribute CacheLogNo, which controls the maximum number of job logs that can be stored by the in-memory job log cache in CCA. Obviously the bigger this number is the more memory CCA takes up. The attribute's value is in the range of 1 and 100, with the default value of 10.
WBINS16139Example 10-7 Using getCacheLogNo Command
getCacheLogNo
This command returns the value of MBean attribute KmPermissionsFile, which is the file system path to the ct_permissions.properties file. If this parameter is set to true, the CCA checks ct_permissions.properties to determine what system commands may be executed. This path may be either absolute or relative. The relative value refers to the $OC4J_HOME/j2ee/home directory. The default value is config/ct_permissions.properties.
WBINS16141Example 10-8 Using getKmPermissionsFile Command
getKmPermissionsFile
This command returns the value of MBean attribute LogRoot, which is the directory that stores the CCA job log file. The attribute value may be either absolute or relative. The relative value refers to $OC4J_HOME/j2ee/home directory; the default value is $OC4J_HOME/j2ee/home/log.
WBINS16143Example 10-9 Using getLogRoot Command
getLogRoot
Returns the value of MBean attribute MaxAbortTimeout, the maximum amount of wait time in seconds before the execution is aborted. The attribute's value is in the range of 1 to 60; and the default value is 60.
WBINS16145Example 10-10 Using getMaxAbortTimeout Command
getMaxAbortTimeout
This command returns the value of MBean attribute MaxRuntimeFileSizeMB, the maximum size of any log file, in MB. When a log file exceeds this limit, it is closed and a new log file is opened. The attribute's value is in the range of 1 MB to 15 MB, and the default value is 3 MB.
WBINS16147Example 10-11 Using getMaxRuntimeFileSizeMB Command
getMaxRuntimeFileSizeMB
This command returns the value of MBean attribute MaxRuntimeLogSizeMB, the maximum size of the log file directory, in MB. When the directory exceeds this limit, log files are purged, starting with the oldest. The attribute's value is in the range of 1 MB to 20 MB, and the default value is 10 MB.
WBINS16149Example 10-12 Using getMaxRuntimeLogSizeMB Command
getMaxRuntimeLogSizeMB
This command returns the value of MBean attribute RuntimeLogEncoding, which specifies the character encoding of the log file. The default value is UTF-8.
WBINS16151Example 10-13 Using getRuntimeLogEncoding Command
getRuntimeLogEncoding
This command returns the value of MBean attribute RuntimeLogFileLocation, the name of CCA job log file, a read-only attribute. This value is $OC4J_HOME/j2ee/home/log/appName.log, where appName is the name of the CCA application.
WBINS16153Example 10-14 Using getRuntimeLogFileLocation Command
getRuntimeLogFileLocation
This application returns the value of MBean attribute RuntimeLogLevel, the log level for run-time logger. The legal values for this attribute are: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL (default).
WBINS16155Example 10-15 Using getRuntimeLogLevel Command
getRuntimeLogLevel
This command returns help information for a specified valid command; if a command is not specified, it returns the list of valid commands.
WBINS16157Example 10-16 Using help Command
help help isLogToOdl
This command returns the value of MBean attribute KmSecurityNeeded, determining whether security is enforced on system commands that are invoked by CCA script. If the value is true (which is the default), CCA checks the ct_permissions.properties file for allowable system commands, and only execute the commands defined in ALLOWED_CMD. If the value is false, CCA executes all system commands.
WBINS16159Example 10-17 Using isKmSecurityNeeded Command
isKmSecurityNeeded
This command returns the value of MBean attribute LogToAuditTable, which turns audit table logging on and off. Audit table logging is only effective for execution job logs. The attribute value is either true or false.
WBINS16161Example 10-18 Using isLogToAuditTable Command
isLogToAuditTable
This command returns the value of MBean attribute LogToOdl, which turns ODL logging on and off. Only effective for execution job logs. Deployment and Web service logs are always created in the ODL log format, regardless of the value of this setting. The attribute value is either true or false.
WBINS16163Example 10-19 Using isLogToOdl Command
isLogToOdl
This command returns the value of MBean attribute ShowRuntimeLoggerLogHostAddr, which determines whether the IP address of the host that is running CCA is included in the run-time log messages. The attribute value is either true or false (default).
WBINS16165Example 10-20 Using isShowRuntimeLoggerLogHostAddr Command
isShowRuntimeLoggerLogHostAddr
This command returns the value of MBean attribute ShowRuntimeLoggerLogHostId, which determines whether the ID of the host that is running CCA is included in the run-time log messages. The attribute value is either true or false (default).
WBINS16167Example 10-21 Using isShowRuntimeLoggerLogHostId Command
isShowRuntimeLoggerLogHostId
This command returns the value of MBean attribute ShowRuntimeLoggerLogMsgClassPath, which determines whether the path of the class where the message is logged is included in the run-time log messages. The attribute value is either true or false (default).
WBINS16169Example 10-22 Using isShowRuntimeLoggerLogMsgClassPath Command
isShowRuntimeLoggerLogMsgClassPath
This command returns the value of MBean attribute ShowRuntimeLoggerLogMsgLogLevel, which determines whether the log level of the log message is included in the run-time log messages. The attribute value is either true or false (default).
WBINS16171Example 10-23 Using isShowRuntimeLoggerLogMsgLogLevel Command
isShowRuntimeLoggerLogMsgLogLevel
This command returns the value of MBean attribute ShowRuntimeLoggerLogUserId, which determines whether the ID of the user is included in the run-time log messages. The attribute value is either true or false (default).
WBINS16173Example 10-24 Using isShowRuntimeLoggerLogUserId Command
isShowRuntimeLoggerLogUserId
This command reads CCA settings from the CCA configuration file.
WBINS16175Example 10-25 Using readSettings Command
readSettings
This command resets attributes to their default values, if the attributes are defined to have defaults.
WBINS16177Example 10-26 Using reset Command
reset
This command sets the value for MBean attribute CacheJobStatusSize, which controls the maximum number of the job status that can be stored in the in-memory job log cache in CCACCA. The attribute's value is an integer in the range of 1 to 10000; the default value is 3000.
WBINS16179Example 10-27 Using setCacheJobStatusSize Command
setCacheJobStatusSize 3000
This command sets a value for MBean attribute CacheLogNo, which controls the maximum number of job logs that can be stored in the in-memory job log cache in CCA. The attribute's value is an integer in the range of 1 and 100; the default value is 10.
WBINS16181Example 10-28 Using setCacheLogNo Command
setCacheLogNo 10
This command sets the value for MBean attribute KmPermissionsFile, which is the file system path to the ct_permissions.properties file. If the value is set to true, the CCA checks the file to determine what system commands may run. The path can be either absolute or relative. The relative refers to $OC4J_HOME/j2ee/home directory; the default value is config/ct_permissions.properties.
WBINS16183Example 10-29 Using setKmPermissionsFile Command
setKmPermissionsFile $OC4J_HOME/j2ee/home/config/ct_permissions.properties
This command sets a value for MBean attribute KmSecurityNeeded, which determines whether security is enforced on system commands invoked from CCA scripts. When the value is true (default), CCA checks the ct_permissions.properties file for system commands that may run, and only execute the ones defined in ALLOWED_CMD. When the value is false, CCA runs all system commands.
WBINS16185Example 10-30 Using setKmSecurityNeeded Command
setKmSecurityNeeded true setKmSecurityNeeded false
This command sets the value of MBean attribute LogRoot, the directory of the CCA job log file. The attribute's value may be either absolute or relative. The relative value refers to $OC4J_HOME/j2ee/home directory; the default value is $OC4J_HOME/j2ee/home/log.
WBINS16187Example 10-31 Using setLogRoot Command
setLogRoot $OC4J_HOME/j2ee/home/log
This command sets the value for MBean attribute LogToAuditTable, which turns audit table logging on and off. Audit table logging is only effective for execution job logs. The attribute's value is true or false.
WBINS16189Example 10-32 Using setLogToAuditTable Command
setLogToAuditTable true setLogToAuditTable false
This command sets the value for MBean attribute LogToOdl, which turns ODL logging on and off. This is only effective for execution job logs; deployment and Web service logs are created in ODL log format regardless of this setting. The attribute's value is true or false.
WBINS16191Example 10-33 Using setLogToOdl Command
setLogToOdl true setLogToOdl false
This command sets the value for MBean attribute MaxAbortTimeout, the maximum wait time (in seconds) before aborting the execution. The attribute's value is an integer in the range of 1 to 60 (default).
WBINS16193Example 10-34 Using setMaxAbortTimeout command
setMaxAbortTimeout 60
This command sets the value of MBean attribute MaxRuntimeFileSizeMB, the maximum size, in MB, a log file in the directory. When a log file exceeds this limit, it is closed and a new log file is opened. The attribute's value is an integer in the range of 1 MB and 15 MB; the default value is 3 MB.
WBINS16195Example 10-35 Using setMaxRuntimeFileSizeMB Command
setMaxRuntimeFileSizeMB 5
This command sets the value of MBean attribute MaxRuntimeLogSizeMB, the maximum size of the log file directory, in MB. When the directory exceeds this limit, log files are purged, starting with the oldest. The attribute's value is in the range of 1 MB to 20 MB, and the default value is 10 MB.
WBINS16197Example 10-36 Using setMaxRuntimeLogSizeMB Command
setMaxRuntimeLogSizeMB 10
This command sets the value of MBean attribute RuntimeLogEncoding, which specifies the character set encoding of the log file. The default value is UTF-8.
WBINS16199Example 10-37 Using setRuntimeLogEncoding Command
setRuntimeLogEncoding UTF-8
This command sets the value for MBean attribute RuntimeLogLevel, the log level for run-time logger. The attribute's value may be SEVERE,WARNING, INFO, CONFIG, FINE, FINER, FINEST, ALL (default).
WBINS16201Example 10-38 Using setRuntimeLogLevel Command
setRuntimeLogLevel ALL
This command sets the value for MBean attribute ShowRuntimeLoggerLogHostAddr, which determines whether the IP address of the CCA host is included in the run-time log messages. The attribute value is either true or false (default).
WBINS16203Example 10-39 Using setShowRuntimeLoggerLogHostAddr Command
setShowRuntimeLoggerLogHostAddr true setShowRuntimeLoggerLogHostAddr false
This command sets the value for MBean attribute ShowRuntimeLoggerLogHostId, which determines whether the ID of the CCA host is included in the run-time log messages. The attribute value is either true or false (default).
WBINS16205Example 10-40 Using setShowRuntimeLoggerLogHostId Command
setShowRuntimeLoggerLogHostId true setShowRuntimeLoggerLogHostId false
This command sets the value for MBean attribute ShowRuntimeLoggerLogMsgClassPath, which determines whether the path of the class that logged the message is included in the run-time log messages. The attribute value is either true or false (default).
WBINS16207Example 10-41 Using setShowRuntimeLoggerLogMsgClassPath Command
setShowRuntimeLoggerLogMsgClassPath true setShowRuntimeLoggerLogMsgClassPath false
This command sets the value for MBean attribute ShowRuntimeLoggerLogMsgLogLevel, which determines whether the log level of the log message is included in the run-time log messages. The attribute value is either true or false (default).
WBINS16209Example 10-42 Using setShowRuntimeLoggerLogMsgLogLevel Command
setShowRuntimeLoggerLogMsgLogLevel true setShowRuntimeLoggerLogMsgLogLevel false
This command sets the value for MBean attribute ShowRuntimeLoggerLogUserId, which determines whether the ID of the user is included in the run-time log messages. The attribute value is either true or false (default).
WBINS16211Example 10-43 Using setShowRuntimeLoggerLogUserId Command
setShowRuntimeLoggerLogUserId true setShowRuntimeLoggerLogUserId false
This command converts CCA setting information to String, and shows all CCA settings.
WBINS16213Example 10-44 Using settingsToString Command
settingsToString
This command shows all job log files names.
WBINS16215Example 10-45 Using showAllJobLogFiles Command
showAllJobLogFiles
|
 Copyright © 2000, 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices |
|
HTML