Understanding Java Component directory structure
The Java Server Pages (JSPs) that implement Actuate Java Component URIs are grouped by function into directories under the context root. The context root is the web directory in which an Actuate Java Component web application resides, which is the web archive (.war) file’s name. When the web archive (.war) file is extracted, the context root for Java Component is the root directory of the web archive (.war) file. The Java Component context root name in the web or application server’s configuration file is the name of the web archive (.war) file as set by the Java jar utility. Figure 3-1 shows the Java Component directory structure.
Figure 3-1  
Actuate Java Component URIs convey user requests to an application server.
Pages that support folder navigation and document viewing reside in the <context root>\iportal\activePortal directory. Within this directory, pages that support report viewing reside in the viewer directory, pages that serve as templates for other pages reside in the templates directory, and so on. Some directory names exist directly under the iportal directory and also under the <context root>\iportal\activeportal\private subdirectory. Customize the JSPs under the private subdirectory. Table 3-1 lists and describes the general context root directories.
Table 3-1  
ajclanding.jsp, the default page for accessing all Actuate Java Component functionality, and supporting material.
JavaScript files that control specific web page elements such as search, toolbar, and table of contents.
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.
Table 3-2 lists and describes the iportal directories.
Pages that support login and authentication and directories for the remaining pages for folder navigation and document usage
Libraries that support BIRT reports, BIRT Studio, and Interactive Viewer and pages that support BIRT reports
Common elements included in all reporting web pages, such as banner and side menu elements
Table 3-3 lists and describes the <context root>\iportal\activePortal directories.
Pages that support login and authentication and directories for the remaining folder and document pages for the Java Component application.
Common elements included in all reporting web pages, such as banner and side menu elements.
Most Java Component folders and documents web pages. Users cannot directly access pages in this directory using URLs. These pages are customizable.
private\channels
private\common
Common elements included in all reporting web pages, such as banner and side menu elements.
private\cubeviewer
Pages that support viewing Actuate Analytics Option cubes. The cube viewer has no relevancy in the Deployment Kit.
private\customization
private\diagnosis
private\filesfolders
Pages that support requests such as completed requests, successful submission, and details pages by redirecting.
private\newrequest
Pages that support new requests, such as parameter processing, scheduling, and job status pages.
private\parameters
Pages that support Actuate Query functionality. Queries have no relevancy in the Deployment Kit.
private\templates
Jakarta Struts template pages that simplify customization by handling common web page structure and functionality for many pages.
Pages that support report viewing. The viewer has no relevancy in the Deployment Kit. The BIRT Viewer is a separate application and is not in the viewer directory.
Actuate recommends that you group Java Component applications in the home directory of an Actuate distribution to make them easier to locate. Place the context root in whatever location your application requires. To ensure that the JSP engine locates your Java Component application’s context root, always use the jar utility to generate the web archive (.war) file after licensing or customization.

Additional Links:

Copyright Actuate Corporation 2012