Skip Headers
Oracle® Content Services Administrator's Guide
10g Release 1 (10.1.2)

Part Number B25275-04
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
View PDF

E Server Configuration Properties

Each Oracle Content Services node can support multiple servers. These servers can be either protocol servers or agents:

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 timeout period.

The properties listed in this appendix are all required for a protocol server or agent to run properly. When you install and configure an Oracle Content Services instance, the properties are configured using the default values shown in this appendix.

This appendix provides information about the following topics:

Shared Properties

Table E-1 defines server configuration properties that are shared among more than one server or agent.

Table E-1 Shared Properties

Property Description and Usage Notes Default

IFS.SERVER.Class

The class used to instantiate the server.

Default varies from server to server.

IFS.SERVER.SESSION.LOCALE.Country

Default country to be used in session localizer.

US

IFS.SERVER.SESSION.LOCALE.Language

Default language to be used in session localizer.

en

IFS.SERVER.SESSION.User

User name for server session. Must be a user with Oracle Content Services administrator privileges.

system

IFS.SERVER.TIMER.ActivationPeriod

Time interval for when the agent runs again. Specified as a number followed by a time unit, such as 4h to indicate a 4-hour interval. Time units are:

h=hours, m=minutes, s=seconds

Default varies from server to server.

IFS.SERVER.TIMER.InitialDelay

The delay before the first time interval, relative to when the server is started. This property is ignored if a value is specified for IFS.SERVER.TIMER. InitialTimeOfDay.

Default varies from server to server.

IFS.SERVER.TIMER.InitialTimeOfDay

The first timer event. Set time based on a 24-hour clock.

00:15:00


Audit Event Dispatch Agent

The Audit Event Dispatch Agent is a time-based agent that dispatches raw audit events to other audit histories. This agent polls for new raw audit events, and copies them to all registered audit histories through registered AuditSpecification instances.


Note:

The Audit Event Dispatch Agent 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, this feature is not available.

The default name for this server configuration is:

AuditEventDispatchAgentConfiguration

Table E-2 lists the properties for the Audit Event Dispatch Agent.

Table E-2 Audit Event Dispatch Agent Configuration Properties

Property Description and Usage Notes Default

ECM.AGENT.AUDITEVENTDISPATCHAGENT.EventBatch Size

The maximum number of events processed in a single iteration of this agent.

5000

ECM.AGENT.AUDITEVENTDISPATCHAGENT.EventCount PublishingPeriod

The number of activation periods that will elapse before the updated event counts are published. For example, if this property is set to 20, and IFS.SERVER.TIMER.Activation Period is set to 3 seconds, then the event counts are updated every 1 minute.

20


Audit Event Handler Agent

This agent is not used. Do not activate this agent.


Note:

The Audit Event Handler Agent 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, this agent does not exist.

Background Processing Agent

The Background Processing Agent is an event-based agent that reacts to requests placed by users for operations that take a long time to perform, such as modifying the Sharing properties of a Site. The agent asynchronously performs the requested operations to avoid performance problems.

The default name for this server configuration is:

BackgroundProcessingAgentConfiguration

Table E-3 lists the properties for the Background Processing Agent.

Table E-3 Background Processing Agent Configuration Properties

Property Description and Usage Notes Default

ECM.AGENT.BACKGROUNDPROCESSINGAGENT.EventBatch Size

The maximum number of events processed in a single iteration of this agent.

5000


Cleanup Agent

The Cleanup Agent performs a variety of cleaning 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 Table E-4 assume an ActivationPeriod of 1 hour, which is the default for this agent.

The default name for this server configuration is:

CleanupAgentConfiguration

Table E-4 Cleanup Agent Configuration Properties

Property Description and Usage Notes Default

ECM.AGENT.CLEANUPAGENT.ARCHIVETOBFILE. ActivationMultiplier

Controls how often content in the Archive is moved to a BFILE. This action is only performed when BFILE archiving has been enabled. See "Setting Up Data Archiving" for more information.

