Properties

This topic alphabetically lists all of the Content Engine API properties. Each property has a See Also section that lists the classes to which the property applies, and provides links to the list of properties for each class. Note that because the metadata for a property is class-specific, you must navigate to the list of properties by class for property metadata information.

[A] [B] [C] [D] [E] [F] [G] [H] [I] [J] [K] [L] [M] [N] [O] [P] [Q] [R] [S] [T] [U] [V] [W] [X]


A


APITraceFlags



Trace flags corresponding to the API subsystem. This value consists of a combination of TraceFlag constants.

See Also



AWSAccessKey



The access key for connecting to the Amazon Web Service.

See Also



AWSSecret



The security secret for connecting to the Amazon Web Service.

See Also



AbandonedContentCleanupInterval



The frequency (in seconds) with which the inbound directory will be scrubbed to eliminate abandoned content

See Also



AbandonedDBContentCleanupInterval



The frequency (in seconds) with which database content tables will be scrubbed to eliminate abandoned content

See Also



AbandonedThumbnailCleanupInterval



The frequency (in seconds) with which abandoned thumbnail renditions will be removed from the system

See Also



AccessMask



The bitmask of access rights.

See Also



AccessType



Indicates whether the permission allows or denies access.

See Also



ActiveDirectorySiteDNS



Specifies the DNS site name listed under Active Directory container: CN=Sites,CN=Configuration,DC=... Domain controllers will be looked up under that site. Each IBM Content Cortex Site instance maps to 0 or 1 DNS site.

See Also



ActiveMarkings



The list of Active Markings currently applied to this object

See Also



AddOn



The add-on associated with this installation record.

See Also



AddOnInstallationRecords



A list of Add On Installation Record objects corresponding to this object store.

See Also



AddOnName



The name of the AddOn to which this AddOnInstallationRecord is associated.

See Also



AddOnType



Specifies whether the add on is optional or required.

See Also



AddOns



AddOns registered with the IBM Content Cortex domain.

See Also



AdvancedStorageDeletionDelay



Specifies the period in seconds by which deletion of content from Advanced Storage Areas should be delayed.

See Also



AffinityGroup



The Text Search Affinity Group with which the object is associated.

See Also



AliasDirection



The replication direction for which this alias applies.

See Also



AliasIds



An optional list of alias IDs for the entity.

See Also



AllRealms



All realms for the IBM Content Cortex Domain

See Also



AllowEmailOrUPNShortNames



If true will allow Active Directory configurations to use UPN or email attributes as short name. This setting affects all AD configs as it disables parsing of principals with an '@' so should be set the same on all; it also implies ReturnNameAsDN=true.

See Also



AllowRetentionReduction



A flag that indicates whether or not Retention Periods on retainable object can be reduced

See Also



AllowStringTruncation



Indicates whether string-valued property values can be truncated if their length exceeds the maximum length of the corresponding property on the search result.

See Also



AllowsContentToBeCached



Specifies whether the content data in this storage area can be cached (true) or not (false). The default is true.

See Also



AllowsDelete



A flag that indicates whether or not the storage allows content to be deleted

See Also



AllowsForeignObject



Specifies whether the described property is permitted to reference an object in another object store.

See Also



AllowsInstances



Indicates whether instances of the class can be created.

See Also



AllowsNull



Indicates whether the column permits null values.

See Also



AllowsPropertyAdditions



Specifies whether user-defined properties may be added to the class.

See Also



AllowsSubclasses



Indicates whether subclasses can be created of the current class.

See Also



AnalysisExporterDimensionCacheSize



The number of dimension rows to cache in memory for each Analysis Exporter.

See Also



AnalysisExporterEnabled



Indicates whether the Analysis Exporter associated with the object is currently enabled.

See Also



AnalysisExporterFactCacheSize



The number of fact table rows to cache in memory for each Analysis Exporter.

See Also



AnnotatedContentElement



The number of the content element (starting at 1) of the object to which this annotation applies.

See Also



AnnotatedObject



The object to which this annotation has been applied.

See Also



Annotations



The annotations associated with this object.

See Also



ApplicationGroupNumber



The unique number identifying the application group.

See Also



ApplicationName



Defines name of application associated with an object.

See Also



ApplyStateID



Unique identifier for the state to which this template applies

See Also



ApplyTemplatePermissions



Specifies whether to apply the associated security template on transition to this state.

See Also



AsyncUpgradeType



The type of the asynchronous upgrade.

See Also



AsynchronousProcessingTraceFlags



Trace flags corresponding to the Asynchronous Processing subsystem. This value consists of a combination of TraceFlag constants.

See Also



AtmosSharedSecret



Atmos shared secret associated to the given UID and Subtenant.

See Also



AtmosSubtenant



Atmos system generated subtenant ID used by Atmos FCD

See Also



AtmosUid



Atmos application ID or User ID used by Atmos FCD

See Also



AtmosUrl



HTTP or HTTPS URL to Atmos storage used by Atmos FCD

See Also



AuditAs



References the PropertyTemplate corresponding to the event property to which this property should be audited as.

See Also



AuditDefinitions



A list of the definition objects to enable auditing on this class.

See Also



AuditDispositionBatchSize



Indicates the batch size in which audited events will be deleted.

See Also



AuditDispositionEnabled



Indicates whether or not audit disposition processing is enabled.

See Also



AuditDispositionPolicies



Enumeration of the Audit Disposition Policies defined in this ObjectStore.

See Also



AuditDispositionQuerySize



Indicates the size of the query results used to sweep through the audit records.

See Also



AuditDispositionTimeslots



A list of CmTimeslot instances where each instance specifies a Weekday, StartTime, and Duration in which to look for audited event records to delete.

See Also



AuditDispositionTraceFlags



Trace flags for controlling audit disposition logging. This value consists of a combination of TraceFlag constants.

See Also



AuditDispositionWaitInterval



Indicates the number of seconds the AuditDisposition thread should wait within its timeslot activity when no other work is immediately present.

See Also



AuditFailure



A value of TRUE for this property enables auditing of failed operations.

See Also



AuditLevel



Specifies the level of automatic auditing by the object store.

See Also



AuditProcessingBookmarks



Enumeration of the Audit Processing Bookmarks defined in this ObjectStore.

See Also



AuditSuccess



A value of TRUE for this property enables auditing of successful operations.

See Also



AuditedDeletePrefix



Prefix string to use with the Centera audited delete feature.

See Also



AuditedEvents



A collection of event objects audited for the object.

See Also



AuthenticationRealmName



The realm name used to authenticate the user against.

See Also



AuthorizationMode



Specifies the manner in which sweep operations are authorized.

See Also



AzureContainerName



The name of the Azure Blob Storage container to use.

See Also



B


BackgroundSearch



The background search instance to which this search result corresponds.

See Also



BackgroundSearchLeaseDuration



The amount of time a busy Background Search request will be allowed to processed before another thread attempts to re-execute the request

See Also



BackgroundSearches



An enumeration of the Background Search instances in this object store.

See Also



BaseClassIds



The base classes associated with this collection.

See Also



BaseDatePropertyName



The symbolic name of a date property defined on the class specified by the Sweep Target that will used to provide the base from which the new retention date will be computed

See Also



BatchDelay



The time in milliseconds that an Import Agent waits while processing batch requests.

See Also



BatchId



The unique identifier of the content id batch represented by this object.

See Also



BatchSelectionSize



The batch selection size used by the CFS IICE Import Agent when selecting federation requests

See Also



BlobReadAheadSize



Specifies the maximum buffer size that the provider will use for reading data.

See Also



BlobWriteCollisionsAvoidanceFlag



Used by the Centera provider to synthesize the FPTagBlobWrite options parameter.

See Also



BuildNumber



Contains the build number associated with this server instance.

See Also



C


CBRPropagationType



Specifies the CBR propagation type for the property.

See Also



CBRQueryDynamicThreshold



Specifies the threshold for the CBR query dynamic switching optimization.

See Also



CBRQueryOptimization



Specifies the optimization strategy to be used for CBR queries.

See Also



CBRQueryRankOverride



Specifies the option for overriding Rank ordering in CBR-optimized queries.

See Also



CBRSearchType



Specifies the type of CBR search engine enabled in the object store.

See Also



CBRSummaryIndexingSize



Specifies the maximum size of text to be retained in the text index from which to generate a summary.

See Also



CBRSummaryResultSize



Specifies the maximum size of summary text to be returned in a full text search result.

See Also



CBRSummaryType



Defines the type of summary text to be available in full text search results.

See Also



CBRTraceFlags



Trace flags corresponding to the CBR subsystem. This value consists of a combination of TraceFlag constants.

See Also



CFSDaemonTraceFlags



Trace flags corresponding to the CFSDaemon subsystem. This value consists of a combination of TraceFlag constants.

See Also



CFSImportAgentTraceFlags



Trace flags corresponding to the CFS Import Agent subsystem. This value consists of a combination of TraceFlag constants.

See Also



CFSPassword



The password for the CFSUserName

See Also



CFSUserName



The principal that will be used to log into the Source Repository via IICE

See Also



CMODApplicationGroups



A collection of the application groups defined in the CMOD repository.

See Also



CMODLanguage



A value required by a CMOD connection that indicates the language in which messages will be output

See Also



CMODPassword



The password associated with CMOD User Name

See Also



CMODPort



The port number on which the CMOD server is listening

See Also



CMODServerName



The name of the CMOD Server with which this Fixed Content Device is associated

See Also



CMODTraceLevel



Sets the amount of trace information that will be gathered by CMOD

See Also



CMODUserName



The security principal that will be used tog log into the target CMOD server

See Also



CSMCache



Identifies the three part name of a local IS CSM cache.

See Also



CacheStatus



Status of the Content Cache Area.

See Also



CanAcceptForwardedRequests



Determines if a Site will accept forwarded requests.

See Also



CanBeDemoted



Indicates whether a document in a given state of a document lifecycle policy can be demoted.

See Also



CanForwardRequests



Determines if requests may be forwarded from a Site.

See Also



Cardinality



Indicates whether the property has a single value or returns a list or enumeration.

See Also



ChangePreprocessorAction



The change preprocessor action object that defines the actions to be taken when the change preprocessor is invoked.

See Also



ChangePreprocessorActions



A collection of change preprocessor actions associated with this object.

See Also



ChangePreprocessorDefinitions



A list of the definition objects to enable change preprocessing on this class.

See Also



ChildComponent



Child component in a compound document structure.

See Also



ChildDocuments



Return, security permitting, enumeration of child component documents.

See Also



ChildRelationships



Return enumeration of child component relationship objects.

See Also



ChildVersionSeries



Object reference to the version series of a child component in a compound document structure.

See Also



ChoiceIntegerValue



Value for choice list integer element.

See Also



ChoiceList



The object giving the controlled value set for the property.

See Also



ChoiceLists



An enumeration of the choice lists defined in the object store.

See Also



ChoiceStringValue



Value for choice list string element.

See Also



ChoiceType



The data type of a choice object.

See Also



ChoiceValues



A list of choice list elements containing values that are allowed for the property that this choice list controls.

See Also



ClassDefinition



The Class Definition

See Also



ClassDescription



Describes an object's class.

See Also



ClassDescriptions



A list of descriptions of all these classes supported by this object store.

See Also



ClassFamily



The symbolic name of the Content Engine root class to which the type of external object corresponds.

See Also



ClassIdentity



The unique identity of the external class.

See Also



ClassificationStatus



The auto-classification status for the document.

See Also



