Examples: Validating Prompt Field and Translate (XLAT) Field Values

This section provides examples of request and response messages for the validating prompt field and translate (XLAT) field values using the PTLOOKUPPROMPT and PTLOOKUPXLAT service operations.

Note: The examples in this section are for non-REST requests and responses only.

The following code example shows a request message sent to a PeopleSoft system as part of the PTLOOKUPXLAT service operation to obtain a list of valid field values and their descriptions for the CERTTYPE field. Note that the LookupFieldValue element is empty (< >). As a result, the PeopleSoft system will return a list of all valid values for the field:

<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http://schemas.xmlsoap.org/ws/2003/03/addressing/" xmlns:xsd="http://www.w3.org/2001/XMLSchema/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance/">
  <soapenv:Header xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <wsse:Security soap:mustUnderstand="1" xmlns:soap="http://schemas.     xmlsoap.org/wsdl/soap/" xmlns:wsse="http://docs.oasis-open.org/wss/     2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
      <wsse:UsernameToken>
        <wsse:Username>username</wsse:Username>
        <wsse:Password>password</wsse:Password>
      </wsse:UsernameToken>
    </wsse:Security>
  </soapenv:Header>
  <soapenv:Body xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <XLAT_Lookup xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/     PT_Lookup.XLAT_Lookup.V1">
      <LookupFieldName>CERTTYPE</LookupFieldName>
      <LookupFieldValue></LookupFieldValue>
      <DescrFieldName>XLATSHORTNAME</DescrFieldName>
      <LanguageCode></LanguageCode>
      <EffectiveDate>2010-01-03</EffectiveDate>
    </XLAT_Lookup>
  </soapenv:Body>
</soapenv:Envelope>

The following code example shows the response message that the PeopleSoft system returns to the integration partner. The returned field values are returned in the <RespVal> and <RespDescr> elements, as highlighted in the example:

<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenc="http://schemas.xmlsoap.org/soap/
encoding/" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/
" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance">
    <soapenv:Body>
        <LookupResponse xmlns="http://xmlns.oracle.com/Enterprise/
        Tools/schemas/PT_Lookup.LookupResponse.V1">
            <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/
            Tools/schemas/PT_Lookup.ResponseComp.V1">
                <RespVal>USER</RespVal>
                <RespDescr>User</RespDescr>
            </ResponseComp>
            <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/
            Tools/schemas/PT_Lookup.ResponseComp.V1"><RespVal>NODE</RespVal>
                <RespDescr>Node</RespDescr>
            </ResponseComp>
            <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/
            Tools/schemas/PT_Lookup.ResponseComp.V1"> <RespVal>CERT</RespVal>
                <RespDescr>Cert</RespDescr>
            </ResponseComp>
            <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/
            Tools/schemas/PT_Lookup.ResponseComp.V1"><RespVal>ROOT</RespVal>
                <RespDescr>Root CA</RespDescr>
            </ResponseComp>
        </LookupResponse>
    </soapenv:Body>
</soapenv:Envelope>

The following code example shows a request message sent to a PeopleSoft system as part of the PTLOOKUPPROMPT service operation to perform a prompt table lookup on the Country table using a wildcard (%) on the field value to find country names that begin with the letter U:

<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/
" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http:
//schemas.xmlsoap.org/ws/2003/03/addressing/" xmlns:xsd="http://www.w3.org/
2001/XMLSchema/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance/">
  <soapenv:Header xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <wsse:Security soap:mustUnderstand="1" xmlns:soap="http://schemas.xmlsoap.
    org/wsdl/soap/" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-
    200401-wss-wssecurity-secext-1.0.xsd">
      <wsse:UsernameToken>
        <wsse:Username>username</wsse:Username>
        <wsse:Password>password/wsse:Password>
      </wsse:UsernameToken>
    </wsse:Security>
  </soapenv:Header>
  <soapenv:Body xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <Lookup xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
    PT_Lookup.Prompt_Lookup.V1">
      <LookupRecName>COUNTRY_TBL</LookupRecName>
      <LookupFieldName>COUNTRY</LookupFieldName>
      <LookupFieldValue>U%</LookupFieldValue>
      <DescrFieldName>DESCR</DescrFieldName>
      <LanguageCode></LanguageCode>
      <EffectiveDate></EffectiveDate>
    </Lookup>
  </soapenv:Body>
