Domain Properties

Specifies the add-ons (including upgrade add-ons) registered with a domain.

Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

A collection of all ContentCacheArea objects associated with the FileNet P8 domain.

Contains a reference to the DITARenditionEngineConnectionSet object that lists the DITA Rendition Engine connections for this domain.

An enumeration of database connections associated with this domain.

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.

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

The base URL for the documentation that is associated with the FileNet P8 domain. The property allows clients that support context-sensitive help to retrieve the base URL from a central location, rather than each client locally storing the URL.

The property supports access of context-sensitive help built into the FileNet P8 Platform documentation. 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 FileNet P8 Platform documentation server.

To use the FileNet P8 Platform documentation, you can link either to the online version of the information center on www.ibm.com, or to a local copy of the information center that you install and deploy.

To link to a local information center, enter the base URL in the following format:
http://server-name[:port]/application-name/topic/

where:

• server-name is the name of the server where the FileNet P8 Platform documentation information center is installed.
• port is the optional port number.
• application-name is the name of the deployed FileNet P8 documentation application.

  To install and link to a local information center, see Installing IBM FileNet P8 Platform documentation.

To link to the online information center, enter the base URL of the desired version. For example, the following URL is for the version 5.1 information center:
http://pic.dhe.ibm.com/infocenter/p8docs/v5r1m0/topic/
For a list of IBM information centers, see Product information.

An enumeration of CmEventExportStore objects that exist in this domain.

Specifies an ExternalRepositorySet object containing the set collection of ExternalRepository objects associated with this domain.

Specifies the collection of fixed content devices defined for a domain.

The revision number of the Global Configuration Database.

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

Represents the collection of IsolatedRegion objects associated with a FileNet P8 domain or a database connection.

Specifies a collection of MarkingSet objects.

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.

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 Working with Custom Schema Scripts.

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 Working with Custom Schema Scripts.

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 Working with Custom Schema Scripts.

Represents the collection of ObjectStore objects associated with a FileNet P8 domain or a database connection.

A PEConnectionPointSet object containing the list of connection points (PEConnectionPoint instances) available in this P8 domain.

A list of descriptions of permissions applicable to objects of the described class.

Manages the discretionary permissions assigned to the object.

Contains a reference to the RenditionEngineConnectionSet object that lists the Rendition Engine connections for this domain.

Specifies a ReplicationGroupSet object containing the collection of ReplicationGroup objects associated with this domain.

A collection of Site objects for this domain. Each element of the collection represents a geographical area in the domain.

A list of subsystem configuration objects that reflect parameters of the configured subsystems.

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.

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.

Deprecated.
For an 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.

Deprecated.
A 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.