deliver(conversation, parameterValues, options)

Use this method to deliver report output to any destination.

This secondary request can use the following run options to specify the destination of the output. Multiple destinations can be specified in the same request.

  • archive

    Use this option to save the report output to a file system.

    You must set the Archive Location File System Root parameter in IBM Cognos Configuration before using this option. See the IBM® Cognos® Analytics Installation and Configuration Guide for more information.

  • email

    Use this option to email the report output.

    The request can specify the following additional run options:

    Use options listed in the bibus » deliveryOptionEnum enumeration set to specify addressing and subject information for the email, as well as any additional content.

    You can use the emailAsURL run option if the output was saved to the content store using the saveOutput or the saveAs run options. If both options are set, the output created by the saveOutput run option is emailed.

    The emailAsURL option specifies that a link to the stored output should be included in the email. If a specification is run, report output cannot be stored in the content store. Therefore, the emailAsURL option cannot be used when a specification is run.

  • mobile

    Use this option to send the report output to IBM Cognos Analytics Reports users.

    Use the to mobile option to specify the recipients of the report output.

  • print

    Use this option to request that a report be printed.

    The request can specify the following additional run options:

    Use of this option requires:

  • saveAs

    Use this option to save the report output as part of a new or existing bibus » reportView in the content store. If you are saving to an existing bibus » reportView, it must reference the same report as the one being executed.

    The bibus » reportView may be in a location that is the same or different from the original report. If the location is the same, then the name must be different.

    Use of this option requires:

    • write permission for the parent of the new object

    • traverse permission for all ancestors of the new object

  • saveOutput

    Use this option to save the report output in the content store. This option may be used only if the report exists in the content store.

    Use of this option requires:

    • traverse permission for all ancestors of the report in the content store

    • write permission for the report in the content store

This method may return the following values in the bibus » asynchReply » status property:

You may be able to make secondary requests after using this method, depending on the server response. For more information about the asynchronous conversation status and secondary requests in asynchronous conversations, see Secondary requests.

Signatures

Java and Apache Axis
 
public  com.cognos.developer.schemas.bibus._3.AsynchReply  deliver( 
com.cognos.developer.schemas.bibus._3.AsynchRequest  conversation, 
com.cognos.developer.schemas.bibus._3.ParameterValue[] 
parameterValues,  com.cognos.developer.schemas.bibus._3.Option[] 
options) 
C# .NET
 
public  asynchReply  deliver(asynchRequest  conversation, 
parameterValue[]  parameterValues,  option[]  options) 
Example: Using the deliver(conversation, parameterValues, options) Method with the Report Service in Java

The following Java code snippet demonstrates how to use the report » deliver(conversation, parameterValues, options) method with the report service.

To see this code in context, view the Java sample SendEmail/Email.java. For more information about the samples, see Code samples and language-specific coding practices.

 
asynchReply  =  connection.getReportService().deliver( 
		response,  new  ParameterValue[]  {},  emailRunOptions); 
 
Example: Using the deliver(conversation, parameterValues, options) Method with the Report Service in C# .NET

The following C# code snippet demonstrates how to use the report » deliver(conversation, parameterValues, options) method with the report service.

To see this code in context, view the C# sample Email/Email.cs. For more information about the samples, see Code samples and language-specific coding practices.

 
	asynchReply  sendEmailResponse  =    connection.CBIRS.run( 
		reportPath,   
		new  parameterValue[]  {},   
		emailRunOptions); 
		connection.CBIRS.deliver( 
				sendEmailResponse.primaryRequest,  new  parameterValue[]  {  },  emailOptions); 
 

References

Part of the following method sets:
Implemented by the following services:

The services that implement the deliver method, along with the associated SOAP actions, are listed in the following table.

Table 1. Services implementing the deliver method.

Service

SOAP Action
batchReportService

http://www.ibm.com/xmlns/prod/cognos/batchReportService/201404/.high
reportService

http://www.ibm.com/xmlns/prod/cognos/reportService/201404/.high

What's new

New in Version 8.4 — Report Server deliver() method

This method was added.

Input parameters

Use the following parameters when calling this method.

conversation

Specifies the current state of the asynchronous conversation. All methods that begin an asynchronous conversation, and most methods used within an asynchronous conversation, return this information as the value of the bibus » asynchReply » primaryRequest property.

The value of this parameter should be obtained from the most recent instance of the bibus » asynchReply » primaryRequest property returned from a method for the same conversation.

This argument

parameterValues

Specifies the parameter values for the request.

Parameter values can also be specified in other locations. For more information, see Specifying Options and Parameters.

This argument

options

Specifies the options for the request.

Options can also be specified in other locations. For more information, see Specifying Options and Parameters.

This argument

  • is an array of type bibus » option

    is encoded as type tns:optionArray

Return values

This method returns the following values.

result

Returns the state of the asynchronous conversation. Possible asynchronous conversation states are defined in the bibus » asynchReplyStatusEnum enumeration set.

Any data requested can be obtained by examining the bibus » asynchReply » details property.

This result