Using Messages to Request Valid Prompt Field and Translate (XLAT) Field Values

The request message for either service operation is a document type message, and includes one or more sets of the following as inputs associated with the look-up operation:

Element

Description

LookupRecName

Populate this element with the prompt table that contains the data to validate.

This element appears only when performing a prompt table lookup and working with the PTLOOKUPPROMPT message.

When you perform an XLAT lookup, there is only one XLAT table for the entire PeopleSoft database and the table name, PSXLATITEM, is fixed. As a result you do not need to provide the table name when performing an XLAT lookup.

LookupFieldName

Populate this element with the field name to validate.

LookupFieldValue

(Optional) Populate this element with the name of the descriptor field. The descriptor field describes the purpose of the record, not the field.

The valid values are:

  • A specific value to look up.

  • Blank (empty). This will return a list of all possible values.

  • A wildcard (%) value. For example, entering A% will return all results that start with the letter A.

DescrFieldName

(Optional) Populate this element with the field name description.

LanguageCode

(Optional) Populate this element with the language code.

EffectiveDate

(Optional) Populate this element with the effective date.

SetControlFieldValue

(Optional) Appears only in the PTLOOKUPPROMPT.V1 request message for validating prompt table field values.

If you are validating a prompt table field value that is controlled by a set control field, enter the set control field value in the SetControlFieldValue element in the request message. The system uses this information to extract the name of the SETID field used to partition the data in the table.

If you do not enter the set control field value, you must enter the set ID value in the SetIDValue element in the request message. The SetIDValue element is described elsewhere in this table.

If you enter a set control field value and a set ID value, the system uses the set control field value to locate the field name.

SetIDValue

(Optional) Appears only in the PTLOOKUPPROMPT.V1 request message for validating prompt table field values.

If you are validating a prompt table field value that is controlled by a set control field, enter the set ID value in the SetIDValue element.

If you also enter a set control field value in the request message, as described elsewhere in this table, the system uses that value, not the set ID value, to locate the field name.

FldName

(Optional) Appears only in the PTLOOKUPPROMPT.V1 request message for validating prompt table field values.

If you are validating a prompt table field use this element in conjunction with the FldNameValue element to return name/value pairs for the field.

FldNameValue

(Optional) Appears only in the PTLOOKUPPROMPT.V1 request message for validating prompt table field values.

If you are validating a prompt table field use this element in conjunction with the FldName element to return name/value pairs for the field.

Examples of response messages are provided elsewhere in this appendix.