This topic alphabetically lists the properties that apply to the Domain class.
null
,
it must begin with either a forward slash (/) or an at sign(@).null
unless the
authentication realm name for the master domain has previously been set to null
.ClassDescription
object containing the fixed description (immutable metadata) of
the class from which this object is instantiated.
ContentCacheArea
objects associated with the FileNet P8 domain.
DITARenditionEngineConnectionSet
object that lists the
DITA Rendition Engine connections for this domain.
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.
DirectoryConfigurationList
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.
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.
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.ExternalRepositorySet
object containing the set collection of ExternalRepository
objects
associated with this domain.
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.
IsolatedRegion
objects associated with a FileNet P8 domain or a database connection.
MarkingSet
objects.
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.
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.
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.
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.
ObjectStore
objects associated with a FileNet P8 domain
or a database connection.
PEConnectionPointSet
object containing the list of connection points (PEConnectionPoint
instances) available
in this P8 domain.
RenditionEngineConnectionSet
object that lists the Rendition
Engine connections for this domain.
ReplicationGroupSet
object containing the collection of ReplicationGroup
objects associated with this domain.
Site
objects for this domain. Each element of the collection
represents a geographical area in the domain.
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.
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.
ObjectStore
object, the VerityDomainConfiguration
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 a Domain
object, this property is deprecated. Use this property on an ObjectStore
object to assign a Verity domain configuration to an object store.
VerityDomainConfigurationSet
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.