start here
DESCRIPTION
Start HereTRANSCRIPT
-
5/26/2018 Start Here
1/56
.
Start Here
-
5/26/2018 Start Here
2/56
Information in this document is subject to change without notice. Examples provideare fictitious. No part of this document may be reproduced or transmitted in anyform, or by any means, electronic or mechanical, for any purpose, in whole or in partwithout the express written permission of Actuate Corporation.
1995 - 2002 by Actuate Corporation. All rights reserved. Printed in the UnitedStates of America.
Contains information proprietary to:
Actuate Corporation701 Gateway BoulevardSouth San Francisco, CA 94080http://www.actuate.com
The software described in this manual is provided by Actuate Corporation under anActuate License agreement. The software may be used only in accordance with theterms of the agreement.
Actuate Corporation trademarks and registered trademarks:Actuate, e.Analysis, e.Report, e.Reporting, e.Spreadsheet, Formula One,Internet Spreadsheet, Live Report Extension,Active Portal, Report Encyclopedia,SmartReports, Spreadsheets Everywhere, Tidestone,and XML reports.
All other brand or product names are trademarks or registered trademarks of their
respective companies or organizations.
Document No. 020515-2-130503 May 7, 2002
-
5/26/2018 Start Here
3/56
i
Contents
Start Here . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Actuate 6 architecture. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Building an Actuate report using e.Report Designer . . . . . . . . . . . . . . . . . . . . . Building a simple report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Building a report using e.Report Designer Java Edition. . . . . . . . . . . . . . . . . . . . Connecting to a database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Building a simple e.Spreadsheet report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating the template package file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Publishing a report on the web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Integrating reporting into your web site . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Creating Actuate Active Portal web sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Actuate Active Portal JSP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Index.jsp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Working with cascading style sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Actuate Active Portal directives . . . . . . . . . . . . . . . . . . . . . . . . . . . Controlling the Actuate Active Portal design . . . . . . . . . . . . . . . . . . . . . . . . Building custom Actuate Active Portal context roots. . . . . . . . . . . . . . . . . . . .
Customizing your web site design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modifying global styles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modifying the logo and banner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Locating common Actuate Active Portal elements . . . . . . . . . . . . . . . . . . . . . Renaming Actuate Active Portal files . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Integrating reportlets with Actuate Active Portal . . . . . . . . . . . . . . . . . . . . . . .
Whats next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
-
5/26/2018 Start Here
4/56
ii
-
5/26/2018 Start Here
5/56
S t a r t H
S t a r t H e
You just opened the Actuate e.Reporting Suite 6 box. Now what?
In this guide you learn about the Actuate 6 products, what they do, andto use them. You go through the process of creating an Actuate report adeploying it on the web. You also find out about the Actuate 6 product
architecture, how to build an Actuate report, and how to integrate struccontent into your corporate web site.
Actuate e.Reporting Suite 6 includes:
e.Report Designer. Developers use e.Report Designer to create basicActuate reports.
e.Reporting System. Administrators use the e.Reporting System to mgenerate, and control access to Actuate reports and other files in a ReEncyclopedia volume. e.Reporting System includes:
e.Reporting Server, the underlying software that manages Encyclovolumes.
Management Console, a web application that administrators use maintain Encyclopedia volume user profiles, reports, and reportgeneration schedules.
Actuate Active Portal, the interface between a web server andEncyclopedia volumes that gives users web browser access to e.r
e.Report Designer Professional.
e.Report Designer Java Edition.
e.Spreadsheet Designer.
Users who view Actuate release 6 reports need only a JavaScript-enable
browser. To view DHTML reports, users access Encyclopedia volumes tha web server using Actuate Active Portal.
-
5/26/2018 Start Here
6/56
2 S t a r t H e r e
The descriptions and instructions in this guide assume that you have theseActuate 6 products already installed:
e.Report Designer
e.Report Designer Java Edition (Swing Version)
e.Reporting System
e.Spreadsheet
You must already have a web server or application server and a web browserinstalled. You must also have administrator privileges for the e.ReportingSystem and your web or application server.
If you have not already installed the Actuate 6 products, here are some simplguidelines:
Install e.Reporting System with the e.Spreadsheet option on a Windows oUnix server where you want reports to execute. e.Reporting System needsaccess to the appropriate databases.
Install e.Report Designer and e.Spreadsheet Designer on a Windowsmachine where you want to do report development.
Install Actuate Active Portal on the same machine as your web orapplication server.
You may want to install other products later, such as Management Console tomanage reports and users, and e.Report Designer Professional to developcomplex, advanced reports.
If you do not have access to a copy of Actuate e.Report Designer, you can useActuate e.Report Designer Professional to design a simple report. For moreinformation about how to design a report using Actuate e.Report Designer
Professional, see Chapter 1, Designing e.reports with the report wizard,inDeveloping Advanced e.Reports.You can also take any of the example reports inthe Examples directory and post the report using the instructions described inIntegrating reporting into your web site,later in this guide.
Of course, you can also install all the products on one Windows machine if youwant to just try them out. Installation is simple. Put the product CD in yourWindows machines CD-ROM drive, and follow the package instructions.
Lets get started!
About the Actuate 6 architectureThe Actuate 6 product architecture supports building dynamic reports anddeploying high resolution structured content on the World Wide Web.
http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/ -
5/26/2018 Start Here
7/56
S t a r t H
Building an Actuate report using e.Report DesigBefore you can add structured content to your web site, you have to buireport. This section describes how to build a simple report using e.RepoDesigners Quick Report Wizard.
Building a simple report
Start e.Report Designer. In the Quick Report Wizard, select your databa
follow the instructions from there. The wizard builds and runs the repordisplays it.
ActuateActive Portal
ServersRemote users
ReportEncyclopedia
volume
Web
browser
End UserDesktop
Actuatee.Reporting
server
Webserver
e.ReportDesigner
e.ReportDesigner
Professionale.ReportDesigner
Java Edition
Actuate desktop applications *
e.Spreadsheet
Viewer
-
5/26/2018 Start Here
8/56
4 S t a r t H e r e
How to build a simple report
1 Choose StartProgramsActuate e.Reporting Suite6e.Report Designer
Choose FileNew.
Welcome to Actuate Report Designer appears.
2 Select Create a New Report, and choose OK.
Create a New Report appears.
3 Select Quick Report Wizard, and choose OK.
Data Sources appears.
-
5/26/2018 Start Here
9/56
S t a r t H
How to create a database connection
1 In Data Sources, select Build a new database connection. Choose Ne
Build New Database Connection appears.
2 In Data Source, type sfdata. Choose Next.
Database Login appears.
-
5/26/2018 Start Here
10/56
6 S t a r t H e r e
3 Choose OK.
Select Table appears.
4 Select customers, then choose Next.
Choose Layout Style appears.
-
5/26/2018 Start Here
11/56
S t a r t H
How to format and save a report
1 In Choose Layout Style, select Columnar for your report format andPortrait for your paper orientation. Choose Next.
Finish appears.
2 Type Customers as the title of your report, and select Display the repChoose Finish.
Save As appears.
-
5/26/2018 Start Here
12/56
8 S t a r t H e r e
3 Accept the default name of the report and the My Reports directory.
Choose Save.
4 In Requester, choose OK.
The report appears.
-
5/26/2018 Start Here
13/56
S t a r t H
Building a report using e.Report Designer Java
EditionThis section describes how to build a simple listing report with e.ReporDesigner Java Edition. In this example, you use the Sfdata database, whconfigured by default when you install e.Report Designer. If you chose configure Sfdata when you installed e.Report Designer, you must do so
Connecting to a database
This section describes how to set up an ODBC data source. Sfdata will blocated in one of the following directories:
\Actuate6\ERD\Examples\Databaseor\Actuate6\ERDPro\Examples\Database
Configure the database using the procedure given below.
How to create an ODBC entry for your database
1 Choose StartSettingsControl Panel.
2 Double-click ODBC Data Sources.
ODBC Data Source Administrator appears.
-
5/26/2018 Start Here
14/56
10 S t a r t H e r e
3 Choose Add.
Create New Data Source appears.
4 Select Microsoft Access Driver (*.mdb).
5 Choose Finish.
ODBC Microsoft Access Setup appears.
Data source files
Available datasource drivers
Enter data source file name
Enter a meaningful description
-
5/26/2018 Start Here
15/56
S t a r t H e
6 In ODBC Microsoft Access Setup, make the following selections:
In Data Source Name, type:
Sfdata
In Description, type:
sample databaseChoose Select.
Select Database appears.
7 Navigate to C:\Actuate6\ERD\Examples\Database\Sfdata.mdb onhard drive.
8 Select Sfdata.mdb, and choose OK.
9 In ODBC Microsoft Access Setup, choose OK.
Sfdata appears in the User Data Sources list.
-
5/26/2018 Start Here
16/56
12 S t a r t H e r e
10 Choose OK.
How to start e.Report Designer Java Edition
e.Report Designer Java Edition uses the Java Database Connectivity (JDBCOpen Database Connectivity (ODBC) bridge to connect to ODBC datasources. The JDBC-ODBC bridge is suitable for demonstrating connectivityto a JDBC data source, but is not designed for production use. For deployedapplications, you should use a database with a native JDBC driver.
For more information about ODBC-JDBC connectivity, see Chapter 4,Connecting to a database, in Designing e.Reports Java Edition.
1 Navigate to StartProgramsActuate e.Reporting Suite 6Actuate
e.Report Designer Java Edition.
2 In Command Prompt, press any key when prompted.
3 Choose DataJDBC Connection Wizard.
Connecting to a database appears.
Sfdata
http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/ -
5/26/2018 Start Here
17/56
S t a r t H e
4 Choose Next.
Select a JDBC Driver appears.
-
5/26/2018 Start Here
18/56
14 S t a r t H e r e
5 In JDBC Driver, select JDBC/ODBC Bridge (Sun JVM), and choose Next.
Specify a JDBC URL appears.
6 In Enter the URL or location of your database, type jdbc:odbc:sfdata.
Choose Next.
User Authentication appears.
-
5/26/2018 Start Here
19/56
S t a r t H e
7 Choose Next.
Working Set of Tables appears.
-
5/26/2018 Start Here
20/56
16 S t a r t H e r e
8 Select customers, and choose Add Selected. Choose Next.
Status appears.
9 Choose Finish.
How to create a new report
1 Choose FileNew.
2 In New Confirmation, choose Yes.
New Report Appears.
-
5/26/2018 Start Here
21/56
S t a r t H e
3 Choose Next.
Style appears.
4 Select Single Table, then choose Finish.
Create a Simple Report appears.
-
5/26/2018 Start Here
22/56
18 S t a r t H e r e
5 Choose Next.
Select Fields for Detail Zone appears.
-
5/26/2018 Start Here
23/56
S t a r t H e
6 Select Customers from the list of tables.
1 In the right pane, select contact_last, contact_first, city, state, andpostalcode. Hold down the Control key to select more than one fi
2 Choose Next.
Select Sort Fields appears.
-
5/26/2018 Start Here
24/56
20 S t a r t H e r e
7 To sort the report by postal code and last name, perform the followingtasks:
1 In the Report Fields pane of the Sorting page, select postalcode. ChoosAdd Selected to add PostalCode to Sort Fields.
2 Add contact_last to Sort Fields.
3 Choose Next.
Data appears.
-
5/26/2018 Start Here
25/56
S t a r t H e
8 In Specify a Report Title, type:
Customers Directory
In Specify text for the report footer, type:
Confidential
Choose Next.
Format Appears.
-
5/26/2018 Start Here
26/56
22 S t a r t H e r e
9 Select the following options:
Add date to the report header
Show gridlines around the table
Report Style: Divider Lines
10 Choose Finish.
The finished report template looks like the following illustration.
-
5/26/2018 Start Here
27/56
S t a r t H e
How to format the report
1 Choose Preview to view the report.
2 Choose Design to return to the report design.
3 Double-click Customers Directory.
4 Choose Font/Colors.
5 In Font, Select Arial. Choose OK.
-
5/26/2018 Start Here
28/56
24 S t a r t H e r e
6 Choose ToolsDesigner OptionsTemplates.
Verify that Save Data Source in Template is selected.
Choose Save and Apply.
How to save the report
1 Choose FileSave As.
2 In Save As, choose Browse.
Navigate to the folder in which you want to save the report.
3 Save the report as Customers.jod.
4 In Save As, choose OK.
-
5/26/2018 Start Here
29/56
S t a r t H e
Building a simple e.Spreadsheet reportUsing Actuate e.Spreadsheet Designer, you can design and create custospreadsheets for distribution over the web. To build an e.Spreadsheet reyou must define three report components:
Data source
A data source defines the type of data you use and its source, either aa database. In the following example, you use the Sfdata database.
Data query
A data query specifies what information should be extracted from thdatabase.
Data range
A data range defines where on the worksheet you want the data to a
The following steps guide you through creating an e.Spreadsheet reporBefore you begin to build a report, verify that you have connected to thdatabase. For information about installing the Sfdata database and creatODBC entry for the database, see Connecting to a database,earlier indocument.
How to start e.Spreadsheet Designer
1 Choose StartProgramsActuate e.Reporting Suite 6Actuatee.Spreadsheet Designer.
e.Spreadsheet Designer appears.
-
5/26/2018 Start Here
30/56
26 S t a r t H e r e
2 Choose FileSave As.
Name the file Start.vts, and save it in the directory of your choice.
3 Choose DataData Manager.
Data Manager appears.
-
5/26/2018 Start Here
31/56
S t a r t H e
How to choose the data source
1 In Data Manager, select Databases, and choose Add Source.
JDBC Data Source appears.
2 Complete the JDBC Data Source information, as follows:
For Data Source Name, type:
eval
For Driver Class Name, select:
sun.jdbc.odbc.JdbcOdbcDriver
For Connection URL, select:
jdbc:odbc:sfdata
Choose Next.
Construct Query appears.
-
5/26/2018 Start Here
32/56
28 S t a r t H e r e
How to define a query and a range
1 In Query, enter the following query:
select * from customers order by postalcode
Choose Next.
Data Range appears.
-
5/26/2018 Start Here
33/56
S t a r t H e
2 For Data Range Name, accept the default, Range.
Select Existing Worksheet.
Choose a worksheet cell to be the top left of the range for the incomidata. By default, the text box refers to the active cell in the active workFor this example, verify that the reference matches this one:
'Sheet1'!$A$1
Choose Next.
Format appears.
-
5/26/2018 Start Here
34/56
30 S t a r t H e r e
How to format data
1 In Format, select Use the wizard, and choose Next.
Fields appears.
-
5/26/2018 Start Here
35/56
S t a r t H e
2 In Fields, expand customers by choosing +.
3 In Available fields, select contact_last. To move contact_last to Selectfields, choose right arrow. Select and move the following fields:
contact_first
customName
postalcode
state
Fields looks like the following illustration.
Choose Next.
Groups appears.
-
5/26/2018 Start Here
36/56
32 S t a r t H e r e
4 Choose customers.
5 In Selected tables and fields, select postalcode. Choose right arrow.
Choose Next.
Sorting appears.
-
5/26/2018 Start Here
37/56
S t a r t H e
6 For field one, select customers.contact_last. Choose Next.
Layout appears.
7 In Layout, select Block, and choose Next.
Style appears.
-
5/26/2018 Start Here
38/56
34 S t a r t H e r e
8 In Styles, select Soft Gray. Choose Next.
Build Style Sheet appears.
9 In Build Style Sheet, accept the default name, Range.xsl. Choose Next.
Data Range Options appears.
-
5/26/2018 Start Here
39/56
S t a r t H e
10 In Formatting, accept the default.
In Cell Formatting, select XSLT document, and verify that Use XSLTselected.
In Data Range Changes on Refresh, select Insert Cells for new data, unused cells.
Choose Finish.
Data Manager reappears, displaying the information you entered.
11 In Data Manager, choose Done.
12 Choose FileSave.
-
5/26/2018 Start Here
40/56
36 S t a r t H e r e
Creating the template package file
VTF files are e.Spreadsheet template package files. You create these archivefiles by assembling and compressing a VTS (e.Spreadsheet file) with additionafiles required for your report. These files can be graphic files (GIF or PNG) andstylesheet files (XSL files) used in the report design.
You create VTF files using the Java JAR command. If jar.exe is not identified inyour system path, preface the jar command with the path to jar.exe from theJava JDK installed on your system.
How to create a VTF file
1 In Windows, choose StartRun.
Run appears.
-
5/26/2018 Start Here
41/56
S t a r t H e
2 In Open, type:
cmd
Choose OK.
Command Prompt appears.
3 Navigate to the directory.
4 To compress the files used in the design into a VTF file, type:
jar cfM start.vtf start.vts Range.xsl
The VTF file containing the archived files appears in the directory.
Publishing a report on the webNow that you have built a report, how do you get it onto your web site?you add it to the Report Encyclopedia volume, then you use your web brto run the report and display the results.
Use Actuate Management Console to add reports, run reports, and perfadministrative tasks. The following steps show you how to publish an A
report.
How to log in to Management Console
1 Choose StartProgramsActuate e.Reporting Suite 6ActuateManagement Console.
Volume Log In appears.
-
5/26/2018 Start Here
42/56
38 S t a r t H e r e
2 Select the volume name from the top drop-down.
3 Type the User name and Password for the volume.
4 Choose Log In.
Files and Folders appears.
How to upload a file
1 Choose Add File.
Add File appears.
-
5/26/2018 Start Here
43/56
S t a r t H e
2 Choose Browse.
Choose file appears.
3 Locate and select start.vtf, then choose Open.
Add File reappears.
4 Choose Upload.
Properties appears.
-
5/26/2018 Start Here
44/56
40 S t a r t H e r e
5 Choose OK.
Files and Folders reappears, showing start as an available report.
How to run a background job
1 Select start.vtf.
Hover the mouse over the arrow icon next to start.vtf. Select NewBackground Job.
New Background Job appears.
-
5/26/2018 Start Here
45/56
S t a r t H e
2 To accept the default settings and run the job immediately, choose O
When the report runs on the server, Files and Folders updates to dispnew e.Spreadsheet report.
How to view a report on the web
Choose Start. Verify that you choose the Microsoft Excel Spreadsheet.
The Excel worksheet appears in a new browser window.
-
5/26/2018 Start Here
46/56
42 S t a r t H e r e
Integrating reporting into your web siteUse Actuate Active Portal to design custom e.reporting web sites that meetbusiness information delivery requirements. Actuate Active Portal supportsaccessing and working with reports or information in web browsers. Users
navigate e.reporting web sites by clicking links on Active Portal pages or byentering Active Portal directives as part of a URL.
Actuate Active Portal technology is platform-independent, easy to customizeand easy to upgrade. User interface design is independent of contentgeneration so e.reporting web site development tasks can proceed in parallelActuate Active Portal technology supports clustering and is scalable.
Actuate Active Portal technology includes the following components:
Java Server Pages (JSPs) support creating HTML or XML pages thatcombine static web page templates with dynamic content.
Standard Object Access Protocol (SOAP) is a standard that provides plain
text transmission of XML using HTML.
Information Delivery API supports direct communication between the JSPcustom tags and the e.Reporting System.
-
5/26/2018 Start Here
47/56
S t a r t H e
Secure HTTP (HTTPS) supports secure information transfer using thWorld Wide Web.
The following diagram illustrates Active Portal architecture.
A user submits a request by clicking a link that specifies an Active PortaThe web or application server passes the URL to the Servlet or JSP enginwhich invokes Active Portal. Actuate Active Portal interprets the URL acommunicates with the e.Reporting System using SOAP. The e.ReportinSystems SOAP API manages the request and returns the results to ActiPortal and the Servlet or JSP engine. The web server returns the results web browser. The web browser displays the results for the user.
Creating Actuate Active Portal web sitesActuate provides a set of default cascading style sheets (CSS), JSP files, JavaScript files with the Actuate Active Portal installation. You can custthe default cascading style sheets and JSP files to meet your reporting wneeds. For example, you can modify a standard form to display only sothe available report parameters, to add a background color or graphic, odisplay your company logo.
To create a custom e.reporting web site, you should have knowledge of following:
Contents of the Actuate Active Portal JSP files
Contents of the Actuate Active Portal cascading style sheets Actuate Active Portal directives
HTML including CSS
Webbrowser
Web or application server
Servlet or JSPengine
Active Portal
Customapplication
EJBserver
e.ReportinSystem
SOAP
Database S
Firewall Firewall Firewall
-
5/26/2018 Start Here
48/56
44 S t a r t H e r e
JSP tags
JavaScript
About Actuate Active Portal JSP
Actuate Active Portal generates web pages using a set of default Java ServerPages (JSP), then sends the web pages to the web browser. The Active PortalJSPs use custom tags and JavaScript to generate dynamic web page content.The JavaScript and tags provide access to other JSPs, JavaBeans, and Javaclasses. For example, application logic can reside on the web server in aJavaBean.
Web browsers can request JSP as web resources with parameters. The first tima web browser requests a JSP, the page is compiled into a servlet. Servlets areJava programs that run as part of a network service such as a web server. Onca JSP is compiled into a servlet, the web server can fulfill subsequent requestsquickly provided that the JSP source has not changed since the last request.
Use the default JSPs, customize the JSPs, or create entirely new JSPs to deployyour e.reporting web site. For information about customizing the default JSPssee Chapter 2, Creating custom e.reporting web sites,in Customizinge.Reporting Web Applications.
About Index.jsp
Each Active Portal directory contains an Index.jsp that provides the entrypoint and web page structure for the functionality supported by thedirectorys JSPs. For example, suppose that a user requests to view a report afollows:
http://marcom:8080/acweb/viewer/viewframeset.jsp?
name=detail.roi&serverURL=http://MARCOM:8000&volume=PHISH
Viewer/Index.jsp is Actuate Active Portals entry point for viewing DHTMLreports. Active Portal routes the request to the Viewer directorys Index.jsp.Viewer/Index.jsp manages building and displaying the web page frameworkin which the DHTML report appears.
Each Index.jsp performs the following tasks:
Includes Authenticate.jsp to provide the authentication framework for thedirective
Initializes the page and JSP encoding
Includes style sheets and JavaScript files required by the directive Includes the banner at the top of the page
http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/ -
5/26/2018 Start Here
49/56
S t a r t H e
Includes the sidebar at the left of the page
Provides a content page for which user actions determine the contenas choosing a tab
Working with cascading style sheets
Cascading style sheets (CSS) provide control over the layout of Web pagCSS gives more control over the appearance of a Web page to the page cthan to the browser designer or the viewer. They are also the most efficiway to maintain and update a large web site.
The Actuate Active Portal CSS files reside in \Css. Thefollowing table lists and describes the Actuate Active Portal CSS files.
You make most global changes for your design in Allstyles.css andLinkStyles.css.
About Actuate Active Portal directives
Actuate Active Portal directives convey user requests to the e.ReportingSystem. Directives include running and viewing reports, accessing Repo
Encyclopedia volume files and folders, and managing report viewing astorage options.
Actuate Active Portal directives consist of the context root and port of thserver where you install and deploy the JSPs or servlets. Actuate Activedirectives have the following syntax:
http://:/acweb/.jsp?
-
5/26/2018 Start Here
50/56
46 S t a r t H e r e
is the name of the JSP
specifies the parameters and values that the JSPrequires
For example, to view a report document, Actuate Active Portal uses a directivwith the following format:
http://:/acweb/viewer/viewdefault.jsp?name=
where
viewer is the directory containing JSPs that provide viewer functionality
viewdefault.jsp is the JSP providing default viewing functionality
name is the viewdefault.jsp parameter specifying the pathname of the filethat the user wants to view
is the complete pathname for the file that the user requested
Controlling the Actuate Active Portal designThe following files control the design of your Actuate Active Portal web site:
\Css\Allstyles.css: Customize user interface elements suchas background color and font face
\Js\Allscripts.js: Customize scripts handling standardfunctions such as presenting online help, file and folder details, viewingdocuments, and checking request status
\Authenticate.jsp: Perform user authentication tasks.
\login.jsp: Display the Actuate Active Portal login page.
\Common\Banner.jsp: Display the Actuate Active Portalweb page banner.
\login_banner.jsp: Display the Actuate Active Portal webpage banner on the login page.
Building custom Actuate Active Portal contextroots
The Actuate Active Portal distribution resides in the context root. You set thecontext root in the JSP engines configuration file. For example, you set thecontext root for Tomcat in \Conf\Server.xml, where is the directory containing your Tomcat installation. Example contextroots are: C:\Actuate6\Tomcat\Conf\Server.xml on a Windows system or /usr/local/tomcat/conf/server.xml on a UNIX system.
-
5/26/2018 Start Here
51/56
S t a r t H e
You can create several Actuate Active Portal context roots. Each contextcan contain a web reporting site with a different design. For example, ycreate a web reporting site for particular language groups or differentdepartments.
The following is the definition for the default Actuate Active Portal conroot, Acweb, from a Windows systems Tomcat server.xml file.
-
5/26/2018 Start Here
52/56
48 S t a r t H e r e
Customizing your web site designThis section describes how to create a custom design for your Actuate ActivePortal site.
To make changes to an Actuate Active Portal site: Modify the Actuate Active Portal cascading style sheet (CSS), JavaScript,
and JSP files directly to change default settings or to add custom features ostyles.
Save your changes.
If you modified a JSP file:
Shut down the JSP engine.
Clear the JSP engines cache or work directory to ensure that the JSPengine picks up your changes. For example, to force Tomcat to use youchanged files, delete all files from C:\Actuate6\Tomcat\Work. You can
also clear the web browsers cache. Restart the JSP engine.
If you modified a JavaScript or cascading style sheets file, refresh the webbrowser. You may also have to clear the web browsers cache, then refreshthe page.
Your changes appear in the web browser.
The default Actuate Active Portal JSPs use HTML tables to provide formattinfor each page. The tables are often nested. Individual JSP files include otherJSP files that define elements such as the declaration. As you modifthe JSPs to suit your needs, verify that the Actuate Active Portal pages for
tasks such as logging in, folder and file listing, viewing, and requesting reportappear correctly in your web browser.
Modifying global styles
Allstyles.css contains the style definitions for the Actuate Active Portal site.Modify Allstyles.css to change the default fonts and font colors for pageelements such as file and folder lists, error messages, parameter groups, theweb page colors, and link styles.
For example, the default Actuate Active Portal page banner appears asfollows:
-
5/26/2018 Start Here
53/56
S t a r t H e
To change the page banner to display the user, system name, and volum16-point italic Comic Sans MS font:
1 Open Allstyles.css in a text editor.
2 Locate the following comment:
/** FONT STYLES */
3 Modify the code that follows the font styles comment as follows:
#fntGlobalPropName { font-family: Comic Sans MS, sans-serif, Courier;size: 16pt; font-style: italic; font-variant: normal; color: rgb(156,207,255)
Since you modified a CSS file, you do not need to stop and restart the JSengine. Refresh your web browser to view the changes. The page banneappears as follows:
Modifying the logo and banner
You can change the default logo and banner to reflect your companysgraphics and color scheme. The following JSP files affect the logo and bthat Actuate Active Portal displays on reporting web site pages:
\Common\Banner.jsp: Displays the logo and bannereach reporting web site page.
\Login_banner.jsp: Displays the logo and banner onlthe login page.
The name of the company logo graphic is hard coded in both Banner.jspLogin_banner.jsp:
Replace the code src=images/actuate_logo.gif with the location of yocompanys logo. The default banner consists of several graphic elementincluding four corner graphics that provide rounded corners for the banAdjust the elements, change them, or remove them entirely as your complook and feel requires. Remember to clear your JSP engines work directrestart your JSP engine, and reload the browser page to view your chan
Notice that the default color specifications are in RGB format, for exampbgcolor="#31699C". You can also specify color names such as navy, yelloteal, for example, bgcolor="yellow".
-
5/26/2018 Start Here
54/56
50 S t a r t H e r e
You follow similar procedures to customize other elements of your ActuateActive Portal pages.
Locating common Actuate Active Portal elements
Most common elements reside in files such as Allscripts.js and Allstyles.css.
Some JSP and JavaScript files contain hard-coded common elements, such asthe location of Viewer JSP files in Report.js and the company logo inBanner.jsp. When you change the location or customize the look of commonelements, update the JavaScript and JSP files that use them.
Renaming Actuate Active Portal files
All Actuate Active Portal directives expect JSP files to have certain names andto reside in a particular directory under the context root. Do not rename thedefault files provided with Actuate Active Portal. Active Portal will not findyour custom file names. If you choose not to modify or use the default ActuatActive Portal files, use them to call your custom files.
Integrating reportlets with Actuate Active PortalWeb integration strategies are generally based on the use of frames. ActuateActive Portal uses a complete web page, or frame, then subdivides it into otheframes. The frames comprise the viewer framework. Reports display one pagat a time.
Reportlets support the following functionality:
Displaying a section of a report within an existing web page framework
Suppressing generation of and tags to supportstreaming the reportlet inside other HTML dynamically in a JSP or ASPpage
Suppressing page breaks in the report piece
You invoke reportlets using URLs. The reportlet URL syntax is as follows:
http://:/acweb/servlet/GetReportData?&format=Reportlet&name=
&version=&type=
&componentID=
-
5/26/2018 Start Here
55/56
S t a r t H e
where
is the name of the application server
is the port on which the application server listens for requ
acweb is the Actuate Active Portal context root
servlet is a keyword indicating the name of a servlet follows
GetReportData is the servlet retrieves report data from a specified
format=Reportlet tells GetReportData to retrieve a reportlet
name = specifies the full pathname of the .ROI frwhich to retrieve the reportlet
version= indicates the version of the .ROI to retrieve
type= indicates the file type
componentID= is the component ID of the report section tretrieve
scalingFactor= is the percentage at which to scale the repo
the web page frame reportletmaxheight= indicates the maximum height
reportlets web page frame
You design reportlet reports using Actuate design tools such as e.ReporDesigner Professional.
Whats nextCongratulations! You have finished building and deploying e.reports ov
web. Now you can customize your reporting web site and learn how toinclude e.reports in your corporate web pages. See the following guidesmore information:
Designing e.Reportsfor e.Report Designer
Developing Advanced e.Reportsfor e.Report Designer Professional
Designing e.Reports Java Editionfor e.Report Designer Java Edition
Designing e.Spreadsheet Reportsfor e.Spreadsheet Designer
Administering Actuate e.Reporting Systemfor Management Console
Customizing e.Reporting Web Applicationsfor Actuate Active Portal
Whether you are developing e.reports and applications, building web sshowcase structured content, or deploying corporate e.reports over the Actuate 6 provides everything you need to do the job.
http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/http://xref.pdf/ -
5/26/2018 Start Here
56/56
52 S t a r t H e r e