| Table of Contents | ||
|---|---|---|
|
Introduction to IFS Qbyte 360 Connect
Safe, secure, and controlled, incoming and outgoing integration with third party applications.
...
General Standards and Concepts
PL/SQL package consisting of a series of functions.
As a general rule the APIs attempt to mimic the behavior of the equivalent frontend; if columns are defaulted or automatically populated by the frontend, then the API will behave in a similar manner.
The audit columns (i.e. create_date, create_user, etc.) will not be passed in as parameters and the values of these columns will be automatically updated by the APIs.
Functions return a Boolean variable indicating success or failure along with a return_code and return_message; the return_code is set to 0 forsuccess and -20001 for application error and the return_message will contain the error explanation.
Complete data validations are performed by functions.
After the first error is encountered, control is returned to the calling program.
Most updates require all columns to be passed in.
Default values on parameters mean that parameters are optional.
If a parameter with a default value is not supplied on an update, the column will be set to the default value.
APIs do not perform commits.
Security
The PL/SQL procedure will be executed with the privileges of its owner (definer’s rights). A definer’s rights procedure operates under the security domain of the user who owns the procedure, regardless of who executes it. Therefore, a user of a definer’s rights procedure requires only the privilege to execute the procedure and no privileges on underlying objects that the procedure accesses. The procedure’s owner must have all necessary object privileges for referenced objects. Fewer privileges must be granted to users of a definer’s rights procedure, resulting in increased control of database access.
...
How to Call the APIs
It is preferable to call the APIs using named notation. This makes the calling program easier to read, maintain, and allows it to better handle optional arguments. If there is an overloaded version of the main routine, position notation should be used.
...
The AFE package supports updating the follow AFE details:
All elements of base AFE
Multiple legal locations
User defined fields
Comments
Cost estimate items
Supplements and revisions
Associated cost centres
Hierarchies
Approvals
Overhead
A pre-validation API is available and should be used to perform any possible validation prior to loading the data.
...
The following APIs are included in the AFE package:
Validation API – Used for pre-validation.
/wiki/spaces/QG/pages/24674539 – Used for loading base AFEs.
Joint Overhead Agreements – Used to link AFEs to an Overhead Method.
Hierarchies – Used to link the AFE to the hierarchy.