ClosureDate



The date a Storage Area will be closed automatically.

See Also



ClusterNodeNames



A list of the names and optionally port number of the nodes forming this Elastic Search cluster.

See Also



CmAuditSequence



Indicates the relative (ascending) order this event was audited relative to other audited events.

See Also



CmCompressionEnabled



Specifies whether content in this storage area should be compressed.

See Also



CmCompressionThresholdPercent



Specifies as a percentage of the original size, the minimum to which the initial portion of a content stream must be compressed in order for the entire stream to be compressed.

See Also



CmContentIdBatchSize



The size of batches of content ids allocated for upload.

See Also



CmContentIdBatchTTL



The time to live for a content id batch, in seconds.

See Also



CmContentIntegrityOptions



Specifies what measures should be applied to detect and repair content integrity problems.

See Also



CmContentValidator



Specifies the handler to perform validation of uploaded content for this storage area.

See Also



CmDefinesAlternatePredecessor



Indicates whether the referenced predecessor is one of a set of alternates for the successor task.

See Also



CmDeviceRetentionMode



Defines the mode of retention alignment for documents stored in this storage area.

See Also



CmEncryptionMethod



Specifies the encryption method used by the area.

See Also



CmFunctionName



The name of the custom search function defined by this object.

See Also



CmHoldRelationships



An enumeration of CmHoldRelationship objects associated with this object.

See Also



CmIndexingFailureCode



Bitmask of well known reasons for indexing of content to fail.

See Also



CmInheritCoordinatorPermissions



Indicates whether permissions should be inhertied from the Coordinator property.

See Also



CmIsMarkedForDeletion



Indicates whether this object is marked for deletion.

See Also



CmOpenTimeLimit



The maximum amount of time, in seconds, to spend locating amongst replicas and opening a content element.

See Also



CmOutputContentType



Specifies the content type of the text extract produced by the preprocessor.

See Also



CmOutputConversion



Specifies the output conversion produced by the handler by reference to the class definition for the Content Conversion Settings subclass that defines the conversion.

See Also



CmRecoveryItem



The recovery item associated with this event's source object.

See Also



CmRetentionDate



Specifies the earliest date at which the object may be deleted.

See Also



CmSearchSchemaVersion



Defines schema version number for Stored Search and Search Templates.

See Also



CmSourceStorageArea



The storage area from which the move content request was issued.

See Also



CmStandbyActivationPriority



Specifies the priority of this area for activation from Standby when other areas become full. A value of zero is highest priority.

See Also



CmStorageDeviceConnections



The list of connections to storage devices associated with this area.

See Also



CmSupportedInputContentTypes



A list of content types from which a conversion handler is able to produce a particular target content type.

See Also



CmSynchronousReplicasDesired



The desired number of replicas to which content should be written synchronously during upload.

See Also



CmSynchronousReplicasRequired



The minimum number of replicas to which content must be written synchronously during upload.

See Also



CmTargetStorageArea



The storage area to which the move content request was issued.

See Also



CmThumbnails



Contains the set of thumbnail images corresponding to this document.

See Also



CmTransactionTimeout



Indicates the transaction timeout value (in seconds) used during the asynchronous event handling of this event action.

See Also



CmUnsupportedInputContentTypes



A list of content types from which a conversion handler is unable to produce a particular target content type.

See Also



CmUseDeviceHolds



Defines whether to use device level holds to protect content.

See Also



CmVirtualTableName



The name of the virtual table materialised by this handler.

See Also



CodeModule



The code module value for action class.

See Also



CodeModuleCacheEntryTTL



Time-To-Live (TTL) for entries in the code module cache.

See Also



CodeModuleCacheMaxFileSpace



Maximum file space to allocate for code module cache entries that overflow from memory to disk..

See Also



CodeModuleCacheMaxMemory



Maximum memory to allocate for code module cache entries..

See Also



CodeModuleTraceFlags



Trace flags corresponding to the CodeModule subsystem. This value consists of a combination of TraceFlag constants.

See Also



ColumnDefinitions



A list of column definition objects.

See Also



ColumnId



The unique identifier of the column in which the value of the property is stored.

See Also



ColumnName



The name of the column.

See Also



ColumnSize



The size of the column.

See Also



CompletedIterations



The number of sweep iterations that have occurred for a multiple iteration sweep

See Also



CompletionWaitInterval



The duration, in seconds, that the audit disposition background task should wait upon successful completion of a full sweep prior to initiating another.

See Also



ComponentCascadeDelete



Specify cascade delete behavior for parent and child components in a compound document.

See Also



ComponentPreventDelete



Specify prevent delete behavior for parent and child components in a compound document.

See Also



ComponentRelationshipType



Enum value for type of component relationship object, Static, Dynamic, Dynamic Label or URI.

See Also



ComponentSortOrder



Integer sort order for components with a compound document structure.

See Also



CompoundDocumentState



State of document, is it a standard document or a compound document.

See Also



CompressionBlockSize



Specifies the maximum size of uncompressed content that will form a single block in a compressed content stream written by the server.

See Also



ConcurrentReaders



Used to limit the maximum number of concurrent Centera reader threads.

See Also



ConfigurationParameters



Configuration parameters associated with this object.

See Also



ConfigurationSecrets



Secret configuration parameters for the manager instance.

See Also



ConnectionTimeout



Active Directory security provider connection timeout.

See Also



ConstraintMask



The bitmask of constraint access.

See Also



ContainedDocuments



A collection of documents contained within a folder.

See Also



Containees



A collection of referential containment relationship objects referencing the containees of the folder.

See Also



Containers



The enumeration of referential containment relationship objects that identify the containers of this object.

See Also



ContainmentName



A unique name for an object as a Head in a relationship.

See Also



ContentAccessRecordingLevel



The recording granularity of DateContentLastAccessed property.

See Also



ContentCacheArea



The object containing configuration data for content cache area.

See Also



ContentCacheAreas



Enumeration of Content Cache Area objects.

See Also



ContentCacheTraceFlags



Trace flags corresponding to the ContentCache subsystem. This value consists of a combination of TraceFlag constants.

See Also



ContentConversionTraceFlags



Trace settings for the content conversion subsystem.

See Also



ContentElementCount



Number of content elements currently stored in a Storage Area.

See Also



ContentElementKBytes



The number of kilobytes used by all content elements in a Storage Area.

See Also



ContentElements



List of content elements contained within this object.

See Also



ContentElementsCreated



Total content elements created in a Storage Area.

See Also



ContentElementsDeleted



Total content elements deleted from a Storage Area.

See Also



ContentElementsPresent



List of the component types of the content elements contained within this object at the time it was last made persistent.

See Also



ContentId



The unique identifier of the content item.

See Also



ContentLocation



Specifies, in URL format, the name of the resource which contains the content data.

See Also



ContentLockMethod



The vendor method to use to lock the content upon ingestion.

See Also



ContentQueueMaxWorkerThreads



The number of worker threads for the content queue.

See Also



ContentRetentionDate



The date until which the object must be retained, as determined by the content storage subsystem.

See Also



ContentSignature



The SHA-256 hash signature of the content, if computed on upload.

See Also



ContentSize



The size (in bytes) of the captured content associated with this object.

See Also



ContentStorageTraceFlags



Trace flags corresponding to the ContentStorage subsystem. This value consists of a combination of TraceFlag constants.

See Also



ContentSummary



Represents a document's content summary.

See Also



ContentTempDirectoryRoot



The root of the directory structure that holds temporary content.

See Also



ContentType



The MIME type of the content associated with the object.

See Also



ContentUploadTimeout



The maximum period of time in seconds a content upload request can be delayed waiting for a storage area to accept the content.

See Also



ControlledClass



Specifies the class for which access is controlled by this deifinition.

See Also



ControllingObject



The sweep policy or job that incurred the failure

See Also



ConversionWorkerIdleTimeout



Specifies the maximum period in seconds for which a background content conversion worker can be idle before terminating.

See Also



CoordinatedTasks



The enumeration of tasks coordinated by the object.

See Also



Coordinator



A reference to the object that is acting as the coordinator for this and other related tasks.

See Also



CopyRetainedContent



Specifies whether moving of content subject to fixed device retention should proceed by simply coping, leaving the retained content on the source device.

See Also



CopyToReservation



Specifies whether the value of the defined property should be copied from a source document to a reservation object created via Checkout.

See Also



Creator



The name of the user who created this object.

See Also



CredentialsManager



The dynamic Credentials Manager to use to obtain credentials for access.

See Also



CredentialsManagers



A collection of all the Credentials Manager instances defined in the domain.

See Also



CurrentDeferredObjectCount



The number of objects that for which the processing has been deferred during the current or most recent sweep iteration

See Also



CurrentExaminedObjectCount



The number objects that were examined during the current or most recent sweep iteration

See Also



CurrentFailedObjectCount



The number of objects that for which the processing failed during the current or most recent sweep iteration

See Also



CurrentIndexServer



IBM Text Search Server currently assigned to index into this index.

See Also



CurrentProcessedObjectCount



The number of objects that were processed during the current or most recent sweep iteration

See Also



CurrentState



The current state of a document.

See Also



CurrentUser



The current user.

See Also



CurrentVersion



The current (latest) document version of this version series, whether it is a major version or a minor version.

See Also



D


DataType



The data type of the property.

See Also



DatabaseCompressionMode



Specifies database compression setting.

See Also



DatabaseConnection



Defines the database connection attributes used by this object.

See Also



DatabaseConnections



An enumeration of database connections associated with this domain.

See Also



DatabaseIndexStorageLocation



The location within the database in which index information is to be created and referenced.

See Also



DatabaseLOBStorageLocation



The location within the database in which LOB information is to be created and referenced.

See Also



DatabaseSchemaName



Specifies the name of the schema in which the tables and other database objects for an object store reside.

See Also



DatabaseTableStorageLocation



The location within the database in which new tables are to be created.

See Also



DatabaseTraceFlags



Trace flags corresponding to the Database subsystem. This value consists of a combination of TraceFlag constants.

See Also



DatabaseType



The database type; one of the DatabaseType values.

See Also



DateCheckedIn



The date and time this object was checked in.

See Also



DateCompleted



The date and time at which the task transitioned into the Complete state

See Also



DateConfirmed



The date and time the managed user record was confirmed.

See Also



DateContentLastAccessed



The date and time when this content of a document was last accessed.

See Also



DateCreated



The date and time this object was created.

See Also



DateLastActive



The date and time when the entity was last detected to be active.

See Also



DateLastModified



The date and time when this object was last modified.

See Also



DateLastStarted



The date and time when the instance was last started.

See Also



DateRequested



Indicates request date/time for the Index request.

See Also



DateStarted



The date and time at which the task transitioned into the Working state

See Also



DefaultDispatcherDelay



The default value for the sweep framework dispatcher delay in seconds

See Also



DefaultFromName



Default string used in the From: field for email sent by system.

See Also



DefaultISDocumentClass



Name of the IS document class that controls mode 1 content.

See Also



DefaultInstanceOwner



The default owner for an object of the described class.

See Also



DefaultInstancePermissionDescriptions



A list of descriptions of permissions applicable to objects of the defined class.

See Also



DefaultInstancePermissions



The default discretionary permissions for an object of the described class.

See Also



DefaultQueryTimeLimit



The default value for the maximum amount of time that the server will allow a query to run (can be overridden on a per-query basis).

See Also



DefaultReplyToName



Default string used in the Reply-To: field for email sent by system.

See Also



DefaultReservationType



