QAS_EXECUTEQRYASYNC_OPER

QAS supports running a query asynchronously. The request is received and executed. When the query has been completed, the results are asynchronously sent back to the requesting system.

Note:

Pub/Sub must be running on the applications server for asynchronous service operations to be queued and processed.

For asynchronous requests, parameters are mandatory in the SOAP header in order to receive the response. This table lists the Reply To elements in the SOAP header:

These are standard parameters for any asynchronous request/response web service.

Element Description

Address

Address where the http listener is running on the client application.

The Address should be valid and should be accessible to Integration Broker in order to return the query result. If not, the results will never be returned.

ReferenceProperties

Any reference properties necessary for the client application.

PortType

Operations of the service.

Any additional elements

Any additional elements necessary for the client application.

MessageID

Unique message ID. Every request to execute query asynchronously should have a different value for MessageID.

This service operation is used to asynchronously request query execution and return the query results. The response message depends on the result type requested (OutResultType).

Request Message: QAS_EXEQRY_ASYNC_REQ_MSG

Element Name Description

QueryName

Query name.

isConnectedQuery

Indicate whether this is a connected query. Valid values are Y and N.

XMLString

XML string.

Note: See XML String for the elements.

OwnerType

Query owner type.

BlockSizeKB

Required element

If the output format is nonfile, indicate the block size to use for chunking the response. BlockSizeKB is a number of length 10 with a decimal position of 0. Block size is in bytes.

Note: If the BlockSize is 0 all query results are retrieved in 1 block.

MaxRows

The maximum number of rows to be fetched

OutResultType

Select the output type. Valid values are:

  • WEBROWSET

  • XMLP

  • EXCEL

  • HTML

Note: For connected queries, the output type must be XMLP.

OutResultFormat

Select the output format. Valid values are:

  • FILE

  • NONFILE

Note: For connected queries, the output format must be FILE.

<Prompts> These elements are used for Connected Query or queries containing prompts. .

Prompt Elements Description

PSQueryName

This field is used only for Connected Query. Enter the name of the query containing the prompt.

UniquePromptName

Unique prompt name defined in the query. This value is case-sensitive.

Use the service operation QAS_LISTQUERYPROMPTS_OPER to find the unique prompt name.

FieldValue

Field value for the prompt. This value is case-sensitive.

Note: Date fields require the date format as YYYY-MM-DD.

<FieldFilter> If you want to return only specific fields in the query, indicate each field you want returned.

FilterFieldName Element Description

FilterFieldName

List of field names to be returned. This value is case sensitive and must be the unique field name as returned by the service operation QAS_LISTQUERYFIELDS.

Example Request:

This is an example request to run the query MSGCAT_PROMPT and notify the client application when the request has finished.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:add="http://schemas.xmlsoap.org/ws/2003/03/addressing"
xmlns:qas="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_EXEQRY_ASYNC_REQ_MSG.VERSION_1"
xmlns:qas1="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_EXEQRY_ASYNC_REQ.VERSION_1">
   <soapenv:Header>
      <add:ReplyTo>
         <add:Address>http://ple-indodev-08:8082/qasrefapp/callbackservice⇒
</add:Address>
      </add:ReplyTo>
      <add:MessageID>2ae456542b</add:MessageID>
   </soapenv:Header>
   <soapenv:Body>
      <qas:QAS_EXEQRY_ASYNC_REQ_MSG>
         <qas1:QAS_EXEQRY_ASYNC_REQ>
            <QueryName>xrfwin</QueryName>
            <isConnectedQuery>n</isConnectedQuery>
           <OwnerType>public</OwnerType>
            <BlockSizeKB>0</BlockSizeKB>
            <MaxRow></MaxRow>
            <OutResultType>xmlp</OutResultType>
            <OutResultFormat>NONFILE</OutResultFormat>
          </qas1:QAS_EXEQRY_ASYNC_REQ>
      </qas:QAS_EXEQRY_ASYNC_REQ_MSG>
   </soapenv:Body>
</soapenv:Envelope>

For Webrowset , the Response Message is QAS_EXECUTEQRYASYNC_RESP_MSG: QAS_QUERYRESULTS_WSR_RESP

Element Name Description

QueryResults

Query Result in webrowset format

Example Response:

For File, the Response Message is QAS_QUERYRESULTS_FILE_RESP.

Element Name Description

FILEURL

File URL