Concept of integration

As used by PRIMAVERA applications, Integration refers to the ability of third party applications to view, modify or insert data about entities in the different modules through the API. In turn, this integration makes use of the concept of extensibility.

For example, if a rule is added to validate that customer postal codes must be in the '####-##' format through extensibility technology, this rule will be executed when creating the entity by both in the ERP and through the API.

This way, the API architecture guarantees that the business rules associated with any entity are executed regardless of the client that is consuming it.

Entities (Business Entities)

All business objects (or entities) managed by each module are available through simple objects with a set of properties. This way, these objects will match or be examples of the different business entities in the ERP, including the tables that it manipulates.

The nomenclature of all the objects representing the entities is the following {APL}BE{Entity}, where:

• APL will be the abbreviation of the module;
• BE is the abbreviation of Business Entity;
• Entity will be the name of the entity.

For example, the entity that represents a sales document is characterized in the VndBEDocumentoVenda class, which in turn is implemented by the VndBEXXX.DLL assembly.

Services (Business Services)

Business services are the objects that expose the services and methods available for each entity. The ErpBSXXX.dll assembly (where XXX represents the version) is the access point of all modules available via API, so this will be the component to use to access the ERP API from an external application.

The nomenclature of all objects that expose the services is the following I{APL}BS{Entity}, where:

• APL will be the abbreviation of the module;
• BS is the abbreviation of Business Service
• Entity will be the name of the entity.

For example, the IVndBSDocumentoVenda class document publishes all services associated with the sales document, which in turn is implemented in assembly VndBSXXX.DLL