This topic alphabetically lists the properties that apply to the StoragePolicy class.
EventSet
collection of the Event
objects containing the audited events that have occurred for the
object.
AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: Event
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
Settability of this property is read-only for most users. For users who have been
granted privileged write access (AccessRight.PRIVILEGED_WRITE
), this property is
settable only on create. After initial object creation, this property is read-only for all users.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 80
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: SETTABLE_ONLY_ON_CREATE
TargetAccessRequired: READ
Settability of this property is read-only for most users. For users who have been
granted privileged write access (AccessRight.PRIVILEGED_WRITE
), this property is
settable only on create. After initial object creation, this property is read-only for all users.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: SETTABLE_ONLY_ON_CREATE
TargetAccessRequired: READ
Settability of this property is read-only for most users. For users who have been granted privileged
write access (AccessRight.PRIVILEGED_WRITE
), this property is read/write. (The read/write access for those
users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that
object store).
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
The text is not locale-specific to the retrieving user except for the following classes:
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 255
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
MaximumLengthString: 64
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
ExternalIdentityList
collection of the ExternalIdentity
objects representing the
identities of replicas of this object in external repositories.
AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ExternalIdentity
RequiresUniqueElements: true
Settability: READ_WRITE
TargetAccessRequired: READ
For a StoragePolicy
object, FilterExpression
is used as the selection criteria
for determining into which storage area the content for a document or annotation should be stored. The
expression is evaluated against all storage areas to determine which ones are deemed "equivalent" in
terms of this storage policy.
For a Subscription
-based object, FilterExpression
is used to determine
whether the event action should be launched.
The filter is applied to either the source object, or optionally to the object specified by the
Subscription
-based object's FilteredPropertyId
property.
Note that for version series subscriptions,
the filter is applied to the document version in the transaction and not to the version series.
The filter evaluation occurs as part of processing an event's subscriptions. The Content Engine server evaluates the filter expression, as follows:
true
, the event specified by the subscription is fired
or enqueued, as appropriate (depending on whether the event code is set to execute synchronously or
asynchronously).false
or unknown
(typically resulting from a property that has no value),
or if there is an error in the evaluation (such as a syntax error in the expression or an incorrect
reference to a property), the event is silently discarded.Note If, in a document subscription that specifiesPublishRequestEvent
as a subscribed event,
you want to apply a filter expression to the document being published, you must set the subscription's FilteredPropertyId
property
to the PublishRequest
object's InputDocument
property.
(When you publish a document, a PublishRequest
object is created, which, at runtime, is the object that triggers PublishRequestEvent
,
not the document being published.)
For both a StoragePolicy
object and a Subscription
-based object,
the syntax of this property must be a fragment of a SQL where
-clause expression
(for example, VersionStatus = 1
) and use supported operators. Note that some operators
that are valid in a Content Engine query are not supported.
The following operators are not supported.
See SQL Syntax Reference.
Note that a filter expression can include conditions expressed against non-queryable and non-persistent properties. For example, the following is a valid expression: Owner='jsmith'
A filter expression using the IsClass operator must be constructed in the following fashion (not case-sensitive): IsClass(Source,<Class_id>). Class_id can be either a symbolic name or a GUID.
In a filter expression using the IN operator, the following conditions apply:
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: false
IsSearchable: true
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
For User
and Group
classes, the Id property takes the value of the
Security Identifier (SID) rather than the 128-bit GUID. The string representation of the
SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269
.
When Active Directory is used as the directory service for IBM FileNet P8, calls to
User.get_Id()
and Group.get_Id()
always return the current SID for the
principal, even if this user or group has only historical SIDs populating the Active
Directory server.
For a given property representation, the Id property has the following characteristics:
PropertyDescription.get_Id()
is equal to PropertyTemplate.get_Id()
, which is equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDefinition.get_PrimaryId()
.PropertyDefinition.get_Id()
is not equal to PropertyDescription.get_Id()
.
For a newly created document object, you can override the Id property of its associated VersionSeries
object
before you save or check in the document for the first time.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: GUID
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
Settability of this property is read-only for most users. For users who have been granted privileged
write access (AccessRight.PRIVILEGED_WRITE
), this property is read/write. (The read/write access for those
users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that
object store).
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 80
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
For most classes, this property is read-only and returns the value of the designated name property for the object,
or its ID if there is no name property. If ClassDescription.NamePropertyIndex
has a value,
this property contains the value of the designated name property. If there is no designated name property value, and
the object has an Id property, this property contains the string value of the Id property. If neither of these conditions
is satisfied, this property contains an empty string.
For a ComponentRelationship
object, this property is read/write and specifies the name of the object.
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: STRING
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE_OWNER
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE_ACL
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: DiscretionaryPermission
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
ReplicationGroup
object representing the replication group to
which this replicable object belongs.
AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE_ACL
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ReplicationGroup
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ
For a storage policy, this represents all storage areas (regardless of the ResourceStatus property value) that the policy references (the filter includes).
AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: StorageArea
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ
AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
Datatype: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: StoragePolicy
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