</soapenv:Envelope>

The following code example shows the response message that the PeopleSoft system returns to the integration partner. The returned field values are returned in the <RespVal> and <RespDescr> elements, as highlighted in the example:

<?xml version="1.0" encoding="UTF-8"?> <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><LookupResponse xmlns="http://xmlns.oracle.com/Enterprise/
   Tools/schemas/PT_Lookup.LookupResponse.V1">
      <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
      PT_Lookup.ResponseComp.V1">
         <RespVal>UMI</RespVal>
         <RespDescr>US Minor Outlying Islands</RespDescr>
      </ResponseComp>
      <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
      PT_Lookup.ResponseComp.V1"><RespVal>UGA</RespVal>
         <RespDescr>Uganda</RespDescr>
      </ResponseComp>
      <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
      PT_Lookup.ResponseComp.V1"><RespVal>UKR</RespVal>
         <RespDescr>Ukraine</RespDescr>
      </ResponseComp>
      <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
      PT_Lookup.ResponseComp.V1"><RespVal>USA</RespVal>
         <RespDescr>United States</RespDescr>
      </ResponseComp>
      <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
      PT_Lookup.ResponseComp.V1"><RespVal>URY</RespVal>
         <RespDescr>Uruguay</RespDescr>
      </ResponseComp>
      <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
      PT_Lookup.ResponseComp.V1"><RespVal>UZB</RespVal>
         <RespDescr>Uzbekistan</RespDescr>
      </ResponseComp>
    </LookupResponse>
  </soapenv:Body>
</soapenv:Envelope>

The following code example shows a request message sent to a PeopleSoft system from an integration partner as part of the PTLOOKUPPROMPT service operation to obtain a list of field values from the Currency table of currencies from Argentina that start with A by using name/value pair as additional filter:

<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/
" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:wsa="http:
//schemas.xmlsoap.org/ws/2003/03/addressing/" xmlns:xsd="http://www.w3.org/
2001/XMLSchema/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance/">
  <soapenv:Header xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <wsse:Security soap:mustUnderstand="1" xmlns:soap="http://schemas.
    xmlsoap.org/wsdl/soap/" xmlns:wsse="http://docs.oasis-open.org/wss/
    2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
      <wsse:UsernameToken>
        <wsse:Username>username/wsse:Username>
        <wsse:Password>password</wsse:Password>
      </wsse:UsernameToken>
    </wsse:Security>
  </soapenv:Header>
<soapenv:Body xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <Lookup xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
   PT_Lookup.Prompt_Lookup_All.V1">
     <LookupRecName>CURRENCY_CD_TBL</LookupRecName>
     <LookupFieldName>CURRENCY_CD</LookupFieldName>
     <LookupFieldValue>A%</LookupFieldValue>
     <DescrFieldName>DESCR</DescrFieldName>
     <LanguageCode></LanguageCode>
     <EffectiveDate/>
     <SetControlFieldValue/>
     <SetIDValue/>
     <NameValPair xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
     PT_Lookup.NameValPair.V1"><FldName>COUNTRY</FldName>
        <FldVal>ARG</FldVal>
     </NameValPair>
  </Lookup>
  </soapenv:Body>
</soapenv:Envelope>


<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/
" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd=
"http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance">
    <soapenv:Body>
        <LookupResponse xmlns="http://xmlns.oracle.com/Enterprise/Tools/
        schemas/PT_Lookup.LookupResponse.V1">
            <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/Tools/
            schemas/PT_Lookup.ResponseComp.V1">
                <RespVal>ARS</RespVal>
                <RespDescr>Argentine Peso</RespDescr>
            </ResponseComp>
        </LookupResponse>
    </soapenv:Body>
</soapenv:Envelope>

The following code example shows a request message sent to a PeopleSoft system from an integration partner as part of the PTLOOKUPPROMPT service operation to obtain a list of valid field values for the VENDOR_ID prompt field, a field controlled by a set control field.

When you provide the set control field value, PeopleSoft uses Set ID indirection (via the GetSetID built-in function ) to obtain the set ID value, and uses it to filter results during lookup.

This example shows specifying the set control field value to obtain the values for the field:

