The ITraceLoggingConfiguration type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyAPITraceFlags
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 propertyAppenderNames
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 propertyAsynchronousProcessingTraceFlags
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 propertyAuditDispositionTraceFlags
Specifies the trace flags for controlling audit disposition logging. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyCBRTraceFlags
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 propertyCFSDaemonTraceFlags
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 propertyCFSImportAgentTraceFlags
Trace flags corresponding to the CFS Import Agent subsystem. This value consists of a combination of TraceFlag constants.
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyCodeModuleTraceFlags
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 propertyContentCacheTraceFlags
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 propertyContentConversionTraceFlags
This property is not supported.

Trace settings for the content conversion subsystem.

Public propertyContentStorageTraceFlags
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 propertyDatabaseTraceFlags
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 propertyEJBTraceFlags
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 propertyEngineTraceFlags
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 propertyErrorTraceFlags
Trace flags corresponding to the Error subsystem. This value consists of a combination of TraceFlag constants.
Public propertyEventsTraceFlags
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 propertyFixedContentProviderTraceFlags
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 propertyGCDTraceFlags
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 propertyHandlerTraceFlags
Specifies the trace flags applied to the classes in the Handlers subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyId
A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.Id.

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

(Inherited from ISubsystemConfiguration.)
Public propertyMetadataTraceFlags
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 propertyOutputLocation
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 propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertyPublishTraceFlags
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 propertyReplicationTraceFlags
Specifies the trace flags applied to the classes in the Replication subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertySearchTraceFlags
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 propertySecurityTraceFlags
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 propertyServerCommunicationTraceFlags
Specifies the trace flags for controlling the server communication subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag enumeration.
Public propertySSITraceFlags
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 propertySweepTraceFlags
Specifies the trace flags applied to the classes in the Sweep subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyThumbnailGenerationTraceFlags
Specifies the trace flags applied to the classes in the ThumbnailGeneration subsystem. This value can be one or a combination (ANDed) of the fields in the TraceFlag class.
Public propertyTraceLoggingEnabled
Indicates whether trace logging is currently enabled for all configured subsystems.
Public propertyWSITraceFlags
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.

ToggleSee Also