Process Request APIs

PeopleTools provides two standard APIs for PeopleSoft Process Scheduler:

• COBOL API to support COBOL processes.

• Structured Query Report (SQR) API to support SQR processes.

The API interfaces for COBOL and SQR enable the process request to update:

• Run status

• Completion code

• Message set

• Message number

These API interfaces also enable you to pass up to five free-form parameters, which you can use with MsgGet (Message Get) and MsgGetText (Message Get Text) PeopleCode to display messages while the process is running.

To ensure that the request is physically updated, the API-aware process must perform the API call just before it commits processing.

Note:

Because Application Engine, and nVision requests are managed through an internal API, they are already API-aware and do not require API interface calls.

The following table shows the PeopleTools-based APIs that are provided, including the module name for referencing how to implement the API.

Generic Process Type	API module	Reference
COBOL	PTPUSTAT.CBL	PTPTEDIT.CBL
SQR	PRCSAPI.SQC	XRFWIN.SQR
Workflow	PSDBA.CPP	NA
Application Engine	PSAE.CPP	NA

Application development teams that are working with PeopleSoft applications should ensure that:

• The preceding APIs are properly included in the batch program code.

• Normal program exits are coded to manage API run status updates, for example, Success.

• Program exceptions are trapped and the run status is updated correctly before program termination, for example, No Success or Error.