24

ECM.AGENT.CLEANUPAGENT.BaseTimeOfDay

The time of day from which all intervals for this agent are based. This property determines the time at which tasks will be run 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 run at 20:15, 4:15, and 12:15.

20:15:00

ECM.AGENT.CLEANUPAGENT.CALCULATEARCHIVEQUOTA. ActivationMultiplier

Controls how often the quota used by files in the Archive for each Site is recalculated.

4

ECM.AGENT.CLEANUPAGENT.CALCULATEDOMAINQUOTA. ActivationMultiplier

Controls how often the total quota used by all files located in Libraries for each Site is recalculated.

1

ECM.AGENT.CLEANUPAGENT.CLEARLINKREFERENCE. ActivationMultiplier

Controls how often links that reference inaccessible items have their internal representation optimized.

12

ECM.AGENT.CLEANUPAGENT.DELETEDOMAINADMINUSER. ActivationMultiplier

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 ECM.AGENT. CLEANUPAGENT.DELETEDOMAINADMINUSER.InactivityPeriod property.

12

ECM.AGENT.CLEANUPAGENT.DELETEDOMAINADMINUSER. InactivityPeriod

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

ECM.AGENT.CLEANUPAGENT.DELETEGRANT. ActivationMultiplier

Controls how often security configurations are optimized to reflect users or groups that have been removed from the system.

24

ECM.AGENT.CLEANUPAGENT.DELETETRASHACL. ActivationMultiplier

Controls how often unused security configurations for items in Trash folders are removed from the system.

24

ECM.AGENT.CLEANUPAGENT.DELETEWORKFLOWUSER. ActivationMultiplier

Controls how often workflow components are optimized with respect to users that have been removed from the system.

12

ECM.AGENT.CLEANUPAGENT.DISABLEDOMAINADMINUSER. ActivationMultiplier

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

ECM.AGENT.CLEANUPAGENT.EMPTYARCHIVE. ActivationMultiplier

Controls how often content that has passed the expiration period set by the Content Administrator is deleted from the Archive.

24

ECM.AGENT.CLEANUPAGENT.EMPTYTRASH. ActivationMultiplier

Controls how often Trash folders are emptied if they were configured to be automatically emptied.

4

ECM.AGENT.CLEANUPAGENT.ISSUEDOMAINQUOTAWARNING. ActivationMultiplier

Controls how often e-mail notification warnings are sent when the quota used by a Site is at or near the allocated quota limit 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 IFS.DOMAIN.EMAIL.AdministratorAddress domain property.

12

ECM.AGENT.CLEANUPAGENT.ISSUEDOMAINQUOTAWARNING. ConsumptionPercentageThreshhold

Specifies how close the used 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

ECM.AGENT.CLEANUPAGENT.ISSUEDOMAINQUOTAWARNING. IncludeArchiveConsumption

Specifies whether documents in a Site's Archive are considered to count against the quota used for a Site.

true

ECM.AGENT.CLEANUPAGENT.PURGEDELETEDWORKSPACE. ActivationMultiplier

Controls how often Libraries that have been deleted and that are unreferenced in the Archive are permanently removed from the system.

24


Content Agent

The Content Agent controls the management of document content when BFILE aging has been set up. When BFILE aging has been enabled, the Content Agent moves content to a BFILE if it has not been accessed after the retention period. See "Managing Storage Options" for information about setting up BFILE aging.

The default name for this server configuration is:

ContentAgentConfiguration

Table E-5 lists the properties for the Content Agent.

Table E-5 Content Agent Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.AGENT.CONTENTAGENT. ContentToBfileManager

The fully qualified classname of the ContentToBfileManager interface.

oracle.ifs.management.servers.content.Ifs ContentToBfileManager

IFS.SERVER.AGENT.CONTENTAGENT. MaxFilesPerFolder

For every relative path created, the maximum number of files that can be moved to a folder.

500