Defines the default type for reservations where an explicit choice is not made.

See Also



DefaultRetentionDays



The default retention period in days.

See Also



DefaultRetentionPassThrough



Flag indicating when the retention period is set to the current Centera system setting.

See Also



DefaultRetentionPeriod



Specifies the default retention period to be applied to instances of the described class, in minutes.

See Also



DefaultSite



The default site object.

See Also



DeferralCount



The number of times the queue entry has been deferred for later processing.

See Also



DeferralData



Data that has been saved in the queue entry for use in subsequent deferred processing.

See Also



DeferredObjectCount



The total number of objects for which processing has been deferred by the sweep.

See Also



DelegateName



The name of the user or group to whom rights are delegated.

See Also



DelegateType



The security principal type of the delegate.

See Also



DelegatingUserName



The name of the individual delegating rights to another.

See Also



DeleteMethod



The delete method which specifies how files are deleted from a file store.

See Also



DeleteMethodSupported



Indicates the maximum level of secure deletion supported by the device.

See Also



DeletionAction



Defines the action taken with respect to values of the property when the object containing the property is deleted.

See Also



DependentDocuments



An enumeration of all the publication documents to which this document is the owner document.

See Also



DequeueHost



The host name of the server responsible for dequeuing the item.

See Also



Description



Description of this object.

See Also



DescriptiveText



Text that describes this object.

See Also



DescriptiveTexts



Locale-specific descriptions.

See Also



DestinationDocuments



An enumeration of all the publication documents to which this document is the source document.

See Also



DestinationRepository



The repository to which the journaled change is to be propagated.

See Also



DeviceAddress



Connection address for ONTAP.

See Also



DeviceConnectionURL



The URL used to make a connection to a storage or fixed content device.

See Also



DevicePassword



Password used to access a storage or fixed content device

See Also



DeviceRootDirectory



The absolute path on the SnapLock device.

See Also



DeviceUserName



User name used to access a storage or fixed content device

See Also



DirectoryConfigurations



List of directory server configurations for the respective directory servers to be queried by the server.

See Also



DirectoryServerHost



The host name of the directory server.

See Also



DirectoryServerPassword



The password for authenticating to the directory server.

See Also



DirectoryServerPort



The port number of the directory server.

See Also



DirectoryServerProviderClass



The directory server provider class name.

See Also



DirectoryServerType



The type of directory server.

See Also



DirectoryServerUserName



The username for authenticating to the directory server.

See Also



DirectoryStructure



Integer representing a directory structure type

See Also



DirectoryTraceFlags



Trace settings for directory (LDAP) operations.

See Also



DispatcherEnabled



Indicates whether the background task associated with the object is currently enabled.

See Also



DispatcherThreadIdleTimeout



Specifies the period in seconds after which an idle thread allocated for background dispatcher task processing will be terminated.

See Also



DispatcherWaitInterval



The time in seconds that a background task will wait before checking for work.

See Also



DisplayName



A user-intelligible name for the object.

See Also



DisplayNames



Locale-specific display names.

See Also



DispositionRule



Contains the expression used to identify the appropriate records to delete.

See Also



DistinguishedName



The distinguished name (name that uniquely identifies the object) for a given group or user.

See Also



DocumentClassificationActions



A collection of Document Classification Action objects associated with the object.

See Also



DocumentLifecycleAction



The Document Lifecycle Action associated with this object.

See Also



DocumentLifecycleActions



A collection of document lifecycle actions associated with this object.

See Also



DocumentLifecyclePolicies



A collection of document lifecycle policies associated with this object.

See Also



DocumentLifecyclePolicy



Document lifecycle policy applied to a document.

See Also



DocumentStates



The valid states of a document through its lifecycle.

See Also



DocumentationURL



The base URL for the documentation associated with the domain.

See Also



DocumentsPerBatch



The number of documents placed into a batch.

See Also



Domain



The Domain to which the object belongs.

See Also



DomainId



The unique identifier of a Domain

See Also



DomainType



Indicates the type of domain to which this object corresponds.

See Also



DomainVersion



Contains the domain version string corresponding to this instance.

See Also



DuplicateSuppressionEnabled



Specifies if suppression of duplicate content (also called single-instancing) is enabled for the storage area.

See Also



Duration



Indicates the length of time (in minutes) that the task should run.

See Also



DynamicGroupMemberAttribute



The LDAP attribute holding static members (actually hybrid group)

See Also



DynamicGroupObjectClass



Dynamic Group Object Class

See Also



DynamicGroupQueryAttribute



The LDAP attribute holding dynamic query

See Also



E


EJBForwardingEndpoint



Holds EJB forwarding URI endpoint for a virtual server.

See Also



EJBTraceFlags



Trace flags corresponding to the EJB subsystem. This value consists of a combination of TraceFlag constants.

See Also



EffectiveEndDate



The date and time after which this sweep rule becomes no longer eligible to run

See Also



EffectiveSQL



The SQL statement produced by the background search after parameter substitution has been performed.

See Also



EffectiveStartDate



The date and time this sweep rule becomes effective and eligible to run

See Also



ElasticSearchAnalyzers



The list of analyzers enabled for Elastic Search indexing and search in this object store.

See Also



ElasticSearchClusters



A collection of the Elastic Search clusters defined for the domain,

See Also



ElasticSearchCredential



The password or other credential used to authenticate with the Elastic Search cluster.

See Also



ElasticSearchIndexes



The Elastic Search indexes associated to this index area

See Also



ElasticSearchPrincipal



The username or other identity as which to authenticate with the Elastic Search cluster.

See Also



ElasticSearchQueryCacheEnabled



Enables the cache of Elastic Search full text search results.

See Also



ElasticSearchQueryCacheExpandHits



Enables Elastic Search continuation queries to request the maximum number of results, which may improve cache performance.

See Also



ElasticSearchQueryCacheMaximumHits



The maximum number of Elastic Search query results to cache.

See Also



ElasticSearchQueryCacheTTL



The time to live for Elastic Search query cache entries.

See Also



ElementSequenceNumber



A unique sequence number for the content element.

See Also



Email



User's E-mail Address

See Also



EmailServicesEnabled



Enable or disable Email services. This is the master switch to enable/disable all Email.

See Also



EmailSuffix



A suffix string against which email addresses are matched by the identity rule.

See Also



EmbeddedDataThreshold



Maximum data size per content element to embed in a C-Clip.

See Also



EnableDefensibleDisposal



Specifies if documents replicated to or from the external repository should be prevented from being deleted in that repository.

See Also



EnableManualLaunch



Indicates whether the workflow can be launched manually.

See Also



EncryptionEnabled



Specifies whether content in this storage area should be encrypted.

See Also



EncryptionKey



Sets the key used for encrypting content in the storage area.

See Also



EndDate



Objects indexed in this Collection will have partitioning dates earlier than this date.

See Also



EndReplicationAfterMove



A flag that indicates that replication will be permanently disabled on documents and annotations after the content has been moved

See Also



EngineTraceFlags



Trace flags corresponding to the Engine subsystem. This value consists of a combination of TraceFlag constants.

See Also



ErrorTraceFlags



Trace flags corresponding to the Error subsystem. This value consists of a combination of TraceFlag constants.

See Also



EventAction



The event action object that defines the actions to be taken when the event occurs.

See Also



EventActions



A collection of the event action objects associated with this object.

See Also



EventClass



This value holds a reference to the class definition for the class of event to be enabled.

See Also



EventExportStores



An enumeration of Event Export Store objects that exist in this Domain

See Also



EventExporterAccountingInterval



The period (in seconds) the event exporter framework will wait before store accounting

See Also



EventExporterLeaseWaitInterval



The period (in seconds) that the event exporter will wait to acquire a lease for processing.

See Also



EventExporterSleepDuration



The period (in seconds) the event exporter sleeps when there is no activity

See Also



EventObject



The Event object to be delivered to the queued event action.

See Also



EventStatus



Indicates whether the operation that caused the creation of this event was successful.

See Also



EventsTraceFlags



Trace flags corresponding to the Events subsystem. This value consists of a combination of TraceFlag constants.

See Also



ExaminedObjectCount



The total number of candidate objects discovered by the sweep.

See Also



ExcludeFromAuthenticatedUsers



Specifies whether users from this directory should be excluded from being treated as being members of #AUTHENTICATED-USERS.

See Also



ExpiredBatchSelectionSize



The Content Queue batch selection size used when selecting expired requests

See Also



ExporterType



An indication as to which type of exporter this object is configured.

See Also



ExternalAliases



The external aliases of the defined entity.

See Also



ExternalClassDescriptions



An enumeration of the replicable classes in the external repository.

See Also



ExternalObjectIdentity



The unique identity of the external replica object, relative to the external repository.

See Also



ExternalPropertyDescriptions



A list of the properties belonging to the external class.

See Also



ExternalReplicaIdentities



A list of the identities of replicas of the object in external repositories.

See Also



ExternalRepositories



An enumeration of the external repositories defined in the domain,

See Also



ExternalRepository



The external repository participating in the replication group.

See Also



ExtractLocale



The locale name for the language in which the text extract is written, if known.

See Also



ExtractedProperties



A list of name and value pairs for properties extracted from the content during text extraction.

See Also



ExtractionStatus



The status of the text extraction operation.

See Also



F


FPLogConfigFile



Path to Centera dynamic logging configuration file

See Also



FPLogEnabled



If true, Centera dynamic logging is enabled using the logging parameters specified in the Centera Log Configuration file (FPLogConfigFile).

See Also



FPOpenStrategy



Specifies the approach that is used to open connections.

See Also



FPPoolBufferSize



The size of an internal C-Clip buffer in bytes.

See Also



FPPoolClusterNonAvailTime



The amount of time that a cluster is marked as not available before retrying with a probe.

See Also



FPPoolDefaultCollisionAvoidance



Flag that determines whether or not collision avoidance is enabled at the pool level.

See Also



FPPoolEnableMulticlusterFailover



True value indicates multi-cluster failover is enabled.

See Also



FPPoolMaxConnections



Specifies the maximum number of sockets that will be allocated.

See Also



FPPoolMulticlusterDeleteStrategy



Specifies the failover strategy for delete operations.

See Also



FPPoolMulticlusterExistsStrategy



Specifies the failover strategy for exists operations.

See Also



FPPoolMulticlusterQueryStrategy



Specifies the failover strategy for query operations.

See Also



FPPoolMulticlusterReadStrategy



Specifies the failover strategy for read operations.

See Also



FPPoolMulticlusterWriteStrategy



Specifies the failover strategy for write operations.

See Also



FPPoolPrefetchSize



Specifies the size of the prefetch buffer.

See Also



FPPoolRetryCount



Specifies the number of times an operation will be retried before failure is reported.

See Also



FPPoolRetrySleep



The time to wait before a failed API function should be retried in milliseconds.

See Also



FPPoolTimeout



TCP/IP Connection timeout in milliseconds.

See Also



FailedObjectCount



The total number of objects that failed when applying the sweep action for sweep.

See Also



FailureCount



The number of times this queued object has failed.

See Also



FailureDescription



A description of the failure that occurred

See Also



FcpPoolIdleTimeoutSeconds



The number of seconds an idle connection can remain in the pool before being eligible to be closed and removed from the pool

See Also



FcpPoolMaxInUse



The maximum number of concurrent connections to the fixed content device

See Also



FcpPoolMaxWaitSeconds



The maximum number of seconds to wait for a connection once the FcpPoolMaxInUse limit has been reached.

See Also



