Contains the connection information necessary to access the Process Engine isolated region. This information is persisted in the GCD (Global Configuration Data).

An isolated region represents a logical subdivision of the Process Engine database. Each isolated region is referenced by one or more Process Engine connection points (PEConnectionPoint instances). The set of isolated regions defined is reflected in the Domain.IsolatedRegions property.

PEConnectionPointDomain

The following tables list the members exposed by IIsolatedRegion.

Public Properties

 NameDescription
Public propertyBrokerPortThe service port number used to access this isolated region.
Public propertyCreatorIndicates 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.

Public propertyDateCreatedIndicates the date and time the object was created. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

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.

Public propertyDateLastModifiedIndicates the date and time the object was last modified. The Content Engine stores dates and times using Coordinated Universal Time (UTC).

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).

Public propertyDNSNameThe DNS (Domain Name System) name of the Process Engine server used to access this isolated region.
Public propertyIdA 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:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.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.

Public propertyIsolatedRegionNumberThe unique ID number identifying this isolated region.
Public propertyLastModifierIndicates 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).

Public propertyRegionKeyThe 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.

Public propertyRegionPasswordThe 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.

Public propertySiteIdentifies 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 Domain.DefaultSite.
Top

See Also