drillPath

Defines a drill-through path between a source and a target.

Drill-through paths defined in a bibus » package object are used by all reports that are based on that package.

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

inherits properties from the bibus » uiClass class

References

Used by the following properties:

bibus » asynchDetailDrillPathObject » drillPath

Used by the following method parameters:

Used by the following method return values:

Related Services and Methods

This can be used with the following services:

The following table lists the services and methods for the drillPath class.

Table 1. Services and methods for the drillPath class.
Action	Mode	Service	Method
Run	Batch	batchReportService	asynch » run(objectPath, parameterValues, options)
Run	Interactive	reportService	asynch » run(objectPath, parameterValues, options)

Container Information

Contained by instances of the following classes

bibus » package

What's new

New in Version 8.4 — Dynamic Filtering of Report Data: This class can now be used with the asynch » run(objectPath, parameterValues, options) method.

Properties

This class has the following properties.

action

Specifies the action for the target object.

This property

is of type bibus » baseReportActionEnum

is encoded as type tns:baseReportActionEnumProp
has a default value of viewOutput

bookmarkItem

Specifies the data item from the source to be used to determine the target bookmark within the drill path target.

This property

is of type bibus » metadataModelItemName

is encoded as type tns:metadataModelItemNameProp

bookmarkText

Specifies the target bookmark within the drill path target.

This property

is of type string

is encoded as type tns:stringProp

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

deploymentReferences

Contains the deployable object references for this object.

This property

is an array of type bibus » deploymentReference

is encoded as type tns:deploymentReferenceArrayProp

New in Version 8.4 — Supporting New Drill-through Targets: This property was added. It replaces the bibus » drillPath » target property.

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

parameterAssignments

Contains the parameter assignments for the drill path.

This property

is an array of type bibus » baseParameterAssignment

is encoded as type tns:baseParameterAssignmentArrayProp

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

scope

Specifies the source domain from which this drill path may be used.

This property

is an array of type bibus » metadataModelItemName

is encoded as type tns:metadataModelItemNameArrayProp

specification

Specifies the information required to perform a drill-through operation between two resources, including information about the target and the action to be performed on the target. The specification may also include mapping between source and target parameters.

This property

is of type bibus » reportServiceDrillThroughSpecification

is encoded as type tns:reportServiceDrillThroughSpecificationProp

New in Version 8.4 — Supporting New Drill-through Targets: This property was added. It replaces the bibus » drillPath » target property.

target

Specifies the drill-through target.

If the target was moved, deleted, or renamed since the drill path was specified, the drill-through will fail.

This property

is an array of type bibus » baseClass

has items that must be of class bibus » analysis, bibus » query, bibus » report, or bibus » reportView

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

New in Version 8.4 — Supporting New Drill-through Targets: This property is deprecated. Use the bibus » drillPath » deploymentReferences property instead.

targetOptions

Contains the set of options to be passed to the drill-through target to perform the drill-through. Applicable options vary depending on the class of the target 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

New in Version 8.4 — Supporting New Drill-through Targets: This property was added.

targetParameters

Contains the set of parameter values to be passed to the drill-through target to perform the drill-through.

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

New in Version 8.4 — Supporting New Drill-through Targets: This property was added.