Validating Translate (XLAT) Field Values
This section discusses how to use the PTLOOKUPXLAT service operation and the PTLOOKUPXLAT_REST_GET service operation to validate XLAT field values.
Note: XLAT values are effective-dated, and only the values marked as Active are used for validation.
XLAT table entries associated with a field definition include the following attributes:
Attribute |
Description |
---|---|
FIELDNAME |
Field name, such as ABSENCE_TYPE. |
LANGUAGE_CD |
Language code. |
FIELDVALUE |
Value for the field; it must be between 1 and 4 characters long. |
EFFDT |
Effective date. |
VERSION |
Internal version number (system-maintained). |
EFF_STATUS |
The status of the field, active or inactive. |
XLATLONGNAME |
Thirty-character description; used as a label on pages and reports. |
XLATSHORTNAME |
Ten-character description; used as a label on pages and reports. |
Use service operation security permission lists to secure access to this service operation.
Requests must be sent to the PeopleSoft system using SSL or TLS.
The PTLOOKUPXLAT service operation is a non-REST service operation that you can use to validate prompt table field values. To access the service operation, select
and select the PTLOOKUPXLAT service operation.PTLOOKUPXLAT is a restricted service operation that is delivered with the following metadata:
Metadata Type |
Name |
Comments |
---|---|---|
Request Message |
PTLOOKUPXLAT.V1 |
PTLOOKUPXLAT.V1 is a document-based message. |
Response Message |
PTLOOKUPXLATRESP.V1 |
PTLOOKUPXLATRESP.V1 is a document-based message. |
Handler |
REQUESTHNDLR |
REQUESTHNDLR is an OnRequest handler that is implemented using an application class. The application class package delivered is PT_IB_LOOKUP and the class ID is RequestHandler. |
Routing |
System generated. |
PeopleSoft delivers a system-generated synchronous any-to-local routing for this service operation. |
Listening Connector |
PeopleSoftServices |
The default listening connector. |
The PTLOOKUPXLAT_REST_GET service operation is a REST-based service operation that you can use to validate prompt table field values. To access the service operation, select
The Service page appears. In the Existing Operation section click the PTLOOKUPXLAT_REST_GET service operation.The PTLOOKUPXLAT_REST_GETservice operation is delivered with the following metadata:
Metadata Type |
Name |
Description |
---|---|---|
URI Templates |
NA |
The service operation is delivered with four (4) pre-defined URI templates. The templates are listed after this table. |
Document Template |
PTLOOKUPXLAT.V1 |
The Document type message. The document message has elements defined with names used for value replacement within the URI template(s). |
Request Message |
NA |
In a REST-based service operation a request is made by sending a URL based on one of the URI templates. |
Response Message |
PTLOOKUPRESP.V1 |
PTLOOKUPRESP.V1 is a document-based message. |
Fault Message |
PT_LOOKUP_RESTFAULT.v1 |
PT_LOOKUP_RESTFAULT.v1 is a document-based message. |
Handler |
REQUESTHNDLR |
REQUESTHNDLR is an OnRequest handler that is implemented using an application class. The application class package delivered is PT_IB_LOOKUP and the class ID is RequestHandler. |
Routing |
System generated. |
PeopleSoft delivers a system-generated synchronous any-to-local routing for this service operation. |
Listening Connector |
RESTListeningConnector |
The default listening connector. |
The following URI templates are delivered with this service operation:
XLAT_Lookup/{LookupFieldName}?fieldVal={LookupFieldValue}
XLAT_Lookup/{LookupFieldName}/{DescrFieldName}/{EffectiveDate}
XLAT_Lookup/{LookupFieldName}/{LanguageCode}/{DescrFieldName}/{EffectiveDate}
XLAT_Lookup/{LookupFieldName}/{LanguageCode}/{EffectiveDate}/{DescrFieldName}?fieldVal={LookupFieldValue}