storedProcedureTask

Defines the class that describes a task that calls an RDBMS stored procedure.

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 storedProcedureTask class.

Table 1. Services and methods for the storedProcedureTask class.
Action Mode Service Method
Run All agentService asynch » run(objectPath, parameterValues, options)

Container Information

Contains instances of the following classes
Contained by instances of the following classes

Properties

This class has the following properties.

history

Contains the history for the object.

The default retention rule for histories is to keep 5 versions.

This property

metadataModel

Refers to the metadata model needed to execute the specification. The content store location of this Framework Manager model is identified by means of a search path.

This model specifies the data to be retrieved, how rollups are aggregated, and the dimensional hierarchies or nested levels that are present in the source cube. The model also defines query properties, such as whether columns are additive or whether governors are used to narrow the scope of the query, thereby overriding the default behavior for a specific report.

Packages can contain objects from more than one model. Therefore, you can add a model reference or change the referenced model to meet the business requirements of your report authors. For example, you can add objects to a model so that a new calculated column is available for use in your reports. After making changes to the model, you must republish the package and update any reports that use the data.

This property

  • is an array of type bibus » baseClass

    has items that must be of class bibus » model

    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

Related information:
IBM® Cognos® Framework Manager Developer Guide
metadataModelPackage

Refers to the package containing the metadata model needed to execute the specification.

This property

  • is an array of type bibus » baseClass

    has items that must be of class bibus » package

    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

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

  • is an array of type bibus » option

    is encoded as type tns:optionArrayProp

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

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 storedProcedureTask object
Versioned Class Maximum Age Maximum Count Ordered By
bibus » history class 5 bibus » baseClass » creationTime property

This property

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 characters

  • must 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.

storedProcedureName

Specifies the name of the stored procedure, as defined in the metadata model.

This property