planningTask
Reserved.
We recommend that you represent instances of this type as leaf nodes in a tree structure. These objects can be manipulated independent of their containing object.
This class
References
- Used by the following properties:
Related Services and Methods
This can be used with the following services:
The following table lists the services and methods for the planningTask class.
Action | Mode | Service | Method |
---|---|---|---|
Run | All | planningTaskService | asynch » run(objectPath, parameterValues, options) |
Container Information
Properties
This class has the following properties.
- contact
Refers to a person or group of people who are responsible for the object.
This property
is an array of type bibus » baseClass
has items that must be of class bibus » account, bibus » contact, bibus » distributionList, bibus » group, or bibus » role
is encoded as type
tns:baseClassArrayProp
refers to other objects in the content store using an id-based search path
must have at most
1
item
- contactEMail
Specifies the email address of the person or group of people who are responsible for the object.
This property
is of type
string
is encoded as type
tns:stringProp
- history
Contains the history for the object.
The default retention rule for histories is to keep 5 versions.
This property
uses the retentions property to manage contained instances of bibus » history
- options
Contains the set of options for this object.
Options can also be specified in other locations. For more information, see Specifying Options and Parameters.
This property
- parameters
Contains the set of execution parameter values for this object.
Parameter values can also be specified in other locations. For more information, see Specifying Options and Parameters.
This property
is an array of type bibus » parameterValue
is encoded as type
tns:parameterValueArrayProp
- retentions
Contains a set of retention rules, each associated with a specified class of child object that this parent can contain. These rules specify values for deleting child objects. For example, you can specify that Content Manager keep the latest three versions, or keep versions created in the last three months. IBM® Cognos® Connection limits retention configuration by either versions or duration.
The following rules are added to a new instance of this class when it is created by an IBM Cognos component:
Table 2. Rules for a new planningTask object Versioned Class Maximum Age Maximum Count Ordered By bibus » history class 5 bibus » baseClass » creationTime property This property
is an array of type bibus » retentionRule
is encoded as type
tns:retentionRuleArrayProp
- routingServerGroup
Specifies the name of the server group that should handle requests using this object.
This property is calculated using the content » determineRouting(objectPaths) method . The related objects are determined using information available to Content Manager about the object class. For example, a user's membership in a group or role can be derived from the user's Passport.
This property
is of type
string
is encoded as type
tns:stringProp
is read-only
can be retrieved without requiring read permission on the object; only traverse permission on the full path to the containing object is required
- routingServerGroupEdition
Specifies the edition of the service that should handle requests using this object.
This property
is of type
string
is encoded as type
tns:stringProp
is read-only
must contain no more than
20
charactersmust contain exactly three decimal numbers consisting of one or more decimal digits separated by a decimal point ('.')
is searchable
can be retrieved without requiring read permission on the object; only traverse permission on the full path to the containing object is required
- New in Version 8.4 — Software Editions
This property was added.
- schedule
Contains the schedule. If an object is not scheduled, it still contains this property, however this property is empty.
This property
must have at most
1
item
- specification
Reserved.
This property
is of type bibus » planningTaskServiceSpecification
is encoded as type
tns:planningTaskServiceSpecificationProp