CmTimeslot Properties

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

Indicates the length of time that the background task will run for a timeslot. Time is set in minutes, so a value of 60 indicates that the duration of the timeslot is one hour. Integer values of 1 and greater are allowed, but if the value is 10080 (the number of minutes in a week) or greater, the background task will run continuously.

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.

Indicates the time of day that the background task will start. The starting time of the timeslot is expressed as an integer number of minutes past midnight, relative to the local time of the server that is running the background task. For example, a value of 0 indicates midnight, 60 indicates 1 AM, and 1380 indicates 11 PM (that is, 60 times 23), local time. Values from 0 to 1439 are allowed.

StartMinutesPastMidnight is not an absolute Coordinated Universal Time (UTC), so given the same timeslot, different servers can start at different times, depending on their time zones. In distributed environments, you might want to configure specific timeslots at the specific server instance level to isolate index or disposition processing to non-business-critical periods.

Indicates the day of week that the background task will start. The value corresponds to those from the Weekday enumerated type (Weekday.SUNDAY, Weekday.MONDAY, etc.)