collectParameterValuesSpecification(specification, parameterValues, options)

Use this method to collect values for all parameters that must be specified for the report or metadata specification before it can be run.

The values are stored in the bibus » asynchDetailParameterValues » parameters property. An instance of this class is returned in the bibus » asynchReply » details property when the request is complete.

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

You can 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 
collectParameterValuesSpecification( 
com.cognos.developer.schemas.bibus._3.AsynchSpecification 
specification,  com.cognos.developer.schemas.bibus._3.ParameterValue[] 
parameterValues,  com.cognos.developer.schemas.bibus._3.Option[] 
options)

C# .NET

 
public  asynchReply  collectParameterValuesSpecification( 
asynchSpecification  specification,  parameterValue[]  parameterValues, 
option[]  options)

References

Part of the following method sets:

parameter

Implemented by the following services:

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

Table 1. Services implementing the collectParameterValuesSpecification method.
Service	SOAP Action
batchReportService	`http://www.ibm.com/xmlns/prod/cognos/batchReportService/201404/`
powerPlayService	`http://www.ibm.com/xmlns/prod/cognos/powerPlayService/201404/`
reportService	`http://www.ibm.com/xmlns/prod/cognos/reportService/201404/`

batchReportService and reportService information

This information is specific to the batchReportService and reportService services.

If the request first generates a prompt page, the page is stored in an instance of bibus » asynchDetailReportOutput, which is returned in the bibus » asynchReply » details property.

Use of this method with this service requires:

read or execute permission for the metadata

The following capability rules are enforced for this method.

The capability rules, along with the associated specifications and classes, are listed in the following table.

Table 2. Capability rules for the collectParameterValuesSpecification method.
Specification	Capabilities	Class
Trusted	bibus » userCapabilityEnum » canUseAdaptiveAnalytics	bibus » reportServiceMetadataSpecification orbibus » reportServiceReportSpecification
Trusted	bibus » userCapabilityEnum » canUseAnalysisStudio	bibus » reportServiceAnalysisSpecification,bibus » reportServiceMetadataSpecification, orbibus » reportServiceReportSpecification
—	bibus » userCapabilityEnum » canUseControllerStudio	bibus » reportServiceReportSpecification
Trusted	bibus » userCapabilityEnum » canUseEventStudio	bibus » reportServiceMetadataSpecification
—	bibus » userCapabilityEnum » canUseEventStudio	bibus » reportServiceReportSpecification
Trusted	bibus » userCapabilityEnum » canUseMetricsManagerAdministration	bibus » reportServiceMetadataSpecification
Trusted	bibus » userCapabilityEnum » canUseMetricStudio	bibus » reportServiceMetadataSpecification orbibus » reportServiceReportSpecification
Trusted	bibus » userCapabilityEnum » canUsePlanningContributor	bibus » reportServiceMetadataSpecification orbibus » reportServiceReportSpecification
Trusted	bibus » userCapabilityEnum » canUseQueryStudio	bibus » reportServiceMetadataSpecification,bibus » reportServiceQuerySpecification, orbibus » reportServiceReportSpecification
—	bibus » userCapabilityEnum » canUseReportStudio	bibus » reportServiceInteractiveReportSpecification,bibus » reportServiceMetadataSpecification, orbibus » reportServiceReportSpecification
—	bibus » userCapabilityEnum » canUseSpecifications	bibus » reportServiceAnalysisSpecification,bibus » reportServiceInteractiveReportSpecification,bibus » reportServiceMetadataSpecification,bibus » reportServiceQuerySpecification, orbibus » reportServiceReportSpecification

To use this method, all conditions specified by any row must be satisfied:

A specification is Trusted if it is digitally signed or was received via the secure dispatcher entry point (http://server_name:9300/p2pd/servlet/dispatch).
A specification is Not Trusted if it is not digitally signed and was received via the external dispatcher entry point (http://server_name:9300/p2pd/servlet/dispatch/ext).
The object must be a member of one of the specified classes.If a class is not specified, then the class of the object is not used to determine whether the user can execute the method.
The user must have all specified capabilities.

New in Version 10.1.0 — New PowerPlay Service Methods

This method was added. It replaces the following methods:

CognosReportNet » collectParameterValues( spec, options )
report » collectParameterValuesSpecification( specification, parameterValues, options )

New in Version 10.1.0 — IBM Cognos Active Report

This method can now be used with a bibus » reportServiceInteractiveReportSpecification.

The capability rules were updated to include the rules related to the use of the bibus » reportServiceInteractiveReportSpecification class.

powerPlayService information

This information is specific to the powerPlayService service.

This service does not support the parameter » collectParameterValuesSpecification(specification, parameterValues, options).

New in Version 10.1.0 — New PowerPlay Service Methods: The documentation has been updated to show that this service now supports this method.

What's new

New in Version 10.1.0 — New PowerPlay Service Methods: This method was added.

Input parameters

Use the following parameters when calling this method.

specification

Defines the specification associated with the request.

This argument

is of type bibus » asynchSpecification

is encoded as type tns:asynchSpecification

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

is an array of type bibus » parameterValue

is encoded as type tns:parameterValueArray

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

is of type bibus » asynchReply

is encoded as type tns:asynchReply