baseDataIntegrationTask

Defines the set of common properties shared by all data integration service tasks.

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

  • is an abstract type used to define properties that are inherited by other types

  • inherits properties from the bibus » uiClass class

Derived Classes

References

Used by the following properties:

Container Information

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

Properties

This class has the following properties.

connections

Refers to the set of data source connections and signons used to run this object.

This property

contact

Refers to a person or group of people who are responsible for the object.

This property

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

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

ownerPassport

When bibus » baseDataIntegrationTask » runAsOwner property is true, this property specifies a CAM cookie created using the credentials associated with the object's owner. The passport and session created during the log on process are used to perform the requested task.

Once the task has completed, a logoff request is issued to invalidate the passport and terminate the session.

This property

  • is of type anyType

    is encoded as type tns:anyTypeProp

  • cannot be processed directly using the IBM Cognos Software Development Kit

New in Version 10.1.0 — Documentation Updates

This topic now accurately describes the contents of this property.

packageBase

Specifies the path to the ancestor package. The format of this property is the same as the format of the bibus » baseClass » searchPath property.

If the object is not a descendant of a package, the value of this property is the path to the root object.

This property

  • is of type string

    is encoded as type tns:stringProp

  • is read-only

  • must contain no more than 4096 characters

  • can be acquired from a containing object

New in Version 8.3 — Package Hierarchies

This property is deprecated. Use the bibus » baseClass » ancestors property instead.

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 1. Rules for new baseDataIntegrationTask 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.

runAsOwner

Specifies whether the security context of the owner is used to perform specific capability checks and to access data when running a task.

For example, the Human Resources department publishes a report that contains information about salary ranges across the company. The nature of the report requires the use of user defined SQL (controlled by canUseUserDefinedSQL). Since this report does not disclose individual salary information, it is not deemed to be confidential. However, the data required to run the report is only available to certain members of the Human Resources department. One of these employees is the owner of the report.

When this property is true, IBM Cognos uses the report owner's security context to access the data necessary to produce the report, as well as to perform certain user capability checks.

In the preceding example, the report owner sets this property to true to allow other employees in the company to run the report. Setting this property to true specifies that IBM Cognos uses the report owner's security context to access the data that is normally unavailable to the majority of employees. In addition, the capability check to determine whether user defined SQL can be used is performed using the report owner's security context. Consumers of the report may not be permitted access to the data or the ability to include user defined SQL in their own reports, but when this property is true, the report owner's security context is used to access the data and to allow the use of user defined SQL.

A user must still have sufficient permissions for the target object in order to run it. For more information, see asynch » run(objectPath, parameterValues, options) method.

Other activities may also use this property to provide access to privileged data or user capabilities. For example, parameter » collectParameterValues(objectPath, parameterValues, options) method collects all the parameters that must be specified before a report can run.

For more information about which owner capabilities are used when this property is true, see the User Capability Details table in the bibus » userCapabilityEnum enumeration set description.

If a request is sent to set this property to true, the contentManagerService service requires that the security context making the request (that is, accounts, groups and active roles) has either read or execute permissions on the credential of the account identified by the owner of the object. This check is performed in addition to the normal permission checks for updating a property. If the security context does not have the appropriate permissions, the request fails.

If consumers of a report only require one of the owner's capabilities and do not require access to privileged data to run the report, use the runWithOwnerCapabilities property instead.

This property

  • is of type boolean

    is encoded as type tns:booleanProp

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

Specifies the specification for the task.

This property