TraceLoggingConfiguration Properties
This topic alphabetically lists the properties that apply to the TraceLoggingConfiguration class.
APITraceFlags Property
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.
Metadata
AppenderNames Property
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 (such as System.out).
- "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 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.
Metadata
AsynchronousProcessingTraceFlags Property
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.
Metadata
AuditDispositionTraceFlags Property
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.
Metadata
CBRTraceFlags Property
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.
Metadata
CFSDaemonTraceFlags Property
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.
Metadata
CFSImportAgentTraceFlags Property
Trace flags corresponding to the CFS Import Agent subsystem. This value consists of a combination of TraceFlag constants.
Metadata
ClassDescription Property
Specifies a ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
Metadata
CodeModuleTraceFlags Property
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.
Metadata
ContentCacheTraceFlags Property
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.
Metadata
ContentConversionTraceFlags Property
This property is not supported.
Trace settings for the content conversion subsystem.
Metadata
ContentStorageTraceFlags Property
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.
Metadata
DatabaseTraceFlags Property
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.
Metadata
EJBTraceFlags Property
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.
Metadata
EngineTraceFlags Property
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.
Metadata
ErrorTraceFlags Property
Trace flags corresponding to the Error subsystem. This value consists of a combination of TraceFlag constants.
Metadata
EventsTraceFlags Property
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.
Metadata
FixedContentProviderTraceFlags Property
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.
Metadata
GCDTraceFlags Property
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.
Metadata
HandlerTraceFlags Property
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.
Metadata
Id Property
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 User
and Group
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, calls to
User.get_Id()
and Group.get_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.get_Id()
is equal to PropertyTemplate.get_Id()
, which is equal to PropertyDefinition.get_PrimaryId()
.
PropertyDefinition.get_Id()
is not equal to PropertyDefinition.get_PrimaryId()
.
PropertyDefinition.get_Id()
is not equal to PropertyDescription.get_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.
Metadata
MetadataTraceFlags Property
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.
Metadata
OutputLocation Property
The fully qualified path to use as the output location for trace logs (used only when the
AppenderNames
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.
Metadata
PublishTraceFlags Property
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.
Metadata
ReplicationTraceFlags Property
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.
Metadata
SSITraceFlags Property
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.
Metadata
SearchTraceFlags Property
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.
Metadata
SecurityTraceFlags Property
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.
Metadata
ServerCommunicationTraceFlags Property
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 class.
Metadata
SweepTraceFlags Property
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.
Metadata
ThumbnailGenerationTraceFlags Property
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.
Metadata
TraceLoggingEnabled Property
Indicates whether trace logging is currently enabled for all configured subsystems.
Metadata
WSITraceFlags Property
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.
Metadata