<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/
"xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http:
//schemas.xmlsoap.org/ws/2003/03/addressing/" xmlns:xsd="http://www.w3.org/
2001/XMLSchema/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance/">
  <soapenv:Header xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <wsse:Security soap:mustUnderstand="1" xmlns:soap="http://schemas.xmlsoap.
    org/wsdl/soap/" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/
    oasis-200401-wss-wssecurity-secext-1.0.xsd">
      <wsse:UsernameToken>
        <wsse:Username>username</wsse:Username>
        <wsse:Password>password</wsse:Password>
      </wsse:UsernameToken>
    </wsse:Security>
  </soapenv:Header>
<soapenv:Body xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <Lookup xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
  PT_Lookup.Prompt_Lookup_All.V1">
    <LookupRecName>VENDOR</LookupRecName>
    <LookupFieldName>VENDOR_ID</LookupFieldName>
    <LookupFieldValue>TPDENTIST</LookupFieldValue>
    <DescrFieldName>VENDOR_NAME_SHORT</DescrFieldName>
    <LanguageCode/>
    <EffectiveDate/><SetControlFieldValue>US001</SetControlFieldValue>
    <SetIDValue/>
    <NameValPair xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
    PT_Lookup.NameValPair.V1">
        <FldName/>
        <FldVal/>
      </NameValPair>
    </Lookup>
   </soapenv:Body>
</soapenv:Envelope>

<?xml version="1.0" encoding="UTF-8"?>
<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>
      <LookupResponse xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
      PT_Lookup.LookupResponse.V1">
         <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
         PT_Lookup.ResponseComp.V1">
              <RespVal>TPDENTIST</RespVal>
              <RespDescr>SMILEWELL-001</RespDescr>
         </ResponseComp>
      </LookupResponse>
    </soapenv:Body>
</soapenv:Envelope>

<?xml version="1.0"?>
<soapenv:Envelope xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/
"xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsa="http:
//schemas.xmlsoap.org/ws/2003/03/addressing/"xmlns:xsd="http://www.w3.org/
2001/XMLSchema/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance/">
  <soapenv:Header xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <wsse:Security soap:mustUnderstand="1" xmlns:soap="http://schemas.xmlsoap.
     org/wsdl/soap/" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-
     200401-wss-wssecurity-secext-1.0.xsd">
      <wsse:UsernameToken>
        <wsse:Username>username</wsse:Username>
        <wsse:Password>password</wsse:Password>
      </wsse:UsernameToken>
    </wsse:Security>
  </soapenv:Header>
<soapenv:Body xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
    <Lookup xmlns="http://xmlns.oracle.com/Enterprise/Tools/schemas/
    PT_Lookup.Prompt_Lookup_All.V1">
        <LookupRecName>VENDOR</LookupRecName>
        <LookupFieldName>VENDOR_ID</LookupFieldName>
        <LookupFieldValue>TPDENTIST</LookupFieldValue>
        <DescrFieldName>VENDOR_NAME_SHORT</DescrFieldName>
        <LanguageCode/>
        <EffectiveDate/>
        <SetControlFieldValue/><SetIDValue>SHARE</SetIDValue>
        <NameValPair xmlns="http://xmlns.oracle.com/Enterprise/Tools/
        schemas/PT_Lookup.NameValPair.V1">
            <FldName/>
            <FldVal/>
         </NameValPair>
     </Lookup>
   </soapenv:Body>
</soapenv:Envelope>

<?xml version="1.0" encoding="UTF-8"?>
<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>
       <LookupResponse xmlns="http://xmlns.oracle.com/Enterprise/Tools/
       schemas/PT_Lookup.LookupResponse.V1">
          <ResponseComp xmlns="http://xmlns.oracle.com/Enterprise/Tools/
          schemas/PT_Lookup.ResponseComp.V1">
              <RespVal>TPDENTIST</RespVal>
              <RespDescr>SMILEWELL-001</RespDescr>
           </ResponseComp>
        </LookupResponse>
    </soapenv:Body>
</soapenv:Envelope>

Examples: Validating Prompt Field and Translate (XLAT) Field Values

Example 1: Validating a Translate (XLAT) Field

Example 2: Performing a Prompt Table Lookup with a Field Value Wildcard

Example 3: Filtering Field Values by Name/Value Pairs

Example 4: Specifying Set Control Field Values to Validate Field Values Controlled by Set Control Fields

Example 5: Specifying Set Control ID Values to Validate Field Values Controlled by Set ID Values