FcpPoolPreferredSize



The preferred size of the fixed provider pool

See Also



FederationJNDIDataSource



The JNDI Name of the data source for the federation database

See Also



FederationJNDIXADataSource



The JNDI Name of the XA data source for the federation database

See Also



FederationUpdateHasPriority



A flag that, when set, causes federation updates to take precedence even when the target object has been modified more recently

See Also



FilterExpression



An expression evaluated against an object to determine if the object should apply.

See Also



FilteredPropertyId



Specifies the symbolic name of an object-valued property of the source object, to which the filter expression is applied.

See Also



FilteredQueryTimeout



Defines the timeout, in seconds, to allow for the sweep query that includes filter conditions.

See Also



FixedContentDevice



The specific fixed content device in which the document content associated with a Fixed Content Storage area will be stored when the document is checked in

See Also



FixedContentDevices



The collection of fixed content devices defined for a domain

See Also



FixedContentProviderTraceFlags



Trace flags corresponding to the Fixed Content Provider subsystem. This value consists of a combination of TraceFlag constants.

See Also



FolderCacheMaxAgeDelta



Maximum age delta for entries in the folder cache.

See Also



FolderCacheMaxEntries



Maximum number of entries allowed in the folder cache.

See Also



FolderCacheReapFrequency



Reap frequency for folder cache.

See Also



FolderName



The name of the folder.

See Also



FoldersFiledIn



The list of folders where this document is filed.

See Also



ForCaseInsensitiveSearch



Indicates whether the index is case-insensitive or not.

See Also



ForceCaseInsensitiveSearch



Specifies whether searches should be forced to operate case-insensitively.

See Also



FromVersions



A list of IDs specifying the add-on version(s) which are upgraded by this upgrade add-on.

See Also



FullTextRowDefault



The default number of full text index rows that are used during a search. This value may be exceeded with use of options on a SQL statement.

See Also



FullTextRowMax



The maximum number of full text index rows that are used during the processing of any query. This limit prevents excessive resource use during a search operation.

See Also



G


GCDCacheTTL



The time-to-live value (in seconds) for the Global Configuration Database cache.

See Also



GCDRevisionNumber



The revision number of the Global Configuration Database.

See Also



GCDTraceFlags



Trace flags corresponding to the GCD subsystem. This value consists of a combination of TraceFlag constants.

See Also



GCHost



Global Catalog host name

See Also



GCPort



Global Catalog port number

See Also



GranteeName



The name of the user or group to whom the permission is granted.

See Also



GranteeType



The type (user or group) of the grantee.

See Also



GroupBaseDN



The base DN for searching for groups in the directory server.

See Also



GroupDNAttribute



The attribute providing the distinguished name of the group.

See Also



GroupDisplayNameAttribute



Directory server attribute used for group display name.

See Also



GroupMembers



The members of the local group.

See Also



GroupMembershipSearchFilter



The search filter for group membership queries.

See Also



GroupName



The symbolic name for the local group.

See Also



GroupNameAttribute



Defines the directory server attribute to be used as the short name for a group.

See Also



GroupSearchFilter



This property specifies search filter for group(s). It needs to be in the format like "(&(objectclass=group)(samAccountName={0}))", where samAccountName will serve as the short name.

See Also



GroupUniqueIDAttribute



Which LDAP attribute is picked as group unique ID

See Also



Groups



A collection of Group objects.

See Also



H


HandlerTraceFlags



Trace flags for controlling handler logging. This value consists of a combination of TraceFlag constants.

See Also



HasHierarchy



Indicates whether the choice list has a hierarchical structure.

See Also



HasIncludeSubclasses



Indicates whether this class supports 'include subclasses' queries.

See Also



HasProperSubclassProperties



Indicates whether this class supports 'include descendant properties' queries.

See Also



HashSequenceNumber



The hash sequence number of the content item.

See Also



HcpDirectoryPath



Path to root directory of a HCP namespace in which content is stored.

See Also



HcpMaxConnections



Maximum number of concurrent connections to Hitachi Content Platform

See Also



HcpNamespaceUrl



HTTP or HTTPS URL to Hitachi Content Platform namespace used by Hitachi FCD

See Also



HcpPassword



Password associated with Hitachi Content Platform data access account

See Also



HcpUser



Hitachi Content Platform namespace data access account name with read/write/delete/purge privileges to namespace.

See Also



Head



The independently persistable object at the Head end of the binary relationship.

See Also



HeldObject



A reference to the held object.

See Also



HeldUntilDate



The date and time until which the lease is held on the journal entry, or until which it must wait until being retried.

See Also



HighlightOffsets



The offsets in the summary text of a text search result which represent fragments that should be highlighted as hits.

See Also



HistoryExporterEnabled



Indicates whether the History Exporter associated with the object is currently enabled.

See Also



HistoryExporterUpdateCacheSize



The number of items that can be stored in the update cache when exporting history-based events.

See Also



Hold



A reference to the CmHold instance to which this object is attached.

See Also



HostNames



A list of the fully qualified DNS names of the host on which the server is running.

See Also



HttpMaxConnections



Maximum number of concurrent HTTP connections to a HTTP based FCD. This value is used by the Http connection pool used by the CE server to communicate with Atmos.

See Also



HttpsCertValidationEnabled



Enable hostname and certificate validation over an https connection to a FCD. Certificate validation may be disabled when the http device being connected to is within the same corporate firewall and using a self-signed certificate.

See Also



I


ICOSAccessKey



The access key for connecting to the IBM Cloud Object Storage device.

See Also



ICOSRegionName



The name of the reguion for the IBM Cloud Object Storage device.

See Also



ICOSSecret



The security secret for connecting to the IBM Cloud Object Storage device.

See Also



ICOSVaultName



The name of the vault to be used in the IBM Cloud Object Storage device.

See Also



IICEConfigurationServerURL



The URL that needs to be provided to the IICE API in order for it to locate the Configuration Server.

See Also



ISDomainName



The domain name component of the NCH name that specifies the address of the target Image Server.

See Also



ISOrganization



The organization component of the NCH name the specifies the address of the target Image Server.

See Also



ISPassword



The password associated with ISUserName.

See Also



ISUserName



The name of the security principal that will be used to gain access to the Image Server.

See Also



Id



The unique object ID.

See Also



IdBatchExpiryTime



The date/time at which the batch of content ids is considered expired and any content abandoned.

See Also



IdentityRuleType



The type of the identity rule.

See Also



IdentityRules



The rules determining acceptable email addresses for managed users in this realm.

See Also



Ids



Identifiers that serve as the names of the entity (class, property, or operator) being described.

See Also



Image



The thumbnail image.

See Also



ImageByteCount



The length in bytes of the thumbnail image.

See Also



ImageColor



Indicates the color scheme to use when generating the thumbnail image.

See Also



ImageFormat



Specifies the format of the thumbnail image to be generated.

See Also



ImageServicesClassDescriptions



A list of the Image Services Class Descriptions from the designated Image Services instance

See Also



ImageServicesClassName



The name of this class as it is defined by Image Services

See Also



ImageServicesDataType



Identifier for a well known data type defined by Image Services

See Also



ImageServicesPropertyDescriptions



A list of ImageServicesPropertyDescriptions that describe the properties defined for this Image Services class

See Also



ImageServicesPropertyName



The name of this Property as it is defined by Image Services

See Also



ImageSize



The request size for generated thumbnails.

See Also



ImmediateSubclassDefinitions



A list of the definition objects for the immediate subclasses of the current class.

See Also



ImmediateSubclassDescriptions



List of class descriptions, one for each class that is an immediate subclass of the current class.

See Also



ImplementationClass



The name of the Java Class that implements the behavior for this Fixed Content Device

See Also



ImportAgentRetryCount



The number of retries a given ImportAgent thread will attempt.

See Also



InactiveUserDisablementIntervalDays



The period of inactivity in days after which a managed user should be disabled.

See Also



InboundBatchSize



The batch size for inbound replication processing.

See Also



InboundBusyWaitInterval



The time in seconds an inbound worker should wait before looking for more work after completing a batch of work.

See Also



InboundDispatcherEnabled



Indicates whether the inbound background task associated with the object is currently enabled.

See Also



InboundFileNameCacheMaxEntries



The maximum number of inbound file names to keep in the LRU cache

See Also



InboundIdleWaitInterval



The time in seconds an inbound worker should wait before looking for more work after exhausting all that is available.

See Also



IncludeSubclassesRequested



Controls whether a search includes subclasses of the class specified.

See Also



IndexArea



The Index Area that contains the collection that IndexationId refers to.

See Also



IndexAreas



The index areas associated with this object.

See Also



IndexDefinitions



Specifies the set of index definitions corresponding to this table definition.

See Also



IndexItems



The items to be indexed by this job.

See Also



IndexJob



The Index Job for which index requests were generated.

See Also



IndexName



The name of the index

See Also



IndexPartitionConstraints



A list of index partitioning constraints on the full text index. Only objects satisfying these constraints are indexed.

See Also



IndexReplicas



The number of replicas per index in this index area.

See Also



IndexRequestStatus



Defines the status of index request.

See Also



IndexRequests



Enumeration of index requests associated to the Index job.

See Also



IndexShards



The number of shards per index in this index area.

See Also



IndexSizeKbytes



The size in KB of the full text Index

See Also



IndexationId



The object ID of the verity collection an object is stored into, or null for objects that were full text indexed prior to the 4.0 release.

See Also



IndexedColumns



The list of objects indicating the columns that comprise this index.

See Also



IndexedObjectCount



The number of objects in this full text index

See Also



IndexingFailureRecordingLevel



Specifies if and how content indexing failures are recorded in associated objects.

See Also



IndexingJobTimeslots



A list of timeslots used to schedule the running of the CBRIndexer background task.

See Also



IndexingOperation



Defines indexing operation being performed.

See Also



IndexingOptions



Specifies options for this Elastic Search index request.

See Also



IndexingStatus



The status of indexing for the full text index.

See Also



InheritParentPermissions



Defines whether this folder should inherit permissions from its parent folder.

See Also



InheritRecoveryBinPermissions



Indicates whether permissions should be inhertied from the Recovery Bin property.

See Also



InheritableDepth



The maximum depth to which the permission should be inherited.

See Also



InitiatingUser



The name of the user that initiated the event. This name will be in the form of a user principal name or distinguished name.

See Also



InlineContentRetrievalLimit



The limit of the size for inline content retrieval.

See Also



InputDocument



Specifies the source document that is to be published.

See Also



InstallationDate



The date and time when installation was completed.

See Also



InstallationReport



An XML format string consisting of the installation report. This value will be null following successful installations.

See Also



InstallationStatus



Indicates the current status of the add-on installation request.

See Also



InstalledByAddOn



Indicates the AddOn that installed this object. If null, this object was either created by the system or an external application.

See Also



Installer



The name of the user issuing the add-on installation request.

See Also



InterBatchDelay



The minimum amount of time in milliseconds between each query for the next batch of candidate objects during the execution of a sweep

See Also



InterSweepDelay



The minimum number of seconds after a sweep iteration has completed before the next iteration can start

See Also



InternalPortNumber



The port number used for Process Engine to Process Engine communication.

See Also



IsCBREnabled



If this property definition is enabled for CBR. A property may only be CBR enabled if the class has an IndexationId property.

See Also



IsCallerInRole



Returns true if the caller retrieving the role is a member of that role.

See Also



IsCurrentVersion



Indicates whether this is the current version in the version series.

See Also



IsDateOnly



