The IIsolatedRegion type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | BrokerPort | Obsolete. |
![]() | ClassDescription |
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.) |
![]() | Creator |
Indicates the name of the user assigned as the creator of the object.
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. |
![]() | DatabaseConnection |
Defines the database connection attributes used by this object.
Set this property to a ICmDatabaseConnection
object, which defines the data sources to be used by the object.
For database connection sharing, set the same ICmDatabaseConnection object
on all object stores, event export stores, and isolated regions that will share the same database.
For an isolated region, if the ObjectStore property is set, then the server automatically sets this property and the DatabaseSchemaName property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the DatabaseSchemaName property. If the isolated region is used by IBM Case Manager, you must set the ObjectStore property. For an isolated region that uses a legacy workflow system, set DatabaseConnection and DatabaseSchemaName to values that reference the legacy system. |
![]() | DatabaseSchemaName |
Specifies the name of the schema in which the tables and indexes
for an object store, isolated region, or event export store reside.
The value serves as a qualified name for the database entities.
A unique value is required for database connection sharing. Database connection sharing is initiated when two or more object stores are configured to use the same ICmDatabaseConnection object. To distinguish between identically named tables associated with multiple object stores that share a database connections, enter a unique, case-insensitive value. The value cannot duplicate the DatabaseSchemaName value of another object store using the same database connections. The value will be prepended to database entities, for example, <schema name>.<table name>. If you do not set a value for an object store, the object store is initialized using the default schema applied by the database server, and this property is set to that default schema name provided it is not already in use by another object store using the same ICmDatabaseConnection object. For an isolated region, if the ObjectStore property is set, then the server automatically sets this property and the DatabaseConnection property to the same values as the object store's properties of the same name. You cannot change the object store-derived values on this or the DatabaseConnection property. If the isolated region is used by IBM Case Manager, you must set the ObjectStore property. For an isolated region that uses a legacy workflow system, set DatabaseConnection and DatabaseSchemaName to values that reference the legacy system. |
![]() | DateCreated |
Indicates the date and time the object was created. The Content Engine server stores dates and times using
Coordinated Universal Time (UTC). For more information, see
Timestamps.
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. |
![]() | DateLastModified |
Indicates the date and time the object was last modified. The Content Engine server stores dates and times
using Coordinated Universal Time (UTC). For more information, see
Timestamps.
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). |
![]() | DisplayName |
The user-readable, provider-specific name of an object. This property is usually the designated Name property of the object's class.
For ICmAuditProcessingBookmark and IAuditDefinition objects, this property is intended to identify client applications that process the audit log. For ICmAuditProcessingBookmark objects, this property, in support of the audit disposition feature, identifies the client that created the object. For IAuditDefinition objects, this property identifies a set of audit definitions for a given client or client functionality. For ICmAuditProcessingBookmark and IAuditDefinition objects, it is recommended that you set this property. Specify a unique value to distinguish one client application from another. Note, however, that the server does not prevent identical display names across multiple ICmAuditProcessingBookmark or IAuditDefinition objects. Therefore, the client application is responsible for enforcing uniqueness. |
![]() | DNSName | Obsolete.
Deprecated. The DNS (Domain Name System) name of the Process Engine server used to access this isolated region. |
![]() | ForceCaseInsensitiveSearch |
Determines whether searches operate in case-insensitive mode regardless of the configured behavior of the database.
For an ObjectStore object, this property determines whether searches in the represented object store operate in case-insensitive mode. For an IIsolatedRegion object, this property determines whether searches in the represented isolated region operate in case-insensitive mode. This setting can be configured independently of the case-insensitive mode setting of the object store that is associated with the isolated region. If this property is not set on an isolated region, the default behavior is to use the setting of the ForceCaseInsensitiveSearch property on the object store that is associated with the isolated region. |
![]() | Id |
A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created.
When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following
format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.
For IUser and IGroup classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, IUser.Id and IGroup.Id always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server. For a given property representation, the Id property has the following characteristics:
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. |
![]() | IsolatedRegionNumber |
The ID number identifying this isolated region.
If multiple isolated regions are associated with the same object store (as set on the ObjectStore property), then the isolated regions will share the same database connection as the object store. For the server to distinguish between isolated regions in the same database using the same database schema name, this property must be set to a unique value for each isolated region. A unique value is not required if the isolated region will not share a database connection with other isolated regions using the same database schema name. |
![]() | LastModifier |
Indicates the name of the user who last modified the object.
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). |
![]() | ObjectStore |
For IObjectStoreParticipant,
the object store of this object store participant of a replication group.
For IIsolatedRegion, the object store associated with the isolated region. If you set this property, the server automatically sets the DatabaseConnection and DatabaseSchemaName properties to the same values as the object store's properties of the same name, even if DatabaseConnection and DatabaseSchemaName were previously set to different values. Once set, this property cannot be modified. If the isolated region is used by IBM Case Manager, you must set the ObjectStore property. |
![]() | PEConnectionPoints |
A PEConnectionPointSet object containing the list of connection points (PEConnectionPoint instances) available
in this P8 domain.
|
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | RegionKey | Obsolete.
Deprecated. The encryption key for this isolated region. The region key is used to generate IBM FileNet P8 Identity Tokens for use between Process Engine applications and Process Engine servers. In the IBM FileNet P8 4.5 release, this key is generated by Content Engine, based on the RegionPassword property. In a future release, Process Engine will generate the isolated region key using the FIPS 140-2 compliant Advanced Encryption Standard (AES) algorithm. The key is then passed to the Content Engine and the value is stored on the Content Engine server in the GCD, encrypted with the Content Engine's master key. Because the datatype is binary, you should set the RegionKey property value through a secure channel (Secure Socket Layer, or SSL). If the value is set, retrieval of the region key returns a zero-length value; otherwise, returns null. Note Support for the isolated region key generation using a password will be discontinued in a future release. |
![]() | RegionPassword | Obsolete.
Deprecated. The isolated region password used to generate a region key for this isolated region. The isolated region key is persisted on the Content Engine server, but the password itself is not persisted anywhere. If this property value is retrieved, the client will get a zero-length value. Setting or resetting the password causes the region key to be regenerated. Note that the region key is used to generate P8 Identity Tokens for use between Process Engine applications and Process Engine servers. The region password that is entered for an isolated region must exactly match the region password that is entered when creating or editing the isolated region through the Process Engine admin tools. If these two passwords (and the region keys that are generated from them) do not match exactly, then Process Engine authentication will fail. The datatype is binary, because the password is encrypted before it goes across the wire. |
![]() | Site | Obsolete.
Identifies the site associated with a given object. A site represents a geographical area in the FileNet P8 domain.
If you do not specify a site when creating the associated object, the value of that object's Site
property defaults to the value of IDomain.DefaultSite.
Note that you cannot change the site directly on an IObjectStore object. To move an object store to a different site, you must change this property on the ICmDatabaseConnection object that is referenced by the IObjectStore object. For IIsolatedRegion, this property is deprecated. |