The ISite type exposes the following members.
Properties
Type | Name | Description |
---|---|---|
![]() | ActiveDirectorySiteDNS |
Specifies the DNS site name listed under the Active Directory container.
For each site, set the value of this property to one DNS site under the Active Directory container "CN=Sites,CN=Configuration,DC=...".
Each FileNet P8 Site instance can be mapped to no specific DNS site or exactly one DNS site. If more than one site is configured for the FileNet P8 domain, and these sites are in different geographical locations, LDAP communication between the application server and the directory server might go across a WAN and performance might suffer. To alleviate this, you can set this property, which causes the API to search for all domain controllers for the given domain under that site. For example, you could set the value of this property to "Chicago". All domain controllers for the given domain under "CN=Chicago,CN=Sites,CN=Configuration,DC=..." are tested by attempting a connection. The first running domain controller is selected. |
![]() | CanAcceptForwardedRequests |
Determines if a Site accepts forwarded requests. The value of this property is True
if the Site accepts forwarded requests; otherwise, it is False (the default). The
property value must be explicitly set to True when configuring the domain for request forwarding.
Request forwarding must be enabled at the site level (both for forwarding requests and for receiving forwarded requests), and each virtual server within the site must have a valid URI specified in its EJBForwardingEndPoint property for it to be able to receive forwarded requests. |
![]() | CanForwardRequests |
Determines if requests may be forwarded from a Site. The value of this property is True
if the Site can forward requests; otherwise, it is False (the default). The
property value must be explicitly set to True when configuring the domain for request forwarding.
Note: If the value is False, no requests may be forwarded from
any virtual server in the site.
|
![]() | 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. |
![]() | 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). |
![]() | DescriptiveText |
User-readable text that describes an object.
The text is not locale-specific to the retrieving user except for the following classes:
|
![]() | 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. |
![]() | 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. |
![]() | 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). |
![]() | Name |
The name for this object.
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. |
![]() | Properties |
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.) |
![]() | SubsystemConfigurations |
A list of subsystem configuration objects that reflect parameters of the configured subsystems.
|
![]() | VirtualServers |
Represents a collection of VirtualServer objects for a given site.
|