ALUI API Documentation

This page provides links to browsing versions and zip downloads of all public ALUI API documentation. Internal portal APIs are listed on the Portal API Documentation page.

AquaLogic User Interaction Development Kit (IDK)  

These API libraries provide detailed documentation on IDK (formerly EDK) objects and methods. For details on installing the IDK, see ALUI Development Environment. To access documentation for previous versions or download the entire documentation package, download the appropriate version of the IDK.
 

IDK Version

Javadocs

NDocs

v6.0

v5.4

ALI Scripting Framework

The ALI Scripting Framework is a collection of client-side JavaScript libraries that provide services to portlets and hosted gatewayed pages. Most services are provided by the JSPortlet API. Opener functionality is provided by the Common Opener API. For lower-level functionality, see the JSXML package. For details on using these APIs, see ALI Scripting Framework.
 

JSPortlet jsdocs

Common Opener jsdocs

JSXML jsdocs

Adaptive Tags  

Adaptive Tags are XML tags that can be included in the markup returned by any gatewayed page, including portlets. These tags provide access to key portal components and support advanced attribute replacement. For details, see Adaptive Tags.
 

ALI v. 6.0 Tagdocs

ALI v. 6.1 Tagdocs

ALI v. 6.1MP1 Tagdocs

Ensemble 1.0 Tagdocs

For information on the portal API used to create custom tags, see the Adaptive Tag Framework API documentation.

ALI Analytics OpenUsage API

ALI Analytics 2.0 delivers detailed information about portal usage.  The OpenUsage API allows you to raise Analytics events from custom portlets and applications and store them in the Analytics database. You can raise events using the OpenUsage Java API or an OpenUsage event tag. For details, see the Dev2Dev article Using the ALI Analytics 2.0 OpenUsage API.
 

OpenUsage Javadocs

OpenUsage TagDocs