IFS.SERVER.AGENT.CONTENTAGENT. MaxFoldersPerActivationPeriod

The maximum number of folders created when the Content Agent runs.

20

IFS.SERVER.AGENT.CONTENTAGENT. RetentionPeriod

How long a file may be kept in the database as a LOB if it is not accessed.

30d


Content Garbage Collection Agent

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 that is specified in the IFS.SERVER.TIMER.InitialTimeOfDay and IFS.SERVER.TIMER.ActivationPeriod properties.

The default name for this server configuration is:

ContentGarbageCollectionAgentConfiguration

Table E-6 lists the properties for the Content Garbage Collection Agent.

Table E-6 Content Garbage Collection Agent Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.AGENT.CONTENTGARBAGE COLLECTIONAGENT.FilteredContent RemovalPeriod

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

IFS.SERVER.AGENT.CONTENTGARBAGE COLLECTIONAGENT.FreedContentBatch Size

The maximum number of unreferenced ContentObjects that are freed in a single iteration of this agent.

10000


Dangling Object AV Cleanup Agent

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 a directory object that was deleted and is no longer valid.

The default name for this server configuration is:

DanglingObjectAVCleanupAgentConfiguration

Table E-7 lists the properties for the Dangling Object AV Cleanup Agent.

Table E-7 Dangling Object AV Cleanup Agent Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.AGENTS.DANGLING OBJECTAVCLEANUPAGENT. ExcludedAttributeList

A list of attributes for which invalid references to LibraryObjects 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


Event Exchanger Agent

The Event Exchanger Agent periodically purges expired events from the event queue.

The default name for this server configuration is:

EventExchangerAgentConfiguration

Table E-8 lists the properties for the Event Exchanger Agent.

Table E-8 Event Exchanger Agent Configuration Properties

Property Description and Usage Note Default

IFS.SERVER.EventLifespan

The time, in seconds, after which an event is assumed to have been delivered and become eligible for purging.

1800


Event Handler Agent

The Event Handler Agent provides the ability for customers to write custom code in response to audit events. Classes implementing the oracle.ifs.fdk.Event Handler are run using this agent.


Note:

The Event Handler Agent 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, this feature is not available.

The default name for this server configuration is:

EventHandlerAgentConfiguration

Expiration Agent

All public objects have an attribute called ExpirationDate. When 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 that is specified in the IFS.SERVER.TIMER.InitialTimeOfDay and IFS.SERVER.TIMER.ActivationPeriod properties.

The default name for this server configuration is:

ExpirationAgentConfiguration

Folder Index Agent

The Folder Index Agent handles additional folder index functions not covered by the Folder Index Analyzer Agent. See the following section for more information about the Folder Index Analyzer Agent.

The default name for this server configuration is:

FolderIndexAgentConfiguration

Table E-9 lists the properties for the Folder Index Agent.

Table E-9 Folder Index Agent Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.AGENTS.FOLDERINDEX AGENT.MaxDeferredUpdates

The maximum number of deferred updates processed in a single iteration of this agent.

5000


Folder Index Analyzer Agent

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 less than optimal state. The Folder Index Analyzer Agent runs periodically to detect and correct these states, and returns the folder index to an optimal state.

The default name for this server configuration is:

FolderIndexAnalyzerAgentConfiguration

Table E-10 lists the properties for the Folder Index Analyzer Agent. Never modify these values.

Table E-10 Folder Index Analyzer Agent Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.AGENTS.FOLDERINDEX ANALYZERAGENT.MaxParentsThreshold

The threshold for the maximum number of parents after which the folder index is considered less than optimal.

This condition is ANDed with the MaxChildrenThreshold.

10

IFS.SERVER.AGENTS.FOLDERINDEX ANALYZERAGENT.MaxChildrenThreshold

The threshold for the maximum number of children after which the folder index is considered less than optimal.

This condition is ANDed with the MaxParentsThreshold.

10


FTP Server

