output

References

Used by the following properties:

• bibus » baseAgentDefinition » mostRecentEventList

• bibus » asynchDetailReportOutput » outputObjects

• bibus » annotation » outputs

Container Information

Contains instances of the following classes

• bibus » graphic

• bibus » page

Contained by instances of the following classes

• bibus » agentOutputHotList

• bibus » reportVersion

• bibus » session

Properties

This class has the following properties.

burstID

Identifies the values for the burst keys that produced the output.

This property

• is of type string

  is encoded as type tns:stringProp

• can contain at least 32767 characters

• is searchable

New in Version 8.3 — Conditional Subscriptions

This property was added.

burstKey

Specifies the label for the burst key values that produced the output.

Bursting creates a set of outputs for a report, based on the information that the recipients are interested in and are authorized to view.

For example, using the SDK or the portal, you can burst sales data by branch or geographic location.

Burst report output always has a property value for the recipients property or the recipientsEMail property. Depending on the report, values may be assigned to both properties.

This property

• is of type string

  is encoded as type tns:stringProp

• can contain at least 4095 characters

New in Version 8.3 — Conditional Subscriptions

The documentation for this property was updated.

Related information:

IBM® Cognos® Administration and Security Guide

context

Specifies the context data for the output.

This property may be encoded as an attachment in a method request message or response message if the encoding parameter is set toMIME. The encoding parameter varies from method to method; see the bibus » addOptions » dataEncoding propertyand the bibus » queryOptions » dataEncoding propertyfor additional details.

This property contains data to be used only by IBM Cognossoftware. The structure of this data is subject to change without notice. Client applications should not attempt to interpret or modify this data.

This property

• is of type bibus » xmlEncodedXML

  is encoded as type tns:xmlEncodedXMLMIMEProp

New in Version 8.3 — Improved Context Metadata for Selection

This property was added.

contextBlockCount

Specifies the number of context blocks stored in the context property.

This property

• is of type int

  is encoded as type tns:intProp

New in Version 8.3 — Improved Context Metadata for Selection

This property was added.

data

Contains the MIME data. The data format is specified in the dataType property.

This property may be encoded as an attachment in a method request message or response message if the encoding parameter is set toMIME. The encoding parameter varies from method to method; see the bibus » addOptions » dataEncoding propertyand the bibus » queryOptions » dataEncoding propertyfor additional details.

This property

• is of type base64Binary

  is encoded as type tns:base64BinaryMIMEProp

dataPathInfo

Contains a URI specifying the location of binary data for this object. The URI can specify a location in the content store or the location of an external repository.

This property

• is of type anyURI

  is encoded as type tns:anyURIProp

• is read-only

New in Version 10.2.1 — External object store for report archiving

This property was added.

dataSize

Specifies the number of bytes of data.

This property

• is of type nonNegativeInteger

  is encoded as type tns:nonNegativeIntegerProp

• is read-only

dataType

Specifies the media type of the value of property data. The media type is expressed as a type/subtype pair. For example, image/jpeg identifies images in JPEG format using JFIF encoding, and text/plain identifies plaintext.

This property

• is of type string

  is encoded as type tns:stringProp

• can contain at least 255 characters

format

Specifies the rendering format.

When used in the bibus » account class or the bibus » contact class, this property specifies the preferred output format of reports for the account or contact.

When used in the bibus » documentContent class or bibus » output class this property specifies the format of the data contained in the object

This property

• is of type bibus » outputFormatEnum

  is encoded as type tns:nmtokenProp

• must contain no more than 10 characters

• is searchable

images

Contains the images for the report output.

lastPage

This property is not supported.

This property

• is of type NMTOKEN

  is encoded as type tns:nmtokenProp

• can contain at least 255 characters

New in Version 10.1.0 — Documentation Updates

This topic now accurately describes the contents of this property.

locale

Specifies the locale for this object. The format of the locale follows the Internet Engineering Task Force (IETF) open standard RFC3066.

When used by bibus » contact, this property determines the language and data format of the returned content.

Use the appropriate language so that users understand object names and search paths. Use the appropriate region so that date, time, and currency values are presented in the proper localized format.

This property

• is of type language

  is encoded as type tns:languageProp

• must contain no more than 64 characters

• is searchable

pages

Contains the pages of XLS output for the report.

New in Version 10.1.0 — Documentation Updates

This topic was updated to indicate the correct contents of this property.

recipients

Refers to the recipients of the burst report output.

Burst report output is secured by the value of the recipients property and by other security features defined in IBM Cognos Analytics, such as the access permissions to objects and capabilities. To access a burst output object, a user must

• be a member of the System Administrators role

• be the owner of the object

• be referenced in the bibus » output » recipients property for the burst output object

• have read permission for the output object

This security filter is also applied when using the defaultOutput(searchPath) function and the bibus » baseReport » defaultOutputFormat property.

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

recipientsEMail

Contains the set of email recipients for the burst report output.

This property

• is an array of type string

  is encoded as type tns:stringArrayProp