Public APIs

This appendix describes the public APIs in Oracle Grants Accounting.

This appendix covers the following topics:

• Definition
• Overview
• Budget API Procedures
• Budget API Rules
• Budget API Prerequisites
• Budget API Process Flowchart
• Budget API Process
• Budget API Parameters

Definition

Oracle Grants Accounting provides public APIs to allow users to perform certain Grants Accounting functions from outside systems. Grants Accounting Budget APIs provide a set of procedures to create, modify, delete, and submit a draft award budget and to designate a draft award budget as the baseline budget.

Overview

This reference chapter assumes users have a familiarity with basic programming skills.

This section includes the following:

• Budget API Procedures

• Budget API Rules

• Budget API Prerequisites

Budget API Procedures

Budget APIs for uploading award budget data from external systems are included in the Grants Accounting system. This package of APIs is comprised of procedures for the following Grants Accounting tasks:

• add a line to a draft or working budget - ADD_BUDGET_LINE

• set a draft budget as the baseline budget - BASELINE_BUDGET

• create a draft budget version for an award and project - CREATE_DRAFT_BUDGET

• delete a budget line of a draft budget - DELETE_BUDGET_LINE

• delete a draft budget - DELETE_DRAFT_BUDGET

• submit the budget baseline concurrent process, which calls the BASELINE_BUDGET procedure - SUBMIT_BUDGET_CONC_PROCESS

• submit an award budget or set an award budget as the baseline budget - SUBMIT_BASELINE_BUDGET

• create a draft project budget from baseline award budgets - SUMMARIZE_PROJECT_TOTALS

• update the attributes of a budget version - UPDATE_BUDGET

• update a budget line of draft budget - UPDATE_BUDGET_LINE

• validate the award budget - VALIDATE_BUDGET

Budget API Rules

The following rules apply to Grants Accounting Budget API procedures:

• Procedures have been designed such that either the ID or the Number can be passed to them.

  For example, in the CREATE_DRAFT_BUDGET procedure, either P_PROJECT_ID or P_PROJECT_NUMBER can be passed in and the API will validate accordingly.

• Some of the procedure parameters may be required or not required based on the Budget Entry Method associated with the budget.

  For example, if the budget is created at the Project level, then Task ID/Task Number need not be passed in.

• If the Budget Entry Method is based on the Projects or General Ledger period, then a valid value for a Projects or General Ledger period should be passed in.

• Award budgets can be created for BURDENED_COST only.

Budget API Prerequisites

Before running Budget APIs in Grants Accounting, the following prerequisites should be met:

• User must have query and update privileges as dictated by GMS Security.

• Global Security context has to be set for the session if these procedures are being called outside of Forms or concurrent program sessions.

• If Workflow is to be used for approving a budget, then the BUDGET_WF_ENABLED_FLAG should be set to "Y" in the GMS_AWARDS_ALL table. It is recommended that BUDGET_WF_ENABLED_FLAG be set to "N" at the award level during data loading.

Budget API Process Flowchart

The Budget API Process Flowchart shows the Budget API process flowchart as described in the Budget API Process table.

Budget API Process Flowchart

Budget API Process

The table below describes the Budget API process.

For additional information about budgets, see: Entering Award Budgets Procedure.

Budget API Process

Event	Description
1.	Users invoke API for each record to be uploaded.
2.	API checks validity of parameters before inserting information into Grants Accounting tables.
3.	API returns the status of the upload.
4.	An error or undefined exception message appears for each record that fails during the process.
5.	Users handle errors. If necessary, user corrects input parameters based on error message.
6.	Users re-execute APIs for failed records; events 1 - 3 repeat until all applicable records have been uploaded.
7.	Users execute commit.

Budget API Parameters

You can view descriptions of all of the parameters for these procedures in the Oracle Integration Repository.

ADD_BUDGET_LINE

The ADD_BUDGET_LINE procedure adds a line to a draft or working budget.

Note: Prior to this procedure, a draft budget must have been created.

BASELINE_BUDGET

The BASELINE_BUDGET procedure sets a draft budget as the baseline budget.

Note: Prior to this procedure, a draft budget with budget lines must have been created.

Note: It is recommended that SUBMIT_BUDGET_CONC_PROCESS be used to call this procedure so that the creation of a budget baseline can be carried out as a concurrent program.

CREATE_DRAFT_BUDGET

The CREATE_DRAFT_BUDGET procedure creates a draft budget version for an award and project. The API validates the input using business logic and returns either validation or error messages.

Note: If a draft budget already exists, then it will be deleted and recreated.

Note: Prior to this procedure, an award must have been created and must be funding the project.

DELETE_BUDGET_LINE

The DELETE_BUDGET_LINE procedure deletes a budget line of a draft budget.

Note: Prior to this procedure, a budget line must have been created.

DELETE_DRAFT_BUDGET

The DELETE_DRAFT_BUDGET procedure deletes a budget line of a draft budget.

Note: Prior to this procedure, a draft budget must have been created.

SUBMIT_BUDGET_CONC_PROCESS

The SUBMIT_BUDGET_CONC_PROCESS procedure submits the budget baseline concurrent program, which calls the BASELINE_BUDGET procedure.

SUBMIT_BASELINE_BUDGET

The SUBMIT_BASELINE_BUDGET procedure submits an award budget or sets an award budget as the baseline budget.

Note: This is a wrapper procedure for BASELINE_BUDGET.

SUMMARIZE_PROJECT_TOTALS

The SUMMARIZE_PROJECT_TOTALS procedure creates a draft project budget from baseline award budgets.

UPDATE_BUDGET

The UPDATE_BUDGET procedure updates the attributes of a budget version.

Note: Prior to this procedure, a draft budget must have been created.

UPDATE_BUDGET_LINE

The UPDATE_BUDGET_LINE procedure updates a budget line of draft budget.

Note: Prior to this procedure, a budget line must have been created.

VALIDATE_BUDGET

The VALIDATE_BUDGET procedure validates the award budget.