Oracle 11i Receivables API用户手册：关键更新与注意事项

需积分: 1 111 浏览量更新于2024-06-26 收藏 1.98MB PDF 举报

Oracle Receivables API User Notes Release 11i 是一份重要的文档，专为Oracle EBS 11i（E-Business Suite 11.1）的用户编写，提供关于Oracle Receivables模块的接口应用程序编程接口（API）的详细信息和指导。该文档发布于2005年8月，由多位主要作者如Ramakant Alat、Jon Beckett等共同编撰，包含了软件及其文档中的专有信息，受Oracle的版权保护，并受到专利和工业产权法律的双重保护。在文档中，开发者们强调了以下几点： 1. **版权与许可协议**：文档及其包含的程序受到1988年和2005年的Oracle版权法保护，用户只能在符合特定许可证协议的限制下使用，禁止未经许可的逆向工程、拆解或反编译，除非是为了实现与其他独立创建软件的互操作性，或者法律规定允许的情况。 2. **信息更新**：文档中的内容可能随时进行更改，用户在使用时需注意查看最新版本以确保获取准确的信息。如果发现任何问题，用户应通过书面形式向Oracle报告。 3. **错误声明**：虽然Oracle承诺尽力提供无误的信息，但并不保证文档完全无误，用户在使用过程中仍需自行判断和解决可能出现的问题。 4. **复制权限**：除了许可协议明确允许的部分外，未经Oracle明确授权，用户不得复制这些程序的任何部分。 5. **目标受众**：该文档是为Oracle Receivables API的用户设计的，旨在帮助他们理解和利用API来管理应收账款，包括处理接收、支付、信用管理等功能，从而提高业务流程的效率。 Oracle Receivables API User Notes Release 11i是一个关键资源，对于正在使用Oracle EBS 11i的企业来说，它提供了开发人员和IT专业人员在集成、定制和优化应收账款管理系统时不可或缺的技术指南和参考。在实际应用中，用户需要遵循文档中的规定，确保在合法和合规的范围内利用这些API，以最大限度地发挥系统的功能优势。

number of parameters. This giv es y ou many options to achiev e y our requirements

when y ou call the relev ant API .

Modular Approach

The API has been designed in a highly modular fashion, resulting in code that is:

• Easy to understand

• Easy to maintain

• Easy to expand

Error Handling

Oracle Receiv ables APIs provide an extensiv e error -handling and error -reporting

mechanism whereby all errors encountered in the Defaulting and V alidation phases

are reported and put on the message stack. The calling program can look up all error

messages, or the ﬁrst error message on the stack.

If only one error exists on the message stack, then y ou do not need to fetch the message

from the stack because the message will return as one of the output parameters of the

API routine .

Robust V alidation

The v alidations that Oracle Receiv ables APIs perform are robust in nature. The APIs

collect all encountered v alidation errors and put them on the message stack. The

relev ant entity handler is called only if no errors are reported during the Defaulting

and V alidation phases .

Debug Messages

Extensiv e debug messages hav e been incorporated to simplify the troubleshooting

process when problems are encountered with any API.

Debug messages can be written to the log ﬁle by calling the appropriate routines

described in Exception Handling and Result Messages, page 1 - 3 .

Solution Outline

Modular Approach

T o modularize an API, the basic structure of the API is divided into four parts:

1. Defaulting the IDs from the v alues and cross v alidating, if y ou provide both the

v alues and the IDs.

2. Defaulting all the entity lev el information, which y ou hav e not entered or which

the API needs internally .

3. V alidating the entity lev el information that y ou entered.

4. Calling to the entity handlers to perform the relev ant task.

This results in code that is easy to understand and easy to maintain. Any new

functionality can be added by a simple code plug-in at each of the four parts .

1- 2 Oracle Receivables API User Notes

Defaulting

In general, the v arious parameters in each API call get defaulted, if not entered, based on

the following:

• V alues of the other parameters in the API call

• V alues set in the AR_SYSTEM_P ARAMETERS table entered through the System

Options form

• Relev ant proﬁle option v alues

Depending on the abov e three factors and the exact business requirement, the minimum

number of parameters required to perform certain business tasks may v ary .

Null v alues are defaulted for the parameters that could not be defaulted by the API

