| Oracle® Content Services Administrator's Guide 10g Release 1 (10.1.1) Part Number B14493-01 |
|
|
View PDF |
| Oracle® Content Services Administrator's Guide 10g Release 1 (10.1.1) Part Number B14493-01 |
|
|
View PDF |
Each Oracle Content Services node can support multiple servers. These servers can be either protocol servers or agents:
The protocol servers, such as the FTP server, listen for requests from clients on a specific Internet Protocol (IP) port and respond to requests according to the rules of the protocol specification.
Agents perform operations periodically (time-based) or in response to events generated by other Oracle Content Services servers or processes (event-based). Although different agents can run in different nodes, each agent must run only on a single node. Typically, most of the shipped agents must be run to ensure a stable system.
Each server is based on a particular server configuration that holds the default values used when the server is started for an Oracle Content Services node. For example, a server configuration for the Oracle Content Services FTP server contains properties that specify the FTP port number, whether anonymous FTP connections are allowed, and the connection time-out period.
The properties listed in this appendix are all required for an agent or protocol server to run properly. When you install and configure an Oracle Content Services instance, the properties are configured using the default values shown in the following tables.
This appendix provides information about the following topics:
Table E-1 defines server configuration properties that are shared between more than one server or agent.
Table E-1 Shared Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
The class used to instantiate the server. |
Default varies from server to server. |
|
|
Default country to be used in session localizer. |
US |
|
|
Default language to be used in session localizer. |
en |
|
|
User name for server session. Must be a user with Oracle Content Services administrator privileges. |
system |
|
|
Time interval to when the agent runs again. Specified as a number followed by a time unit, such as "4h" to indicate a four-hour interval. Time units are: h=hours, m=minutes, s=seconds |
Default varies from server to server. |
|
|
The delay before the first time interval, relative to when the server is started. This property is ignored if a value is specified for |
Default varies from server to server. |
|
|
The first timer event. Set time based on a 24-hour clock. |
00:15:00 |
This agent performs a variety of "clean-up" tasks on a periodic basis, such as deleting content in the Archive that has passed the expiration period set by the Content Administrator. Each of these tasks has a corresponding property called an Activation Multiplier that controls how often the task is performed.
The Activation Multiplier works in conjunction with the IFS.SERVER.TIMER.ActivationPeriod property. For example, if IFS.SERVER.TIMER.ActivationPeriod is set to 1h, and ECM.AGENT.CLEANUPAGENT.EMPTYARCHIVE.ActivationMultiplier is set to 8, then the Cleanup Agent will delete expired content in the Archive every 8 hours.
The descriptions and notes provided in the following table assume an ActivationPeriod of one hour (1h), which is the default for this agent.
The default name for this server configuration is:
CleanupAgentConfiguration
Table E-2 Cleanup Agent Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
Controls how often content in the Archive is moved to BFILE. This action is only performed when BFILE archiving has been enabled; see "Setting Up Data Archiving" for more information. |
24 |
|
|
The time of day from which all intervals for this agent are based. This property determines the time at which tasks will be executed that perform only once every 24 hours, and the relative time for tasks performed only a few times in a 24-hour period. For example, if a task has an ActivationMultiplier of 8 and the BaseTimeOfDay is set to 20:15:00, that task will execute at 20:15, 4:15, and 12:15. |
20:15:00 |
|
|
Controls how often the quota consumed by files in each Site's Archive is recalculated. |
4 |
|
|
Controls how often the total quota consumed by all files residing in Libraries for each Site is recalculated. |
1 |
|
|
Controls how often links that reference inaccessible items have their internal representation optimized. |
12 |
|
|
Controls how often the administration mode representation for users is removed from the system, for users whose application administration access has been disabled for a sufficient period of time. This time period is controlled by the |
12 |
|
|
The amount of time the administration representation for a user remains after the user loses all application administration rights, before that user is removed from the system. |
24h |
|
|
Controls how often security configurations are optimized to reflect users or groups that have been removed from the system. |
24 |
|
|
Controls how often unused security configurations for items in Trash folders are removed from the system. |
24 |
|
|
Controls how often workflow components are optimized with respect to users that have been removed from the system. |
12 |
|
|
Controls how often verification is performed for administrative users to ensure that the users still have administration mode access. For users that have lost all administration mode access, the administration representation of the user is disabled, and remains disabled until the user is again granted application administration access, or is removed from the system. |
1 |
|
|
Controls how often content that has passed the expiration period set by the Content Administrator is deleted from the Archive. |
24 |
|
|
Controls how often Trash folders that have been configured for "auto empty" are emptied. |
4 |
|
|
Controls how often e-mail notification warnings are sent when the quota consumed by a Site is at or near the allocated quota limit in effect for that Site. E-mail notifications are sent to any users of that Site with the Quota Administrator role, as well as to the administrator e-mail address specified in the |
12 |
|
|
Specifies how close the consumed quota for a Site needs to be to the allocation limit for a Site quota warning to be issued. The value is specified as a percentage of the Site quota allocation. |
95 |
|
|
Specifies whether documents in a Site's Archive are considered to count against the consumed quota for a Site. |
true |
|
|
Controls how often Libraries that have been deleted and that are unreferenced in the Archive are permanently removed from the system. |
24 |
This agent controls the management of document content when BFILE aging has been set up. Once BFILE aging has been enabled, the Content Agent moves content to BFILE if it has not been accessed after the retention period. See "Managing Storage Options" for information on setting up BFILE aging.
The default name for this server configuration is:
ContentAgentConfiguration
Table E-3 Content Agent Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
The fully qualified classname of the |
|
|
|
For every relative path created, the maximum number of files that can be moved to a folder. |
500 |
|
|
The maximum number of folders created when the Content Agent runs. |
20 |
|
|
How long a file may be kept in the database as a LOB if no one accesses it. |
30d |
File attributes and content are stored separately. For performance reasons, the content of a document is not deleted when the document is deleted. The Content Garbage Collection Agent deletes the unreferenced content. Like many agents, this agent runs at a specific time as specified in the IFS.SERVER.TIMER.InitialTimeOfDay and IFS.SERVER.TIMER.ActivationPeriod properties.
The default name for this server configuration is:
ContentGarbageCollectionAgentConfiguration
Table E-4 Content Garbage Collection Agent Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
Amount of time filtered content is kept in the system before it is deleted. HTML-generated rendition of content is an example of filtered content. Unit of measure is seconds. |
3600 |
|
|
The maximum number of unreferenced ContentObjects that are freed in a single iteration of this agent. |
10000 |
Similar to the Garbage Collection Agent, the Dangling Object AV Cleanup Agent removes orphaned object type references and identifies all invalid object references, such as references to objects that no longer exist, and sets these references to null for array type attributes and zero for scalar attributes. For example, this agent cleans up the owner attribute of a document pointing to directory object which was deleted and is now invalid.
The default name for this server configuration is:
DanglingObjectAVCleanupAgentConfiguration
Table E-5 Dangling Object AV Cleanup Agent Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
A list of attributes for which invalid references to Library Objects are not cleaned up. Do not delete the default values, so the Garbage Collection Agent can handle deleted users correctly. Add additional attributes as needed. |
AUDITENTRY PUBLICOBJECT:OWNER PUBLICOBJECT:DELETOR PUBLICOBJECT:CREATOR PUBLICOBJECT:LASTMODIFIER VERSIONSERIES:RESERVOR |
This agent periodically purges expired events from the event queue.
The default name for this server configuration is:
EventExchangerAgentConfiguration
All public objects have an attribute called ExpirationDate. Once this date passes, the Public Objects are automatically deleted. This is handled by the Expiration Agent, which periodically deletes expired objects. If the expiration date of a Public Object passes, the agent deletes the Public Object. Like many agents, this agent runs at a specific time as specified in the IFS.SERVER.TIMER.InitialTimeOfDay and IFS.SERVER.TIMER.ActivationPeriod properties.
The default name for this server configuration is:
ExpirationAgentConfiguration
The Folder Index Agent handles additional Folder Index functions not covered by the Folder Index Analyzer Agent. See the following section for more information on the Folder Index Analyzer Agent.
The default name for this server configuration is:
FolderIndexAgentConfiguration
Oracle Content Services uses an internal mechanism called the Folder Index to speed up folder-restricted queries. This index is modified every time the folder hierarchy gets changed, to reflect the up-to-date folder hierarchy. However, certain forms of file links may leave the Folder Index in a suboptimal state. The Folder Index Analyzer Agent runs periodically to detect and correct any such state, and return the Folder Index to an optimal state.
The default name for this server configuration is:
FolderIndexAnalyzerAgentConfiguration
You should never modify these values.
Table E-8 Folder Index Analyzer Agent Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
The threshold for max number of parents after which the Folder Index is considered suboptimal. This condition is ANDed with the |
10 |
|
|
The threshold for max number of children after which the Folder Index is considered suboptimal. This condition is ANDed with the |
10 |
The Oracle Content Services FTP server allows users to easily transfer files between one file system and the Oracle Content Services repository. FTP is particularly useful when performing bulk transfers.
The FTP server is disabled by default after Oracle Content Services is installed and configured. See "Enabling FTP" for information about enabling the FTP protocol.
The default name for this server configuration is:
FtpServerConfiguration
Table E-9 FTP Server Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
The number of server requests back-logged before denying requests. Do not change. |
50 |
|
|
If set to true, allows anonymous connections. |
false |
|
|
The string displayed when the FTP client is started. The FTP Banner can only support ascii characters, because as not all FTP clients can support non-ascii text. |
Oracle Content Services FTP Server ready. Access to this system is limited to authorized users for company business purposes only. Unauthorized access to or use of this system is prohibited and may subject you to civil and criminal prosecution. Use of this system may be monitored for the purpose of maintaining system security, and system information may be accessed or disclosed under limited circumstances. |
|
|
If set to true, character set is the same as the Default Character Set specified by the user in Globalization Preferences. If set to false, character set is the same as specified in If no character set is found, character set is the same as specified in the service-wide default, |
true |
|
|
Specifies the default date format. |
MMM dd HH:mm |
|
|
Default FTP protocol command character set. |
ISO-8859-1 |
|
|
Optionally, specify the host name if the host is multi-homed in the network. |
Default_Hostname |
|
|
The maximum number of connections for this FTP server. |
100 |
|
|
21 If port 21 is already in use, 2100 is used. |
|
|
|
Amount of time between activity before the connection times out; default is 900 seconds or 15 minutes. Unit of measure is milliseconds. |
900000 |
The Oracle Content Services FTPS servers provide support for FTP over SSL. Explicit FTPS secures the connection when the client issues an AUTH command. An Explicit FTPS connection starts out as a regular FTP connection; the connection becomes secure only after the client issues an AUTH command.
The FTPS servers are disabled by default after Oracle Content Services is installed and configured. See "Enabling FTPS" for information about enabling the FTPS protocol.
The Explicit FTPS server contains many of the same properties as the FTP Server. Table E-10 only lists those properties that are specific to Explicit FTPS, along with those properties that have different default values. See Table E-9 for information about the other properties.
The default name for this server configuration is:
FtpsServerExplicitConfiguration
Table E-10 Explicit FTPS Server Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
21 |
|
|
|
Determines whether this FTPS server accepts Implicit FTPS or Explicit FTPS clients. |
Set to false by default in the |
|
|
Location of the Wallet file. |
|
The Oracle Content Services FTPS servers provide support for FTP over SSL. Implicit FTPS secures the channel on connection.
The FTPS servers are disabled by default after Oracle Content Services is installed and configured. See "Enabling FTPS" for information about enabling the FTPS protocol.
The Implicit FTPS server contains many of the same properties as the FTP Server. Table E-11 only lists those properties that are specific to Implicit FTPS, along with those properties that have different default values. See Table E-9 for information about the other properties.
The default name for this server configuration is:
FtpsServerImplicitConfiguration
Table E-11 Implicit FTPS Server Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
990 |
|
|
|
Determines whether this FTPS server accepts Implicit FTPS or Explicit FTPS clients. |
Set to true by default in the |
|
|
Location of the Wallet file. |
|
The Garbage Collection Agent fixes invalid Public Object owners, creators, and modifiers. For example, a document is created and modified by "jsmith." The creator, owner, and last modifier attribute of document are set to jsmith's object ID. If "jsmith" is deleted, the attribute value becomes invalid. The agent replaces these invalid attribute values with the ID of the replacement owner, creator, or modifier specified in the server configuration properties.
The default name for this server configuration is:
GarbageCollectionAgentConfiguration
Table E-12 Garbage Collection Agent Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
User to be replaced as owner. Modify as needed. |
|
|
|
User to be replaced as creator. Modify as needed. |
|
|
|
User to be replaced as modifier. Modify as needed. |
|
This server allows users to access the Oracle Content Services Web interface. It also contains properties for WebDAV access.
The default name of this server configuration is:
EcmHttpServerConfiguration
Table E-13 HTTP Server Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
If set to true, WebDAV will return a directory listing when a user tries to GET a folder through the WebDAV servlet. If set to false, the user is redirected to the Web interface. |
true |
|
|
Nonce refers to the challenge used by WebDAV in digest authentication. After using a nonce to authenticate, the client can continue accessing the server until the time-out period is reached, at which point the server sends another challenge and the client must authenticate again. Unit of measure is minutes. |
10 |
|
|
The minimum timeout value, in seconds, that a client can request when acquiring a lock. This value prevents clients from asking for short timeouts, then refreshing frequently, which increases server load. |
601 |
|
|
Whether to allow depth-infinity PROPFIND requests on collections., which can be extremely expensive. |
true |
|
|
The maximum number of results to collect for a depth-infinity PROPFIND on a collection before rejecting the request. This limit only applies to depth-infinity PROPFIND requests; depth-one requests are not affected. Set to -1 to collect unlimited results. This property is ignored if |
1001 |
|
|
The array of welcome document names that are served up if a GET is done on a directory containing one of these documents. Typically used so that index.html will be served automatically when the directory is requested. To disable this feature, set to an empty array. |
index.html index.htm |
Renaming the Oracle Content Services HTTP Server
Do not change the name of the EcmHttpServer. If you change the server name, you will not be able to access Oracle Content Services through the Web application interface.
If you must change the server name, you must also change the name in the web.xml configuration file. To change the server name:
Rename the server using the Oracle Collaboration Suite Control.
Edit web.xml, located in the following directory:
ORACLE_HOME/j2ee/OC4J_Content/applications/files/files/WEB-INF/
Look for the following lines of code and replace the value for <param-value>:
<init-param> <param-name>IFS.SERVER.PROTOCOL.DAV.IfsServer.Name</param-name> <param-value>EcmHttpServer</param-value> </init-param>
Save the file.
Restart the OC4J instance.
The Inbound Queue Listener Agent is a time-based agent that polls all of the inbound queues periodically so that Oracle Content Services can act upon the messages placed on inbound queues. The Inbound Queue Listener Agent can dequeue a message and delegate the work of processing to the message object itself.
The default name for this server configuration is:
InboundQueueListenerAgentConfiguration
The Lock Expiration Agent is a time-based agent that releases locks that are timed out. The agent needs to be running at all times for the lock auto-expiration function to work.
The default name for this server configuration is:
LockExpirationAgentConfiguration
The Most Recent Doc Agent is an event-based agent that reacts to documents that have been uploaded or accessed by each user. The information provided by the agent is used whenever a user accesses My Recent Documents.
The default name for this server configuration is:
MostRecentDocAgentConfiguration
The Oracle Internet Directory Credential Manager Agent is a time-based agent that polls for changes to Oracle Internet Directory users. If a user has been added, modified, or deleted in Oracle Internet Directory, the Oracle Internet Directory Credential Manager Agent provisions the change in Oracle Content Services.
Set the IFS.SERVER.TIMER.ActivationPeriod if you want to change how frequently this agent runs. The default is every 15 minutes.
The default name for this server configuration is:
OidCredentialManagerAgent
Table E-16 Oracle Internet Directory Credential Manager Agent Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
Number of events to handle at a time. |
100 |
|
|
The fully-qualified classname of the |
|
The Quota Agent is triggered by an event to compute the consumed quota for Libraries. This agent also periodically checks all Libraries that are active, according to a specified timer period. The agent updates the Library's consumed storage. When the consumed storage is over the allocated quota, users of the Library will not be able to add any more documents to that Library. Documents in Trash count toward a Library's quota.
A Library's quota is calculated based on the content already consumed. This means that a Library will go over quota when a user of that Library adds the final file that pushes the consumed storage over the allocated storage. When you set the allocated quota for a Library, remember that a user's last file will put the Library over quota before being denied.
Quotas will not be enforced if:
The Quota Agent has not been started or is not running.
The quota for a Library has not been enabled.
The default name for this server configuration is:
QuotaAgentConfiguration
The Read Document Agent is an event-based agent that reacts to documents read by users, by triggering a custom workflow if one is configured for the document that is read. If no custom workflow is configured for the "Read Document" operation on the folders where the documents are read, the agent takes no action.
The default name for this server configuration is:
ReadDocumentAgentConfiguration
The Reassign Quota agent is an event-based agent that adjusts the quota charged for content in the system when content is moved between Libraries, often a time-consuming task.
The default name for this server configuration is:
ReassignQuotaAgentConfiguration
This server allows users to access the Oracle Records Management Web interface.
The default name for this server configuration is:
RmHttpServerConfiguration
The Records Management Lifecycle Agent is a time-based agent that processes the cut-off, retention, and disposition instructions on Record Categories and Record Folders.
The default name for this server configuration is:
RmLifeCycleAgentConfiguration
When a node is started, this agent automatically preloads the service's data cache. All properties for this agent are required. Unlike most other agents, this agent is configured to run separately on each node.
The default name for this server configuration is:
ServiceWarmupAgentConfiguration
Table E-19 Service Warmup Agent Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
If set to true, preloads ACL collection. |
false |
|
|
If set to true, preloads format collection. |
true |
|
|
If set to true, preloads Media collection. |
true |
|
|
Whether the preloading is done in administration mode. |
true |
|
|
If set to true, preloads user collection. |
false |
The Service Watchdog Agent cleans up after Oracle Content Services services that do not shut down cleanly.
The default name for this server configuration is:
ServiceWatchdogAgentConfiguration
Table E-20 Service Watchdog Agent Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
The number of seconds after which a service is considered inactive. When a service becomes inactive, it is eligible for cleanup by the Service Watchdog Agent. |
120 |
The Statistics agent is a time-based agent that gathers statistics pertaining to service activity on the node where the agent is executing. Unlike most other agents, this agent is configured to run separately on each node, so that statistics are gathered independently for each node. The agent's properties determine whether the statistics are logged, and whether they are written to a document stored in the Oracle Content Services repository.
The default name for this server configuration is:
StatisticsAgentConfiguration
Table E-21 Statistics Agent Configuration Properties
| Property | Description and Usage Notes | Default |
|---|---|---|
|
|
Specifies whether an HTML document should be created, whose content is the currently gathered statistics. The name for this file is autogenerated and appears as |
false |
|
|
If set to true, the currently gathered statistics are sent to the node or application log file. |
true |
|
|
The path within the Oracle Content Services folder hierarchy where the statistics document should be created. The path must refer to a Library or a folder within a Library. Do not include a file name as part of this path; the statistics document file name is autogenerated. |
N/A |
The Version Purge agent is an event-based agent that purges versioned documents that have exceeded the version limit specified by the Versioning Configuration in effect for the documents. The purged versions are moved to the associated Trash folder.
The default name for this server configuration is:
VersionPurgeAgentConfiguration
The Virus Repair Agent is responsible for repairing files that have been infected with a virus, as well as retrieving the latest virus definitions. Whenever the agent becomes active, it will poll the SAVSE server for updated virus definitions, then attempt to repair the quarantined files. The agent will not attempt to repair the following files:
Files that have exceeded the maximum number of repair attempts
Files that have already experienced repair attempts using the current virus definitions
The default name for this server configuration is:
VirusRepairAgentConfiguration
