• FileNet P8 Documentation
    • Help Directory
    • System Installation
      • Plan and Prepare Your Environment for IBM FileNet P8 (PDF)
      • FileNet P8 Platform Installation and Upgrade (PDF)
      • FileNet Rendition Engine Installation and Upgrade (PDF)
      • FileNet P8 eForms Installation and Upgrade (PDF)
      • FileNet Workplace XT Installation and Upgrade (PDF)
      • FileNet Connector for SharePoint Web Parts Installation and Upgrade (PDF)
      • FileNet Connector for SharePoint Document Libraries Installation and Upgrade (PDF)
      • FileNet P8 Portlets for WebSphere Installation and Upgrade (PDF)
      • FileNet Process Analyzer Installation and Upgrade (PDF)
      • FileNet Process Simulator Installation and Upgrade (PDF)
      • FileNet Records Manager Installation and Upgrade (PDF)
      • FileNet Business Activity Monitor Installation and Configuration (PDF)
      • FileNet Content Federation Services for Image Services Planning and Configuration Guide (PDF)
      • FileNet Content Federation Services for Content Manager OnDemand Configuration Guide (PDF)
      • FileNet Content Federation Services Installation and Upgrade Guide (PDF)
      • IBM Enterprise Content Management Widgets Installation Guide (PDF)
      • FileNet P8 Release Notes (PDF)
      • FileNet P8 High Availability Technical Notice (PDF)
    • Application Deployment
    • System Administration
      • Enterprise-wide Administration
      • Application Engine and Workplace XT Administration
      • Content Engine Administration
      • Process Engine Administration
    • Application Design
      • IBM ECM Widgets
    • User Help
      • Using Workplace XT
      • Using Workplace
      • Using IBM ECM Widgets
      • Actions, preferences, and tools
      • Integrating workflow
        • Workflow overview
        • Workflow applications
          • Process Administrator
          • Process Configuration Console
          • Process Designer
          • Process Simulation Console
          • Process Simulation Designer
          • Process Tracker
          • Personal Work Manager
    • Developer Help
      • Developer Roadmap
      • Upgrade Custom Applications
      • Content Engine Development
        • Introduction
        • Java and .NET Developer's Guide
          • Overview
          • Getting Started
            • Concepts
              • Developer Requirements
              • Setting Up a Thick Client Development Environment
              • Setting Up a Thin Client Development Environment Using EJB Transport
              • Setting Up a Thin Client Development Environment Using CEWS Transport
              • Java Packages and .NET Namespaces
              • Transport Protocols
              • Client Configuration
              • FileNet P8 Domain
              • Base Classes and Interfaces
              • Collections
              • Constants
              • Authentication
              • Authorization
              • Instantiating Objects
              • Saving Objects
              • Object Deletion
              • Object Serialization
              • Client-initiated Transactions
            • Procedures
              • Getting a Connection
              • Retrieving an EntireNetwork Object
              • Creating a Domain Object
              • Working with Realm Objects
          • Security
            • Concepts
              • Authentication and JAAS
              • LoginModules
              • Authorization
              • Encryption
              • Security Caching
              • Integrated Logon (SSO)
              • Basic Object Permissions
              • Role-Based Security
              • Security Markings
              • Object Security
              • Security Inheritance
              • Security Policies
            • Working with Security
              • Obtaining a Login Context
              • Setting Permissions
              • Working with Marking Objects
              • Implementing Kerberos
              • Working with Security Policies
          • Object Stores
            • Concepts
              • ObjectStore Object
              • Properties
              • Retrieving Information from the Object Store
              • Security
            • Working with Object Stores
              • Instantiating an ObjectStore Object
              • Installing an AddOn Object on the Object Store
              • Setting Object Store Access Rights
              • Setting Privileged Write Access on an Object Store
              • Working with Custom Schema Scripts
          • Batches
            • Concepts
            • Working with Batches
              • Batch Updating
              • Batch Retrieving
          • Containment
            • Concepts
              • Folders
              • Referential Containment Relationships
              • Containment Names
              • Containment Paths
            • Working with Containment
              • Creating a Folder Object
              • Retrieving Folder Objects
              • Retrieving Documents or Custom Objects from a Folder
              • Filing an Object into a Folder
              • Creating ReferentialContainmentRelationship Objects
              • Creating DynamicReferentialContainmentRelationship Objects
          • Collections
            • Concepts
            • Working with Collections
              • Creating a Collection
              • Iterating a Collection
          • Classes
            • Concepts
              • Class Metadata
              • Class Descriptions
              • Class Definitions
              • Subclasses
              • Custom Properties
              • Object Instantiation
              • Types of Object Persistence
              • Federated Documents
            • Working with Classes
              • Retrieving a ClassDescription Object
              • Retrieving a ClassDefinition Object
              • Creating a Subclass, Creating an Object Instance, and Changing an Object's Class
          • Properties
            • Concepts
              • Property Metadata
              • Property Descriptions
              • System and Custom Properties
              • Property Templates
              • Property Definitions
              • Property Values
              • Property Cache Concepts
              • Property Filter Concepts
            • Working with Properties
              • Retrieving a PropertyDescription object
              • Retrieving a PropertyDefinition object
              • Creating a Custom Property
              • Creating a Property Filter
              • Using a Property Filter
              • Property Recursion
              • Dependent Objects
          • Choice Lists
            • Concepts
              • Choice List Objects
            • Working with Choice Lists
              • Creating a Choice List
              • Associating a Choice List with a Property Template
              • Associating a Choice List with a Property Definition
          • Documents
            • Concepts
              • Document Object Characteristics
              • Document Content
              • Document Storage
              • Document Federated Ownership
            • Working with Documents
              • Creating a Document
              • Taking Federated Ownership
              • Retrieving a Document (getInstance)
              • Retrieving a Document (fetchInstance)
              • Deleting a Document
              • Updating Document Properties
              • Setting a Document's Content
              • Retrieving a Document's Content
              • Assigning a Storage Area
              • Assigning a Storage Policy
              • Moving a Document's Content
              • Customizing a Document Class
          • Versioning
            • Concepts
              • Version Levels
              • Version Numbering
              • Version Status
              • Security
              • Reservation Object
            • Working with Versioning-related Objects
              • Adding Document Versions
              • Canceling a Checkout
              • Retrieving a VersionSeries Object
              • Deleting a VersionSeries Object
              • Working with Versioning Properties
              • Demoting an Object
              • Promoting an Object
              • Freezing Properties
          • Annotations
            • Concepts
            • Working with Annotation Objects
              • Annotating a Document
              • Annotating a Folder
              • Retrieving Annotations
              • Moving Content to a Different Storage Area
              • Creating an Annotation Subclass
          • Custom Objects
            • Concepts
            • Working with CustomObject Objects
              • Creating a CustomObject Object
              • Retrieving a CustomObject Object
              • Creating a CustomObject Subclass and Adding a Custom Name Property
          • Queries
            • Concepts
              • The SQL Statement
              • The Search Scope
              • Content Searches
            • Working with Queries
              • Constructing a SQL Statement
              • Searching for Content
              • Searching Multiple Repositories
              • Searching for Objects
              • Searching for Database Rows
              • Searching for Metadata
              • Best Practices for Searches
          • Content-Based Retrieval
            • Concepts
              • Domain and Server Information
              • Index Areas and Collections
              • Indexing and Index Jobs
            • Working with Content-Based Retrieval
              • Configuring Domain Information
              • Configuring Server Information
              • Configuring an Index Area
              • Managing Indexing
          • Events and Subscriptions
            • Event Concepts
            • Subscription Concepts
              • Subscription Setup Requirements
            • Working with Subscriptions
              • Creating an Event Action Handler
              • Creating an EventAction Object
              • Creating a Subscription Object
              • Retrieving Subscriptions
              • Adding Subscribed Events to Existing Subscription
              • Creating and Raising a Custom Event
              • Setting Status for a Custom Event
              • Retrieving Queue Items from an Object Store
          • Publishing
            • Publishing Concepts
            • Working with Publishing Objects
              • Creating a PublishTemplate Object
              • Retrieving a PublishTemplate Object
              • Working with PublishTemplate Properties
              • Creating a PublishStyleTemplate Object
              • Retrieving a PublishStyleTemplate Object
              • Working with PublishStyleTemplate Properties
              • Publishing and Republishing a Document
              • Retrieving a PublishRequest Object
              • Working with PublishRequest Properties
          • DITA Publishing
            • DITA Publishing Concepts
              • DITA Documents
              • DITA Relationships
              • DITA Classifier
              • DITA Query
              • DITA Publishing
            • Working with DITA Publishing
              • Setting Up a DITA Project
              • Creating a p8dita.env File
              • Navigating DITA Relationships
              • Searching for DITA Metadata
              • Creating a DitaRenditionEngineConnection Object
              • Creating a Publish Style Template for DITA
              • Creating a Publish Template for DITA
              • Publishing a DITA Project
          • Workflows
            • Workflow Concepts
              • Workflow Definitions
              • Workflow Subscriptions
            • Working with Workflow-related Objects
              • Creating a WorkflowDefinition Object
              • Retrieving a WorkflowDefinition Object
              • Transferring a Workflow Definition to the Process Engine
              • Creating a Workflow Subscription Object
              • Retrieving Workflow Subscriptions
          • Document Lifecycle Policies
            • Lifecycle Policy Concepts
              • Lifecycle Policy Setup Requirements
            • Working with Lifecycle-related Objects
              • Creating a Lifecycle Action Handler
              • Creating a DocumentLifecycleAction Object
              • Creating a DocumentLifecyclePolicy Object
              • Assigning a DocumentLifecycle Policy Object
              • Changing a Document's State
              • Retrieving DocumentLifecyclePolicy Objects
          • Automatic Document Classification
            • Document Classification Concepts
              • Custom Classifier Requirements
              • Document Checkin Process
            • Working with Document Classification-related Objects
              • Creating a Document Classifier
              • Creating a DocumentClassificationAction Object
              • Retrieving DocumentClassificationAction Objects
              • Autoclassifying a Document
          • User-Implemented Server Components
            • Implementation Concepts
              • Restrictions
              • Best Practices
            • Deploying Action Handlers
              • Referencing Action Handlers in the Classpath
              • Creating a CodeModule Object
              • Updating a CodeModule Object
          • Feature Addons
            • Feature Addon Concepts
              • Creating Addons
              • Installing Addons
              • Upgrading Addons
              • Deleting Addons
            • Working with Addon-Related Objects
              • Creating an Addon
              • Creating an Upgrade Addon
              • Retrieving Registered Addons
              • Installing an Addon
              • Checking for Superseded Addons
              • Retrieving Addon Installation Records
              • Deleting an Addon
          • Auditing
            • Auditing Concepts
              • Auditing Setup Requirements
              • Auditable Classes and Events
              • Source Object Persistence
            • Working with Auditing-related Objects
              • Configuring a Class for Auditing
              • Retrieving Audit Definitions for a Class
              • Retrieving Audit History for an Object
              • Querying the Audit Event Log
              • Retrieving Source Objects
          • Compound Documents
            • Concepts
              • Component Relationship Types
              • Label-based Binding
              • Circular References
              • Example use cases
            • Working with Compound Documents
              • Assembling a Compound Document
              • Creating a Static Component Relationship
              • Creating a Dynamic Component Relationship
              • Creating a Dynamic Label Component Relationship
              • Deleting Components
              • Versioning Parents
          • Exception-Handling
            • Concepts
              • Exceptions
              • Exception Codes
              • Exception Chaining
            • Working with Exceptions
              • Catching an EngineRuntimeException
              • Interpreting an Exception Code
              • Interpreting the Error Stack
              • Throwing an EngineRuntimeException
          • Trace Logging
            • Concepts
              • Server-Side Versus Client-Side Logging
              • log4j Installation
              • Supported FileNet P8 Subsystems
              • Trace Logging Settings
              • Trace Log Appender Names
              • Trace Log Output Locations
              • Enabling Trace Logging for All Subsystems
              • Default Error Logging
            • Working with the Apache log4j Configuration File
              • Sample log4j Configuration Files
              • Modifying the log4j Configuration File
              • Enabling log4j Logging
              • Performance Considerations
              • Common Problems
            • Analyzing Trace Logging Output
              • Conversion of Output Entries
              • Analyzing log4j Output
          • Cooperative Locking
            • Concepts
              • Locking an Object
              • Applying Changes
              • Unlocking an Object
              • Checking Lock Status
            • Working with Lockable Objects
              • Locking and Unlocking an Object
              • Extending a Lock
              • Testing for a Lock
          • Reference
            • Properties
            • Properties by Class
            • Database Reference
              • Database Engine Differences
              • Database Table Schemas
            • Publish Options XML
            • SQL Syntax Reference
              • SQL Statement Grammar
              • Class and Property Identification in Query Text
              • Folder Operators Description
              • IsClass Function Description
              • Include/Exclude Subclasses Function Description
              • Object Function Description
              • Comparing Objects
              • Pattern-matching Queries on String Properties
              • The IN Operator
              • Float-Valued Property Queries
              • Joins
              • Full-Text Queries
              • Query Restrictions
              • Query Options
              • General Query Examples
        • Java API Reference
        • .NET API Reference
        • Web Service Developer's Guide
          • Concepts
            • Introduction
            • Administration
            • Client-Specific Information
            • Soap Headers
            • Error Reporting
            • Overview of the Content Engine Object Model
          • Action Elements
            • ActionType Element
            • ApplySecurityTemplateAction Element
            • ChangeClassAction Element
            • ChangeStateAction Element
            • CheckinAction Element
            • CheckoutAction Element
            • CreateAction Element
            • DeleteAction Element
            • DemoteVersionAction Element
            • FreezeAction Element
            • InstallAddOnAction Element
            • LockAction Element
            • MoveContentAction Element
            • PromoteVersionAction Element
            • RaiseEventAction Element
            • TakeFederatedOwnershipAction Element
            • UnlockAction Element
            • UpdateAction Element
          • Elements
            • ChangeRequestType Element
            • ChangeResponseType Element
            • CollectionTerminatorType Element
            • ContentData Element
            • ContentElementResponse Element
            • ContentErrorResponse Element
            • ContentRequestType Element
            • ContentResponseType Element
            • ContentType Element
            • DependentObjectType Element
            • DiagnosticType Element
            • DIMEAttachmentReference Element
            • DIMEContent Element
            • ElementSpecificationType Element
            • EndOfCollection Element
            • EndOfPage Element
            • EnumOfObject Element
            • ErrorRecordType Element
            • ErrorStackResponse Element
            • ErrorStackType Element
            • ExecuteChangesRequest Element
            • FaultStackType Element
            • FilterElementType Element
            • GetContentRequest Element
            • GetContentResponse Element
            • GetSearchMetadataRequest Element
            • GetSearchMetadataResponse Element
            • GuidType Element
            • InlineContent Element
            • ListOfBinary Element
            • ListOfBoolean Element
            • ListOfDateTime Element
            • ListOfFloat64 Element
            • ListOfId Element
            • ListOfInteger32 Element
            • ListOfObject Element
            • ListOfString Element
            • Localization Element
            • MergedScope Element
            • MIMEAttachmentReference Element
            • MIMEContent Element
            • ModifiablePropertyType Element
            • ModifiedPropertiesType Element
            • ObjectEntryType Element
            • ObjectReference Element
            • ObjectRequestType Element
            • ObjectResponseType Element
            • ObjectSetResponse Element
            • ObjectSetType Element
            • ObjectSpecification Element
            • ObjectStoreScope Element
            • ObjectValue Element
            • PrincipalSearch Element
            • PropertyFilterType Element
            • PropertyType Element
            • RepositorySearch Element
            • RetrievalError Element
            • SearchRequestType Element
            • SearchScopeType Element
            • SingleObjectResponse Element
            • SingletonBinary Element
            • SingletonBoolean Element
            • SingletonDateTime Element
            • SingletonFloat64 Element
            • SingletonId Element
            • SingletonInteger32 Element
            • SingletonObject Element
            • SingletonString Element
            • StoredSearch Element
            • TraversalError Element
            • Unevaluated Element
            • UnevaluatedCollection Element
            • WithObjectIdentityType Element
          • Operations
            • ExecuteChanges Operation
            • ExecuteSearch Operation
            • GetContent Operation
            • GetObjects Operation
            • GetSearchMetadata Operation
          • Enumerations
            • ChangeStateActionLifecycleAction Enumeration
            • CollectionType Enumeration
            • DependentObjectTypeDependentAction Enumeration
            • ErrorNameType Enumeration
            • ListOfObjectListMode Enumeration
            • MergedScopeMergeMode Enumeration
            • PrincipalSearchPrincipalSearchAttribute Enumeration
            • PrincipalSearchPrincipalSearchType Enumeration
            • PrincipalSearchPrincipalSort Enumeration
            • RepositorySearchModeType Enumeration
            • ReservationType Enumeration
            • StringEncodingType Enumeration
          • Code Examples
            • Document Creation MTOM Content Example
            • Document Creation Inline Content Example
            • Folder Creation Example
            • File Document Example
            • Unfile Document Example
            • Document Content Example
            • Document Checkout Example
            • Document Checkin Example
            • Document Copy Example
            • Document GetContent Example
            • Class Creation Example
            • Choice Lists Example
            • Repository Search Example
            • Principal Search Example
            • GetSearchMetadata Example
        • Web Service Extensible Authentication Framework Developer's Guide
          • Introduction
          • Overview
          • WS-EAF
          • Using WS-EAF
          • Code Samples
          • Resources
      • eForms Development
      • FileNet System Manager Development
      • IBM ECM Widgets Development
      • Process Engine Development
      • Records Manager Development
      • Workplace Development
    • Expansion Products
      • Business Activity Monitor
      • Content Federation Services
      • FileNet P8 eForms
        • eForms User Help
        • Form Policies
      • FileNet P8 Portlets
      • IBM FileNet Connector for SharePoint
      • Process Analyzer
      • Process Simulator
      • Records Manager
    • ibm.com: About IBM - Privacy - Contact
      • About IBM (web)
      • Privacy (web)
      • Contact (web)