Previous Contents Index Next |
iPlanet BuyerXpert 4.5 Administrator's Guide |
Chapter 10 Reports
This chapter provides information for configuring the Actuate report writer, creating new reports, and modifying existing iPlanet BuyerXpert reports.
Note For overview material on reports, refer to the Concepts document or the online Help for the iPlanet BuyerXpert User interface.
This chapter contains the following sections:
About Administering Reports
Configuring Actuate Reports for iPlanet BuyerXpert
About Administering Reports
Three types of iPlanet BuyerXpert reports are created using the Actuate report writer:
An extensive set of these reports is supplied with iPlanet BuyerXpert, but users cannot access them until you have configured Actuate for iPlanet BuyerXpert and set up the report business rules. The reports are listed in Concepts and in the User interface Help.
Before doing any reports administration, the following must be true:
Actuate Developer Workbench is installed and operational. If it is not, follow instructions in the Installation Guide.
Note The Actuate instance must be on the same machine as the iPlanet BuyerXpert instance or the installation script does not function properly.
The iPlanet BuyerXpert database is installed and operational.
Administrator's Report Tasks
To perform the tasks in this chapter, you must have basic knowledge in:
Actuate Developer Workbench (Actuate documentation provided) Table 10-1 contains a list of your report tasks. The right-hand column provides information about where to find instructions, guidelines, or tools for performing that task.
Table 10-1    Administrator's Reports Tasks
Task
Location of Instructions/Guidelines/Tools
Creating New Reports section
Modifying Existing Reports section
Making Reports Available section
Configuring Actuate Reports for iPlanet BuyerXpert
The following tasks are required to configure the Actuate reports for iPlanet BuyerXpert:
Creating a New Actuate User These tasks are explained in the following sections.
Creating a New Actuate User
To create a new Actuate user:
Log into the Actuate Administrator application. The first time you log in, the Report Encyclopedia Login screen displays.
Enter user name, password, and volume.
The Actuate Administrator Desktop displays. This is where you can add folders and users. Reports and roles are added to the server by an installation script.
Right click User and select New User from the drop down box.
The properties - New User box displays.
Enter the following information in the Properties - New User fields:
Leave the rest of the tabs as the default (specify later).
The user you have created displays in the frame furthest to the right.
Creating the Folder Structure
After creating a new Actuate user, you are ready to set up the folder structure.
Note It is important that you name the folders exactly as specified here or iPlanet BuyerXpert is not able to access the Actuate reports.
Click the main Library.
Your reporting instance displays. In the example, it is called Cheunger.
Select New Folder from the drop down box.
Create two sub-folders under BXreports called Reports and Output.
Setting Up Folder Permissions
After creating the folder structure, you are ready to set up folder permissions.
Folder permissions are crucial for sustaining iPlanet BuyerXpert reports security. One folder provides users with execute privileges and the other folder serves as a temporary storage area for previously-run reports. The temporary storage folder does not have read privileges. This prevents users from accessing reports they are not authorized to view.
To set up permissions for a folder:
Set up the permissions for the new Actuate user according to Table 10-2.
Table 10-2    Report Folder Permissions
Permission
Folder Name
Description of Folder
Setting Up User Preferences
User preferences allow users to view reports in DHTML and will disable email notification.
Click User.
Right click the anonymous user.
Choose Properties. A properties box displays
In the General tab, choose Dynamic HTML (DHTML) from the viewer preference section.
Creating New Reports
The following topics are addressed in this section:
Understanding Page Layout Sections
Creating a Framework with the Report Wizard
Understanding Page Layout Sections
There are many page layout sections in each report. An understanding of the following sections is necessary for correctly displaying your information.
AfterThis information appears at the end of the report. PageFooter information does not appear in HTML reports.
BeforeThis places information at the very beginning of the section. This information does not repeat.
ContentThis is the area where you enter your detailed content.
GroupSectionThis helps you logically organize your information into groups. All the information that a particular user creates is kept together.
PageFooterThis information is repeated at the end of every page in the report.
PageHeaderThis information is repeated at the top of every page in the report. If any information exists for a Before section, the PageHeader follows. PageHeader information does not appear in HTML reports. All labels and field headers appear in this section.
SubpageThis section is for content unrelated to your report. For example, this is where a logo or a disclaimer could be added to the end of every report.
Scenario: New Report
You are creating a report that provides details on all the orders that were created within a week, categorized by user. You want to know the order number, the description of what was ordered, and the total cost of the order. Totals should be at the user level and the report level. The following are the sections, with associated content, that you must provide to create the report:
Report:BeforeNothing.
Report:PageHeaderEnter the standard header information such as title, report parameters, company logo, and the field labels.
GroupSection1:BeforeEnter the user name because the report is required to be categorized by each user. This allows all the information created by a each user to appear together.
Creating a Framework with the Report Wizard
The Actuate report wizard is a tool that simplifies the task of creating a report framework.
Note Do not attempt to create an entire report in the report wizard. The report wizard is only used for preparing the report framework.
Before using the report wizard, the following must be true:
A development database must be set up on a staging server.
Note The production database should not be used to build or test reports.
The Oracle client must be installed on your staging server and the tnsnames.ora file must be properly configured to access the Oracle database. To create a report using the report wizard:
Select New Report Wizard from the pop up screen that appears when you open Actuate, or select New from the file menu.
The New Report Wizard appears with the About Wizard tab displayed.
Click Next.
The Connection screen appears.
Set up the database connection as follows:
ConfigKey = <blank>
DisplayNamE = Oracle Connection
HostString = your Oracle database name
Password = development password
Username = development username
Select among the following tabs:
Tables and ViewsChoose the tables and views you want to report on.
Sorting and GroupingChoose the groups you want in the report. This creates extra sections in the report to assist you in the logical organization of your data.
FieldsSelect this to add fields to the report, which can be customized later.
Page StylesSkip this by selecting Finish.
Adding Additional Data to Reports
If you are expecting data that you cannot find using the selection criteria, you need to go into the data source for the report:
Click somewhere in the Component Editor.
Select View - Datasource, or click the icon for the data source. For more information refer to Actuate online Help at:
http://www.actuate.com/customer_zone/install_doc.asp.
Verifying a New Report
After the report is complete, run it against a database with enough data so you can see how the report will look. You may need to modify the width of the fields so they fit the width of the page.
Modifying Existing Reports
To modify an existing report, first make a copy of the report, then make modifications to the copy as follows:
Open Actuate Administrator Desktop.
Select the modified file and click OK.
Verify your modifications by running the report against a database that contains enough data so see can how the report will look.
Note You may need to modify the width of the fields to fit the width of the page.
Return the modified report to the Actuate Administrator Desktop.
The reporting architecture finds the new report in the directory where you place report design files. (A design file defines what information a report contains and how that information is presented.) If the modified report is not found in the design file directory, iPlanet BuyerXpert defaults to the original report.
Scenario: Modified Report
To specify a different report executable for a specific country, you must add an entry to the reportsInfo.ntv file which is a text file located in the iPlanet BuyerXpert configuration directory on the application server. The file is updated to add new or modified reports to the iPlanet BuyerXpert framework.
The reportsInfo.ntv file has nested NTVs. The deepest level contains individual ntvs that contain configuration information for individual reports. An NTV file is a configuration file with a listing of variable names and their values. Here is a partial example of a reportsInfo.ntv file:
// the parameters required for this report
"params" StrArr [ "start_date", "end_date", "currency" ],
// the "static" field labels which appear in the report
"staticLabels" StrArr ["l_start_date", "l_end_date", "l_total"],
// the report executable file name
"en_US_Variant" Str "goo.rox",
By adding entries to the executable NTV, you can specify a different executable for a specific locale. All others use the default executable. The naming convention for the locales is:
Adding Reports to the iPlanet BuyerXpert Framework
Any new or modified report whose parameters are a subset of the valid parameters described in report_parameters.xls file can be added to the SellerXpert framework. Table 10-3 lists the valid parameters.
Making Reports Available
New and modified reports must be made available to iPlanet BuyerXpert through the reportsInfo.ntv file. This text file is located in the iPlanet BuyerXpert configuration directory on the application server.
To add a new or modified report to the iPlanet BuyerXpert framework by updating the reportsInfo.ntv file:
Decide which category the report belongs to. The report must fall under one of the main categories of the reportsInfo.ntv file:
Add your report to an existing subcategory or to a subcategory that you create.
Subcategories, which reside under each main category, are numbered sequentially and begin with subcategory1. Each main category can contain any number of subcategories and each subcategory can contain any number of reports. New subcategories are added as NTV entries in the reportsInfo.ntv file.
Example
A reportsInfo.ntv file at the subcategory level:
"reports" StrArr ["my_reqs","my_approved_reqs","my_cancelled_reqs", "my_declined_reqs"],
// each report is represented by an NTV
// the parameters required for this report
"params" StrArr ["start_date", "end_date", "currency", "company", "user_id"],
// the "static" field labels which appear in the report
"staticLabels" StrArr ["lab_adj", "lab_co_name", "lab_cr_dt", "lab_disp_cur"],
// the report executable file name
"default" Str "MyRequisitions.rox",
Define a report by a code within the subcategory. In the previous example the report code is my_reqs. The report code names are arbitrarily created but should reflect of the report's content. The code name must also be included in the reports string array in the subcategory:
"reports" StrArr ["my_reqs"],
Create an NTV entry for the report. The previous example contains the following NTV entry components.
Report parameters
Report parametersIdentified by the params entry. The parameters in the params list tell the framework how to generate the requester form for the report. See the list of available parameters in Table 10-3.
Static labelsOptional. Static labels are used to define language specific text fields in reports. For example, in an English report the text specifying price would be different from a Spanish report. These static labels are defined within the messages.ntv file in the static labels section. The messages.ntv file is a local specific configuration file that specifies the language-sensitive text used in Actuate reports and iPlanet BuyerXpert.
To modify a static label, open the messages.ntv file. The syntax for the static labels in the messages.ntv file is:
"Reports:labels:<label name>" Str "<label text>",
The <label name> is the static label name and <label text> is the display text that should appear in the report.
Report executableThe executable NTV structure defines the .rox Actuate report executable. Report executables can be overridden for a given locale.
Insert the file name of the report you want to add. For example:
// the report executable file name
"executable" NTV {
"default" Str "<file>.rox",
Add an entry into the messages.ntv file for the subcategory title. For the example we have been using the entry in the messages.ntv file is:
"Reports:userReports:subcategory1:my_reqs" Str "My Requisitions",
Previous Contents Index Next
Copyright © 2002 Sun Microsystems, Inc. All rights reserved.
Last Updated June 10, 2002