CmTextSearchServer Properties

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

AffinityGroup Property

The Text Search Affinity Group with which the object is associated.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: CmTextSearchAffinityGroup
RequiresUniqueElements: false
Settability: READ_WRITE
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

Creator Property

The name of the user who created this object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: TBD [RD-1]
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: undefined
TargetAccessRequired: READ

DateCreated Property

The date and time this object was created.

Metadata

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

DateLastModified Property

The date and time when this object was last modified.

Metadata

DescriptiveText Property

Text that describes this object.

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_WRITE
TargetAccessRequired: READ

DisplayName Property

A user-intelligible name for the object.

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: undefined
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

IsSSLEnabled Property

Defines whether or not SSL is enabled.

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

LastModifier Property

The name of the user who last modified this object.

Metadata

MaximumConcurrentIndexingBatches Property

Defines the maximum number of concurrent indexing batches that should be submitted to the server.

Metadata

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

Site Property

The site associated with this 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: undefined
TargetAccessRequired: READ

SupportedLanguages Property

Text Search Server supported languages

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
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

TextSearchCredential Property

Credential (i.e. authentication token) required to connect to a IBM Text Search Server

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: undefined
TargetAccessRequired: READ

TextSearchServerHost Property

Host name for IBM Text Search server

Metadata

TextSearchServerMode Property

Specifies the usage mode of the IBM Text Search Server (e.g., searching, indexing, both, disabled).

Metadata

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

TextSearchServerPort Property

Port for IBM Text Search server

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: TBD [RD-3]
PropertyMinimumInteger32: TBD [RD-4]
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

TextSearchServerShutdownOnDisable Property

Control whether a shut down request is sent to text search server when the CmTextSearchServer status is changed to DISABLED.

Metadata

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

TextSearchServerStatus Property

Specifies the status of the IBM Text Search Server (e.g., enabled, disabled, unavailable).

Metadata

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

ValidateCertificateHost Property

Specifies whether the host name in the certificate presented by the server when establishing an SSL connection should be validated.

Metadata

ValidateServerCertificate Property

Specifies whether the certificate presented by the server when establishing an SSL connection should be validated.