A management class that represents a specific retention setting for an IBM Tivoli Storage Manager (TSM) server. A TivoliFixedContentDevice class can have one or more CmTivoliMangementClass classes associated with it (via its TSMManagementClasses property). Each management class that you create represents a retention scheme type and a retention period that you can associate with a specific TivoliFixedContentDevice class. Note that if data retention protection is turned off (controlled via the TSMArchiveProtectionFlag property of a TivoliFixedContentDevice class), any management classes that specify a chronological retention scheme will be made unavailable by the Content Engine server.

There are two types or retention schemes that a management class can represent: chronological or event. The type of retention scheme used by the management class determines how the retention period is interpreted:

  • In a chronological retention scheme, the retention period is determined by the value of the TSMRetentionPeriod property. After a document is checked in for the first time, the retention period is initiated and a hold is place on the document to prevent deletion in the TSM archive until after the retention period has expired.
  • In an event retention scheme, the retention period is determined by the value of the TSMMinimumRetention property. In this type of retention scheme, you must set the TSMRetentionPeriod property to 0. The retention period is initiated after an object has been deleted from an object store.

The following tables list the members exposed by ICmTivoliManagementClass.

Public Properties

 NameDescription
Public propertyDescriptiveTextUser-readable text that describes an object.

The text is not locale-specific to the retrieving user except for the following classes:

  • ClassDescription
  • PropertyDescription*
  • ClassDefinition
  • PropertyTemplate*
  • PropertyDefinition*
Public propertyNameThe 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.

Public propertyTSMMinimumRetentionThe minimum number of days to retain an object that has been archived with an IBM Tivoli Storage Manager server before it is deleted. For management classes that represent an event retention scheme, this property determines the length of the retention period; otherwise, this property is ignored.
Public propertyTSMRetentionInitiationSpecifies the type of retention scheme for a management class: chronological or event. The setting of this property determines how the retention periods specified by the TSMRetentionPeriod and TSMMinimumRetention properties will be interpreted.

This property can have one of the following values:

  • 0: Specifies a chronological retention scheme. The retention period is determined by the value of the TSMRetentionPeriod property. After a document is checked in for the first time, the retention period is initiated and a hold is place on the document to prevent deletion in the IBM Tivoli Storage Manager archive until after the retention period has expired.
  • 1: Specifies an event retention scheme. The retention period is determined by the value of the TSMMinimumRetention property. In this type of retention scheme, you must set the TSMRetentionPeriod property to 0. The retention period is initiated after an object has been deleted from an object store.
Public propertyTSMRetentionPeriodThe number of days to retain a Content Engine object that has been archived with an IBM Tivoli Storage Manager server before it is deleted. For management classes that represent a chronological retention scheme, this property determines the length of the retention period; otherwise, this property must be set to 0.
Top

See Also