| Oracle® Content Services Administrator's Guide 10g Release 1 (10.1.2) Part Number B25275-04 |
|
|
View PDF |
| Oracle® Content Services Administrator's Guide 10g Release 1 (10.1.2) Part Number B25275-04 |
|
|
View PDF |
You can use the Oracle Collaboration Suite Control to manage Oracle Content Services processes, including starting and stopping the Oracle Content Services domain, starting and stopping servers, and managing nodes. You can also manage Oracle Content Services processes from the command line using the opmnctl utility. To manage Oracle Content Services using the Oracle Collaboration Suite Control or opmnctl, OPMN must be started on all Applications tiers.
This chapter provides information about the following topics:
An Oracle Content Services domain is a logical grouping of Oracle Content Services nodes and an Oracle Database instance (called the Oracle Collaboration Suite Database) that contains the Oracle Content Services data.
The Oracle Content Services software runs as a set of Applications tier processes, called node. Oracle Content Services node processes manage one or more services, agents, and protocol servers.
Each node runs on a particular Applications tier, or in other words, within a particular Oracle home. You can have multiple Applications tiers on the same computer. Although the nodes of a domain are often split across a set of Applications tiers, a single Applications tier can have more than one Oracle Content Services node.
There are two types of nodes: regular nodes and HTTP nodes. Each HTTP node runs as part of an OC4J process. You cannot have more than two HTTP nodes on a single Applications tier: one to support the Oracle Content Services application and one to support the Oracle Records Management application. The OC4J instance for the Oracle Content Services application is OC4J_Content, while the OC4J instance for the Oracle Records Management application is OC4J_RM.
You can start and stop the domain using the Oracle Collaboration Suite Control. Even if your domain is distributed across multiple Applications tiers, you can start and stop the domain from a single Applications tier.
From the Collaboration Suite Home page, click the name of the Oracle Content Services domain. Oracle Content Services domain targets typically appear as Content.
Figure 5-1 shows the Collaboration Suite Home page.
The Content Services Home page appears, showing the status of the set of nodes that belong to the domain. A green Up arrow in the Status column means the process is running.
Figure 5-2 shows the Content Services Home page.
Start, stop, or restart the domain, as follows:
To start the Oracle Content Services domain, click Start Domain. The entire domain is started across all Applications tiers, including all regular nodes and all HTTP nodes. Processes that are already running are not affected.
To restart the Oracle Content Services domain, click Restart Domain, then click Yes on the Warning page. The entire domain is restarted across all Applications tiers, including all regular nodes and all HTTP nodes. Only those processes that are running are affected; processes that are not running will not be started.
To stop the Oracle Content Services domain, click Stop Domain, then click Yes on the Warning page. The entire domain is stopped across all Applications tiers, including all regular nodes and all HTTP nodes.
If you are performing scheduled maintenance and want to stop one Applications tier at a time, do not click Stop Domain. Instead, start and stop individual domain processes, as follows:
To start, stop, or restart individual processes, such as regular nodes or HTTP nodes, select the appropriate process and click Start, Stop, or Restart. You can start, stop, or restart nodes that are on the local Applications tier, or on remote Applications tiers.
You can start, stop, and restart Oracle Content Services from the Collaboration Suite Home page. Because the Collaboration Suite Home page only shows processes for the current Applications tier, you need to log in to all your Applications tiers separately to manage an Oracle Content Services deployment distributed across multiple Applications tiers.
The Content Services Home page allows you to see all Oracle Content Services processes across all Applications tiers. In addition, each node process is listed separately on the Content Services Home page, providing you with maximum flexibility.
To start, stop, or restart Oracle Content Services from the Collaboration Suite Home page, select the domain display name (typically Content) and click Start, Stop, or Restart. Do not use the Reload button with any Oracle Content Services processes.
You can use the Oracle Collaboration Suite Control to start, stop, and restart nodes, as well as modify run-time node properties and deactivate nodes.
You can also use the opmnctl utility to start, stop, and restart nodes, as well as check node status; see "Managing Oracle Content Services from the Command Line" for more information.
This section contains the following topics:
You can start, stop, and restart nodes using the Oracle Collaboration Suite Control. Even if your nodes are distributed across multiple Applications tiers, you can start, stop, and restart them from a single Applications tier, regardless of where the nodes are located.
If a node fails to start, stop, or restart, check the node logs for more information. Click Logs in the upper right corner of any Oracle Collaboration Suite Control page to search for and view node logs.
Starting Nodes
To start a regular node or HTTP node using the Oracle Collaboration Suite Control:
On the Content Services Home page, in the Processes section, select the node you want to start.
Click Start. The Status column displays a green arrow pointing up, indicating that the node is up.
Stopping Nodes
To stop a regular node or HTTP node using the Oracle Collaboration Suite Control:
On the Content Services Home page, in the Processes section, select the node you want to stop.
Click Stop.
On the Warning page, click Yes to stop the node. The Status column displays a red arrow pointing down, indicating that the node is down.
Restarting Nodes
You can only restart nodes that are already started.
To restart a regular node or HTTP node using the Oracle Collaboration Suite Control:
On the Content Services Home page, in the Processes section, select the node you want to restart.
Click Restart. The node is stopped, then started again.
You can make run-time changes to nodes, such as configuring loggers for the node log, changing the service used by the node, or changing servers. Changes made at run time are lost when the node is restarted. If you want to make permanent changes, modify the node configuration for the node and then restart the node.
To modify a node at run time using the Oracle Collaboration Suite Control:
On the Content Services Home page, in the Processes section, click the name of the node you want to modify. The Node page appears.
In the Logging section, you can configure loggers for this node. See "Configuring Node Loggers" for more information.
In the Services section, you can create, modify, or delete services for this node. See "Managing Services at Run Time" for more information.
In the Servers section, you can create, modify, or delete servers for this node. See "Managing Servers at Run Time" for more information.
As an alternative to deleting a node configuration, consider making a node inactive instead. This option lets you keep the configuration information, and you can activate the node later.
Typically, you only deactivate nodes that are local to the current Applications tier. In rare cases, however, such as when an Applications tier fails, you may need to deactivate a node on a remote Applications tier. Although nodes that were deactivated from remote Applications tiers will still respond to opmnctl commands, these nodes cannot be used because their node configurations are inactive.
To make a node inactive using the Oracle Collaboration Suite Control:
On the Content Services Home page, stop the node, if it is running.
In the Administration section, click Node Configurations.
Click the name of the node configuration that corresponds to the node you want to make inactive.
In the General section, deselect Active.
Click OK.
Although deactivating a node will stop the node, if it is running, it is better to stop the node before you deactivate it.
You can use the Oracle Collaboration Suite Control to create or delete service for a particular node. When you create a service, you specify what service configuration object provides its properties.
You can make temporary (run-time) changes to a service by modifying the service from the Node page. You can also dynamically configure the Committed Data Cache, Read-only Connection Pool, and the Writeable Connection Pool while the service runs. Changes made to services at run time are lost when the node is restarted.
You can also make permanent changes to a service by modifying its service configuration; see "Managing Service Configurations" for more information.
This section contains the following topics:
You can create services for a particular node by modifying the node at run time, or by modifying the appropriate node configuration. You can also create services when you create node configurations.
To create a service by modifying the node at run time:
On the Content Services Home page, in the Processes section, click the name of the node for which you want to create a service.
On the Node page, in the Services section, click Create.
On the Create Service page, enter a name for the service. It must be unique within the node.
Choose a Service Configuration on which to base this service.
Click OK on the Create Service page.
These changes will be lost when the node is restarted.
To permanently add a service to a node by modifying its node configuration:
On the Content Services Home page, in the Administration section, click Node Configurations.
Click the name of the node for which you want to add a service.
In the Services section, click Add.
On the Add Service page, enter a name for the service. It must be unique within the node.
Select a Service Configuration on which to base this service.
Select Active if you want this service to be automatically started by the node.
Click OK on the Add Service page.
Click OK on the Edit Node page.
Changes take effect when the node is restarted.
You can make run-time changes to services, such as limiting concurrent sessions or choosing whether or not to accept new sessions. Changes you make at run time are lost when the node is restarted. To make permanent changes to a service, edit the service configuration directly. See "Modifying Service Configurations" for more information.
To modify run-time service parameters:
On the Content Services Home page, in the Processes section, click the name of the node that uses the service you want to change.
On the Node page, click the name of the service you want to modify.
You can change the following properties in the General section:
Concurrent Sessions: You can have an unlimited number of concurrent sessions, or you can limit concurrent sessions to a specified number. If you have an unlimited number of concurrent sessions, you may run out of memory. See Chapter 6, "Deploying Oracle Content Services" in Oracle Collaboration Suite Deployment Guide for more information.
Accepting New Sessions: Select this option if you want the service to accept additional sessions.
Disposed on Last Disconnected Session: Select this option if you want the service to shut down automatically when the last session is disconnected.
Click Apply to save your changes.
Use the locator links to return to the Node page.
You can change the service configuration for a particular service from the Edit Node Configuration page:
On the Content Services Home page, click Node Configurations.
Click the name of the node configuration that uses the service you want to modify.
In the Services section, select the service you want to change and click Edit.
Select a new service configuration from the Configuration list and click OK.
On the Edit Node page, click OK.
Changes take effect when the node is restarted.
The Committed Data Cache provides caching of the attribute values of frequently used objects without a database request, improving performance and scalability. Least recently used data is periodically purged from the cache. Each service has its own Committed Data Cache.
You can make run-time changes to the Committed Data Cache properties for a service using the Oracle Collaboration Suite Control. You can also view Committed Data Cache statistics for a service. See "Monitoring Service Performance" for information about viewing or resetting the statistics.
For more information about cache settings, see Chapter 6, "Deploying Oracle Content Services" in Oracle Collaboration Suite Deployment Guide.
To make run-time changes to Committed Data Cache properties:
On the Content Services Home page, click the name of the node that uses the service you want to modify.
On the Node page, click the name of the service you want to modify.
On the Service page, in the Administration section, click Committed Data Cache Administration.
Figure 5-3 shows the Committed Data Cache Administration page.
Figure 5-3 Committed Data Cache Administration Page
You can change the following cache settings:
Cache Capacity: The absolute maximum size of the data cache of the service, in LibraryObjects. (The LibraryObject class is the base class for all persistent Oracle Content Services objects.) The service data cache holds the attribute values of recently used LibraryObjects.
After you specify Cache Capacity, you can click Calculate to automatically fill in the values for the other parameters based on the capacity you specified.
Normal Purge Trigger: The cache size, in LibraryObjects, at which the service data cache schedules a low-priority purge of data that has not been recently used.
Urgent Purge Trigger: The cache size, in LibraryObjects, at which the service data cache schedules a high-priority purge of data that has not been recently used. The value must be greater than the Normal Purge Trigger value.
Emergency Purge Trigger: The cache size, in LibraryObjects, at which the service data cache performs an immediate purge of data that has not been recently used. The value must be greater than the Urgent Purge Trigger value, but less than the Cache Capacity value.
Purge Target: The target cache size, in LibraryObjects, upon completion of a purge cycle. The value must be less than the Normal Purge Trigger value.
Click Apply after you are finished specifying cache settings.
Changes you make at run time are lost when the node is restarted. To make permanent changes to Committed Data Cache properties, edit the service configuration directly. See "Modifying Service Configurations" for more information.
Table 5-1 maps the properties on the Committed Data Cache Administration page with their service configuration parameter equivalents.
Table 5-1 Committed Data Cache Service Configuration Properties
| Property | Service Configuration Parameter Equivalent |
|---|---|
|
Cache Capacity |
|
|
Normal Purge Trigger |
|
|
Urgent Purge Trigger |
|
|
Emergency Purge Trigger |
|
|
Purge Target |
|
There are two connection pools used by each service: the Read-Only Connection Pool and the Writable Connection Pool. The Read-Only Connection Pool is a set of database connections shared by the sessions to perform database read operations. The Writeable Connection Pool is a set of database connections shared by the sessions to perform database read and write operations within a database transaction.
A minimum number of connections are created in each pool when the service is started. Depending on the number of concurrent operations performed by the sessions, and the type of operations, additional connections may be added to each pool up to a specified maximum.
You can make run-time changes to the Connection Pool properties for a particular service using the Oracle Collaboration Suite Control. You can also view Read-Only and Writeable Connection Pool statistics for a particular service. See "Monitoring Service Performance" for information about viewing or resetting the statistics.
For more information about connection pool settings, see Chapter 6, "Deploying Oracle Content Services" in Oracle Collaboration Suite Deployment Guide.
To improve performance, Oracle Content Services reuses Oracle prepared statements (objects used to query and update the database) when possible. Because Oracle Content Services stores statements in the statement cache, similar queries can reuse existing statements. Least recently used statements are purged when the number of statements in the cache equals the Statement Cache Purge Trigger value.
You can manage statement cache settings from the Connection Pool Administration page. You can also view statement cache statistics (number of attempted purges and purge count) on the Connection Pool Statistics page. See "Monitoring Service Performance" for more information.
|
Note: The Statement Cache feature was added in the Oracle Collaboration Suite Cumulative Patchset 10.1.2.3. If you are using a previous version or patchset of Oracle Collaboration Suite, the Statement Cache Purge Target and Statement Cache Purge Trigger, along with their corresponding service configuration parameter equivalents, do not exist in Oracle Content Services. |
To make run-time changes to Connection Pool properties:
On the Content Services Home page, click the name of the node that uses the service you want to modify.
On the Node page, click the name of the service you want to modify.
On the Service page, in the Administration section, click Connection Pool Administration.
Figure 5-4 shows the Connection Pool Administration page.
Figure 5-4 Connection Pool Administration Page
You can change the following properties for each connection pool:
Minimum Number of Connections: The initial number of database connections in the connection pool.
If you change this property, ensure the value you specify is greater than the current size for this connection pool. You can view the current connection pool size from the Connection Pool Statistics page. See "Monitoring Service Performance" for more information.
Target Maximum Number of Connections: The target maximum number of database connections in the connection pool. The value must be greater than or equal to the Minimum Number of Connections value.
Absolute Maximum Number of Connections: The absolute maximum number of database connections in the connection pool. The value must be greater than or equal to the Target Maximum Number of Connections value.
Statement Cache Purge Target: The target cache size, in number of statements, for the statement cache upon completion of a purge cycle. The value must be less than the Statement Cache Purge Trigger value.
Statement Cache Purge Trigger: The cache size, in number of statements, at which the statement cache schedules a purge.
Target Size Timeout: The maximum period, in milliseconds, that the service will postpone a connection allocation request when there are no unallocated connections, when the current size of the connection pool is greater than or equal to its target size but less than the maximum size. If a database connection does not become available within this period, a new connection will be created.
Maximum Size Timeout: The maximum period, in milliseconds, that a service will postpone a connection allocation request when there are no unallocated connections, when the current size of the connection pool is equal to its maximum size. If a database connection does not become available within this period, the allocation request will fail, and an exception will occur.
Click Apply after you are finished specifying connection pool settings.
Changes you make at run time are lost when the node is restarted. To make permanent changes to Connection Pool properties, edit the service configuration directly. See "Modifying Service Configurations" for more information.
Table 5-2 maps the properties on the Connection Pool Administration page with their service configuration parameter equivalents.
Table 5-2 Connection Pool Service Configuration Properties
| Property | Service Configuration Parameter Equivalent |
|---|---|
|
Minimum Number of Connections |
|
|
Target Maximum Number of Connections |
|
|
Absolute Maximum Number of Connections |
|
|
Statement Cache Purge Target |
|
|
Statement Cache Purge Trigger |
|
|
Target Size Timeout |
|
|
Maximum Size Timeout |
|
You can delete services for a node by modifying the node at run time, or by modifying the appropriate node configuration.
If you delete a service with active sessions, and if there are data transfers in progress over those sessions, data may be lost when you delete the service. In addition, any servers using this service will stop accepting new requests.
To delete a service by modifying the node at run time:
On the Content Services Home page, in the Processes section, click the name of the node that uses the service you want to delete.
On the Node page, in the Services section, select the service you want to delete and click Delete. Each node must have one active service.
On the Warning page, click Yes.
If you delete a service at run time that is defined in the node configuration, the service will reappear on the node when the node is restarted. To permanently delete the service, you must remove it from the node configuration, as described in the following section.
To permanently remove a service from a node by modifying its node configuration:
On the Content Services Home page, in the Administration section, click Node Configurations.
Click the name of the node that uses the service you want to remove.
In the Services section, select the service you want to remove and click Remove.
You cannot remove a service if it is the only service defined in the node configuration. Each node must have at least one active service.
Click OK.
Changes take effect when the node is restarted.
You can use the Oracle Collaboration Suite Control to create or delete server for a particular node. When you create a server, you specify what server configuration object provides its properties.
You can make temporary (run-time) changes to a server by modifying the server from the Node page. Changes made to servers at run time are lost when the node is restarted.
You can also make permanent changes to a server by modifying its server configuration. See "Managing Server Configurations" for more information.
This section contains the following topics:
You can create servers for a particular node by modifying the node at run time, or by modifying the appropriate node configuration. You can also create servers when you create node configurations.
To create a server by modifying the node at run time:
On the Content Services Home page, click the name of the node for which you want to create a server.
On the Node page, in the Servers section, click Create.
On the Create Server page, enter a name for the server. It must be unique within the node.
Select a Service Name to support this server.
Select a Server Configuration on which to base this server.
Click OK.
These changes will be lost when the node is restarted.
To permanently add a server to a node by modifying its node configuration:
On the Content Services Home page, in the Administration section, click Node Configurations.
Click the name of the node for which you want to add a server.
In the Servers section, click Add.
On the Add Server page, enter a name for the server. It must be unique within the node.
Select a Server Configuration on which to base this service.
Select a Service to support this server.
For Initial Priority, select the Java thread priority of the server.
Select Active to deploy this server on the node at run time. If you do not select this option, this server will not appear in the Servers list on the Node page.
Select Initially Started if you want this server to be automatically started by the node. You should only select this option for active nodes.
Click OK.
On the Edit Node page, click OK.
Changes take effect when the node is restarted.
You can manually start, stop, restart, suspend, and resume servers from the Node page. The Create, Delete, and Reload buttons are discussed in separate sections.
To manage servers from the Node page:
On the Content Services Home page, click the name of the node that contains the server you want to manage. The Node page appears.
Figure 5-5 shows the Node page.
Figure 5-5 Services and Servers Section of Node page
On the Node page, in the Servers section, there is a list of all servers for this node. Check the Status column to see whether a particular server is started, stopped, starting, stopping, or suspended. Use the following buttons to manage servers:
Start: Use this option to start a server that is not running.
Stop: Use this option to stop a server that is running.
Restart: Use this option to stop and then start a server that is running. This option does not refresh the server configuration information.
Suspend: Use this option to suspend a server that is running.
Resume: Use this option to resume a server that is suspended.
The Suspend and Resume functions are not available for all protocol servers, including the FTP server.
If a server fails to start, check the node log for errors. For regular nodes, click the Base Log File link in the Logging section to view the node log. For HTTP nodes, click Logs in the upper right corner of the screen and go to the appropriate log.
Which servers and agents start with the node are defined in the node configuration. Servers and agents marked Active and Initially Started in the node configuration are started automatically when you start the domain.
To ensure that a particular server starts when the node restarts, you must modify the node configuration for the node where the server is running:
On the Content Services Home page, in the Administration section, click Node Configurations.
Click the name of the node configuration you want to modify.
In the Servers section, select the server you want to change and click Edit.
Select Initially Started.
Click OK.
On the Edit Node page, click OK.
You can make run-time changes to servers, such as changing the Java thread priority of the server or changing run-time server properties. Changes you make at run time are lost when the node is restarted or when the server is reloaded. To make permanent changes to a server, edit the server configuration directly. See "Modifying Server Configurations" for more information.
To modify run-time server parameters:
On the Content Services Home page, click the name of the node that contains the server you want to change.
On the Node page, click the name of the server you want to modify.
In the Priority section, click Change Priority to change the Java thread priority of the server. On the Change Priority page, select a new priority and click OK. Most servers and agents let you change the Java thread priority at run time, but a few servers, including the FTP server, do not provide this option.
The run-time properties for the server are displayed in the Runtime Properties section. Properties that can be modified at run time are displayed as links. Click the name of a property to update it. For example, to allow anonymous connections to the FTP server, click IFS.SERVER.PROTOCOL.FTP.AnonymousAllowed, change the Value to true, and click OK. Some run-time properties can only be modified when the server is stopped.
Use the locator links at the top of the page to return to the Node page.
To change the configuration used by a server, delete the existing server and then create a new server from the Node page. Alternatively, you can change the configuration for a server from the Edit Node Configuration page:
On the Content Services Home page, in the Administration section, click Node Configurations.
Click the name of the node configuration that contains the server you want to modify.
In the Servers section, select the server you want to change and click Edit.
Select a new server configuration from the Configuration drop-down list.
Click OK.
On the Edit Node page, click OK.
Changes take effect when the server is reloaded or when the node is restarted.
If you modify a server configuration, you need to reload the server before the changes take effect. Restarting a server and reloading a server are different functions:
Restart stops and then starts the server. You can only restart servers that are started. Restarting the server will not pick up changes to server configuration properties.
Reload does the following:
Stops the server, if it is not stopped already.
Deletes the server.
Creates a new instance of the server, picking up any changes to the server configuration properties.
Returns the server to the state it was in when you clicked Reload (stopped, running, or suspended).
Both restarting and reloading a server will disconnect any users connected to that server.
To reload a server:
On the Content Services Home page, in the Processes section, click the name of the node that contains the server you want to reload.
In the Servers section of the Node page, select the server you want to reload (for example, FtpServer).
Click Reload. The server picks up the new server properties.
You can delete servers from a node by modifying the node at run time, or by modifying the appropriate node configuration.
To delete a server by modifying the node at run time:
On the Content Services Home page, click the name of the node that contains the server you want to delete.
On the Node page, in the Servers section, select the server you want to delete and click Stop, if it is not stopped already. You cannot delete a server that is running or suspended.
Select the server again and click Delete.
On the Warning page, click Yes. The server still appears in the server list, but the following message is displayed: "This server is configured but not loaded now."
If you delete a server at run time that is defined in the node configuration, the server will reappear on the node when the node is restarted. To permanently delete the server, you must remove it from the node configuration, as described in the following section.
To permanently remove a server from a node by modifying its node configuration:
On the Content Services Home page, in the Administration section, click Node Configurations.
Click the name of the node that contains the server you want to remove.
In the Servers section, select the server you want to remove and click Remove.
Click OK.
Changes take effect when the node is restarted.
As an alternative to using the Oracle Collaboration Suite Control to manage the Oracle Content Services domain and nodes, you can use opmnctl, the command-line tool for OPMN. The OPMN command-line tool can be found in:
ORACLE_HOME/opmn/bin/
Checking Node Status
Use the following command to check the status of Oracle Content Services nodes on the local Applications tier:
opmnctl status
Include the @farm option to check nodes on all Applications tiers, as follows:
opmnctl @farm status
Starting, Stopping, or Restarting the Oracle Content Services Domain
Use the following commands to start, stop, or restart Oracle Content Services domain processes across all Oracle Content Services Applications tiers:
opmnctl @farm startproc ias-component=Content opmnctl @farm stopproc ias-component=Content opmnctl @farm restartproc ias-component=Content
To start, stop, or restart Oracle Content Services domain processes on the local Applications tier, omit the @farm option, as follows:
opmnctl startproc ias-component=Content opmnctl stopproc ias-component=Content opmnctl restartproc ias-component=Content
|
Note: If you have multiple Oracle Content Services domains registered in Oracle Internet Directory, you must specify which domain to start or stop. The first Oracle Content Services domain to be registered is always identified as Content, while the second domain to be registered is identified as Content_2, and so on. You need to specify the appropriate domain display name inopmnctl commands. For example:
|
Starting, Stopping, or Restarting Node Processes
Use the following commands to start, stop, or restart Oracle Content Services nodes (regular and HTTP) on the local Applications tier:
opmnctl startproc process-type=node_display_name opmnctl stopproc process-type=node_display_name opmnctl restartproc process-type=node_display_name
For example:
opmnctl startproc process-type=OC4J_Content opmnctl startproc process-type=Node
To start, stop, or restart Oracle Content Services processes on a remote Applications tier, include the Oracle Application Server instance name for the remote Applications tier. For example, use the following command to start a regular node on a remote Applications tier:
opmnctl @instance:remote_instance_name startproc process-type=Node
If you are unsure of which Oracle Application Server instance name to use, use the opmnctl @farm status command to list Oracle Application Server instance names.
In rare cases, a regular node will hang and will not respond to opmnctl commands. See Appendix A, "Troubleshooting Oracle Content Services" for information about how to solve this problem.
