Previous  Next          Contents  Index  Navigation  Glossary  Library

Cost Plus Application Programming Interface (API)

Oracle Projects provides a procedure you can use to call the Cost Plus Application Programming Interface. This procedure retrieves an amount based on your burden cost setup. You can specify the burden schedule, effective date, expenditure type, and organization to retrieve the burden cost amount based on the criteria you specify.

For example, you can use this procedure to derive the raw cost amount of a related transaction using a specific burden schedule of rates and the project organization as inputs.

Attention: Any amounts calculated using the API will not show up in cost plus detail views that display the burden cost breakdown. Also, if you update rates for the burden schedule, you must manually mark all items that are affected by the rate changes.

Stored Procedure

pa_cost_plus.get_burden_amount

Parameter Usage Type Description
burden_schedule_id IN NUMBER The schedule id of the burden schedule used to calculate the burden amount.
effective_date IN DATE The date used to find the burden schedule revision to calculate the burden amount.
expenditure_type IN VARCHAR2 The type of expenditure item used to find a cost base.
organization_id IN NUMBER The id of the organization used to find a multiplier.
raw_amount IN NUMBER The raw amount for which the burden amount is calculated.
burden_amount IN OUT NUMBER The calculated burden amount.
burden_sch_rev_id IN OUT NUMBER The schedule revision id of the burden schedule used to calculate the burden amount.
compiled_set_id IN OUT NUMBER The id of the active compiled set used to calculate the burden amount.
status IN OUT NUMBER The processing status of the procedure.
stage IN OUT NUMBER The exit stage of the procedure.
Table 1 - 135. (Page 2 of 2)

Error Handling

Use the status and stage parameters to help resolve error conditions should your procedure fail.

The status parameter indicates the processing status of your procedure as follows:

status = 0 The procedure executed successfully.
status < 0 An Oracle8 error occurred and the process did not complete.

Suggestion: Ensure that you are returning the status of the cost plus procedure to the procedure that you are calling the cost plus API from to help resolve error conditions.

status > 0 See stage parameter.
The stage parameter shows you where in the processing of the cost plus API the procedure failed. Use the stage parameter to resolve the specific problem that caused your procedure to fail.

Stage Meaning
100 Cannot find a revision for the given burden schedule and effective date
200 Cannot find the burden structure
300 Expenditure type is not in a cost base in the burden structure
400 There is no active compiled set for the given burden schedule and organization
500 There is no compiled multiplier for the given qualification
Table 1 - 136. (Page 2 of 2)

See Also

Labor Transaction Extensions

         Previous  Next          Contents  Index  Navigation  Glossary  Library