Specifies whether this DateTime property should be treated as a date only property.

See Also



IsEnabled



Indicates whether this object is enabled.

See Also



IsFrozenVersion



Indicates whether user properties or content can be modified.

See Also



IsHidden



Indicates whether the class or property should be hidden from non-administrative users.

See Also



IsHierarchical



Specifies whether the marking set is hierarchical or not.

See Also



IsImportAgentEnabled



Indicates whether or not the Import Agent is enabled for a particular site

See Also



IsInExceptionState



Indicates whether the lifecycle of a document is in exception state.

See Also



IsMigrationJob



Identifies this IndexJob instance as a migration job

See Also



IsNameProperty



Indicates whether that the property value provides the name of the object.

See Also



IsOrderable



Indicates whether this property can appear in the orderings list of a query.

See Also



IsPersistent



Indicates whether the entity can be made persistent

See Also



IsReadOnly



Indicates whether the property can be modified.

See Also



IsReadProtected



Indicates whether the corresponding property is read protected or not.

See Also



IsReserved



Indicates whether a user has reserved the right to check in a version following this version.

See Also



IsSSLEnabled



Defines whether or not SSL is enabled.

See Also



IsSearchable



Specifies whether the class or property can be used as part of the search criteria.

See Also



IsSecurable



Defines whether objects of the described class have independently settable security.

See Also



IsSelectable



Specifies whether the class or property can be selected in a query result set.

See Also



IsSingleIndexed



Specifies and controls the presence of a user-defined index on this column.

See Also



IsSynchronous



Indicates whether this event should be fired synchronously or in the background.

See Also



IsSystemGenerated



Indicates whether this property is generated and set by the DMA system.

See Also



IsSystemOwned



Indicates whether the entity is owned by the system and therefore cannot be altered.

See Also



IsValueRequired



Indicates whether every instance of the described property must have a value.

See Also



IsVersioningEnabled



Determines if versioning is enabled for this class of object.

See Also



IsolatedRegion



The isolated region to which this connection point provides access.

See Also



IsolatedRegionNumber



eProcess Isolated Region Number.

See Also



IsolatedRegions



The list of PE isolated regions that are available in the IBM Content Cortex domain.

See Also



IterationNumber



A specific iteration of a multiple iteration sweep

See Also



J


JNDIDataSource



The JNDI DataSource for a database connection.

See Also



JNDIXADataSource



The JNDI DataSource for an XA database connection.

See Also



JobAbortRequested



If this job has been requested to abort.

See Also



JobPauseRequested



Pause or resume an IndexJob instance

See Also



JobStatus



Whether the job is running, finished, aborted, etc.

See Also



K


KeyServiceConnection



Specifies the parameters for connecting to the external service managing cryptographic keys on behalf on the Content Platform Engine.

See Also



KeyServiceType



Specifies the type of the external service managing cryptographic keys on behalf on the Content Platform Engine.

See Also



L


LabelBindValue



Label binding value for component relationship.

See Also



LastFailureReason



A description of the reason for the last processing failure for this object.

See Also



LastModifier



The name of the user who last modified this object.

See Also



LastProcessed



Indicates the last record processed.

See Also



LeaseDuration



The amount of time a busy request will be allowed to be processed before another thread attempts to re-execute the request.

See Also



LeaseExpiryTime



The expiration time that the CurrentIndexServer has exclusive write access to this text search index.

See Also



LeaseHolderId



An ID assigned to a batch of objects leased for processing.

See Also



LifecycleOperation



The lifecycle operation performed on the source object.

See Also



LoadId



Unique identifier for the batch in which the report was loaded.

See Also



LocalDomain



The local domain.

See Also



LocalGroupsEnabled



Enables use of local groups for this domain.

See Also



LocaleName



Indicates the name of the locale this object is currently operating in.

See Also



LocaleNames



The list of locales this object supports.

See Also



LocalizedText



The text in a specific locale.

See Also



LockOwner



A string supplied by the WebDAV client when a lock is applied that describes the owner of the lock.

See Also



LockTimeout



The number of seconds beyond the last modified date that the server will retain a lock.

See Also



LockToken



The token used by a WebDAV client to signal a lock on this resource.

See Also



LowerDirectoryCount



The number of directories in the lower level of two-tier structure for storing content in a File System Storage Device.

See Also



M


MajorVersionNumber



The major version number for this document version.

See Also



ManagedUserStatus



The status of the managed user.

See Also



ManagerClass



The full name of the Java class providing the implementatio of the CredentialsManager interface.

See Also



MappableDirection



Specifies the replication direction with respect to which a mapping of the external property to or from a Content Engine property may be defined.

See Also



Marking



A Marking that is applied to an object for access control purposes

See Also



MarkingSet



The object giving the Marking Set for the property

See Also



MarkingSetCacheEntryTTL



Time-To-Live (TTL) for entries in the marking set cache.

See Also



MarkingSetCacheMaxEntries



Maximum number of entries allowed in the marking set cache.

See Also



MarkingSets



A list of MarkingSets.

See Also



MarkingUseGranted



The effective access the user has for a Marking object

See Also



MarkingValue



The value of the marking.

See Also



Markings



A list of Markings.

See Also



MaxBatchSize



The maximum batch size used during full text index creation.

See Also



MaxDispatcherThreads



The maximum of number of threads that may be allocated for processing of background dispatcher tasks.

See Also



MaxEventCollectorThreads



The maximum number of threads permitted in the collector pool.

See Also



MaxEventExporterThreads



The maximum number of threads permitted in the exporter pool.

See Also



MaxHeartbeatThreads



The maximum number of threads permitted in the Process Engine heartbeat pool.

See Also



MaxInMemoryElementState



Maximum number of content cache elements to keep state about in-memory.

See Also



MaxInMemoryItems



The maximum [un-dispatched] batches allowed in the in-memory CFS Federation Request queue

See Also



MaxInMemoryQueueItems



The maximum [un-dispatched] batches allowed in the in-memory Content Queue per Object Store

See Also



MaxInboundWorkers



The maximum number of worker threads to operate inbound replication processing.

See Also



MaxIndexes



The maximum number of indexes to create in this index area

See Also



MaxObjectsPerIndex



The maximum number of objects that a full text index can contain.

See Also



MaxOutboundWorkers



The maximum number of worker threads to operate outbound replication processing.

See Also



MaxPrimaryThreads



The maximum number of threads permitted in the Process Engine primary pool.

See Also



MaxQueryTimeLimit



The maximum amount of time that the server will allow a query to run (cannot be overridden on a per-query basis).

See Also



MaxReaderSemaphoreWaitTime



The maximum waiting time to get a read semaphore for read operation before the system fails the operation.

See Also



MaxRequestQueueSize



The maximum number of incomplete index requests queued for an index job.

See Also



MaxResolutionBatchSize



The maximum number of Content Queue items that will be resolved within the context of a single database delete statement

See Also



MaxRollingFileBackups



Specifies the number of previous system and trace log files that are kept as rollover occurs.

See Also



MaxRollingFileSize



Specifies the maximum size in bytes to which a system or trace log file can grow before logging will roll over into a new file.

See Also



MaxSecondaryThreads



The maximum number of threads permitted in the Process Engine secondary pool.

See Also



MaxSizePerIndexKbytes



The maximum size in KB that a full text index can have

See Also



MaxSweepWorkers



The maximum number of workers that may be allocated for processing a sweep

See Also



MaxTextFiltersPerBatch



Maximum number of text filters per batch

See Also



MaxThumbnailGenerationProcesses



The maximum number of concurrent external thumbnail generation processes that can be launched.

See Also



MaxWorkerThreads



The maximum of number of threads that may be allocated for processing of background work.

See Also



MaximumConcurrentIndexingBatches



Defines the maximum number of concurrent indexing batches that should be submitted to the server.

See Also



MaximumContentElements



The maximum number of content elements allowed in a Storage Area.

See Also



MaximumConversionQueueSize



Specifies the maximum size to which the internal queue of content conversion work items can grow before attempts to insert new items will block.

See Also



MaximumConversionWorkers



Specifies the maximum number of background workers to be engaged in content conversion activity.

See Also



MaximumExaminedRowCount



Specifies the number of rows the background search should examine before stopping. A value of zero indicates that all rows be examined.

See Also



MaximumFailures



The maximum number of times a dequeue operation for a Queue Sweep will be retried following a failure

See Also



MaximumLengthBinary



The maximum length, in bytes, of a value for the described property.

See Also



MaximumLengthString



The maximum length, in characters (excluding the null terminator), of a value for the described property.

See Also



MaximumPreprocessingQueueSize



Specifies the maximum size to which the internal queue of text indexing preprocessing work items can grow before attempts to insert new items will block.

See Also



MaximumPreprocessingWorkers



Specifies the maximum number of workers to be employed for text indexing preprocessing.

See Also



MaximumResultsWindow



The maximum number of results per query segment for indexes in this index area.

See Also



MaximumRetentionDays



The maximum retention period in days.

See Also



MaximumSizeKBytes



The maximum allowable content element size in a Storage Area.

See Also



MaximumTimeToLive



The maximum time, in minutes, a file will be maintained in the content cache if there is no further accesses of that file.

See Also



MaximumUploadBufferSize



The maximum amount of memory, in kilobytes, to devote to buffering uploaded content prior to writing to a storage area.

See Also



MemberOfGroups



A collection containing the groups of which a particular group or user is a member.

See Also



MemberPrincipal



Specifies the security principal that is a role member.

See Also



MemberRealm



Specifies the realm of which all users are members of the role.

See Also



MemberRole



References the role object whose members are to be treated as members of the containing role.

See Also



MetadataMergedScopeCacheMaxEntries



The maximum number of metadata merged scope caches that will be retained in memory.

See Also



MetadataTraceFlags



Trace flags corresponding to the Metadata subsystem. This value consists of a combination of TraceFlag constants.

See Also



MimeType



The MIME type of the document.

See Also



MinimumRetentionDays



The minimum retention period in days.

See Also



MinorVersionNumber



The minor version number for this document version.

See Also



ModificationAccessRequired



Specifies the access required to the object having the described property in order to be able to change the value of that property.

See Also



ModifiedProperties



A list of the symbolic names of the properties modified by the operation.

See Also



MoveContentLeaseThreshold



The number of seconds that must be remaining on the version series row lease to allow a move content operation to proceed.

See Also



MyRealm



The realm for the current user.

See Also



N


Name



Returns the value of the designated name property for the object, or its ID if there is no name property.

See Also



NamePropertyIndex



The index of the property that serves as the 'name' for instances of the class being described.

See Also



NeverDeleteClipsOrContent



When set to True this property prevents deletion of any content element or clip managed by the device.

See Also



NextOverflowTableDefinition



References the table definition corresponding to the table that was created as a result of overflow table creation.

See Also



NextRetryDate



The date and time the queue item will next be retried.

See Also



NextStartTime



The earliest time the next sweep iteration can start

See Also



NoWorkDelay



The time in milliseconds that an Import Agent waits when there is no work.

See Also



NonPagedQueryMaxSize



The maximum size of a non-paged query result set.

See Also



NumImportAgents



The number of ImportAgent worker threads.

See Also



O


ObjectSecurityCacheEntryTTL



Time-To-Live (TTL) for entries in the object-security cache.

See Also



ObjectSecurityCacheMaxEntries



Maximum number of entries allowed in the object-security cache.

See Also



ObjectStateRecordingLevel



The level of recording performed relative to the target object of the audited event.

See Also



ObjectStore



