Entering Prompts

This section describes the service operations that are available for discovering prompt and valid prompt values for a query. These include:

SOAP based service operations:
- QAS_LISTQUERYPROMPTS_OPER
  
  See, QAS_LISTQUERYPROMPTS_OPER.
- QAS_GETPROMPTTABLEVALUES_OPER
  
  See, QAS_GETPROMPTTABLEVALUES_OPER.
- QAS_GETXLAT_OPER
  See, QAS_GETXLAT_OPER.
RESTful based service operation:
- QAS_LISTQUERYPROMPTS_REST_GET
  
  See, QAS_LISTQUERYPROMPTS_REST_GET.
- QAS_GETPROMPTTABLEVAL_REST_GET
  
  See, QAS_GETPROMPTTABLEVAL_REST_GET.
- QAS_GETXLAT_REST_GET
  See, QAS_GETXLAT_REST_GET.

Use this service operation to retrieve a list of the prompts and associated prompt table for a specific query.

Request Message: QAS_LISTQUERYPROMPTS_REQ_MSG

Element Name	Description
QueryName Required element	Complete Query Name. Required.
OwnerType	Optionally, enter the query owner type. If no value is entered, both public and private are searched.
isConnectedQuery Required element	Indicate whether this is a connected query. Required. Valid values are `Y` and `N.`

Element Name

Description

QueryName

Required element

Complete Query Name. Required.

OwnerType

Optionally, enter the query owner type.

If no value is entered, both public and private are searched.

isConnectedQuery

Required element

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

Example Request:

This request will return the prompt field and prompt table for the query TWO_PROMPT_QUERY.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:qas="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_LISTQUERYPROMPTS_REQ_MSG.VERSION_1"
xmlns:qas1="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_LISTQUERYPROMPTS_REQ.VERSION_1">
   <soapenv:Header/>
   <soapenv:Body>
      <qas:QAS_LISTQUERYPROMPTS_REQ_MSG>
         <qas:QAS_LISTQUERYPROMPTS_REQ>
            <qas1:PTQASWRK class="R">
               <qas1:QueryName>TWO_PROMPT_QUERY</qas1:QueryName>
               <!--Optional:-->
               <qas1:OwnerType>PUBLIC</qas1:OwnerType>
               <qas1:isConnectedQuery>n</qas1:isConnectedQuery>
            </qas1:PTQASWRK>
         </qas:QAS_LISTQUERYPROMPTS_REQ>
      </qas:QAS_LISTQUERYPROMPTS_REQ_MSG>
   </soapenv:Body>
</soapenv:Envelope>

Response Message: QAS_LISTQUERYPROMPTS_RESP_MSG

Element Name	Description
QueryName	Query name.
FieldName	If this prompt uses a translate table, the field name for the prompt is returned.
HeadingText	Heading text for the prompt.
FieldType	Prompt field type.
FormatText	Format for the text.
FieldLength	Field length for the prompt.
FieldDecimal	Number of decimal places in the prompt field.
UniquePromptName	The unique name used for the prompt. This value is case-sensitive.
EditType	The type of edit: `Translate table` `Yes/No table` `Prompt table` `No table edit`
PromptTable	If this prompt uses a prompt table, the table name is returned.

Example Response:

This response has two prompts, one for a prompt table and one for a translate table edit.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <QAS_LISTQUERYPROMPTS_RESP_MSG xmlns="http://xmlns.oracle.com/
      Enterprise/Tools/schemas/QAS_LISTQUERYPROMPTS_RESP_MSG.VERSION_1">
         <QAS_LISTQUERYPROMPTS_RESP>
            <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/
            Tools/schemas/QAS_LISTQUERYPROMPTS_RESP.VERSION_1">
               <QueryName>TWO_PROMPT_QUERY</QueryName>
               <PTQASPRMPTWRK class="R">
                  <FieldName>NODE_TYPE</FieldName>
                  <HeadingText>Node Type</HeadingText>
                  <FieldType>string</FieldType>
                  <FormatText>upper</FormatText>
                  <FieldLength>30</FieldLength>
                  <FieldDecimal>0</FieldDecimal>
                  <UniquePromptName>BIND1</UniquePromptName>
                  <EditType>Translate table</EditType>
                  <PromptTable/>
               </PTQASPRMPTWRK>
               <PTQASPRMPTWRK class="R">
                  <FieldName>PORTAL_TYPE</FieldName>
                  <HeadingText>Portal</HeadingText>
                  <FieldType>string</FieldType>
                  <FormatText>upper</FormatText>
                  <FieldLength>30</FieldLength>
                  <FieldDecimal>0</FieldDecimal>
                  <UniquePromptName>BIND2</UniquePromptName>
                  <EditType>Prompt table</EditType>
                  <PromptTable>PSPRDMDEFN</PromptTable>
               </PTQASPRMPTWRK>
            </PTQASWRK>
         </QAS_LISTQUERYPROMPTS_RESP>
      </QAS_LISTQUERYPROMPTS_RESP_MSG>
   </soapenv:Body>
</soapenv:Envelope>

Use this service operation to retrieve a list of the prompts and associated prompt table for a specific query.

Request Message: QAS_LISTQUERYPROMPTS_TEMPL

Element Name	Description
QueryName	Enter the complete Query Name. It is a required element.
OwnerType	Optionally, enter the query owner type. If no value is entered, both public and private are searched.
isConnectedQuery	Indicate whether this is a connected query. It is a required element. Valid values are `Y` and `N.`.
json_response	Enter `true` for JSON response type; enter `false` for standard XML response. If no value is provided, the default is standard XML response.

Example Request:

This request will return the prompt field and prompt table for the query TWO_PROMPT_QUERY.

https://<servername>:<port>/PSIGW/RESTListeningConnector/<defaultlocal node>/QueryPrompts.v1/public/MESSAGES_FOR_MSGSET?isconnectedquery=N

Example of an URI template

{OwnerType}/{QueryName}?isconnectedquery={IsConnectedQuery}&json_resp={json_response}

Response Message: QAS_LISTQUERYPROMPTS_RESP_MSG

Element Name	Description
QueryName	Query name.
FieldName	If this prompt uses a translate table, the field name for the prompt is returned.
HeadingText	Heading text for the prompt.
FieldType	Prompt field type.
FormatText	Format for the text.
FieldLength	Field length for the prompt.
FieldDecimal	Number of decimal places in the prompt field.
UniquePromptName	The unique name used for the prompt. This value is case-sensitive.
EditType	The type of edit: `Translate table` `Yes/No table` `Prompt table` `No table edit`
PromptTable	If this prompt uses a prompt table, the table name is returned.

Example Response:

This response has two prompts, one for a prompt table and one for a translate table edit.

<?xml version="1.0"?>
<QAS_LISTQUERYPROMPTS_RESP_MSG xmlns="http://xmlns.oracle.com/Enterprise/
Tools/schemas/QAS_LISTQUERYPROMPTS_RESP_MSG.VERSION_1">
    <QAS_LISTQUERYPROMPTS_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/Tools/
         schemas/QAS_LISTQUERYPROMPTS_RESP.VERSION_1">
            <QueryName>MESSAGES_FOR_MSGSET</QueryName>
            <PTQASPRMPTWRK class="R">
                <FieldName>MESSAGE_SET_NBR</FieldName>
                <HeadingText>Message Set Number</HeadingText>
                <FieldType>decimal</FieldType>
                <FormatText>upper</FormatText>
                <FieldLength>5</FieldLength>
                <FieldDecimal>0</FieldDecimal>
                <UniquePromptName>MESSAGE_SET_NBR</UniquePromptName>
                <EditType>Prompt table</EditType>
                <PromptTable>PSMSGSETDEFN</PromptTable>
            </PTQASPRMPTWRK>
        </PTQASWRK>
    </QAS_LISTQUERYPROMPTS_RESP>
</QAS_LISTQUERYPROMPTS_RESP_MSG>

Example response

When the parameter json_response is set to true:

{   "status": "success","data": {   "QueryPrompts": [   {"queryName": "MESSAGES_FOR_MSGSET","Prompts": [   {"fieldName": "MESSAGE_SET_NBR","headingText": "Message Set Number","fieldType": 
     "decimal","formatText": "upper","fieldLength": 5,"fieldDecimal": 0,
     "uniquePromptName":"MESSAGE_SET_NBR","editType": 
     "Prompt table","promptTable": "PSMSGSETDEFN"}	]}	]}}

Use this service operation to return a list of field values for a given prompt table.

Request Message: QAS_GETPRMPTTBLVAL_REQ_MSG

Element Name	Description
PromptTableName Required element	Complete prompt record name. Required.
FieldValue	Optional search string for the key field value. If no value is entered, a list of all key values will be returned. Note: Multiple keys are not supported in PS Query. Tables with no keys are not supported in PS Query.
MaxRows	Optionally, enter the maximum number of rows to be returned. MaxRows is a number of length 10 with a decimal position of 0.

Element Name

Description

PromptTableName

Required element

Complete prompt record name. Required.

FieldValue

Optional search string for the key field value.

If no value is entered, a list of all key values will be returned.

Note: Multiple keys are not supported in PS Query. Tables with no keys are not supported in PS Query.

MaxRows

Optionally, enter the maximum number of rows to be returned. MaxRows is a number of length 10 with a decimal position of 0.

Example Request:

This request will return the first three rows of prompt table values for the table PSMSGSETDEFN.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:qas="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_GETPRMPTTBLVAL_REQ_MSG.VERSION_1" xmlns:qas1="http://xmlns.oracle.com/
Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_REQ.VERSION_1">
   <soapenv:Header/>
   <soapenv:Body>
      <qas:QAS_GETPRMPTTBLVAL_REQ_MSG>
         <!--Zero or more repetitions:-->
         <qas:QAS_GETPRMPTTBLVAL_REQ>
            <qas1:PTQASWRK class="R">
               <qas1:PromptTableName>psmsgsetdefn</qas1:PromptTableName>
               <!--Optional:-->
               <qas1:MaxRows>3</qas1:MaxRows>
               <!--Optional:-->
               <qas1:FieldName></qas1:FieldName>
            </qas1:PTQASWRK>
         </qas:QAS_GETPRMPTTBLVAL_REQ>
      </qas:QAS_GETPRMPTTBLVAL_REQ_MSG>
   </soapenv:Body>
</soapenv:Envelope>

Response Message: QAS_GETPRMPTTBLVALUES_RESP_MSG

Element Name	Description
FieldValue	Field value.

Example Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <QAS_GETPRMPTTBLVAL_RESP_MSG xmlns="http://xmlns.oracle.com/
       Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP_MSG.VERSION_1">
         <QAS_GETPRMPTTBLVAL_RESP>
            <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
            Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
               <FieldValue>1</FieldValue>
            </PTQASFIELDWRK>
         </QAS_GETPRMPTTBLVAL_RESP>
         <QAS_GETPRMPTTBLVAL_RESP>
            <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
             Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
               <FieldValue>2</FieldValue>
            </PTQASFIELDWRK>
         </QAS_GETPRMPTTBLVAL_RESP>
         <QAS_GETPRMPTTBLVAL_RESP>
            <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
            Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
               <FieldValue>3</FieldValue>
            </PTQASFIELDWRK>
         </QAS_GETPRMPTTBLVAL_RESP>
      </QAS_GETPRMPTTBLVAL_RESP_MSG>
   </soapenv:Body>
</soapenv:Envelope>

Use this service operation to return a list of field values for a given prompt table.

Request Message: QAS_GETPROMPTTABLEVALUES_TEMPL

Element Name	Description
PromptTableName	Enter complete prompt record name. It is a required element.
FieldValue	Optional search string for the key field value. If no value is entered, a list of all key values will be returned. Note: Multiple keys are not supported in PS Query. Tables with no keys are not supported in PS Query.
MaxRows	Optionally, enter the maximum number of rows to be returned. MaxRows is a number of length 10 with a decimal position of 0.
json_response	Enter `true` for JSON response type; enter `false` for standard XML response. If no value is provided, then the default is standard the XML response.

Example Request:

https://<servername>:<port>/PSIGW/RESTListeningConnector/<defaultlocal node>/PromptTableValues.v1/PSMSGSETDEFN?fieldvalue=&maxrows=1000

Example of an URI template

{PromptTableName}?fieldvalue={FieldValue}&maxrows={MaxRows}&json_resp={json_response}

Response Message: QAS_GETPRMPTTBLVALUES_RESP_MSG

Element Name	Description
FieldValue	Field value.

Example Response:

<?xml version="1.0"?>
<QAS_GETPRMPTTBLVAL_RESP_MSG xmlns="http://xmlns.oracle.com/
Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP_MSG.VERSION_1">
    <QAS_GETPRMPTTBLVAL_RESP>
        <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
         Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
            <FieldValue>1</FieldValue>
        </PTQASFIELDWRK>
    </QAS_GETPRMPTTBLVAL_RESP>
    <QAS_GETPRMPTTBLVAL_RESP>
        <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
         Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
            <FieldValue>2</FieldValue>
        </PTQASFIELDWRK>
    </QAS_GETPRMPTTBLVAL_RESP>
    <QAS_GETPRMPTTBLVAL_RESP>
        <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
         Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
            <FieldValue>3</FieldValue>
        </PTQASFIELDWRK>
    </QAS_GETPRMPTTBLVAL_RESP>
    <QAS_GETPRMPTTBLVAL_RESP>
        <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
         Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
            <FieldValue>4</FieldValue>
        </PTQASFIELDWRK>
    </QAS_GETPRMPTTBLVAL_RESP>
    <QAS_GETPRMPTTBLVAL_RESP>
        <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
         Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
            <FieldValue>5</FieldValue>
        </PTQASFIELDWRK>
    </QAS_GETPRMPTTBLVAL_RESP>
    <QAS_GETPRMPTTBLVAL_RESP>
        <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
         Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
            <FieldValue>6</FieldValue>
        </PTQASFIELDWRK>
    </QAS_GETPRMPTTBLVAL_RESP>
    <QAS_GETPRMPTTBLVAL_RESP>
        <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
        Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
            <FieldValue>7</FieldValue>
        </PTQASFIELDWRK>
    </QAS_GETPRMPTTBLVAL_RESP>
    <QAS_GETPRMPTTBLVAL_RESP>
        <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
         Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
            <FieldValue>8</FieldValue>
        </PTQASFIELDWRK>
    </QAS_GETPRMPTTBLVAL_RESP>
    <QAS_GETPRMPTTBLVAL_RESP>
        <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
         Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
            <FieldValue>9</FieldValue>
        </PTQASFIELDWRK>
    </QAS_GETPRMPTTBLVAL_RESP>
    <QAS_GETPRMPTTBLVAL_RESP>
        <PTQASFIELDWRK class="R" xmlns="http://xmlns.oracle.com/
         Enterprise/Tools/schemas/QAS_GETPRMPTTBLVAL_RESP.VERSION_1">
            <FieldValue>10</FieldValue>
        </PTQASFIELDWRK>
    </QAS_GETPRMPTTBLVAL_RESP>
</QAS_GETPRMPTTBLVAL_RESP_MSG>

Example response

When the parameter json_response is set to true:

{	"status": "success","data": {	"fieldValue": [	"1","2","3","4","5","6","7","8","9","10"]}}

Use this service operation to return the translate values for a given field.

Request Message: QAS_GETXLAT_TEMPL

Element Name	Description
FieldName	Complete field name. Required.

Example Request:

This request will return the translate value for EFF_STATUS.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:qas="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_GETXLAT_REQ_MSG.VERSION_1"
xmlns:qas1="http://xmlns.oracle.com/Enterprise/Tools/schemas/
QAS_GETXLAT_REQ.VERSION_1"> 
   <soapenv:Header/>
   <soapenv:Body>
      <qas:QAS_GETXLAT_REQ_MSG>
         <!--Zero or more repetitions:-->
         <qas:QAS_GETXLAT_REQ>
            <qas1:PTQASWRK class="R">
               <qas1:FieldName>EFF_STATUS</qas1:FieldName>
            </qas1:PTQASWRK>
         </qas:QAS_GETXLAT_REQ>
      </qas:QAS_GETXLAT_REQ_MSG>
   </soapenv:Body>
