ImageServicesSiteSettings Properties

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

CSMCache Property

Specifies the NCH 3-part name of the CSM cache that is nearer to the site than the default cache. Each part of the name is separated by a colon and takes the form page_cache<n>:<domain>:<organization>. There must be no more than one local CSM cache name for a given value of <domain>:<organization>.

For example, for domain ntvaga and organization FileNet, the names are of the form page_cache<n>:ntvaga:FileNet, where <n> is an unsigned decimal integer greater than or equal to 2. The default CSM cache on the document server is page cache number 1 (for example, page_cache1:ntvaga:FileNet).

This property will be used when the Content Engine server is running within the site identified by this object's Site property.

If a FileNet Image Services fixed content device is made available across multiple sites in a FileNet P8 domain, you should create an ImageServicesSiteSettings object for each site that has a local CSM cache. This SiteSettings object will override the value of the CSMCache property for the site to enable a local CSM cache to be utilized.

Metadata

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

ClassDescription Property

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

Metadata

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

Id Property

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:

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.

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

Site Property

Identifies the site associated with a given object. A site represents a geographical area in the FileNet P8 domain. If you do not specify a site when creating the associated object, the value of that object's Site property defaults to the value of Domain.DefaultSite.

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