An object representing the object store in which the object resides.

See Also



ObjectStoreId



The persistent ID that identifies this object store.

See Also



ObjectStoreSchemaDB2



The default SQL script used to create an ObjectStore's tables within a DB2 database.

See Also



ObjectStoreSchemaMSSQL



The default SQL script used to create an ObjectStore's tables within a SQL Server database.

See Also



ObjectStoreSchemaMySQL



The default SQL script used to create an ObjectStore's tables within a MySQL database.

See Also



ObjectStoreSchemaOracle



The default SQL script used to create an ObjectStore's tables within an Oracle database.

See Also



ObjectStoreSchemaPostgreSQL



The default SQL script used to create an ObjectStore's tables within an PostgreSQL database.

See Also



ObjectStores



A collection of ObjectStore objects.

See Also



OpenStackAuthenticationURL



The URL for the OpenStack authentication service.

See Also



OpenStackContainerName



The name of the OpenStack container in which content is stored.

See Also



OperationData



Data for the operation.

See Also



OrderByGroupedProperties



Indicates whether the properties specified in the background search GROUP BY clause should be included in the underlying ORDER BY clause (if applicable).

See Also



OriginalClassId



The class ID of the original object.

See Also



OriginalCreator



The creator of the original object.

See Also



OriginalDateCreated



The creation date of the original object.

See Also



OriginalDateLastModified



The last modification date of the original object.

See Also



OriginalId



The ID of the original object.

See Also



OriginalLastModifier



The last modifier of the original object.

See Also



OriginalName



The name property value of the original object.

See Also



OriginalObject



The snapshot of the event's source object prior to the event.

See Also



OutboundBatchSize



The batch size for outbound replication processing.

See Also



OutboundBusyWaitInterval



The time in seconds the outbound dispatcher should wait before looking for more work after completing a batch of work.

See Also



OutboundDispatcherEnabled



Indicates whether the outbound background task associated with the object is currently enabled.

See Also



OutboundIdleWaitInterval



The time in seconds the outbound dispatcher should wait before looking for more work after exhausting all that is available.

See Also



OutputLocation



Path to the tracing output location. The default path will be the 'filenet' directory located under the application server instance's working directory.

See Also



Owner



The security owner of the object.

See Also



OwnerDocument



Points to the publication source document, if this document is a publication and there is a cascade delete relationship with the source.

See Also



P


PEConnectionPoints



The list of PE connection points that are available in the IBM Content Cortex domain.

See Also



Parent



The object that directly contains this object.

See Also



ParentComponent



Parent component in a compound document structure.

See Also



ParentDocuments



Return, security permitting, enumeration of parent component documents.

See Also



ParentRelationships



Return enumeration of parent component relationship objects.

See Also



PartialResolutionChunkSize



The number of Content Queue items to be resolved using a single delete statement, when a batch is resolved in chunks.

See Also



PartitionDateInterval



The length of time in months that each full text index will span for partitioning.

See Also



PartitionPropertyName



The name of a property that will be used for text search index partitioning.

See Also



PartitionStringValue



The partitioning string property value used as a partitioning constraint for this index.

See Also



PartitioningProperties



The index partitioning properties in an object store.

See Also



PartnerObjectStore



Defines the object store that will act as the partner of the external repository in the replication group.

See Also



PathName



The full path name for the folder.

See Also



PermissionDescriptions



A list of descriptions of permissions applicable to objects of the described class.

See Also



PermissionSource



Indicates the source of the permission.

See Also



PermissionType



The type (right or level) of the described permission.

See Also



Permissions



The discretionary permissions for the object.

See Also



PersistenceType



Indicates whether the entity can be made persistent and its method of persistence

See Also



PolicyControlledSweepBatchSize



The batch size for Policy Controlled Sweeps

See Also



PolicyControlledSweeps



An enumeration of Policy Controlled Sweeps related to this object store

See Also



PoolAddress



The Centera Pool Address passed to FPPool as the 'PoolAddress' parameter.

See Also



PostCondition



A condition the task object must satisfy before it may be considered complete.

See Also



PreCondition



A condition the task object must satisfy in order to be considered ready to be worked upon.

See Also



PredecessorTask



Identifies the predecessor in the relationship between tasks.

See Also



Predecessors



An enumeration of task relationships objects identifying the predecessors of this task.

See Also



PreloadOnCreate



Enables or disables the preloading of content in the cache when content is created.

See Also



PreprocessingWorkerIdleTimeout



Specifies the maximum period in seconds for which a text indexing preprocessing worker can be idle before terminating.

See Also



Prerequisites



Indicates which add-ons are required prior to installation of this add-on.

See Also



PreserveDirectPermissions



Determines whether or not direct access control entries will be preserved when this template is applied

See Also



PrimaryId



The primary DMA ID of the entity.

See Also



PrincipalCacheEntryTTL



Time-To-Live (TTL) for entries in the principal cache.

See Also



PrincipalCacheMaxEntries



Maximum number of entries allowed in the principal cache.

See Also



PrincipalCategory



Defines the category applied to users and groups in this directory realm.

See Also



Priority



Orders the firing of subscriptions in response to an event.

See Also



PrivilegedSettability



Defines the settability of the property when user has privileged write access.

See Also



ProcessEngineEnabled



Indicates whether the Process Engine associated with the object is currently enabled.

See Also



ProcessedObjectCount



The total number of objects processed by the sweep.

See Also



ProgId



The COM Prog ID of the code that implements this object.

See Also



ProperSubclassPropertyDescriptions



A list of all properties of all the subclasses of the current class.

See Also



PropertyDefaultBinary



The default binary value for this property.

See Also



PropertyDefaultBoolean



The default Boolean value for this property.

See Also



PropertyDefaultDateTime



The default date/time value for this property.

See Also



PropertyDefaultFloat64



The default float value for this property.

See Also



PropertyDefaultId



The default ID value for this property.

See Also



PropertyDefaultInteger32



The default integer value for this property.

See Also



PropertyDefaultObject



The default object for this property.

See Also



PropertyDefaultString



The default string value for this property.

See Also



PropertyDefinitions



A list of the definition objects for the properties of the class.

See Also



PropertyDescriptions



Describes this class's properties.

See Also



PropertyDisplayCategory



A string used to group related properties together for display.

See Also



PropertyDisplayName



The display name of the property to which a marking is assigned

See Also



PropertyIdentity



The unique identifier of the external class property.

See Also



PropertyMap



A list of mappings between properties of the object and fields of the workflow.

See Also



PropertyMaximumDateTime



The maximum value acceptable for this property.

See Also



PropertyMaximumFloat64



The maximum value acceptable for this property.

See Also



PropertyMaximumInteger32



The maximum value acceptable for this property.

See Also



PropertyMinimumDateTime



The minimum value acceptable for this property.

See Also



PropertyMinimumFloat64



The minimum value acceptable for this property.

See Also



PropertyMinimumInteger32



The minimum value acceptable for this property.

See Also



PropertySelectionBinary



The list of binary values that can be assigned to this property.

See Also



PropertySelectionsBoolean



The list of Boolean values that can be assigned to this property.

See Also



PropertySelectionsDateTime



The list of date/time values that can be assigned to this property.

See Also



PropertySelectionsFloat64



The list of float values that can be assigned to this property.

See Also



PropertySelectionsId



The list of ID values that can be assigned to this property.

See Also



PropertySelectionsInteger32



The list of integer values that can be assigned to this property.

See Also



PropertySelectionsObject



List of the objects that can be assigned to this property.

See Also



PropertySelectionsString



The list of string values that can be assigned to this property.

See Also



PropertyTemplate



The definition object for the property template from which the class property derives.

See Also



PropertyTemplates



An enumeration of all currently defined property templates.

See Also



ProtectedPropertyCount



Specifies the number of property definitions that can neither be moved nor removed from the class definition.

See Also



PruneAmount



The percentage of elements and/or size to prune when the content cache threshold is reached.

See Also



PruneThresholdContentElements



The threshold where content cache pruning begins. When the total number of content elements exceeds this level.

See Also



PruneThresholdSizeKBytes



The threshold where content cache pruning begins. When the total size of content elements exceeds this level, in KBytes.

See Also



PublicationInfo



Contains XML that specifies the parameters used when the document was published.

See Also



PublishTraceFlags



Trace flags corresponding to the Publish subsystem. This value consists of a combination of TraceFlag constants.

See Also



PublishingSubsidiaryFolder



Points to subsidiary folder object which contains the subsidiary objects of a HTML publication.

See Also



Q


QueriedObject



The queried document object that provided the content searched.

See Also



QueryCountDefaultSize



The default lookahead amount for query result count estimation.

See Also



QueryCountMaxSize



The maximum lookahead amount for query result count estimation.

See Also



QueryDatabaseTimeout



Specifies the timeout in seconds applied to each database query performed as part of a search operation.

See Also



QueryPageDefaultSize



The default size of a query page in a result set.

See Also



QueryPageMaxSize



The maximum size for a query page in a result set.

See Also



QueryText



The original query text from which the query was generated.

See Also



QueueEntryStatus



The status of the queue entry.

See Also



QueueItemDatabaseTimeout



Database timeout for queue items

See Also



QueueItemMaxDispatchers



Maximum number of dispatchers.

See Also



QueueItemRetryCount



The number of retries for queue items

See Also



QueueSweepLeaseDuration



The amount a time a busy Queue Sweep request will be allowed to processed before another thread attempts to re-execute the request

See Also



QueueSweeps



An enumeration of Queue Sweeps related to this object store

See Also



QueuedObject



The object that is the subject of the queued operation.

See Also



R


Rank



Level of importance given documents returned in content query.

See Also



Realm



The Realm to which the entity belongs.

See Also



RealmDirectoryType



The type of directory from which this Realm was materialised.

See Also



RecordFailures



A flag on Sweep Jobs that indicates whether or not failure records will be recorded

See Also



RecoverableObjectsCount



The total number of objects that may be recovered through the recovery item.

See Also



RecoveryBin



The container of the recoverable object.

See Also



RecoveryItems



A collection of the recovery items that have been placed into the recovery bin.

See Also



ReferencingActions



A collection of the action objects referencing this object.

See Also



ReflectivePropertyId



The ID of a property of the object referenced by the described property which reflects back the object having the described property.

See Also



ReleasedVersion



The latest released major version of this version series.

See Also



RemovalIndexationId



An update to a full index will be moved to a different index. The Removal Indexation Id is the Id of the full index where the entry is to be removed.

See Also



RenameFileRetryAttempts



The number of times a file rename will be attempted (from the inbound to the content directory during content finalization) before the request will be returned to the queue for future processing.

See Also



ReplicaSynchronizationType



Defines if content should be written synchronously or be asynchronous replicated to the storage device.

See Also



ReplicableDirection



Specifies the direction in which instances of the described external class may be replicated.

See Also



ReplicationData



Additional data pertaining to the external replica object.

See Also



ReplicationGroup



A reference to the replication group to which the object is affiliated.

See Also



ReplicationGroups



An enumeration of the replication groups defined in the domain,

See Also



ReplicationMode



The mode in which the repository participates in the replication group.

See Also



ReplicationOperation



The operation represented by the journal entry.

See Also



ReplicationParticipants



A list defining the repositories that participate in the replication group.

See Also



ReplicationStatus



The processing status of the journal entry.

See Also



ReplicationTraceFlags



Trace flags for the replication subsystem.

See Also



Report



The report object with which the section is associated.

See Also



RequiredClass