The Oracle Content Services FTP server lets users transfer files between one file system and the Oracle Content Services repository. FTP is particularly useful for 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-11 lists the properties for the FTP server.

Table E-11 FTP Server Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.PROTOCOL.FTP. AcceptQueueSize

The number of server requests backlogged before denying requests.

Do not change.

50

IFS.SERVER.PROTOCOL.FTP. AnonymousAllowed

If set to true, allows anonymous connections.

false

IFS.SERVER.PROTOCOL.FTP. BannerText

The string displayed when the FTP client is started.

The FTP Banner only supports ASCII characters, because not all FTP clients can display 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.

IFS.SERVER.PROTOCOL.FTP. CommandCharacterSetIsUser CharacterSet

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 IFS.SERVER.PROTOCOL. FTP.DefaultCommandCharacter Set.

If no character set is found, character set is the same as specified in the session default for the user specified in IFS. SERVER.SESSION.User.

true

IFS.SERVER.PROTOCOL.FTP. DateFormat

Specifies the default date format.

MMM dd HH:mm

IFS.SERVER.PROTOCOL.FTP. DefaultCommandCharacterSet

Default FTP protocol command character set.

ISO-8859-1

IFS.SERVER.PROTOCOL.FTP. Localhost

Optionally, specify the host name if the host has multiple homes in the network.

Default_Hostname

IFS.SERVER.PROTOCOL.FTP. MaximumConnections

The maximum number of connections for this FTP server.

100

IFS.SERVER.PROTOCOL.FTP. Port

The port on which the server is running.

21

If port 21 is already in use, 2100 is used.

IFS.SERVER.PROTOCOL.FTP. TimeoutPeriod

Amount of time between activity before the connection times out; default is 900 seconds or 15 minutes.

Unit of measure is milliseconds.

900000


FTPS Server - Explicit

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-12 only lists those properties that are specific to Explicit FTPS, and those properties that have different default values. See Table E-11 for information about the other properties.

The default name for this server configuration is:

FtpsServerExplicitConfiguration

Table E-12 Explicit FTPS Server Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.PROTOCOL.FTP. Port

The port on which the server is running.

21

IFS.SERVER.PROTOCOL.FTPS.SECURITY. IMPLICIT

Determines whether this FTPS server accepts Implicit FTPS or Explicit FTPS clients.

Set to false by default in the FtpsServerExplicit Configuration.

IFS.SERVER.PROTOCOL.FTPS.WALLET. Location

Location of the Wallet file.

/scripts/cwallet.sso


FTPS Server - Implicit

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-13 only lists those properties that are specific to Implicit FTPS, along with those properties that have different default values. See Table E-11 for information about the other properties.

The default name for this server configuration is:

FtpsServerImplicitConfiguration

Table E-13 Implicit FTPS Server Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.PROTOCOL.FTP. Port

The port on which the server is running.

990

IFS.SERVER.PROTOCOL.FTPS.SECURITY. IMPLICIT

Determines whether this FTPS server accepts Implicit FTPS or Explicit FTPS clients.

Set to true by default in the FtpsServerImplicit Configuration.

IFS.SERVER.PROTOCOL.FTPS.WALLET. Location

Location of the wallet file.

/scripts/cwallet.sso


Garbage Collection Agent

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 the object ID of jsmith. If jsmith is deleted, then 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-14 lists the properties for the Garbage Collection Agent.

Table E-14 Garbage Collection Agent Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.AGENT.GARBAGECOLLECTIONAGENT. ReplacementOwner

User to be replaced as owner.

Modify as needed.

system

IFS.SERVER.AGENT.GARBAGECOLLECTIONAGENT. ReplacementCreator

User to be replaced as creator.

Modify as needed.

system

IFS.SERVER.AGENT.GARBAGECOLLECTIONAGENT. ReplacementModifier

User to be replaced as modifier.

Modify as needed.

system


HTTP Server

The HTTP server lets users access the Oracle Content Services Web client. It also contains properties for WebDAV access.

The default name of this server configuration is:

EcmHttpServerConfiguration

Table E-15 lists the properties for the HTTP server.

Table E-15 HTTP Server Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.PROTOCOL.DAV.Browse.Enabled

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

IFS.SERVER.PROTOCOL.DAV. DigestNonceTimeout

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 timeout period is reached, at which point the server sends another challenge and the client must authenticate again. Unit of measure is minutes.

10

IFS.SERVER.PROTOCOL.DAV. Locks.Timeout.Min

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

IFS.SERVER.PROTOCOL.DAV. Propfind.Infinity.Enabled

Whether to allow depth-infinity PROPFIND requests on collections, which can be extremely resource-intensive.

true

IFS.SERVER.PROTOCOL.DAV. Propfind.Infinity.MaxResponses

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 IFS.SERVER. PROTOCOL.DAV.Propfind.Infinity. Enabled is set to false.

1001

IFS.SERVER.PROTOCOL.DAV.Welcome

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:

  1. Rename the server using the Oracle Collaboration Suite Control.

  2. 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>
    
    
  3. Save the file.

  4. Restart the OC4J instance.

Inbound Queue Listener Agent

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

Table E-16 lists the properties for the Inbound Queue Listener Agent.

Table E-16 Inbound Queue Listener Agent Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.AGENT.INBOUNDQUEUELISTENERAGENT. Queues

Holds a list of queues on which the agent will listen.

IFS_IN

IFS_BPEL_IN


Lock Expiration Agent

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 automatic expiration function of the lock to work.

The default name for this server configuration is:

LockExpirationAgentConfiguration

Most Recent Doc Agent

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

Table E-17 lists the properties for the Most Recent Doc Agent.

Table E-17 Most Recent Doc Agent Configuration Properties

Property Description and Usage Notes Default

ECM.AGENT.MOSTRECENTDOCAGENT.EventBatchSize

The maximum number of events processed in a single iteration of this agent.

5000


Oracle Internet Directory Credential Manager Agent

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 property 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-18 lists the properties for the Oracle Internet Directory Credential Manager Agent.

Table E-18 Oracle Internet Directory Credential Manager Agent Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.AGENT. OIDCREDENTIALMANAGERAGENT. MaxEventCount

Number of events to handle at one time.

100

IFS.SERVER.AGENT. OIDCREDENTIALMANAGERAGENT. OidChangeHandler

The fullyqualified classname of the OidChangeHandler implementation.

oracle.ifs.ecm.util.oid.EcmOidChangeHandler


Quota Agent

The Quota Agent is triggered by an event to compute the quota used for Libraries. This agent also checks all active Libraries periodically, according to a specified timer period. The agent updates the storage used by the Library. When the storage used 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 the quota for a Library.

The quota for a Library is calculated based on the content already used. This means that a Library will go over quota when a user of that Library adds the final file that pushes the storage used over the storage limit. When you set the allocated quota for a Library, remember that the last file the user puts in the Library must go over quota before being denied.

Quotas will not be enforced if:

The default name for this server configuration is:

QuotaAgentConfiguration

Read Document Agent

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

Table E-19 lists the properties for the Read Document Agent.

Table E-19 Read Document Agent Configuration Properties

Property Description and Usage Notes Default

ECM.AGENT.READDOCUMENTAGENT.EventBatchSize

The maximum number of events processed in a single iteration of this agent.

5000


Reassign Quota Agent

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

Table E-20 lists the properties for the Reassign Quota Agent.

Table E-20 Reassign Quota Agent Configuration Properties

Property Description and Usage Notes Default

ECM.AGENT.REASSIGNQUOTAAGENT.EventBatchSize

The maximum number of events processed in a single iteration of this agent.

5000


Records Management HTTP Server

The records management HTTP server allows users to access the Oracle Records Management Web client.

The default name for this server configuration is:

RmHttpServerConfiguration

Records Management Lifecycle Agent

The Records Management Lifecycle Agent is a time-based agent that processes the cutoff, retention, and disposition instructions on record categories and record folders.

