Domain Properties

This topic alphabetically lists the properties that apply to the Domain class.

AddOns Property



AddOns registered with the IBM Content Cortex domain.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: AddOn
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ClassDescription Property



Describes an object's class.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ContentCacheAreas Property



Enumeration of Content Cache Area objects.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ContentCacheArea
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

CredentialsManagers Property



A collection of all the Credentials Manager instances defined in the domain.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: CmCredentialsManager
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

DatabaseConnections Property



An enumeration of database connections associated with this domain.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: CmDatabaseConnection
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

DefaultSite Property



The default site object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: Site
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

DirectoryConfigurations Property



List of directory server configurations for the respective directory servers to be queried by the server.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: DirectoryConfiguration
RequiresUniqueElements: true
Settability: READ_WRITE
TargetAccessRequired: READ

DocumentationURL Property



The base URL for the documentation associated with the domain.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

DomainType Property



Indicates the type of domain to which this object corresponds.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

ElasticSearchClusters Property



A collection of the Elastic Search clusters defined for the domain,

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: CmElasticSearchCluster
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

EventExportStores Property



An enumeration of Event Export Store objects that exist in this Domain

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: CmEventExportStore
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ExternalRepositories Property



An enumeration of the external repositories defined in the domain,

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ExternalRepository
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

FixedContentDevices Property



The collection of fixed content devices defined for a domain

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: FixedContentDevice
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

GCDRevisionNumber Property



The revision number of the Global Configuration Database.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Id Property



The unique object ID.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: GUID
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

IsolatedRegions Property



The list of PE isolated regions that are available in the IBM Content Cortex domain.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: IsolatedRegion
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

KeyServiceConnection Property



Specifies the parameters for connecting to the external service managing cryptographic keys on behalf on the Content Platform Engine.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: 262144
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

KeyServiceType Property



Specifies the type of the external service managing cryptographic keys on behalf on the Content Platform Engine.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: 262144
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

LocalGroupsEnabled Property



Enables use of local groups for this domain.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

MarkingSets Property



A list of MarkingSets.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: MarkingSet
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Name Property



Returns the value of the designated name property for the object, or its ID if there is no name property.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

ObjectStoreSchemaDB2 Property



The default SQL script used to create an ObjectStore's tables within a DB2 database.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ObjectStoreSchemaMSSQL Property



The default SQL script used to create an ObjectStore's tables within a SQL Server database.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ObjectStoreSchemaMySQL Property



The default SQL script used to create an ObjectStore's tables within a MySQL database.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ObjectStoreSchemaOracle Property



The default SQL script used to create an ObjectStore's tables within an Oracle database.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ObjectStoreSchemaPostgreSQL Property



The default SQL script used to create an ObjectStore's tables within an PostgreSQL database.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ObjectStores Property



A collection of ObjectStore objects.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ObjectStore
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

PEConnectionPoints Property



The list of PE connection points that are available in the IBM Content Cortex domain.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: PEConnectionPoint
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

PermissionDescriptions Property



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

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: PermissionDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Permissions Property



The discretionary permissions for the object.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: 8
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: AccessPermission
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

ReplicationGroups Property



An enumeration of the replication groups defined in the domain,

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ReplicationGroup
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Sites Property



Enumeration of site objects.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: Site
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

SubsystemConfigurations Property



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

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: SubsystemConfiguration
RequiresUniqueElements: true
Settability: READ_WRITE
TargetAccessRequired: READ

SystemUserName Property



The name for the system user account.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

SystemUserPassword Property



The password for the system user account.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BINARY
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

Tenants Property



An enumeration of the Tenants associated with this domain.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: CmTenant
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

TextSearchAffinityGroups Property



An enumeration of Text Search Affinity Groups objects that exist in this Domain

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: CmTextSearchAffinityGroup
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

TextSearchServers Property



Collection of Text Search Servers on Domain

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: CmTextSearchServer
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

UpgradeStatus Property



Specifies the upgrade status of the domain.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: null
PropertyMaximumInteger32: TBD [RD-3]
PropertyMinimumInteger32: TBD [RD-4]
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