defaulting routines.

For v arious attributes of the business objects, y ou can pass either the ID or the v alue of

the attribute.

If y ou specify only the v alue, then the v alue is used to deriv e the ID; otherwise, the ID (if

speciﬁed) is taken directly . If y ou specify both the ID and the v alue, then the ID takes

precedence ov er the v alue and a w arning message informs y ou of this .

Exception Handling and Result Messages

Each Oracle Receiv ables API returns three types of information to its calling programs:

• Ov erall status

• Messages describing the operations performed or errors encountered by the APIs

• Some output v alues that the API caller might w ant to use (this is different for

different API routines and is described in each API’ s relev ant chapter , in the API

Usage section) .

Return Status

The return status (x_return_status) of the API informs the caller about the result of

the operation (or operations) performed by the API. The different possible v alues for

an API return status are:

• Success (FND_API.G_RET_STS_SUCCESS)

• Error (FND_API.G_RET_STS_ERROR)

• Unexpected error (FND_API.G_RET_STS_UNEXP_ERROR)

The following section describes the different v alues of return status and their meanings.

Success

A success return status means that the API w as able to perform all the operations

requested by its caller . A success return status may be accompanied by informativ e

messages in the API message list.

Error

An error return status means that the API failed to perform some or all of the operations

requested by its caller . An error return status is usually accompanied by messages

describing the error (or errors) and how to ﬁx it.

Using Oracle Receivables APIs 1- 3

In most cases, y ou should be able to take correctiv e action to ﬁx regular , expected errors

such as missing attributes or inv alid date ranges.

Unexpected error

An unexpected error status means that the API has encountered an error condition it did

not expect or could not handle. In this case, the API is unable to continue with its regular

processing. Examples of such errors are irrecov erable data inconsistency errors, memory

errors, and programming errors (such as attempting a division by zero).

In most cases, only system administrators or application dev elopers can ﬁx these

unexpected errors .

Messages

The APIs put result messages into a message list. Programs calling the APIs can then

get the messages from the list and process them by issuing them, loading them into a

database table, or writing them to a log ﬁle.

Messages are stored in an encoded format to let the API callers ﬁnd message names using

the standard functions provided by the message dictionary . It also allows the storing of

these messages in database tables and reporting off these tables in different languages.

The API message list must be initialized ev ery time a program calls an API. API callers

can either call the message list utility function FND_MSG_PUB.Initialize or request that

the API do the initialization on their behalf by setting the p_init_msg_list parameter

to TRUE.

The program calling the API can retriev e messages from the message stack using the

existing FND API functions FND_MSG_PUB.Count_Msg and FND_MSG_PUB.Get.

Message Level Threshold

The message lev el threshold is stored in a proﬁle option named FND_API_MSG_LEVEL_

THRESHOLD. This proﬁle option can be updated at all lev els (site, application, or

user). The API checks against this threshold before writing a message to the API

message list .

Debug Messages

Y ou must enable debugging by calling the routine arp_standard.enable_ﬁle_debug. The

routine requires 2 parameters: path_name and ﬁle_name.

arp_standard.enable_file_debug(<pathname>, <filename>)

The path name can be identiﬁed by using the following select statement:

select value from v$parameter where name = ’utl_file_dir’,

The ﬁle name can be any name that y ou choose.

Example

arp_standard.enable_file_debug (’/sqlcom/log’,’txt.log’)

This call w ould write the output debug ﬁle ’ txt.log’ in the path ’/sqlcom/log’ .

1- 4 Oracle Receivables API User Notes

剩余247页未读，继续阅读

weixin_40191861_zj

粉丝: 86
资源: 1万+

Oracle 11i Receivables API用户手册：关键更新与注意事项

Oracle Applications User’s Guide Release 11i

Oracle Receivables Tax Manual Release 11i

Oracle Grants Accounting User’s Guide Release 11i

Oracle iPayment Implementation Guide Release 11i

Oracle Receivables User Guide

Oracle Receivables API 用户指南

Oracle Receivables Guide to Integrating Oracle Receivables with

Oracle_Receivables-Updates_to_Invoice_Interface_Lines.docx

Oracle ERP 11i中英對照辭彙表 (二).docx

LO645 Credit and Risk Management for Receivables

最新资源