Creating a Request Message

This section provides an overview of the request message and describes how to create messages that:

  • Create an optimization engine.

  • Check optimization engine status.

  • Run an optimization engine transaction.

  • Set the trace level.

  • Get the trace level.

  • Shutdown an optimization engine.

Understanding the Request Message

For optimization, the Application Engine PeopleCode in PeopleSoft Process Scheduler sends a request OPT_CALL message. The message uses rowsets built from PT_OPTPARMS records as the request. You can use the following rowset structures as an example of how to perform certain optimization actions, by sending them as requests from the application engine program in the process scheduler to the message notification PeopleCode in the application server.

Creating an Optimization Engine

To create an optimization engine, structure the rowset as follows, using the PT_OPTPARMS record. You set key values using the PARMKEY field, and then set a value for that key field in the VALUE field.

PARMKEY Field VALUE Field

OPTCMD

CREATE

Causes the PeopleCode program implementing the Integration Broker OnRequest method to load an optimization engine. The OPT_CALL example executes the CreateOptEngine function.

PROBINST

The name of the analytic instance.

PROCINSTANCE

The name of the process instance for this process scheduler job.

SYNCH

Y if this optimization engine load is to occur synchronously, N if asynchronously.

Checking Optimization Engine Status

To check optimization engine status (for example, to see when it finishes loading), structure the rowset as follows, using the PT_OPTPARMS record.

PARMKEY Field VALUE Field

OPTCMD

CHECK_STATUS

Causes the PeopleCode program implementing the Integration Broker OnRequest method to check the status of an optimization engine. The OPT_CALL example executes the CheckOptEngineStatus function.

PROBINST

The name of the analytic instance.

PROCINSTANCE

The name of the process instance for this process scheduler job.

Running a Transaction

To run a transaction, structure the rowset as follows, using the PT_OPTPARMS record.

PARMKEY Field VALUE Field

OPTCMD

RUN

Causes the PeopleCode program implementing the Integration Broker OnRequest method to run an optimization transaction. The OPT_CALL example executes the GetOptEngine method and either the RunSynch or RunAsynch method.

PROBINST

The name of the analytic instance.

PROCINSTANCE

The name of the process instance for this process scheduler job.

SYNCH

Y for a synchronous transaction, N for asynchronous.

TRANSACTION

The name of the transaction to run.

The names of one or more transaction parameters.

The value of each named transaction parameter.

Setting the Trace Level

To set a trace level, structure the rowset as follows, using the PT_OPTPARMS record.

PARMKEY Field VALUE Field

OPTCMD

SET_TRACE_LEVEL

Causes the PeopleCode program implementing the OnRequest Integration Broker method to set the severity level at which events will be logged for an optimization engine. The OPT_CALL example executes the SetTraceLevel method.

PROBINST

The name of the analytic instance.

PROCINSTANCE

The name of the process instance for this process scheduler job.

COMPONENT

One of the following values:

  • %Opt_Engine server activity of the running optimization engine.

  • %Opt_Utility low level elements that support the running optimization engine.

  • %Opt_Datacache the in-memory database cache.

  • %Opt_Plugin the plug-in being used for the running optimization engine.

SEVERITY_LEVEL

The severity level to log.

The following list starts with the most severe level; the level you specify includes all higher levels. For example, if you specify %Severity_Error, it logs %Severity_Fatal, %Severity_Status, and %Severity_Error messages and filters out the others.

  • %Severity_Fatal

  • %Severity_Status

  • %Severity_Error

  • %Severity_Warn

  • %Severity_Info

  • %Severity_Trace1

  • %Severity_Trace2

Getting the Trace Level

To get a trace level, structure the rowset as follows, using the PT_OPTPARMS record.

PARMKEY Field VALUE Field

OPTCMD

GET_TRACE_LEVEL

Causes the PeopleCode program implementing the OnRequest Integration Broker method to get the severity level at which events will be logged for an optimization engine. The OPT_CALL example executes the GetTraceLevel method.

PROBINST

Set to the name of the analytic instance.

PROCINSTANCE

Set to the name of the process instance for this process scheduler job.

COMPONENT

One of the following values:

  • %Opt_Engine server activity of the running optimization engine.

  • %Opt_Utility low level elements that support the running optimization engine.

  • %Opt_Datacache the in-memory database cache.

  • %Opt_Plugin the plugin being used for the current opt engine.

Shutting Down an Optimization Engine

To shut down an optimization engine, structure the rowset as follows, using the PT_OPTPARMS record.

PARMKEY Field VALUE Field

OPTCMD

SHUTDOWN

Causes the PeopleCode program implementing the OnRequest Integration Broker method to shut down an optimization engine. The OPT_CALL example executes the Shutdown method.

PROBINST

The name of the analytic instance.

PROCINSTANCE

The name of the process instance for this process scheduler job.