The IDomain type exposes the following members.

ToggleProperties

Type NameDescription
Public propertyAddOns
Specifies the add-ons (including upgrade add-ons) registered with a domain.
Public propertyAuthenticationRealmName
The realm name that is used to confirm that a user that is making requests of this domain has authenticated in the appropriate manner for that domain. Content Platform Engine enforces the following requirements:
  • If the authentication realm name for a master or tenant domain is not null, it must begin with either a forward slash (/) or an at sign(@).
  • The authentication realm name for a tenant domain cannot be set to null unless the authentication realm name for the master domain has previously been set to null.
  • When a request is received, the realm that is embedded in the subject must match either the authentication realm name that corresponds to the tenant against which the request is being directed or the master authentication realm name.
Public propertyClassDescription
The ClassDescription object containing the property metadata for the EngineObject.
(Inherited from IEngineObject.)
Public propertyContentCacheAreas
A collection of all ContentCacheArea objects associated with the FileNet P8 domain.
Public propertyDatabaseConnections
An enumeration of database connections associated with this domain.
Public propertyDefaultSite
Identifies the default geographical site associated with the FileNet P8 domain. The value of this property is initialized to "Initial Site" when the Content Engine server is initialized and the GCD is created. Initial Site is a system-generated instance of the Site class that holds the Virtual Server (and thus, Server Instance) of the current application server instance. A user with system administrator rights can subsequently assign a different site to be the default, if desired.

If you do not specify a site when creating a site-related object (such as an ObjectStore object), the created object's Site property is set to the value of the DefaultSite property.

Public propertyDirectoryConfigurations
An IDirectoryConfigurationList object that specifies the collection of directory server configurations for a given FileNet P8 domain. This collection represents the type-specific directory server configurations for the supported directory servers (Microsoft Active Directory, ADAM, CA eTrust, IBM Tivoli, Novell eDirectory, Oracle Internet Directory (OID), and Oracle Directory Server) that will be queried by the Content Engine server when authorizing user and group names for login.
Public propertyDITARenditionEngineConnections
Contains a reference to the DITARenditionEngineConnectionSet object that lists the DITA Rendition Engine connections for this domain.
Public propertyDocumentationURL
The base URL for the IBM® documentation that is associated with the FileNet P8 domain. The property allows client applications that provide help links to retrieve the base URL from a central location, rather than each client locally storing the URL.

To use the IBM documentation, you can link either to IBM Knowledge Center on www.ibm.com, or to a local information center that you install and deploy. For successful retrieval of a help topic, the client must concatenate the plug-in path of the applicable topic to the base URL of the documentation server.

For more information about setting the base URL for the IBM documentation, see Updating the base documentation URL for the FileNet P8 domain.

Public propertyDomainType
A DomainType object that indicates the type of this domain. A DomainType property can have one of the following values:
  • STANDALONE: Indicates that the domain is a stand-alone domain. A stand-alone domain does not allow any tenant domains to be created.
  • MASTER: Indicates that the domain is a master domain. A master domain is operationally the same as a stand-alone domain, but it allows for the optional creation of one or more tenant domains, which share the same physical infrastructure and resources as the master domain.
  • TENANT: Indicates that the domain is a tenant domain. Each tenant domain shares the physical infrastructure and resources of a master domain, but appears to the API to be a stand-alone domain.
Public propertyEventExportStores
An enumeration of ICmEventExportStore objects that exist in this domain.
Public propertyExternalRepositories
Specifies an ExternalRepositorySet object containing the set collection of ExternalRepository objects associated with this domain.
Public propertyFixedContentDevices
Specifies the collection of fixed content devices defined for a domain.
Public propertyGCDRevisionNumber
The revision number of the Global Configuration Database.
Public propertyId
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:

  • 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 propertyIsolatedRegions
Represents the collection of IIsolatedRegion objects associated with a FileNet P8 domain or a database connection.
Public propertyMarkingSets
Specifies a collection of MarkingSet objects.
Public propertyName
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.

Public propertyObjectStores
Represents the collection of IObjectStore objects associated with a given FileNet P8 domain or a database connection.
Public propertyObjectStoreSchemaDB2
Specifies the default SQL script to use when creating object stores within a DB2 database.

You can customize the supplied default schema script and then submit your customized script when you call the Factory.ObjectStore.CreateInstance(domain, admins, users, schemaScript) method. Typical modifications to the default script include the distribution of the various tables, indexes, and Large Object (LOB) columns across different tablespaces. For more information, see Using a Custom Schema Script.

Public propertyObjectStoreSchemaMSSQL
Specifies the default SQL script to use when creating object stores within a Microsoft SQL Server database.

You can customize the supplied default schema script and then submit your customized script when you call the Factory.ObjectStore.CreateInstance(domain, admins, users, schemaScript) method. Typical modifications to the default script include the distribution of the various tables, indexes, and Large Object (LOB) columns across different tablespaces. For more information, see Using a Custom Schema Script.

Public propertyObjectStoreSchemaOracle
Specifies the default SQL script to use when creating object stores within an Oracle database.

You can customize the supplied default schema script and then submit your customized script when you call the Factory.ObjectStore.CreateInstance(domain, admins, users, schemaScript) method. Typical modifications to the default script include the distribution of the various tables, indexes, and Large Object (LOB) columns across different tablespaces. For more information, see Using a Custom Schema Script.

Public propertyPEConnectionPoints
A PEConnectionPointSet object containing the list of connection points (PEConnectionPoint instances) available in this P8 domain.
Public propertyPermissionDescriptions
A list of descriptions of permissions applicable to objects of the described class.
Public propertyPermissions
Manages the discretionary permissions assigned to the object.
Public propertyProperties
The IProperties collection of properties for the EngineObject.
(Inherited from IEngineObject.)
Public propertyRenditionEngineConnections
Contains a reference to the RenditionEngineConnectionSet object that lists the Rendition Engine connections for this domain.
Public propertyReplicationGroups
Specifies a ReplicationGroupSet object containing the collection of ReplicationGroup objects associated with this domain.
Public propertySites
A collection of Site objects for this domain. Each element of the collection represents a geographical area in the domain.
Public propertySubsystemConfigurations
A list of subsystem configuration objects that reflect parameters of the configured subsystems.
Public propertyTextSearchAffinityGroups
A list of CmTextSearchAffinityGroup objects, each of which represents an affinity group that has been created in this domain. This list is maintained by the Content Engine server.
Public propertyTextSearchServers
A list of CmTextSearchServer objects, each of which represents an IBM® Content Search Services server used in this domain. This list is maintained by the Content Engine server and is read-only. IBM Content Search Services objects can be added to or removed from this list by manipulating the server CmTextSearchServer objects directly by using the API.
Public propertyVerityDomainConfiguration Obsolete.
Deprecated.
For an IObjectStore object, the IVerityDomainConfiguration object that contains the IBM Legacy Content Search Engine configuration properties for a Verity domain. The configuration determines the Verity domain used by the object store. More than one object store can share the same Verity domain configuration.

For an

IDomain
object, this property is deprecated. Use this property on an IObjectStore object to assign a Verity domain configuration to an object store.

Public propertyVerityDomainConfigurations Obsolete.
Deprecated.
An IVerityDomainConfigurationSet collection object that contains the VerityDomainConfiguration objects for the FileNet P8 domain. A newly created VerityDomainConfiguration object is added to this set automatically when you save the object.

ToggleSee Also