authoredReport

Defines the abstract class for authored reports.

This class

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

  • inherits properties from the bibus » baseReport class

Derived Classes

References

Used by the following properties:
Used by the following method parameters:
Used by the following method return values:

Properties

This class has the following properties.

canBurst

Specifies whether the report output can be burst.

This property

  • is of type boolean

    is encoded as type tns:booleanProp

defaultTriggerDescription

Specifies the description of the external occurrence named by the triggerName property that best matches the description expressed in the user's preferred language. This is the content language specified by the bibus » account » contentLocale property. The user selects this language in the user preferences.

This property

  • is of type string

    is encoded as type tns:stringProp

  • can contain at least 32767 characters

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

paths

Contains the navigation paths. A navigation path is used to drill through from a source to a target.

For example, a navigation path can specify how to get from one report to another to allow a user to access related, or more detailed, information.

This property

queryMode

Reserved.

This property

  • is of type anyURI

    is encoded as type tns:anyURIProp

New in Version 10.1.0 — Query Modes

This property was added.

runWithOwnerCapabilities

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

For example, a report may contain user-defined SQL or HTML items. Running a report containing these items requires the canUseUserDefinedSQL or canUseHTML capabilities, that are normally assigned to report authors. When you set this property to true, other employees in the company may be able to run this report even if they do not have the required capabilities.

When this property is true, IBM Cognos uses the report owner's security context to perform certain user capability checks. This differs from bibus » baseReport » runAsOwner property in that it includes only the owner's capabilities and excludes other aspects of the owner's security context, such as access to data sources.

In the preceding example, the report owner sets this property to true to allow other employees in the company to run the report. This specifies that IBM Cognos uses the report owner's security context to determine whether user defined SQL can be used. Consumers of the report might not have the capability to include user defined SQL in their own reports, but when this property is true, the report owner's security context allows 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 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 property 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 require access to privileged data to run the report, in addition to capabilities of the owner, use the bibus » baseReport » runAsOwner property instead.

This property

  • is of type boolean

    is encoded as type tns:booleanProp

New in Version 10.1.0 — Run with Owner Capabilities

This property was added.

New in Version 10.1.1 — Run with Owner Capabilities

This previously reserved feature, introduced in Version 10.1.0, is now available for use.

specification

Specifies the information required to execute the report. This property is the definition for the report.

This property

  • is of type anyType

    is encoded as type tns:anyTypeProp

triggerDescription

Specifies the description of the external occurrence named by the triggerName property.

This property

  • is of type string

    is encoded as type tns:multilingualStringProp

  • can contain at least 32767 characters

  • is multilingual

triggerName

Specifies the name of the external occurrence that initiates execution of the report.

When set, the value of this property is also stored in the triggerName property of the bibus » schedule object contained within the object (if it exists), as well as any bibus » schedule objects contained within any bibus » reportView objects associated with the bibus » authoredReport object (see the bibus » reportView » base property).

Note that if this property has not been set, the bibus » schedule » triggerName property may be set independently.

If you require multiple external occurrences to trigger the execution of this report, you must manage this in the application you use to call the event » trigger(triggerName) method.

This property

  • is of type string

    is encoded as type tns:stringProp

  • can contain at least 255 characters

  • is searchable