/wiki/spaces/QG/pages/24674321
Overview
Offers the ability to INSERT and UPDATE ownership agreement link records. It also performs all data validations and returns a Status Code, Ownership Link ID, and Error Message. The name of the API package for updating the OWNERSHIP_AGREEMENT_LINKS is OWNERSHIP_AGREEMENTS_API. The functions are:
Function Name | Purpose |
|---|
get_default_doi | Returns the default agreement_id for the specified cost centre, date and account. | update_default_doi | Updates TEMP_LINE_ITEMS with the default agreement_id for the specified voucher. |
|
The procedures are:
Procedure Name | Purpose |
|---|
get_default_doi | Returns the default agreement_id for the specified cost centre, date and account. | update_default_doi | Updates TEMP_LINE_ITEMS with the default agreement_id for the specified voucher. |
|
assign_doi_api.GET_DEFAULT_DOI()
- Performs default DOI retrieval logic for the specified parameters.
- The agreement_id is returned in o_agreement_id.
- If a default DOI cannot be found o_agreement_id will be NULL and DOI not found will be placed in o_return_message.
- Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.
- Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.
- Available as both a function and a procedure.
Parameter | In/Out | Type | Default Value |
|---|
i_org_id | IN | NUMBER(5) |
| i_afe_num | IN | VARCHAR2(10) |
| i_cc_num | IN | VARCHAR2(10) |
| i_major_acct | IN | VARCHAR2(4) |
| i_minor_acct | IN | VARCHAR2(4) |
| i_actvy_per_date | IN | DATE |
| i_acct_per_date | IN | DATE |
| o_agreement_id | OUT | NUMBER(10) |
| o_return_status
*procedure only | OUT | VARCHAR2 | Possible values: | o_return_code | OUT | NUMBER | Possible values: - 0 – Success
- -20001 – Handled Application Error
- -20000 – Generic Error
| o_return_message | OUT | VARCHAR2 | Insert ‘Successful’ or ‘Failure’ or error message |
|
assign_doi_api.UPDATE_DEFAULT_DOI()
- This function will loop through each of the TEMP_LINE_ITEMS gross entries for the specified voucher_id then determine which lines have not been billed and do not have an agreement_id value in govern_agr_id.
- For each value it will use default DOI retrieval logic to determine the agreement_id to place in govern_agr_id.
- If an agreement_id cannot be found then the record will be bypassed.
- Function returns VARCHAR2 (‘TRUE’/’FALSE’) to indicate a successful/unsuccessful action.
- Default values on parameters indicate that the parameter is optional and the default value will be inserted into the corresponding column.
- Available as both a function and a procedure.
Parameter | In/Out | Type | Default Value |
|---|
i_voucher_id | IN | NUMBER(10) |
| o_return_status
*procedure only | OUT | VARCHAR2 | Possible values: | o_return_code | OUT | NUMBER | Possible values: - 0 – Success
- -20001 – Handled Application Error
- -20000 – Generic Error
| o_return_message | OUT | VARCHAR2 | Insert ‘Successful’ or ‘Failure’ or error message |
|