Configuring Analytic Type Transactions

In the analytic type definition, select the Transactions tab, and then select Insert, and then Transaction.

This example illustrates the fields and controls on the Analytic Type Transaction Property dialog box. You can find definitions for the fields and controls later on this page.

Note:

You can access the properties of an existing analytic type transaction by right-clicking the transaction and selecting the Analytic Type Transaction Properties. option.

Field or Control	Description
Transaction Name	Enter the case-sensitive name of the transaction. If the PeopleCode Plugin check box is selected in the analytic type properties, this value must match the name of a method defined in the application class that you specified for this analytic type. If the PeopleCode Plugin check box is not selected in the analytic type properties, this value must match the name of a service defined in the OPI that you selected in the analytic type properties. The transaction name that you specify must be distinct within an analytic type. For the exercise machine example, three transactions are needed. The QEOPT.DLL OPI implements these transactions: SOLVE solves the exercise machine problem. GET_SUMMARY produces a summary of exercises for a person. IS_MACHINE_AVAILABLE returns whether an exercise machine is available for a specified time. The transaction name can contain up to 30 characters. See OptBase Application Class.
Lock Flag	Select this option to prevent changes to the optimization application tables while this transaction runs. Typically, this flag should be set for extremely fast but critical transactions where data integrity is crucial. In the exercise planning example, optimization transactions do not need the lock flag. Important: The lock flag can hamper performance, so use it with caution.

Field or Control

Description

Transaction Name

Enter the case-sensitive name of the transaction.

If the PeopleCode Plugin check box is selected in the analytic type properties, this value must match the name of a method defined in the application class that you specified for this analytic type.

If the PeopleCode Plugin check box is not selected in the analytic type properties, this value must match the name of a service defined in the OPI that you selected in the analytic type properties.

The transaction name that you specify must be distinct within an analytic type.

For the exercise machine example, three transactions are needed. The QEOPT.DLL OPI implements these transactions:

SOLVE solves the exercise machine problem.
GET_SUMMARY produces a summary of exercises for a person.
IS_MACHINE_AVAILABLE returns whether an exercise machine is available for a specified time.

The transaction name can contain up to 30 characters.

See OptBase Application Class.

Lock Flag

Select this option to prevent changes to the optimization application tables while this transaction runs. Typically, this flag should be set for extremely fast but critical transactions where data integrity is crucial. In the exercise planning example, optimization transactions do not need the lock flag.

Important: The lock flag can hamper performance, so use it with caution.

Parameter Attributes

Each transaction can have any number of parameters.

If the application class method corresponding to this transaction has parameters, you must define a row in this grid with equivalent attributes for each of the parameters.

Field or Control	Description
Name	Enter the name of the parameter. The name must match the transaction parameter name defined in the OPI, or the equivalent method parameter defined in the application class that you specified for this analytic type. The transaction parameter name can contain up to 20 characters, and it must be distinct within an analytic type.
Type	Select the parameter type (String, Integer, Double, Date, DateTime, Time, or arrays of these types, or Record Array). The type must match the transaction parameter type defined in the OPI, or the equivalent method parameter type defined in the application class that you specified for this analytic type. Note: Do not pass an array of type Integer as a transaction parameter. Use an array of type Number instead.
Input/Output	Select Input, Output, or Both.
Attributes	Select Required, Optional, or Default (the parameter has a default value). This is not applicable to output parameters. Note: If an input parameter is required, it must be supplied when you use either the RunSynch or RunAsynch PeopleCode methods.
Value	If the Attributes field is set to Default, enter a default value for this parameter. If the type is Record Array, enter the name of the record. Otherwise, leave this blank.