Visualization Platform client directory structure

The Java Server Pages (JSPs) that implement Visualization Platform client URIs are grouped by method into directories under the context root. The context root is the home directory in which a Visualization Platform client web application resides. The default context root for the embedded Visualization Platform client for iHub on Windows systems is <Actuate home>\iHub\servletcontainer\iportal and on UNIX and Linux systems is <Actuate home>/iHub/servletcontainer/iportal. The default context root for a separate Visualization Platform client installation on Windows systems is <Actuate home>\iHub3\modules\BIRTiHub\iHub\web\iportal and on UNIX and Linux systems is <Actuate home>/iHub3/modules/BIRTiHub/iHub/web/iportal. The Visualization Platform client context root name in the web or application server’s configuration file is iportal. Figure 2‑1 shows the Visualization Platform client directory structure.

Pages supporting folder navigation and document viewing reside in the <context root>\iportal\myfiles directory. Pages supporting the BIRT Viewer reside in the iv directory, pages serving as templates for other pages reside in the templates directory, and so on. Table 2‑1 lists and describes the general iHub2\servletcontainer\iportal or iPortal\iportal directories.

Table 2‑1 <Context root> directories
Directory	Contents
This directory	landing.jsp, the default starting page for accessing Visualization Platform client functionality.
admin	UI files for application administration. Do not change.
birtAdapter	BIRT Viewer integration files.
bizRD	Pages that support Report Studio.
common	Common files for the user interface, style, and images.
da	BIRT Data Analyzer support files.
dashboard	Dashboard support files.
downloads	Downloaded files.
dtd	Document type definitions.
filesfolders	Pages that support working with files and folders.
images	Visualization Platform client user interface images and icons.
iportal	The Visualization Platform client application internals.
iv	Pages that support BIRT Interactive Viewer.
js	JavaScript files that control specific web page elements such as search, toolbar, and table of contents.
META-INF	The Visualization Platform client manifest file. iHub embedded InfoConsole directory.
myfiles	Files for listing repository content controlled by myfiles.jsp.
newrequest	Pages that support new requests, such as parameter processing, scheduling, and job status pages.
options	Options-specific pages, such as notification pages.
requests	Pages in this directory provide backward compatibility for custom web applications referencing these pages by URL. Use the action paths and the private\jobs directory for new customization projects.
temp	Working directory for transient content.
viewer	Pages that support legacy report viewing.
WEB-INF	Files that manage session information such as current user login, roles, and volume.

Table 2‑2 <Context root>/common/jslib/common directories
Directory	Contents
default	Style sheets for most pages in the Visualization Platform client
font	Font definition files.
img	Icon, button, and logo files.

Table 2‑3 <Context root>/iportal directories
Directory	Contents
activePortal	Pages that support login and authentication and directories for the remaining pages
common	Common elements included in the common template.
jsapi	JavaScript pages to support the JavaScript API demonstration page

Table 2‑4 <Context root>/iportal/activePortal directories
Directory	Contents
This directory	Pages that support login and authentication and directories for the remaining folder and document pages for the Visualization Platform client application.
common	Common elements included in all reporting web pages, such as banner and side menu elements.
dtd	Document type definitions.
errors	Error pages.
images	Images for reporting web pages, such as buttons, icons, lines, and arrows.
private	Most Visualization Platform client folders and documents web pages. Users cannot directly access pages in this directory using URLs. These pages are customizable.
private\common	Common elements included in all reporting web pages, such as banner and side menu elements.
private\diagnosis	Self-diagnostic utility page.
private\filesfolders	Pages that support working with files and folders.
private\jobs	Pages that support requests such as completed requests, successful submission, and details pages by redirecting.
private\mobile	Pages that support BIRT Mobile subscriptions.
private\newrequest	Pages that support new requests, such as parameter processing, scheduling, and job status pages.
private\parameters	Pages that support table parameters.
private\sample	Example custom requester page.
viewer	Pages that support report viewing.