</soapenv:Envelope>

Response Message: QAS_GETXLAT_RESP_MSG

Element Name	Description
FieldValue	Translate value.
ShortName	Short name for the translate value.
LongName	Long name for the translate value.

Example Response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Body>
      <QAS_GETXLAT_RESP_MSG xmlns="http://xmlns.oracle.com/Enterprise/
      Tools/schemas/QAS_GETXLAT_RESP_MSG.VERSION_1">
         <QAS_GETXLAT_RESP>
            <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/
            Tools/schemas/QAS_GETXLAT_RESP.VERSION_1">
               <FieldValue>A</FieldValue>
               <ShortName>Active</ShortName>
               <LongName>Active</LongName>
            </PTQASWRK>
         </QAS_GETXLAT_RESP>
         <QAS_GETXLAT_RESP>
            <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/
            Tools/schemas/QAS_GETXLAT_RESP.VERSION_1">
               <FieldValue>I</FieldValue>
               <ShortName>Inactive</ShortName>
               <LongName>Inactive</LongName>
            </PTQASWRK>
         </QAS_GETXLAT_RESP>
      </QAS_GETXLAT_RESP_MSG>
   </soapenv:Body>
</soapenv:Envelope>

Use this service operation to return the translate values for a given field.

Request Message: QAS_GETXLAT_TEMPL

Element Name	Description
FieldName	Complete field name. Required.

Example Request:

https://<servername>:<port>/PSIGW/RESTListeningConnector/<defaultlocal node>/TranslateValues.v1/EFF_STATUS

Response Message: QAS_GETXLAT_RESP_MSG

Element Name	Description
FieldValue	Translate value.
ShortName	Short name for the translate value.
LongName	Long name for the translate value.

Example Response:

<?xml version="1.0"?>
<QAS_GETXLAT_RESP_MSG xmlns="http://xmlns.oracle.com/Enterprise/
Tools/schemas/QAS_GETXLAT_RESP_MSG.VERSION_1">
    <QAS_GETXLAT_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/
        Tools/schemas/QAS_GETXLAT_RESP.VERSION_1">
            <FieldValue>A</FieldValue>
            <ShortName>Active</ShortName>
            <LongName>Active</LongName>
        </PTQASWRK>
    </QAS_GETXLAT_RESP>
    <QAS_GETXLAT_RESP>
        <PTQASWRK class="R" xmlns="http://xmlns.oracle.com/Enterprise/
         Tools/schemas/QAS_GETXLAT_RESP.VERSION_1">
            <FieldValue>I</FieldValue>
            <ShortName>Inactive</ShortName>
            <LongName>Inactive</LongName>
        </PTQASWRK>
    </QAS_GETXLAT_RESP>
</QAS_GETXLAT_RESP_MSG>

Entering Prompts

QAS_LISTQUERYPROMPTS_OPER

Request Message: QAS_LISTQUERYPROMPTS_REQ_MSG

Response Message: QAS_LISTQUERYPROMPTS_RESP_MSG

QAS_LISTQUERYPROMPTS_REST_GET

Request Message: QAS_LISTQUERYPROMPTS_TEMPL

Example Request:

Example of an URI template

Response Message: QAS_LISTQUERYPROMPTS_RESP_MSG

QAS_GETPROMPTTABLEVALUES_OPER

Request Message: QAS_GETPRMPTTBLVAL_REQ_MSG

Response Message: QAS_GETPRMPTTBLVALUES_RESP_MSG

QAS_GETPROMPTTABLEVAL_REST_GET

Request Message: QAS_GETPROMPTTABLEVALUES_TEMPL

Example Request:

Example of an URI template

Response Message: QAS_GETPRMPTTBLVALUES_RESP_MSG

QAS_GETXLAT_OPER

Request Message: QAS_GETXLAT_TEMPL

Response Message: QAS_GETXLAT_RESP_MSG

QAS_GETXLAT_REST_GET

Request Message: QAS_GETXLAT_TEMPL

Response Message: QAS_GETXLAT_RESP_MSG