reportVersion

Contains the information required to reproduce report output, such as prompt values and output formats.

For example, a quarterly sales report runs on the last day of the quarter. Because sales data for the quarter continues to come in after the last day of the quarter, the report must be run again to include the new data. The reportVersion object contains the information used to produce the original output. Therefore, the user does not have to specify this information the next time the report runs.

This class also contains the rendered report output. Saving rendered output can reduce the load on application and database servers, because the report need not be run every time a user wants to view the output. The reduced load makes more resources available for other requirements, such as ad-hoc reporting jobs.

We recommend that you represent instances of this type as a set of properties of its containing object. Users may access this object by opening a property sheet or launching an editor.

This class

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.

allowAnnotations

Specifies whether the outputs in this report version can be annotated by report consumers.

The value of this property is normally determined by the value of the allowAnnotations option when the report version was created.

This property

  • is of type boolean

    is encoded as type tns:booleanProp

  • has a default value of false

New in Version 8.4 — Report Output Annotations

This property was added.

annotationFolder

Specifies the annotation folder for this report version.

This property

  • must have at most 1 item

New in Version 8.4 — Report Output Annotations

This property was added.

asOfTime

Specifies the end of the period used to filter data for this report version, in Coordinated Universal Time (UTC). For example, you can specify the date and time of the end of the quarter for your quarterly inventory report.

This property

  • is of type dateTime

    is encoded as type tns:dateTimeProp

  • is searchable

canBurst

Specifies whether the report output can be burst.

This property

  • is of type boolean

    is encoded as type tns:booleanProp

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

expirationTime

Specifies the date and time at which the object should be removed from the content store due to the retention rules specified on the parent object.

This property

  • is of type dateTime

    is encoded as type tns:dateTimeProp

  • is read-only

  • is searchable

New in Version 8.4 — On Demand Refresh of Prompt Cache

This property was added.

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

output

Contains the output for this report version.

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

serverGroup – deprecated

Specifies the server group associated with this object. This property is not used by IBM Cognos Analytics.

This property

  • is of type string

    is encoded as type tns:stringProp

  • is deprecated and will be removed in a future version of the product

  • can contain at least 255 characters

  • can be acquired from a containing object

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

SQL

Contains the SQL for this report version.