Public Properties

  Name Description
Public property APITraceFlags Specifies the trace flags applied to the classes in the API subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property AppenderNames One or more log4j class names identifying the output destinations to use for the trace logging data. Multiple appender names are separated by commas. It is expected that the use of multiple names will be to specify a console appender and a file appender. If the class names are specified using package prefixes, the class names are interpreted absolutely; otherwise, the class names are prefixed with "org.apache.log4j" during processing. Validation of appender names occurs when they are persisted, rather than when logging is configured.

If no appender name is specified, RollingFileAppender is used by default. In this way, you need only enable the TraceLoggingEnabled property and set the appropriate fields in TraceFlags to initiate useful trace logging.

Note: The error log "filenet_error" (the default) is updated to reference the configured appenders. If the base error log file is not "filenet_error", error log messages are not written to the trace logs.

The supported output destinations (class names) are as follows:

  • ConsoleAppender - Sends trace logging data to the default console.
  • FileAppender - Sends trace logging data to the location specified in the OutputLocation property.
  • DailyRollingFileAppender - A subclass of FileAppender. Backs up (rolls over) the trace logs located in the directory referenced by the OutputLocation property on a scheduled basis. The log4j DatePattern is "yyyy-MM-dd", which initiates the backup operation daily at midnight.
  • RollingFileAppender - A subclass of FileAppender. The default appender used if none is specified. Backs up the trace logs located in the directory referenced by the OutputLocation property when the files exceed the maximum size.

    The default maximum trace log file size is 100MB, and the default backup index file size is 5MB. You can override these default values using the log4j command line properties "MaxRollingFileSize" and "MaxRollingFileBackups".

For more information, see org.apache.log4j.FileAppender.

Public property AsynchronousProcessingTraceFlags Specifies the trace flags applied to the classes in the Asynchronous Processing subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property CBRTraceFlags Specifies the trace flags applied to the classes in the CBR (Content-Based Retrieval) subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property CFSDaemonTraceFlags Specifies the trace flags applied to the classes in the CFS Daemon (Content Federation System) subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property CFSImportAgentTraceFlags Trace flags corresponding to the CFS Import Agent subsystem. This value consists of a combination of TraceFlag constants.
Public property CodeModuleTraceFlags Specifies the trace flags applied to the classes in the Code Module subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property ContentCacheTraceFlags Specifies the trace flags applied to the classes in the Content Cache subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property ContentStorageTraceFlags Specifies the trace flags applied to the classes in the Content Storage subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property DatabaseTraceFlags Specifies the trace flags applied to the classes in the Database subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property EJBTraceFlags Specifies the trace flags applied to the classes in the EJB subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property EngineTraceFlags Specifies the trace flags applied to the classes in the Engine subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property ErrorTraceFlags Trace flags corresponding to the Error subsystem. This value consists of a combination of TraceFlag constants.
Public property EventsTraceFlags Specifies the trace flags applied to the classes in the Events subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property FixedContentProviderTraceFlags Specifies the trace flags applied to the classes in the Fixed Content Provider subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property GCDTraceFlags Specifies the trace flags applied to the classes in the GCD (Global Configuration Data) subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property MetadataTraceFlags Specifies the trace flags applied to the classes in the Metadata subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property OutputLocation The fully qualified path to use as the output location for trace logs (used only when the AppenderName property value is the FileAppender class or a subclass. If unspecified or null, this property value defaults to the application server instance's working directory path appended with "/FileNet". The filename for the trace log is always "p8_server_trace.log", and the log4j layout pattern used is "%d %5p [%t] - %m%n".

Note: Because log4j creates directories on the fly, the only validation against a non-null value for this property is that the location resides within a valid directory.

Public property PublishTraceFlags Specifies the trace flags applied to the classes in the Publish subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property ReplicationTraceFlags This property is not supported.
Public property SearchTraceFlags Specifies the trace flags applied to the classes in the Search subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property SecurityTraceFlags Specifies the trace flags applied to the classes in the Security subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property SSITraceFlags Specifies the trace flags applied to the classes in the SSI (Single-document Storage Interface) subsystem, an interface between the Content Engine and FileNet Image Services. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public property TraceLoggingEnabled Indicates whether trace logging is currently enabled for all configured subsystems.
Public property WSITraceFlags Specifies the trace flags applied to the classes in the Web Services subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Top

See Also