Show TOC

Enterprise Portal Client Framework (EPCF)Locate this document in the navigation structure

Use

The Enterprise Portal Client Framework (EPCF) provides a JavaScript API designed for the client-side communication between portal components and the portal core framework.

The EPCF has the following capabilities:

  • Browser abstraction - the framework provides an abstraction from the specifics of different browser types, as well as an ability to detect the client environment.

    For more information, see System and Environment.

  • Client-side communication - the framework acts as a mediator for communication between the portal components on the client side. This communication is enabled by a powerful publish-subscribe eventing mechanism and a possibility to store data in a client data bag and share it in the same user session across different pages.

    For more information, see Client-Side Eventing and Client Data Bag.

  • Navigation - the framework provides methods to trigger portal navigation programmatically from the portal components. For more information, see Navigation API.

  • WorkProtect - the framework provides means to avoid loss of unsaved application data when navigating to other pages.

    For more information, see WorkProtect Feature.

Prerequisites

To use the EPCF, you need the following skills:

  • Experience in portal application development with the PRT API

  • Familiarity with JavaScript

  • Familiarity with the Document Object Model (DOM)

EPCM Object

The EPCF provides a collection of JavaScript public methods and constants, which are can be accessed through a dedicated Enterprise Portal Client Manager (EPCM) object. An instance of this object is automatically available for the portal components developed with the PRT API. Portal components created with other technologies should access the EPCM object of their parent frame.

Typically, a portal page contains several instances of the EPCM objects in different frames at the same time. An iView should use the nearest EPCM object, which is located in the same frame or in the parent frame (in this case, use the parent.EPCM object).

More Information