The class to which the object(s) will conform.

See Also



RequiredClassId



The primary ID for the class to which values of the property must conform.

See Also



RequiresUniqueElements



Specifies whether the elements of the list must be unique.

See Also



Reservation



The reservation of the current version series.

See Also



ReservationType



Indicates the type (collaborative or exclusive) of the reservation.

See Also



ResetLifecycleOnCheckin



Indicates whether to reset lifecycle to its initial state when checking in a document.

See Also



ResourceStatus



Open, closed, full, or standby status

See Also



ResourceString



A provider specific free form string value that can be used as input to content creation

See Also



RestrictMembershipToConfiguredRealms



Restrict group membership search within configured realms

See Also



ResyncModificationDate



A UTC date/time value representing the earliest DateLastModified an indexed object could have and not be possibly stale in the index. If specified, any object present in the index whose DateLastModified is after this will be reindexed.

See Also



RetentionDurationUpdate



The duration of the retention period that will be applied to object selected by the Retention Update Policy

See Also



RetentionPeriod



Number of minutes until the content element expires and can be deleted

See Also



RetentionPeriodUnits



Specifies the time units in which a retention period associated with the object is expressed.

See Also



RetrievalName



Suggested name suffix for the file into which the document content should be retrieved for editing.

See Also



RetrievalRetryAttempts



The number of times the content retriever will search for a content element file (inbound & content directories) before failing a retrieval request.

See Also



RetrievalTimeout



Maximum time to wait for a response that starts returning content.

See Also



RetryCount



The number of remaining attempts to process the queue item.

See Also



ReturnNameAsDN



Flag to indicate whether to return name as DN for Active Directory security provider.

See Also



Role



A reference to the role through which the permission grants access.

See Also



RoleAccessDefinitions



The list of access-defining objects for the role class.

See Also



RoleCacheCheckInterval



Defines the period in seconds between checks for updates to cached roles.

See Also



RoleCacheEntryTTL



The time-to-live (TTL) for entries in the role cache.

See Also



RoleCacheMaxEntries



The maximum number of entries allowed in the role cache.

See Also



RoleMembers



A list of objects defining the membership of the role.

See Also



RoleMembershipAction



Defines the membership handler for roles of this class.

See Also



RollFwdBatchRetryAttempts



The number of roll-forward batch retry attempts against the Content Queue that will be tried before returning the batch to the queue for future processing

See Also



RootClassDefinitions



An enumeration of the root mutable class definitions.

See Also



RootDirectoryPath



The path to the root directory used for file storage.

See Also



RootFolder



The folder at the root of the folder hierarchy.

See Also



S


S3BucketName



Specifies the name of the bucket into which content should be stored in the S3 device.

See Also



S3RegionName



The name of the region for the S3 device.

See Also



S3SecurityToken



The security token for accessing the S3 device.

See Also



SCIMAuthenticationURL



The URL through which to obtain an authentication token for access to the SCIM service.

See Also



SCIMContextPath



The path component of the URL used to access the SCIM service.

See Also



SCIMServiceType



Specifies the type of service providing the SCIM directory interface.

See Also



SMTPHostName



SMTP server hostname.

See Also



SMTPPort



SMTP server port.

See Also



SMTPServerLoginID



SMTP server login ID.

See Also



SMTPServerLoginPassword



SMTP server login password.

See Also



SSITraceFlags



Trace flags corresponding to the SSI subsystem. This value consists of a combination of TraceFlag constants.

See Also



SchemaVersion



The current version string corresponding the ObjectStore's database schema.

See Also



ScriptText



The script text.

See Also



ScriptType



Specifies the engine to be used to execute the script (VB, Java, etc.)

See Also



SearchCrossForestGroupMembership



Flag for enable/disable Active Directory security provider search cross forest group membership.

See Also



SearchDynamicGroup



do we want to search Dynamic Groups as well

See Also



SearchExpression



The Content Platform Engine SQL expression used in the background search.

See Also



SearchObjectStore



Indicates the object store against which this background search should execute.

See Also



SearchResults



The current enumeration of search results objects corresponding to the background search.

See Also



SearchTraceFlags



Trace flags corresponding to the Search subsystem. This value consists of a combination of TraceFlag constants.

See Also



SearchType



Defines an object as either a Stored Search or Search Template.

See Also



SearchingObjectStores



Defines which object stores to search.

See Also



SearchingObjectType



Defines type of object store search.

See Also



SectionClass



The class of the section objects associated with the report.

See Also



SectionIndex



The zero-based index of the section within the ordered collection associated with the same report.

See Also



Sections



A collection of the sections associated with the report.

See Also



SecurityDescCacheMaxEntries



Maximum number of entries allowed in the security descriptor cache.

See Also



SecurityFolder



Partial security proxy defined for inherited access control

See Also



SecurityIdMappingCacheMaxEntries



Specifies the maximum number of entries to include in the security id mapping cache.

See Also



SecurityParent



The object from which this object inherits security.

See Also



SecurityPolicies



An enumeration of all currently defined Security Policy objects

See Also



SecurityPolicy



The Security Policy associated with this object

See Also



SecurityProxyType



Specifies the manner in which setting a value for the described property establishes a security proxy for the object.

See Also



SecurityTemplates



The list of Security Templates managed by this Security Policy

See Also



SecurityTraceFlags



Trace flags corresponding to the Security subsystem. This value consists of a combination of TraceFlag constants.

See Also



SequenceNumber



Indicates the sequence number of the index request in the database.

See Also



ServerCommunicationCertificateValidationEnabled



Specifies if a source server engaging in server-to-server communication with this server as the destination over HTTPS should perform host name and certificate chain validation on this server's certificate.

See Also



ServerCommunicationTraceFlags



Trace flags for the server communication subsystem.

See Also



ServerCommunicationURL



Specifies the web service endpoint URL to be used for server-to-server communcation directed at this virtual server.

See Also



ServerInstances



Enumeration of server instance objects.

See Also



Settability



Defines the settability of the property.

See Also



ShortName



The short name of a given group or user.

See Also



SingleItem



The single item to be indexed.

See Also



Site



The site associated with this object

See Also



SiteSettings



The Site Settings associated with the object.

See Also



Sites



Enumeration of site objects.

See Also



SnapLockPassword



The password for the security principal identified by the SnapLockUserName property.

See Also



SnapLockUserName



Security Principal used to connect to remote SnapLock device.

See Also



SortOrder



Specifies the sort order of the indexed column.

See Also



SourceClassId



Class ID of object that is the subject of this event.

See Also



SourceContentRetained



Indicates that the source content was subject to device retention and was not deleted by the Move Content operation.

See Also



SourceDatabaseConnection



The database connection corresponding to the source location from which events should be exported.

See Also



SourceDatabaseSchemaName



The database schema name corresponding to the source database connection from which events should be exported.

See Also



SourceDocument



Points to the publication source document, if this document is a publication.

See Also



SourceObject



The snapshot of the object which is the source of this event at the time the event occurred.

See Also



SourceObjectId



ID of the object that is the subject of this event.

See Also



SourceObjectStore



An object representing the source object store from which events should be exported.

See Also



SourceRepositoryName



Name of the repository that is the source of documents federated by the CFS IICE Federation Service

See Also



SpecificRetentionDate



Specifies a an absolute retention date that will be applied to objects affected by this retention update policy

See Also



StagingAreaPath



A path string that refers to the file system directory location that will be used to temporarily store fixed content prior to uploading it to a fixed content device.

See Also



StartDate



Objects indexed in this Collection will have partitioning dates no earlier than this date.

See Also



StartMinutesPastMidnight



Indicates the time of day the task should start. This is the integer value of minutes past midnight, relative to the local time of the server running the background task.

See Also



StateName



The name of a valid state defined in a document lifecycle policy.

See Also



StorageArea



The Storage Area this object is stored in.

See Also



StorageAreas



A collection of Storage Areas.

See Also



StorageDevice



The storage device associated with this object.

See Also



StorageLocation



The storage location for the document.

See Also



StoragePolicies



A collection of all the storage policies defined in the object store.

See Also



StoragePolicy



The storage policy for the document.

See Also



SubFolders



A collection of the child folders.

See Also



Subject



Suggested subject prefix for a workflow launch.

See Also



SubjectCacheEntryTTL



Time-To-Live (TTL) for entries in the subject cache.

See Also



SubjectCacheMaxEntries



Maximum number of entries allowed in the subject cache.

See Also



SubmittedCount



The number of objects that have been submitted for indexing.

See Also



SubscribedEvents



A list of objects defining the events to which the subscription applies.

See Also



SubscriptionCacheMaxEntries



The maximum number of subscribed events to store in the subscription cache. If more subscribed events exist, the cache will not be used. If this setting is zero, caching will be disabled.

See Also



SubscriptionTarget



The target object of the subscription.

See Also



Subscriptions



A collection of the event subscriptions associated with this object.

See Also



SubsystemConfigurations



A list of subsystem configuration objects that reflect parameters of the configured subsystems.

See Also



SuccessorTask



Identifies the successor in the relationship between tasks.

See Also



Successors



An enumeration of task relationships objects identifying the successors of this task.

See Also



SuperclassDefinition



The definition object for the superclass of the current class.

See Also



SuperclassDescription



Describes the class that is the immediate superclass of the current class in the DMA property class hierarchy.

See Also



SuperclassIdentity



The unique identity of the superclass of the external class.

See Also



SuperclassPropertyCount



The number of properties in the immediate superclass (and therefore inherited by this class).

See Also



SupersededAddOnIds



The IDs of AddOns superseded by this AddOn.

See Also



SupportedAnalyzers



A list of the analyzers supported by this Elastic Search cluster.

See Also



SupportedConsumers



Specifies the metadata classes of the types of object which can consume credentials this manager can provide.

See Also



SupportedLanguages



Text Search Server supported languages

See Also



Sweep



The Policy Controlled Sweep instance in this relationship

See Also



SweepAction



Specifies the instance of CmSweepAction that contains the user defined behavior for a Custom Sweep

See Also



SweepBatchSize



The number of candidate objects that will be passed to the Sweep handler in a single batch

See Also



SweepEndDate



A timestamp indicating the sweep has completed and when. If NULL, the sweep has not completed yet.

See Also



SweepJobLeaseDuration



The amount a time a busy Sweep Job request will be allowed to processed before another thread attempts to re-execute the request

See Also



SweepJobs



An enumeration of Sweep Jobs related to this object store

See Also



SweepMode



The mode under which a Sweep Job or Policy will execute

See Also



SweepPolicies



An enumeration of Sweep Policies related to this object store

See Also



SweepResultIterationKeepCount



The number of sweep iterations for which a sweep result will be preserved before it is automatically deleted

See Also



SweepResultType



Identifies the type of this Sweep Result

See Also



SweepResults



An enumeration of Sweep Results related to a Sweep Policy or Sweep job

See Also



SweepRetryWaitInterval



The minimum number of seconds after retriable exception has occurred during the processing of a sweep batch before another attempt will be made to process the batch

See Also



SweepStartDate



A timestamp indicating the sweep is in progress and when it started. Null means no sweep is currently in progress

See Also



SweepSubscriber



The subscribing sweep policy in this relationship

See Also



SweepSubscribers



A collection of Sweep Relationship objects referencing policy objects subscribing to this Policy Controlled Sweep

See Also



SweepSubscriptions



An enumeration of Sweep Relationships that identify the Policy Controlled Sweeps related to this Sweep Policy

See Also



SweepTarget



Specifies the class for which instances will be swept

