EPCF API 

The EPCF service defines the Enterprise Portal Client Manager (EPCM) JavaScript object. With the methods of the EPCM object you can access the EPCF service functions as follows:

EPCM.[API_method_name]( [Params]* );

iViews can access the EPCM object from every Portal page or IFrame. Every iView of the Portal runtime contains the EPCM object. As a result every embedded or isolated iView can use the EPCF service with the method:

EPCM.subscribeEvent(, eventName, eventHandler );

For details on namespaces, see the glossary chapter Namespaces

Every EPCM object stores the data it receives and delegates them automatically to the registered EPCM objects.

With EPCF level 2 every Portal page and as a result in all isolated iViews, contain a Java applet. The applet serves as a class factory for methods that return references to the intrinsic classes. These classes are implemented as Singletons  so every class has only a single instance in a Portal session, even when iViews are reloaded. The applet object is instantiated inside every Portal page frame.

The EPCF API has following parts:

·        System API

The system API provides methods to get the version and the level of the EPCF service and information about the client.

·        Event API

The event API , which allows iViews to communicate with each other and with the Portal environment itself on the. This is done by using JavaScript functions on the client which are invoked on client events like onload, onclick and so on.

·        Client Data Bag API

The client data bag API offers a transient data buffer for iViews. The data remains in the buffer are saved even after the iView or the whole Portal page is reloaded. Depending on the EPCF level, following storage mechanisms are used:

¡        EPCF level 1 - JavaScript

Values are stored as cookies in the browser.

¡        EPCF level 2 – Java Applet

Values are stored as a Java class attribute.

·        WorkProtect API

The WorkProtect API provides the infrastructure for handling unsaved data in a stateful application.

·        Navigation API

The navigation API provides methods to navigate in the Portal.

·        Distributed Session Management (DSM) API

The DSM API is used for session management. The DSM uses this API to access the properties of the SessInfo object.

·        EPCM Proxy

The EPCM proxy API allows the EPCF functionality in Portal applications that are rendered in their own IFrame (for example, ITS-based applications and BSP).