The default name for this server configuration is:

RmLifeCycleAgentConfiguration

Refresh Security Agent

The Refresh Security Agent is an event-based agent that reacts to changes in grants applied at the Site or Container level, and modifies the security applied lower in the folder hierarchy accordingly, if necessary.

The default name for this server configuration is:

RefreshSecurityAgentConfiguration

Table E-21 lists the properties for the Refresh Security Agent.

Table E-21 Refresh Security Agent Configuration Properties

Property Description and Usage Notes Default

ECM.AGENT.REFRESHSECURITYAGENT.EventBatch Size

The maximum number of events processed in a single iteration of this agent.

5000


Secure Enterprise Search Group Agent

This agent is not used. Do not activate this agent.


Note:

The Secure Enterprise Search Group Agent 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, this agent does not exist.

Service Warmup Agent

When a node is started, the Service Warmup Agent automatically preloads the data cache of the service. 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-22 lists the properties for the Service Warmup Agent.

Table E-22 Service Warmup Agent Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.AGENT.SERVICEWARMUP. WarmupAcls

If set to true, preloads ACL collection.

false

IFS.SERVER.AGENT.SERVICEWARMUP. WarmupFormats

If set to true, preloads format collection.

true

IFS.SERVER.AGENT.SERVICEWARMUP. WarmupMedias

If set to true, preloads Media collection.

true

IFS.SERVER.AGENT.SERVICEWARMUP. WarmupSetAdmin

Whether the preloading is done in administration mode.

true

IFS.SERVER.AGENT.SERVICEWARMUP. WarmupUsers

If set to true, preloads user collection.

false


Service Watchdog Agent

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-23 lists the properties for the Service Watchdog Agent.

Table E-23 Service Watchdog Agent Configuration Properties

Property Description and Usage Notes Default

IFS.SERVER.AGENT.SERVICEWATCHDOGAGENT. ServiceTimeoutPeriod

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


Statistics Agent

The Statistics agent is a time-based agent that gathers statistics pertaining to service activity on the node where the agent is running. Unlike most other agents, this agent is configured to run separately on each node, so that statistics are gathered independently for each node. The properties of the agent 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-24 lists the properties for the Statistics Agent.

Table E-24 Statistics Agent Configuration Properties

Property Description and Usage Notes Default

ECM.AGENT.STATISTICSAGENT. CreateStatisticsDocument

Specifies whether an HTML document should be created, whose content is the currently gathered statistics. The name for this file is automatically generated and appears as node_name_log.html.

false

ECM.AGENT.STATISTICSAGENT.LogStatistics

If set to true, the currently gathered statistics are sent to the node or application log.

true

ECM.AGENT.STATISTICSAGENT. StatisticsFolderPath

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.

If the folder where the statistics file resides does not have a versioning policy set on it, the file will be overwritten every time the agent logs statistics. You should set the folder versioning policy to Auto Versioning or Manual Versioning so that a new version is generated each time the agent logs statistics.

When you set the versioning policy, be sure to set the Maximum number of versions to keep to a high number to ensure that statistics are kept for an adequate time period. For example, if you keep the activation period for this agent at 15 minutes (the default), you would need 96 versions in order to retain statistics for a 24-hour period.

Not applicable


Version Purge Agent

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

Table E-25 lists the properties for the Version Purge Agent.

Table E-25 Version Purge Agent Configuration Properties

Property Description and Usage Notes Default

ECM.AGENT.VERSIONPURGEAGENT.EventBatchSize

The maximum number of events processed in a single iteration of this agent.

5000


Virus Repair Agent

The Virus Repair Agent is responsible for repairing files that have been infected with a virus, and for retrieving the latest virus definitions. Whenever the agent becomes active, it will poll the SAVSE server for updated virus definitions, and then attempt to repair the quarantined files. The agent will not try to repair the following files:

The default name for this server configuration is:

VirusRepairAgentConfiguration