See Also



SweepTimeslots



A list of Timeslot objects that determine the schedule for sweep processing.

See Also



SweepTraceFlags



Trace flags for the sweep subsystem.

See Also



SymbolicName



The programmatic identifier for the metadata entity.

See Also



SynchronousReplicationSupported



Indicates if the storage device can be configured as a synchronous replica.

See Also



SystemUserName



The name for the system user account.

See Also



SystemUserPassword



The password for the system user account.

See Also



T


TSMApplicationType



A free format string that identifies the application to the TSM server.

See Also



TSMArchiveProtectionFlag



Corresponds to ENABLEARCHIVERETENTIONPROTECTION in TSM server options file

See Also



TSMCompressionFlag



Corresponds to COMPression parameter in TSM server options file

See Also



TSMConcurrentTapeReaders



Specifies how many concurrent users may read from tape in a CE server instance. This value should be equal to the number of tape drives available in the TSM tape library.

See Also



TSMConfigurationFilesShare



Full path to the device configuration file root directory. This directory must already exist and the Content Engine must have read/write access to the directory.

See Also



TSMDSMIDirectory



A fully-qualified directory path that contains a message file on UNIX or Linux systems. This value should not be populated for Windows systems.

See Also



TSMFilespaceName



TSM file space name used to archive and retrieve TSM objects

See Also



TSMManagementClasses



A collection of the TSM Management classes defined on the TSM Server.

See Also



TSMMinimumRetention



Specifies the minimum days an object will be retained. Only applies when TSMRetentionInitiation = EVENT (i.e. 1).

See Also



TSMMountWaitDuration



Define how long to wait for content stored on tape in the TSM server. Requests that exceed this wait period will be terminated with an error.

See Also



TSMNodeName



TSM client node name used to connect to the TSM server. All Content Engine objects archived to TSM will be written and retrieved under this node name.

See Also



TSMOptions



Configuration options string. This is passed to the TSM server to override settings in TSM configuration files.

See Also



TSMOwnerName



TSM owner name used when connecting to the TSM server, and when creating or retrieving TSM content objects

See Also



TSMPassword



TSM node password

See Also



TSMPort



TSM server Port

See Also



TSMRetentionInitiation



Specifies when the retention specified by TSMRetentionPeriod will be started, the options are on CREATION of the object (TSMRetentionInitiation=0), or on activation EVENT (TSMRetentionInitiation=1).

See Also



TSMRetentionPeriod



The number of days to retain the archive object

See Also



TSMServerAddress



TSM server's IP address

See Also



TSMWriteBufferSize



Buffer size (bytes) to use when transferring content from Content Engine to TSM server

See Also



TableDefinition



The table definition object for the table in which the entity resides.

See Also



TableDefinitions



A collection of Table Definition objects associated with the object.

See Also



TableName



The name of the table.

See Also



TableOverflowEnabled



Indicates whether overflow tables can be created or not. The default value is false.

See Also



Tail



The independently persistable object at the Tail end of the binary relationship.

See Also



TargetAccessRequired



A bitmask specifying the access required to an object intended as a target (referenced value) for the described property.

See Also



TargetClass



The class under which the XML document should be classified.

See Also



TargetObjectStore



The default or required object store to which objects beloging to this entity are to be federated/replicated.

See Also



TaskState



The state of the task.

See Also



TempDBContentLifetime



The number of seconds temporary content can exist in the database before being considered abandoned

See Also



TempDirectoryPath



The path to the directory used for temporary file storage.

See Also



TempFileLifetime



The number of seconds temporary files can exist in the inbound directory before being eligible to be considered abandoned

See Also



TemplatePermissionDescriptions



A list of descriptions of permissions applicable to the template.

See Also



TemplatePermissions



The template discretionary permissions.

See Also



TenantFilter



Specifies a list of tenant names for which trace logging should take place.

See Also



Tenants



An enumeration of the Tenants associated with this domain.

See Also



TextExtractionBatchSize



Specifies the maximum number of text extraction requests processed in a batch.

See Also



TextFilterTimeout



Text filter timeout, after this the text filter process will be killed

See Also



TextIndexingPreprocessorAction



Specifies the handler for the defined text indexing preprocessor.

See Also



TextIndexingPreprocessorDefinitions



A list of text indexing preprocessors associated with the defined class.

See Also



TextSearchAffinityGroups



An enumeration of Text Search Affinity Groups objects that exist in this Domain

See Also



TextSearchCredential



Credential (i.e. authentication token) required to connect to a IBM Text Search Server

See Also



TextSearchEnabled



Enable this object store for full text search.

See Also



TextSearchIndexes



The Text Search indexes associated to this index area

See Also



TextSearchIndexingLanguages



The list of languages used for the Text Search Indexing on this object store. The list should contain zero or more language codes from the ECMTS supported languages.

See Also



TextSearchServerHost



Host name for IBM Text Search server

See Also



TextSearchServerMode



Specifies the usage mode of the IBM Text Search Server (e.g., searching, indexing, both, disabled).

See Also



TextSearchServerPort



Port for IBM Text Search server

See Also



TextSearchServerShutdownOnDisable



Control whether a shut down request is sent to text search server when the CmTextSearchServer status is changed to DISABLED.

See Also



TextSearchServerStatus



Specifies the status of the IBM Text Search Server (e.g., enabled, disabled, unavailable).

See Also



TextSearchServers



Collection of Text Search Servers on Domain

See Also



TextSearchThreadCount



The number of threads to use for a user's search request to concurrently query relevant text search indexes.

See Also



This



Enables the expression of relationships among objects in DMA queries and selects candidate objects in query results.

See Also



ThreadCount



The number of threads to use for background processing.

See Also



ThreadSubsystemsEnabled



Configures trace filtering based on the type of thread from which the logging is being generated.

See Also



ThumbnailGenerationBatchSize



The maximum number of files that can be processed by one Outside In thumbnail generation process

See Also



ThumbnailGenerationDelay



The minimum number of seconds to delay generation of thumbnails for newly added content.

See Also



ThumbnailGenerationProcessTimeOut



The time out in seconds for processing a single batch using the external the OutSide In thumbnail generation process

See Also



ThumbnailGenerationTempDir



The location of the content temporary directory for use in thumbnail generation

See Also



ThumbnailGenerationTraceFlags



Trace flags for controlling thumbnail generation logging. This value consists of a combination of TraceFlag constants.

See Also



ThumbnailTempFileLifeTime



The number of seconds temporary files can exist in the thumbnail temporary working directory before being eligible to be considered abandoned

See Also



TimeAllSubmitted



The time at which all the index requests have been submitted for this job. Does not indicate that all index requests are completed. Null if not all index requests submitted yet.

See Also



TimeLastProcessed



The last time an activity occurred on this job.

See Also



TimeOutSeconds



Timeout in seconds for retrieving content from the Image Server.

See Also



ToVersions



A list of IDs specifying the add-on version(s) which are logically produced as a result of applying this upgrade add-on.

See Also



TopFolders



A collection of folder objects that represent starting points for folder navigation.

See Also



TotalTextFiltersAllowed



Total number of text filters allowed per CE server

See Also



TraceLoggingEnabled



Indicates whether trace logging is currently enabled relative to this object instance.

See Also



TraceOptionsEnabled



Specifies the names of the options for which tracing is enabled.

See Also



U


URIValue



URI Value.

See Also



UnconfirmedUserCleanupIntervalDays



The period in days from creation after which an unconfirmed user record will be removed.

See Also



UpdateFailureDescription



A description of the last failure that occurred when processing an update to the number of shards or replicas for the index,

See Also



UpdateHeldUntilDate



The date and time until which the lease is held on the index for the purpose of updating the number of shards or replicas, or until which update processing is suspended pending a retry.

See Also



UpdateOperation



An integer indicating the type of shards or replicas update in progress for the index,

See Also



UpdateStoragePolicy



Specifies whether the move content sweep should update the storage policy of objects moved.

See Also



UpgradeStatus



Specifies the upgrade status of the domain.

See Also



UpperDirectoryCount



The number of directories in the upper level of two-tier structure for storing content in a File System Storage Device.

See Also



UseSequentialIds



Specifies whether object IDs should be assigned in a manner such that they are approximately ordered chronologically.

See Also



UseTokenGroups



Specifies whether to use the Active Directory tokenGroups attribute for retrieval of group memberships for a user.

See Also



UsedByAreas



An enumeration of the Advanced Storage Areas having a connection to this storage device.

See Also



UsedInClasses



An enumeration of the class definition objects having a property constructed from this property template.

See Also



UserBaseDN



The base DN for searching for users in the directory server.

See Also



UserDNAttribute



The attribute providing the distinguished name of the user.

See Also



UserDisplayNameAttribute



Directory server attribute used for user display name.

See Also



UserNameAttribute



Defines the directory server attribute to be used as the short name for a user.

See Also



UserSearchFilter



This property specifies search filter for user(s). It needs to be in the format like "(&(objectclass=user)(samAccountName={0}))", where samAccountName will serve as the short name.

See Also



UserString



A string with no built-in behavior.

See Also



UserTokenCacheEntryTTL



Time-To-Live (TTL) for entries in the user token cache.

See Also



UserTokenCacheMaxEntries



Maximum number of entries allowed in the user token cache.

See Also



UserUniqueIDAttribute



Which LDAP attribute is picked as user unique ID

See Also



Users



A collection of User objects.

See Also



UsesLongColumn



Specifies whether the property uses a long string database column to store its value.

See Also



V


VWVersion



Compiled form of a workflow definition.

See Also



ValidateCertificateHost



Specifies whether the host name in the certificate presented by the server when establishing an SSL connection should be validated.

See Also



ValidateServerCertificate



Specifies whether the certificate presented by the server when establishing an SSL connection should be validated.

See Also



VendorName



The name of the vendor.

See Also



VersionBindType



Enum value for version binding type in component relationship objects.

See Also



VersionSeries



The version series object with which this object is associated.

See Also



VersionSeriesId



The ID of the Version Series for the source object.

See Also



VersionStatus



The version status of this document version.

See Also



Versions



The enumeration of versions of the document.

See Also



VirtualServer



Parent virtual server.

See Also



VirtualServers



Enumeration of virtual server objects.

See Also



W


WSITraceFlags



Trace flags corresponding to the WSI subsystem. This value consists of a combination of TraceFlag constants.

See Also



WaitForQueueActivityDelay



The number of milliseconds the sweep framework dispatcher will wait when there is no queue activity

See Also



WaitForWorkersDelay



The number of milliseconds the sweep framework dispatcher will wait for workers to complete

See Also



WaitForWorkersShortDelay



The number of milliseconds the sweep framework dispatcher will wait before attempting retrying a deadlock

See Also



Weekday



Indicates the day of week the task should start. Sunday=0, Monday=1, ..., Saturday=6.

See Also



WorkerThreadIdleTimeout



Specifies the period in seconds after which an idle thread allocated for background worker task processing will be terminated.

See Also



WorkflowDefinition



The workflow definition associated with the object.

See Also



WorkflowDefinitions



A collection of workflow definition objects associated with the object.

See Also



WorkflowSourceSubscriptions



Enumeration of workflow subscription objects for which this object is the designated workflow definition.

See Also



WorkflowSubscriptions



Enumeration of workflow subscription objects whose target is this object.

See Also



X


XMLDocumentType



The type of XML document to which the script applies.

See Also



XMLPropertyMappingScripts



A collection of XML Property Mapping Script objects associated with the object.

See Also