Vous êtes sur la page 1sur 288

WebFOCUS Managed

Reporting Administrator's
Manual
Version 7 Release 6.1 and Higher

DN4500809.1208
EDA, EDA/SQL, FIDEL, FOCCALC, FOCUS, FOCUS Fusion, FOCUS Vision, Hospital-Trac, Information Builders, the
Information Builders logo, Parlay, PC/FOCUS, SmartMart, SmartMode, SNAPpack, TableTalk, WALDO, Web390,
WebFOCUS and WorldMART are registered trademarks, and iWay and iWay Software are trademarks of Information
Builders, Inc.

Due to the nature of this material, this document refers to numerous hardware and software products by their
trademarks. In most, if not all cases, these designations are claimed as trademarks or registered trademarks by their
respective companies. It is not this publisher’s intent to use any of these names generically. The reader is therefore
cautioned to investigate all claimed trademark rights before using any of these names other than to refer to the
product described.

Copyright © 2008, by Information Builders, Inc. and iWay Software. All rights reserved. Patent Pending. This manual,
or parts thereof, may not be reproduced in any form without the written permission of Information Builders, Inc.
WebFOCUS

Contents
Preface................................................................................................................9
Documentation Conventions............................................................................................11
Related Publications........................................................................................................12
Customer Support...........................................................................................................12
Information You Should Have...........................................................................................13
User Feedback................................................................................................................14
Information Builders Consulting and Training.....................................................................14

1. Introducing WebFOCUS Managed Reporting..................................................15


Managed Reporting Overview...........................................................................................16
WebFOCUS Products.......................................................................................................16
Managed Reporting..................................................................................................17
Business Intelligence Dashboard..............................................................................17
ReportCaster...........................................................................................................17
Managed Reporting Concepts..........................................................................................18
Managed Reporting Capabilities...............................................................................18
Managed Reporting Deployment Process..........................................................................21
Using Managed Reporting................................................................................................23
Using the Browser Toolbar .......................................................................................24
Accessing Dashboard......................................................................................................26
Using the Mozilla Firefox Browser With Dashboard View Builder...................................27
Customizing Dashboard...................................................................................................28
Setting Up a WebFOCUS Environment...............................................................................29
Working With Environment Properties........................................................................29
Local Machine Properties.........................................................................................33
Web Component Properties......................................................................................35
WebFOCUS Client Properties....................................................................................36
Managed Reporting/ReportCaster Properties.............................................................37
Data Server Properties.............................................................................................39

WebFOCUS Managed Reporting Administrator's Manual 3


Contents

Project Development Properties................................................................................39

2. Creating Domains, Groups, Roles, and Users................................................41


Using the Managed Reporting Administration Interface.......................................................42
Creating Domains...........................................................................................................43
Working With the Server and Application Path Properties............................................45
Creating Groups..............................................................................................................46
Creating Users................................................................................................................48
Searching for Users.................................................................................................50
Assigning the Group Administrator Privilege...............................................................50
Assigning Development Domains..............................................................................51
Setting Up Users to Save Parameter Values..............................................................53
Creating Roles................................................................................................................53
User Roles Defined..................................................................................................54
User Privileges Defined............................................................................................59
Customizing the Interface................................................................................................62

3. User Management..........................................................................................63
User Management Tree Object in Domain Builder..............................................................64
Managing a User's Reports..............................................................................................66
Promoting a Custom Report to a Standard Report..............................................................68

4. Managing Dashboard.....................................................................................69
Managing Public Views....................................................................................................70
Managing Library Access in a Public View..................................................................71
Managing Group Views....................................................................................................71
Managing Library Only Views............................................................................................71
Managing Private Views...................................................................................................72
Logging On to Dashboard and View Inheritance.................................................................72
Logon Process for All Users (Excluding Library Only Users)..........................................73
Logon Process for Library Only Users........................................................................74
Managing Users..............................................................................................................75
Setting an ID and Password for the Public User..........................................................77
Setting a Server User ID and Password for the Public User.........................................79
Controlling the Idle Limit for Authenticated and Public Users..............................................81

4 WebFOCUS
Contents

Handling Messages.........................................................................................................83
Hiding Report Types in the Domain Tree............................................................................83
Hiding Report Types in the Domain Tree for All Role Types..........................................85
Hiding the Share Report Option for Finished My Reports.....................................................86
Displaying Optional Properties in Dashboard.....................................................................87
Creating Standard Reports in Dashboard..........................................................................88

5. Creating Public and Group Views..................................................................91


What Is a Public View?....................................................................................................92
What Is a Group View?....................................................................................................92
What Is a Library Only Group View?...................................................................................93
Adding a Group or Public View..........................................................................................93
Group Administrator Access to the View Builder.........................................................96
Directing Users to a Group View Upon Login......................................................................96
Adding a Library Only View...............................................................................................97
Removing a Public or Group View......................................................................................98
Editing a Public or Group View..........................................................................................98
Customizing Dashboard Pages for a Public or Group View...................................................99
Copying a Public or Group View......................................................................................102
Exiting the Public Views or Group Views Window..............................................................103

6. Customizing Dashboard...............................................................................105
Before You Begin Customizing Dashboard.......................................................................106
Opening the View Builder...............................................................................................107
Selecting a Template.....................................................................................................109
Creating a Custom Template..................................................................................111
Selecting Custom Colors................................................................................................115
Positioning the Domain Tree, Role Tree, and Banner........................................................123
Selecting Scrolling Options for Domain Trees and Role Trees....................................125
Inserting a Logo............................................................................................................125
Customizing the Banner.................................................................................................127
Displaying a Welcome Message in the Banner.........................................................131
Creating a Custom Toolbar.............................................................................................132
Adding a Message of the Day.........................................................................................135
Customizing the Logoff Window......................................................................................136

WebFOCUS Managed Reporting Administrator's Manual 5


Contents

Changing the ReportCaster Scheduling Tool....................................................................138


Resetting the View Builder.............................................................................................139
Saving Selections and Exiting a Customization................................................................139
Exiting the View Builder.................................................................................................140

7. Creating a Role Tree....................................................................................141


What Is a Role Tree?.....................................................................................................142
Adding a Role Tree........................................................................................................142
Editing a Role Tree........................................................................................................144

8. Creating Dashboard Content........................................................................147


Creating Dashboard Content Overview............................................................................148
Content Window............................................................................................................148
Creating Content Pages.................................................................................................150
Creating Library Content for a Public View................................................................152
Adding a Content Block..................................................................................................153
Creating a Locked Content Block............................................................................158
Adding Report Library Content to a Content Block....................................................159
Removing a Content Block......................................................................................159
Editing a Content Block.................................................................................................160
Enabling Automatic Block Refresh...........................................................................163
Selecting Scrolling Options.....................................................................................165
Hiding the Toolbar in a Content Block......................................................................166
Creating Filters For Standard Reports.............................................................................167
Executing a Domain Profile in Dashboard........................................................................167
Selecting Content Layout...............................................................................................167

9. Managed Reporting Extract Utility..............................................................171


Managed Reporting Extract Utility...................................................................................172
Running the Managed Reporting Extract Utility.................................................................172
Managed Reporting Extract Utility Output Files.................................................................174
Master Files and Sample Procedure...............................................................................176
Reporting From Extract Files...........................................................................................182
Sending the Data Files...........................................................................................182
Allocating the Extract Files to the WebFOCUS Reporting Server.................................183

6 WebFOCUS
Contents

Output File Relationships.......................................................................................184


Property Flags...............................................................................................................185

10. Change Management.................................................................................189


Understanding the Change Management Process............................................................190
Managed Reporting Development Environment................................................................191
Understanding Internal Managed Reporting References....................................................192
Managed Reporting Change Management Features..........................................................193
Copying Files Between Environments Using Developer Studio...................................194
Copying a Domain Between Environments Using Developer Studio............................196
Change Management Extract Utility................................................................................197
Change Management Load Utility...................................................................................201
Alternate Change Management Load Program..........................................................204
Dashboard Change Management....................................................................................207

11. Additional Administration Topics...............................................................211


Selecting the Tool Type for ReportCaster.........................................................................212
Debugging....................................................................................................................213
Your Browser's Java Console..................................................................................213
Tracing the Java Applets........................................................................................214
Tracing the WebFOCUS Client.................................................................................214
Enabling Tracing Options in Dashboard...................................................................215
Setting Up Traces for Managed Reporting User Requests.................................................218
Repository File Name Processing....................................................................................218
Obtaining a List of Available Master Files........................................................................219

12. Application Integration Topics...................................................................221


Invoking the Deferred Report Status Interface Directly......................................................222
Managed Reporting Browser Window Feature..................................................................223
WebFOCUS Managed Reporting Implementation......................................................223
Site Customization................................................................................................224
Browser Window Options........................................................................................226
Browser Window Exceptions...................................................................................227
Customizing the Amper Auto-Prompting Facility........................................................227
Using Launch Pages Outside the Default Repository........................................................228

WebFOCUS Managed Reporting Administrator's Manual 7


Contents

13. Two-Way Email Administration...................................................................231


Accessing the Administrator Console..............................................................................232
Adding or Deleting a Subscriber......................................................................................233
Maintaining an E-mail Address.......................................................................................235
Refreshing a User's Templates......................................................................................236
Using the Job Log..........................................................................................................237
Viewing the Status of an Executed Job....................................................................237
Purging the Job Log...............................................................................................239
Using the Event Log......................................................................................................240
Monitoring E-mail Traffic.........................................................................................242
Purging the Event Log............................................................................................244
Checking the Status of a Job or Canceling a Job..............................................................245

14. Managing Deferred Tickets........................................................................247


Managing Deferred Workload.........................................................................................248
Understanding Alternate Deferred Servers...............................................................248
Configuring Deferred Services.................................................................................249
Deferred Report Expiration Setting..........................................................................250
Reading Saved Deferred Output Created by WebFOCUS CGI/ISAPI Client...................251
Managing the Deferred Ticket Cleanup Utility...................................................................252
Deferred Ticket Cleanup Utility Processing...............................................................253
MR Repository and User Credentials.......................................................................253
WebFOCUS Reporting Server and User Credentials...................................................254
Log File and Backup of User HTM File.....................................................................256
Running the MR Deferred Ticket Cleanup Utility........................................................259
Processing Multiple MR Repositories in Silent Mode................................................269
Troubleshooting.....................................................................................................270

Reader Comments...........................................................................................287

8 WebFOCUS
WebFOCUS

Preface
This documentation describes the WebFOCUS Managed Reporting Administrators environment,
which enables the creation of powerful EIS and decision-support applications that deliver
easy access to the information that users need, regardless of hardware platforms, database
structures, or application programs. It is intended for system administrators.

How This Manual Is Organized


This manual includes the following chapters:

Chapter/Appendix Contents

1 Introducing WebFOCUS Describes Managed Reporting, ReportCaster, and


Managed Reporting Dashboard. Explains Managed Reporting concepts,
Dashboard customization, and how to access and
use Managed Reporting and Dashboard. Describes
how to add, edit, and review properties of WebFOCUS
environments.

2 Creating Domains, Groups, Describes how to create domains, groups, roles, and
Roles, and Users users with the Managed Reporting Administration
interface.

3 User Management Describes how the User Management tree object is


used to view all types of user’s reports and to open,
edit, run, save, and delete Managed Reporting user’s
reports.

4 Managing Dashboard Describes how the Administrator controls what users


can access in the general public view, the custom
public view, and in group views. This includes the
domains they can view and certain functionality such
as the Domain Search.

WebFOCUS Managed Reporting Administrator's Manual 9


Chapter/Appendix Contents

5 Creating Public and Group Describes how to create and manage public views
Views (general and custom) and group views from the Public
Views and Group Views windows in the View Builder.
From the Public/Group Views windows you can add,
remove, edit, or copy a public or group view.

6 Customizing Dashboard Describes how to customize the Dashboard by


choosing colors, adding a logo, selecting the position
of the Domain Tree, Role Tree, and banner, and more.

7 Creating a Role Tree Describes how to create Role Trees, which allow
Dashboard users access to items (reports, graphs,
launch forms, and URLs) that have been associated
with their Managed Reporting User Groups.

8 Creating Dashboard Content Describes how to create content blocks, which display
when you open the Dashboard. Content blocks can
contain launched reports, links to reports, or links to
Internet resources.

9 Managed Reporting Extract Describes how the Managed Reporting Extract utility
Utility allows you to extract data from your Managed
Reporting Repository in order to generate reports
about users, groups, domains, and domain content.

10 Change Management Describes features in Managed Reporting that can


be used to facilitate change management, which is
the process of moving application components
between WebFOCUS environments.

11 Additional Administration Provides additional information for administrators


Topics about Deferred Receipt, Report Assistant and Graph
Assistant, and tracing the WebFOCUS Client, Java
Applet, and Dashboard.

12 Application Integration Provides information on invoking the Deferred Report


Topics Status Interface, browser window features, and
launch pages.

13 Two-Way Email Describes how to use the Two-Way Email


Administration Administrator console.

10 WebFOCUS
Preface

Chapter/Appendix Contents

14 Managing Deferred Tickets Provides information for Administrators to manage


deferred workload and the Deferred Ticket Cleanup
Utility.

Documentation Conventions
The following table lists and describes the conventions that apply in this manual.

Convention Description

THIS TYPEFACE Denotes syntax that you must enter exactly as shown.
or
this typeface

this typeface Represents a placeholder (or variable) in syntax for a value that
you or the system must supply.

underscore Indicates a default setting.

this typeface Represents a placeholder (or variable), a cross-reference, or an


important term. It may also indicate a button, menu item, or
dialog box option you can click or select.

this typeface Highlights a file name or command.

Key + Key Indicates keys that you must press simultaneously.

{ } Indicates two or three choices; type one of them, not the braces.

[ ] Indicates a group of optional parameters. None are required,


but you may select one of them. Type only the parameter in the
brackets, not the brackets.

| Separates mutually exclusive choices in syntax. Type one of


them, not the symbol.

... Indicates that you can enter a parameter multiple times. Type
only the parameter, not the ellipsis points (...).

WebFOCUS Managed Reporting Administrator's Manual 11


Related Publications

Convention Description

. Indicates that there are (or could be) intervening or additional


commands.
.
.

Related Publications
To view a current listing of our publications and to place an order, visit our Technical
Documentation Library, http://documentation.informationbuilders.com. You can also contact
the Publications Order Department at (800) 969-4636.

Customer Support
Do you have any questions about this product?
Join the Focal Point community. Focal Point is our online developer center and more than a
message board. It is an interactive network of more than 3,000 developers from almost
every profession and industry, collaborating on solutions and sharing tips and techniques,
http://forums.informationbuilders.com/eve/forums.
You can also access support services electronically, 24 hours a day, with InfoResponse
Online. InfoResponse Online is accessible through our World Wide Web site,
http://www.informationbuilders.com. It connects you to the tracking system and known-
problem database at the Information Builders support center. Registered users can open,
update, and view the status of cases in the tracking system and read descriptions of reported
software issues. New users can register immediately for this service. The technical support
section of www.informationbuilders.com also provides usage techniques, diagnostic tips,
and answers to frequently asked questions.
Call Information Builders Customer Support Service (CSS) at (800) 736-6130 or (212) 736-
6130. Customer Support Consultants are available Monday through Friday between 8:00
a.m. and 8:00 p.m. EST to address all your WebFOCUS Managed Reporting questions.
Information Builders consultants can also give you general guidance regarding product
capabilities and documentation. Please be ready to provide your six-digit site code number
(xxxx.xx) when you call.
To learn about the full range of available support services, ask your Information Builders
representative about InfoResponse Online, or call (800) 969-INFO.

12 WebFOCUS
Preface

Information You Should Have


To help our consultants answer your questions effectively, be prepared to provide the following
information when you call:
Your six-digit site code (xxxx.xx).
Your WebFOCUS configuration:
The front-end you are using, including vendor and release.
The communications protocol (for example, TCP/IP or HLLAPI), including vendor and
release.
The software release.
Your server version and release. You can find this information using the Version option
in the Web Console.
The stored procedure (preferably with line numbers) or SQL statements being used in
server access.
The Master File and Access File.
The exact nature of the problem:
Are the results or the format incorrect? Are the text or calculations missing or
misplaced?
The error message and return code, if applicable.
Is this related to any other problem?
Has the procedure or query ever worked in its present form? Has it been changed recently?
How often does the problem occur?
What release of the operating system are you using? Has it, your security system,
communications protocol, or front-end software changed?
Is this problem reproducible? If so, how?
Have you tried to reproduce your problem in the simplest form possible? For example, if
you are having problems joining two data sources, have you tried executing a query
containing just the code to access the data source?
Do you have a trace file?
How is the problem affecting your business? Is it halting development or production? Do
you just have questions about functionality or documentation?

WebFOCUS Managed Reporting Administrator's Manual 13


User Feedback

User Feedback
In an effort to produce effective documentation, the Documentation Services staff welcomes
your opinions regarding this manual. Please use the Reader Comments form at the end of
this manual to communicate suggestions for improving this publication or to alert us to
corrections. You can also use the Documentation Feedback form on our Web site,
http://documentation.informationbuilders.com/feedback.asp.
Thank you, in advance, for your comments.

Information Builders Consulting and Training


Interested in training? Information Builders Education Department offers a wide variety of
training courses for this and other Information Builders products.
For information on course descriptions, locations, and dates, or to register for classes, visit
our World Wide Web site (http://www.informationbuilders.com) or call (800) 969-INFO to
speak to an Education Representative.

14 WebFOCUS
WebFOCUS

1 Introducing WebFOCUS Managed Reporting

WebFOCUS is a complete, Web-ready,


Topics:
enterprise data access and reporting
system, which takes advantage of the Managed Reporting Overview
low-cost, low-maintenance, and wide
distribution capabilities of the World Wide WebFOCUS Products
Web and internal corporate Web sites. Managed Reporting Concepts
Managed Reporting Deployment
Process
Using Managed Reporting
Accessing Dashboard
Customizing Dashboard
Setting Up a WebFOCUS Environment

WebFOCUS Managed Reporting Administrator's Manual 15


Managed Reporting Overview

Managed Reporting Overview


WebFOCUS enables application developers and Web designers to create powerful EIS and
decision-support applications that deliver easy access to the information that users need,
regardless of hardware platforms, data source structures, or application programs. Developers
can create sophisticated Web pages that enable end users to view static reports, to run
dynamic reports, and to create parameterized queries for individual requests.
The WebFOCUS Business Intelligence Dashboard is an HTML-based thin client that enables
you to create a customized user interface for access to WebFOCUS Managed Reporting.
When you connect to Dashboard you are also connecting to WebFOCUS Managed Reporting,
which means all of the Standard Reports and Reporting Objects that are available in Managed
Reporting are also available in Dashboard.
You define and manage your WebFOCUS environments from the WebFOCUS Environment
Properties dialog box in Developer Studio. You access this dialog box from either the
WebFOCUS Environments node in the Explorer or from the Environments List dialog box.

WebFOCUS Products
In this section:
Managed Reporting
Business Intelligence Dashboard
ReportCaster

To develop Web-based reporting applications, WebFOCUS provides integrated Java-based


development tools that are seamlessly integrated with the WebFOCUS server-side software
components. WebFOCUS enables Developers to prototype, test, and deploy Web-based
reporting applications quickly, without requiring knowledge of HTML, Web server
administration, or the FOCUS 4GL reporting language. WebFOCUS offers the following
application development and deployment tools:
Managed Reporting on page 17.
Business Intelligence Dashboard on page 17.
ReportCaster on page 17.

16 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

Managed Reporting
Managed Reporting provides a streamlined reporting environment that virtually eliminates
the complexities of today's corporate data. Managed Reporting Administrators can use the
Domain Builder tool in the browser version to develop Managed Reporting, including Standard
Reports and Reporting Objects. With the User Administrator tool available from the Managed
Reporting browser or Developer Studio environments, Administrators can manage access
to Managed Reporting domains. Administrators grant authorized users access to the
information they need, while restricting unauthorized users from sensitive or confidential
corporate data.
Users of Managed Reporting can create and save reports that meet their individual business
needs without knowing the details and complexities of the underlying data source or of the
FOCUS reporting language. Managed Reporting ensures that users can access the information
they require, while protecting sensitive or confidential data.

Business Intelligence Dashboard


The WebFOCUS Business Intelligence Dashboard allows you to create a customized user
interface for access to WebFOCUS Managed Reporting.
From Dashboard you can:
Customize the look of the WebFOCUS environment (administrators only).
Create personalized content blocks that can contain launched reports, links to reports,
and links to Internet resources.
Search domains available in the WebFOCUS environment.
Create and manage public views (administrators only).
Dynamically access non-WebFOCUS documents.
View the status of deferred reports.
Access reporting tools such as Power Painter, Report Assistant, Graph Assistant, and
ReportCaster.

ReportCaster
ReportCaster is an optional Java-based tool that provides a single point of management for
report scheduling and distribution using the Web, e-mail, Managed Reporting, or a printer.
ReportCaster enables you to provide essential, updated information directly to the people
who need it, on time, automatically.

WebFOCUS Managed Reporting Administrator's Manual 17


Managed Reporting Concepts

You can access ReportCaster by clicking the ReportCaster icon in the Managed Reporting
browser or Developer Studio. All ReportCaster functions are available from your reporting
environment, including:
Scheduling reports to be run once or repeatedly.
Bursting reports to send specific values in a report to different users, files, or printers.
Distributing report output using e-mail, FTP, printer, or Managed Reporting.
Maintaining scheduled jobs, the address book of distribution lists, and log files.
For more information about ReportCaster, see the ReportCaster Development and
Administration manual.

Managed Reporting Concepts


In this section:
Managed Reporting Capabilities

Managed Reporting Administrators create and manage user environments. Managed Reporting
Developers develop content for users. Managed Reporting users can run Standard Reports,
defined in advance by a Managed Reporting Administrator or a Developer. In addition,
Managed Reporting users can create and save reports that meet their individual business
needs without knowing the details and complexities of the underlying data source or of the
FOCUS reporting language.
To organize the Standard Reports and Reporting Objects available to users, Managed
Reporting Administrators create a series of domains, using the Managed Reporting Domain
Builder in the browser or the Explorer in the full Developer Studio. Organizing Standard
Reports and Reporting Objects by domains ensures that users can access the information
they require, while protecting sensitive or confidential data.

Managed Reporting Capabilities


As a Managed Reporting Administrator or Developer, you create the Standard Reports that
users run, as well as publish the HTML launch pages used to call reports that require
parameters. In addition, you can perform the following actions:
Create access rights to Managed Reporting. To enable a user to access Managed
Reporting, you must create a user account for every user, assign the user a role, and
specify the groups to which every user is a member. You also specify which reporting
domains belong to each group. User accounts and groups are created with the Managed
Reporting Administration interface.

18 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

For more information about the Managed Reporting Administration interface, see Creating
Domains, Groups, Roles, and Users on page 41. The Managed Reporting Administration
interface is not available in Managed Reporting Developer for Windows.
Create and access the metadata for data sources. To create a report that accesses
a data source, you must first create and access the metadata for that data source.
Metadata is information about the structure of the data itself, such as the columns or
fields in the data source, their format, or the location of the data sources.
You create and manage metadata from the Data Servers feature in Domain Builder in
the browser or in the Explorer in Developer Studio. You can enhance this metadata with
additional descriptive information like the business context of a particular field.
Build the reports that retrieve and format data. Using Managed Reporting, you can
build, test, and deploy sophisticated tabular reports and graphs, without knowing the
FOCUS reporting language. In addition to creating new report procedures, you can move
existing procedures from the WebFOCUS Reporting Server to the WebFOCUS Managed
Reporting Repository in order to modify or enhance them. For information about creating
tabular reports and graphs, see the WebFOCUS Managed Reporting End User's Manual.
For information about creating advanced graphs and using report procedures stored on
the WebFOCUS Reporting Server, see the WebFOCUS Managed Reporting Developer's
Manual.
Create Reporting Objects for users. Managed Reporting lets you create Reporting
Objects for Managed Reporting and Dashboard users. Reporting Objects are
representations of data sources, which present the available data using terms and formats
meaningful to the user. Using predefined Reporting Objects, Managed Reporting users
build and save their own reports without having to know the details and complexities of
the underlying data sources.
For more information about creating Reporting Objects, see the WebFOCUS Managed
Reporting Developer's Manual.
Create OLAP-enabled reports. Managed Reporting enables you to update metadata
files to make them OLAP-enabled as well as to create OLAP-enabled Standard Reports
and Reporting Objects for your users. Users can run OLAP-enabled reports and use the
OLAP selections panel or the OLAP Control Panel to manipulate the reports in order to
view different representations of the data, without modifying the actual Standard Report
or Reporting Object. For more information, see the WebFOCUS Managed Reporting End
User's Manual.

WebFOCUS Managed Reporting Administrator's Manual 19


Managed Reporting Concepts

Publish HTML launch pages for the reports. After you create and test your reports,
you can use Managed Reporting to publish the report to the Web. When you publish a
report, you create a launch page, a complete HTML file that calls the report procedure.
You can create an HTML launch page for any report stored using Managed Reporting.
These launch pages can be published back to Managed Reporting or they can be
incorporated into a self-service application.
You can customize launch pages by editing the HTML file to add additional HTML tags
and syntax. For example, the HTML launch page can include image files (GIF or JPG files),
tables, frames, JavaScript™ functions, and hypertext links to other Web pages. In addition,
the launch pages that you create can be accessed through HTML hyperlinks from other
Web pages.
For more information about publishing launch pages, see the WebFOCUS Managed
Reporting Developer's Manual.
Schedule reports. Managed Reporting provides access to ReportCaster, where you can
schedule and distribute Standard Reports. ReportCaster enables you to provide essential,
updated information directly to the people who need it, on time, automatically. For
information about scheduling and distributing report output with Managed Reporting, see
the ReportCaster Development and Administration manual.
Distribute reports when certain test conditions are met using ReportCaster Alerts.
A ReportCaster Alert sends notification to a user whenever a specified event takes place.
You are able to create test conditions (rules) and specify how often you would like these
rules or events to be checked against a data source. ReportCaster can then generate a
report or sections of that report (burst option) as a result of the alert.
ReportCaster Alerts work with all e-mail clients and WAP-enabled mobile phones. Alerts
can also be sent to any PC or laptop computer with e-mail capability.
For more information about ReportCaster Alerts administration, see the WebFOCUS
Managed Reporting Developer's Manual.
Receive a WebFOCUS report by Two-Way Email. As a Managed Reporting Administrator
or Developer, you use Managed Reporting to create and maintain Two-Way Email
templates, the means by which a user requests a report. A Managed Reporting
Administrator can also use the Two-Way Email Administrator Console to manage subscriber
information, monitor the execution of report requests, cancel requests, and perform other
administrative tasks.
For more information about Two-Way Email administration, see Two-Way Email
Administration on page 231.

20 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

Customize Managed Reporting. Managed Reporting lets you customize the user
environment by adding profiles and customized help files to domains. A profile, which
runs each time a user opens a Managed Reporting domain, can provide an introductory
report or information about the Managed Reporting domain. Customized help files, which
users access from the Managed Reporting domain, provide additional information specific
to the Managed Reporting domain, such as detailed explanations of Standard Reports
and Reporting Objects.
For more information, see Creating Domains on page 43.

Managed Reporting Deployment Process


Managed Reporting (MR) has many features that enable security integration with your
business at the enterprise level. If security integration is not your immediate concern, you
can skip this section because Managed Reporting is installed out of the box with its own
built-in user repository.
The first step in an enterprise Managed Reporting deployment is to identify roles and
responsibilities. It is possible in a large enterprise that there are different people charged
with the following roles:
WebFOCUS Administrator has access to the WebFOCUS Administration Console and
can configure global settings including Managed Reporting security, multi-language
support, data server access, and so on. You can access the iServer Console from the
WebFOCUS Administration Console.
iServer Administrator has access to the iServer Console and has rights to configure
adapter settings and also global settings such as server security. They can also identify
and set access rights for other individuals who can use the iServer Console.
iServer Application Administrator has access to the iServer Console and has rights
to create metadata and application resources. For a complete description of this and
other iServer privilege levels, consult your Server documentation.
Managed Reporting Administrator has access to the Managed Reporting Administration
interface and can create MR users, groups, domains, and roles. They can also assign
Group Administration rights to specified users and define which reports are available to
which groups of users.
Managed Reporting Group Administrator can add and remove users from the groups
to which they are granted administration rights, and can create users with some
limitations. Group Administrators can also access the View Builder to create and update
Group Views for groups they administer.

WebFOCUS Managed Reporting Administrator's Manual 21


Managed Reporting Deployment Process

Managed Reporting Developer can use the Developer Studio (Windows) and Domain
Builder (Java applet) interfaces to create report content for MR domains. This includes
Reporting Objects which enable end users to create their own ad-hoc reports. If granted
access, these users can create metadata on the server.
Managed Reporting Users based on their role and privilege settings can create and
run reports and access other features such as Report Library.
Before deploying Managed Reporting, an enterprise may follow the process described in the
following image.

After you have identified roles and responsibilities, the WebFOCUS Administrator should
decide how users will be authenticated and authorized to use Managed Reporting (MR). For
example, if users will be authenticated by Active Directory this is configured in the WebFOCUS
Administration Console. Likewise, the Managed Reporting Administration interface supports
user maintenance in a relational DBMS. To configure this security option, you use the
WebFOCUS Administration Console. It is possible to grant multiple people access to the
WebFOCUS Administration Console, so that MR security settings can be made by the MR
administrator. For more information, see the WebFOCUS Security and Administration manual.

22 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

Using Managed Reporting


In this section:
Using the Browser Toolbar

As a Managed Reporting Administrator or Developer, use the following tools to create and
manage the Managed Reporting user environment:
Developer Studio MR Component and Domain Builder applet enable you to create
Standard Reports that users run, launch pages that make those reports available on the
Web, and Reporting Objects for users to create their personal reports. The Managed
Reporting Repository supports long file names (up to 64 characters) for My Reports,
Standard Reports, Reporting Objects, and Other files.For more Domain Builder information,
see Creating Domains on page 43.
Managed Reporting Administration enables you to configure user access to Managed
Reporting by specifying user profiles, roles, and the domains that the users can access.
Grouping users and domains ensures that users can access the information they need,
while protecting sensitive or confidential data. Managed Reporting Administration is only
available to Administrators and limited functionality is available for Developers that are
assigned the Group Administrator privilege. For more information, see Creating Domains,
Groups, Roles, and Users on page 41. This tool is not available in Managed Reporting
Developer for Windows.
ReportCaster is an optional tool that enables you to schedule the execution of Standard
Reports, and distribute the information directly to the people who need it, on time,
automatically. ReportCaster requires ReportCaster Administrator privileges. For more
information, see the ReportCaster Development and Administration manual.
Two-Way Email enables mobile business professionals to request and receive WebFOCUS
reports through e-mail, using a handheld device, laptop, or desktop. For more information,
see Two-Way Email Administration on page 231.
Data Servers lets you create, access, and use data source descriptions and procedure
files that reside on the WebFOCUS Reporting Server. The Data Servers component contains
the stored procedures and Master Files called by the reports that you create. The Domain
Builder in the browser and the Explorer in Developer Studio display the Data Servers
component in a hierarchical, tree-like structure.
Note: If you are a Developer using the browser, or you are not using the full edition of
Developer Studio and you do not have the Data Server privilege, the Data Servers node
is hidden. Developers with the Data Server privilege will be able to view and edit the
Server and Application path properties on a Domain. Without the Data Server privilege,
Developers will only be able to view these properties.

WebFOCUS Managed Reporting Administrator's Manual 23


Using Managed Reporting

Domains reside on the Web server in the Managed Reporting Repository and are used
to build and test Standard Reports, Reporting Objects, and the Web pages that launch
those procedures. Each domain that you create (in the browser or the full Developer
Studio) contains a group of folders for the different types of objects you create for
Managed Reporting users. The Domain Builder in the browser and the Explorer in Developer
Studio display the domains in a hierarchical, tree-like structure.
The following image shows the Developer Studio window with the standard Windows menu
bar and two rows of toolbar. The window is then divided into two sections, the left section
displays the hierarchical structure of the objects created for Managed Reporting users and
the right section contains the available domains.

Using the Browser Toolbar


The WebFOCUS Managed Reporting Domain Builder and Domains environments both provide
access to the toolbar.
The toolbar contains the tools required to create, test, edit, and publish report procedures
and Web launch pages. Using the toolbar, you can create the metadata for data sources,
build the reports that retrieve and format that data, and generate Web pages that enable
users to run the reports. The following image shows the Managed Reporting toolbar which
is later described in a table.

You perform these tasks using the toolbar buttons as outlined in the following table. The
tables provides the name of the button and a description of the task you can perform from
the button.

Button Description

New Adds a new component. For example, if you highlight the Domains
folder and then click New, you create a new domain.

Open/Close Opens/closes a selected object.

Edit Source Displays the code for the selected object (report, procedure, or launch
page) in the text editor window.

Search Enables you to search the selected domain, folder, or object.

24 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

Button Description

Refresh Updates the contents of the Managed Reporting Repository window.


This button is useful when more than one Administrator is working in
Managed Reporting. Changes one Administrator makes to the
Repository may not always be visible to other Administrators.
This feature is context sensitive; only the selected object will refresh.

Run Executes the selected report or displays the selected launch page.

Run Deferred Executes the selected report in deferred mode.

Deferred Status Displays the Deferred Report Status Interface in a new browser
window.

Publish Creates an HTML launch page for the selected report. For more
information, see the WebFOCUS Managed Reporting Developer's
Manual.

Managed Opens the Managed Reporting Administration interface. For details,


Reporting see Creating Domains, Groups, Roles, and Users on page 41.
Administration

ReportCaster Enables you to access ReportCaster. For more information, see the
ReportCaster Development and Administration manual.

ReportCaster Enables you to access the ReportCaster Console. For more


Console information, see the ReportCaster Development and Administration
manual.

Report Library Enables you to access the content in the Report Library.

Cut Removes an object (Standard Report, Reporting Object, launch page,


or Other File) from the domain and copies it to the clipboard.

Copy Copies an object to the clipboard.

Delete Removes the selected folder or object.

Paste Places the clipboard item into the indicated destination.

Properties Displays the name and data source of the selected object.

Help Displays online help.

WebFOCUS Managed Reporting Administrator's Manual 25


Accessing Dashboard

The Managed Reporting toolbars are positioned at the top of both Managed Reporting
interfaces.

Accessing Dashboard
In this section:
Using the Mozilla Firefox Browser With Dashboard View Builder
How to:
Open Dashboard

There are several views in Dashboard:


Public. This view is accessible to public users and cannot be personalized. Public users
have execute-only access; they cannot save report requests or report output to a domain.
For details, see How to Open Dashboard on page 26.
Group. A group view is accessible to users with a valid Managed Reporting user ID and
password. The user must be a member of the group to gain access to the view. Group
views cannot be personalized by users.
Private. This view is accessible to users with a valid Managed Reporting user ID and
password. From this view a user can add to or edit the content blocks the administrator
has set up. For details, see How to Open Dashboard on page 26.
You use the View Builder to create a unique look for each public and group view.

Procedure: How to Open Dashboard


You can open the Dashboard View Builder, Group Views page, and Public Views page
from the WebFOCUS Welcome page (http://hostname/ibi_apps/).
Alternatively, you can:
Enter the following URL in your Web browser:
http://hostname[:port]/ibi_apps/bid
where:
hostname
Is the host name and optional port number (specified only if you are not using the
default port number) where Dashboard is deployed.

26 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

You can access the following pages directly by entering the URL:
http://hostname [:port]/ibi_apps/bid/pagename
where:
pagename
In one of the options listed in the following table. The first column lists the page
names, the second column lists their descriptions.

Page Name Description

vblogin Opens the View Builder login page.

mpv Opens the public views index page. This page lists all
existing public views.

public Opens the general public view.

viewname_mpv Opens the specified public view. Viewname is automatically


generated when the view is created in the View Builder.

viewname_gbv Opens the specified group view. Viewname is automatically


generated when the view is created in the View Builder.

login Opens the user login page.

passchange Opens the change password page.

Using the Mozilla Firefox Browser With Dashboard View Builder

How to:
Change Firefox Browser Settings

If you are accessing the Dashboard View Builder using the Mozilla Firefox browser, there is
a security setting that must be changed. When you are creating a Public or Group View, the
browser setting "security.checkloaduri" must be set to false so that the View Builder can
check image dimensions (for example, an image file you are using for the logo in your banner).
This setting change is required due to the fact that Firefox does not allow access to file
properties by default.
Note: This setting change is only required for the Dashboard administrators using the View
Builder. Dashboard users do not need to make any changes.

WebFOCUS Managed Reporting Administrator's Manual 27


Customizing Dashboard

Procedure: How to Change Firefox Browser Settings


1. In the Firefox browser address bar, enter about:config.
2. Press Enter or click Go.
3. In the Preference Name column, scroll down to security.checkloaduri.
4. Double click security.checkloaduri to change the value to false.

Customizing Dashboard
When you create a customized view of Dashboard you can:
Create a unique customization for each public and group view. This includes selecting a
template, selecting custom colors, positioning the Domain Tree, Role Tree and banner,
inserting a company logo, and much more.
Create the default content blocks that the user sees when a Dashboard public or group
view is opened.
Create and edit public and group views.
Identify the Managed Reporting password that the Dashboard will use to connect the
public user to Managed Reporting.
Set a default user ID and password for the public user. When a user ID and password
are set, the public user does not have to enter logon information when accessing a public
view.
Create Role Trees for Managed Reporting User Groups.
When a user opens Dashboard, a single logon page appears. You can set a user ID and
password for the public user so they do not have to enter logon information when they
open Dashboard.
For additional security, you can configure the Dashboard logon page so users log on to
both Dashboard and the WebFOCUS Reporting Server. For more information, see the
Installation and Configuration manual for your platform. You can also integrate the
Dashboard logon with other systems such as Web server or LDAP security. See the
WebFOCUS Security and Administration manual for details.

28 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

Setting Up a WebFOCUS Environment


In this section:
Working With Environment Properties
Local Machine Properties
Web Component Properties
WebFOCUS Client Properties
Managed Reporting/ReportCaster Properties
Data Server Properties
Project Development Properties

A WebFOCUS environment consists of a Web server, a WebFOCUS Client, and WebFOCUS


Reporting Servers. To add a WebFOCUS environment, you specify a Web server containing
the WebFOCUS Client and the connection method it uses (servlet, CGI, or ISAPI). Developer
Studio then finds all of the WebFOCUS Reporting Servers that the WebFOCUS Client can
access.
You add WebFOCUS environments and edit existing environments in Developer Studio using
the WebFOCUS Environment Properties dialog box or the Explorer tree itself. Use either of
these approaches to create and manage additional environments, such as test and
production.

Working With Environment Properties

How to:
Add a WebFOCUS Environment

When you set up access to WebFOCUS environments, your settings are retained when you
restart or even reinstall Developer Studio. WebFOCUS environment settings are normally
stored in:
drive:\Documents and Settings\user_id\Application Data\
Information Builders\wfscom.xml
where:
user_id
Is your logged on Windows ID.

WebFOCUS Managed Reporting Administrator's Manual 29


Setting Up a WebFOCUS Environment

Note:
This file and directory may not be visible by default. To see this directory, open Windows
Explorer, click Tools, choose Folder Options, and select the View tab. Then, select Show
hidden files and folders and click OK.
In Developer Studio Version 5 Release 3 and earlier, this file was named wfscom.wfs.
When you launch Developer Studio Version 7 Release 1 and higher, an existing wfscom.wfs
file is renamed to wfscom.xml.
If an existing wfscom.xml or wfscom.wfs file existed and had a localhost environment,
the existing localhost environment gets updated with settings based on the installation
and configuration options selected during the installation. If localhost did not exist, it is
created with settings based on the installation and configuration options selected during
installation.
User IDs and passwords stored in wfscom.xml are encrypted to keep them confidential.
WebFOCUS environment properties apply to your current Developer Studio configuration.
It will not impact other users or the WebFOCUS configuration.

Procedure: How to Add a WebFOCUS Environment


Note: You can also add a WebFOCUS Environment by right-clicking WebFOCUS Environments
on the Developer Studio Explorer and selecting Add.

30 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

1. Select the File menu and choose Show Environments. The Environments List dialog box
opens as shown in the following image.

This dialog lists all the WebFOCUS Environments defined for Developer Studio, which
may already be defined if previously installed. If not installed, only the localhost
environment exists. To edit an existing environment, select it and click Properties.
Note: The Set Development Environment button does not pertain to Managed Reporting
and is only used for a self-service deployment paradigm.

2. Click the Add button.

WebFOCUS Managed Reporting Administrator's Manual 31


Setting Up a WebFOCUS Environment

The WebFOCUS Environment Properties dialog box opens as shown in the following
image. At the top part of the dialog box is the Description text box followed by the
Environment Settings section where you will find up to six clickable objects. At the bottom
part of the dialog box are two sections, Web Component and Web Component
Authentication. In the Web Component section, you enter the IP Address (hostname),
select Protocol type, enter Port number information, and optionally supply an HTML Alias.
In the Web Component Authentication section, you enter User ID and Password
information.

Use the WebFOCUS Environment Properties dialog box to define which components
make up the environment. You can optionally enter authentication information for
components that require logon credentials.

32 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

3. At the top of the window, type a Description for the WebFOCUS environment. This
description will appear in the Developer Studio Explorer under WebFOCUS Environments.
As shown in the following image, the top area contains a series of buttons, arranged in
a diagram, each of which depicts one component in the WebFOCUS environment. The
Web Components button is selected by default. Note that the Project Development
Environment Settings are only available in the full edition of Developer Studio.

4. At the bottom of the Web Environment Properties page, specify the information needed
to access the Web server.
For some environments, after you specify the Web server, all other options are set by
default. If the WebFOCUS environment you are accessing does not use default settings
or the components require authentication, click the appropriate button in the top pane
to provide parameters. The sections that follow explain the parameters available for
each component.
Note: WebFOCUS environment properties must be supplied in a particular order. For
example, if Web server security is enabled, you cannot set the WebFOCUS Client script
name until you have provided valid Web server credentials. Similarly, you cannot retrieve
a list of WebFOCUS Reporting Servers until you have provided a valid WebFOCUS Client
Path. As you select a component button in the dialog box, Developer Studio ensures
that it has the necessary information before it displays that component's properties in
the lower part of the dialog box. If the required information is not available, you will not
be able to proceed to the next component.

Local Machine Properties


Local Machine properties are optional. You can select the Local Machine button to indicate
whether to cache files when accessing the WebFOCUS environment.

WebFOCUS Managed Reporting Administrator's Manual 33


Setting Up a WebFOCUS Environment

The following image shows the WebFOCUS Environment Caching section of the WebFOCUS
Environment Properties dialog box.

In caching, copies of files or information stored on a remote machine are temporarily stored
on your local Developer Studio machine. Developer Studio then works with the locally stored
files. Caching speeds Developer Studio performance because remote machines are not
accessed and queried every time you request information. This is especially useful when
accessing mainframes or when a network connection is slow. However, caching should not
be used when multiple developers are working with the same files because the possibility
exists that you may overwrite each others changes. By default, caching is not enabled.
Two properties are available:
Cache remote directory and file information. This option caches information about
files stored on the WebFOCUS environment. This does not actually cache files, only
information about them. If selected, Developer Studio does not re-query the WebFOCUS
Reporting Server every time it needs a list of files stored on the server.
Enable file content caching. This option caches files normally stored on the server.
Developer Studio only retrieves files once and then when you wish to read or edit them,
it uses a cached copy. Be aware that when you edit a cached file, the edited cached file
is returned to the server and replaces the actual file on the server.
Developer Studio retrieves information and files the first time you request them and then
caches them locally. Developer Studio then uses the cached copies until Developer Studio
is restarted or you click the Clear buttons for each level. You can perform a manual refresh
and clear all cache files by clicking View, then Refresh, or by pressing F5. Refresh is performed
for the area that is selected in the Explorer when you perform this action.
Note:
If you create a new synonym, you must manually perform a refresh to view the new files
in the Developer Studio Explorer when caching is enabled.
You cannot use the caching options for the local development environment if the Source
Control feature is enabled.

34 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

Web Component Properties


The Web Components button is normally selected by default. Web Component properties
specify how Developer Studio accesses the Web server. The Web server must be identified
before any other components. The following image shows the Web Component section of
the WebFOCUS Environment Properties dialog box.

The following properties are available:


Host Name/IP Address. This specifies the hostname or IP address where your Web
server is running. This field is required and will not default. For a network installation,
ensure this is the actual hostname and not localhost.
Protocol. This is the protocol to use for accessing the Web server (HTTP, HTTPS, FTP).
Port. This the TCP/IP port for accessing the Web server. Port 80 is the default for HTTP
with most servers. However with Tomcat, this is port 8080.
HTML Alias. This is the alias defined on the Web server for the environment's ibi_html
directory. If your WebFOCUS environment does not use the default ibi_html alias, specify
the custom alias defined on the remote Web server. Developer Studio must know this
alias to retrieve key information from WebFOCUS Client files such as cgipath.js and
ibiapplets.txt.
Use Default. This specifies whether to use the default ibi_html alias. Leave this checked
unless you change the HTML Alias.

WebFOCUS Managed Reporting Administrator's Manual 35


Setting Up a WebFOCUS Environment

Web Component Authentication. This specifies whether authentication is required on


the Web server. To set security, select Basic in the drop-down list and type a Web server
User ID and Password. If this is set to None, the Web server must allow anonymous
access. Additional custom security methods can be added, such as SiteMinder. For more
information, see the WebFOCUS Security and Administration manual.

WebFOCUS Client Properties


When you click the WebFOCUS Client button, Developer Studio makes a connection to your
Web server to retrieve information about the WebFOCUS environment. Therefore, you must
first specify Web Component properties and your Web server must be running. The following
image shows the WebFOCUS Client section of the WebFOCUS Environment Properties dialog
box.

Note: If the Client Path field is empty and the Use Default option is selected, there is a
problem connecting to the WebFOCUS Client. Ensure your Web server is started and that
you typed the correct properties on the Web Components page. If you cannot connect, contact
your WebFOCUS Administrator.
The following properties are available:
Client Path. This specifies how calls are made from Developer Studio to the Web server.
By default, when you add a new WebFOCUS environment, it is set to use the WebFOCUS
Servlet with the default ibi_apps context path:
/ibi_apps/WFServlet

36 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

If the WebFOCUS environment does not use servlet or uses a non-default context path,
uncheck Use Default and provide the correct Client Path. Common default settings appear
in the Client Path drop-down list. They are:
/ibi_apps/WFServlet (Servlet)
/cgi-bin/ibi_cgi/ibiweb.exe (CGI)
/cgi-bin/ibi_cgi/webapi.dll (ISAPI)
Servlet is required for Managed Reporting or Tomcat. If the Client Path is incorrect for
the environment, you receive an error when you click the Data Servers button on the top
of the page. If you do not know your path, ask your WebFOCUS Administrator or check
the WebFOCUS Administration Console of the environment to which you want to connect.
The Client Path settings for the environment are located under Utilities and Client Selection.
Select Language. This specifies the language of the WebFOCUS Client.
Supply Credentials. If required, you can check this box and type a WebFOCUS Client
User ID and Password. These credentials are only used for Project-based development
and do not apply to Managed Reporting. They are used to ensure that a developer is
authorized to perform certain activities such as deploying an application and writing to
Web server directories.
WebFOCUS Client user IDs are the same IDs used to access the WebFOCUS Administrative
Console in Developer mode. If authentication is enabled for the Console and these fields
are empty, you are prompted to log on to the WebFOCUS Client when you access the
environment. Your WebFOCUS Administrator will let you know if you must supply
WebFOCUS Client credentials.
When the correct WebFOCUS Client Path is provided, you can specify properties for the
remaining component.

Managed Reporting/ReportCaster Properties


If you plan to work with Managed Reporting (MR) and/or ReportCaster, you can optionally
select the Managed Reporting/ReportCaster button. This allows you to set logon credentials
or change the default Managed Reporting repository.
This feature is not applicable to the Power Reporter edition of Developer Studio.

WebFOCUS Managed Reporting Administrator's Manual 37


Setting Up a WebFOCUS Environment

The following image shows the Managed Reporting Repository section of the WebFOCUS
Environment Properties dialog box.

The following properties are available:


Path. This lets you specify a non-default Managed Reporting repository. For a default
Managed Reporting repository, the Path field is empty and the Use Default check box is
selected. Your WebFOCUS Administrator may instruct you to deselect the Use Default
check box and enter a path, for example:
e:\user_test\basedir01/usr/user_test/basedir01
You will not see a value in this field when Use Default is checked, because it is not
currently possible for WebFOCUS to detect the list of potential repositories on the Web
server.
Note: ReportCaster only supports the Managed Reporting Repository as defined in the
WebFOCUS Client Configuration file MR_BASE_DIR.
Supply Credentials. If required, you can check this box and type a Managed
Reporting/ReportCaster logon. Developer Studio will automatically use this logon each
time it accesses MR or ReportCaster. If this is blank, Developer Studio prompts you for
the logon when it requires access to MR or ReportCaster.
Note: If your WebFOCUS Administrator has integrated MR authentication with Web server
authentication, do not supply MR credentials here. They will be picked up from the Web
server component properties.

38 WebFOCUS
1. Introducing WebFOCUS Managed Reporting

Data Server Properties


You can set authentication and view available WebFOCUS Reporting Servers by clicking the
Data Servers button. When you select Data Servers, Developer Studio connects to the
WebFOCUS Client and retrieves a list of servers from its communication configuration file
(odin.cfg).
The following image shows the WebFOCUS Servers section of the WebFOCUS Environment
Properties dialog box.

The following property is available:


Supply Credentials. If checked, you can type a WebFOCUS Server ID and password for the
server highlighted in the list. Clicking Set stores the credentials with the environment
properties, and the ID entered is shown next to the server in the list. The credentials are
checked the next time you use a feature on that server, not when you click the Set button.

Project Development Properties


Project development is not a feature supported by Managed Reporting. For more information
about this feature, see Project Development Properties in the Introducing WebFOCUS and
Developer Studio chapter in the Developer Studio Application Development Getting Started
manual.

WebFOCUS Managed Reporting Administrator's Manual 39


Setting Up a WebFOCUS Environment

40 WebFOCUS
WebFOCUS

2 Creating Domains, Groups, Roles, and Users

You can create domains, groups, roles,


Topics:
and users with the Managed Reporting
Administration interface. Administrators Using the Managed Reporting
create domains, add them to groups, and Administration Interface
assign these groups to users and
developers. Developers can then build Creating Domains
reports in these domains for the users. Creating Groups
Administrators can also create roles to
make it easier to assign combinations Creating Users
of privileges to the users and developers.
Creating Roles
Customizing the Interface

WebFOCUS Managed Reporting Administrator's Manual 41


Using the Managed Reporting Administration Interface

Using the Managed Reporting Administration Interface


The Managed Reporting Administration interface can be accessed from the link on the
WebFOCUS Welcome page, the Developer Studio toolbar (except for the MR Developer for
Windows edition), and the toolbar in the Managed Reporting Domain Builder applet.
You can also access the interface directly from your Web browser by entering the following
URL:
http://webserver/ibi_apps/mradmin
where:
webserver
Indicates the name of the Web server that is running the Managed Reporting
Administration interface.
Depending on your site's Managed Reporting security settings, you may be prompted for
your MR credentials. The logon page is bypassed when coming from the toolbar link in
Domain Builder, and from the toolbar in Developer Studio when Developer Studio has your
valid MR credentials.
At the top of the interface, a series of tabs take you to pages where you can perform various
tasks. Each page has a list pane on the left and a detail pane on the right, as shown in the
following image.

42 WebFOCUS
2. Creating Domains, Groups, Roles, and Users

The tabs that appear, and your capabilities on each of the pages, depend on your role and
privileges:
MR Administrators have full access to each of the four tabs: Groups, Users, Roles, and
Domains.
Users with Group Administration privileges have limited access to the Groups and Users
tabs.
Developers with the Data Server privilege have limited access to the Domains tab.
Some aspects of the interface’s behavior can be customized. For more information, see
Customizing the Interface on page 62.

Creating Domains
In this section:
Working With the Server and Application Path Properties

The Domains tab is used by Managed Reporting Administrators to create, edit, and delete
domains. Developers who have the Data Server privilege can use the Domains tab to edit
the Server and Application Path properties on domains to which they have development
access. To learn how to control which domains developers have development access to,
see Assigning Development Domains on page 51.

WebFOCUS Managed Reporting Administrator's Manual 43


Creating Domains

The following image shows four domains in the list pane on the left, and the properties for
the selected domain, Sales Reporting, in the detail pane on the right.

You can change the alphabetical sort order of the domains in the list pane by clicking the
Name column.

You can create a new domain by clicking the New icon on the toolbar and entering the
name of the domain in the Name field of the detail pane. Optionally, you can define a specific
Reporting Server and/or server application path to be used for reports run from this domain.
For more information about these properties, see Working With the Server and Application
Path Properties on page 45.

You can modify a domain's properties by selecting it in the list and clicking the Edit icon
on the toolbar. You can also double-click a domain in the list to display and/or edit the
domains properties.

You can delete domains by selecting them in the list pane and clicking the Delete icon
on the toolbar. You can also press the delete key to delete selected domains. The list pane
supports multi-select functionality by holding down the Shift or Ctrl key while selecting.

44 WebFOCUS
2. Creating Domains, Groups, Roles, and Users

Note: Administrators can create, edit, and delete domains from within Developer Studio
(except for the MR Developer for Windows edition) and in the Managed Reporting Domain
Builder applet. Developers with the Data Servers privilege can edit a domain's Server and
Application Path properties from within these tools. Administrators can also create domains
with the MR Change Management load utility. For details, see Change Management on page
189.

Working With the Server and Application Path Properties

How to:
Specify the Application Path

Managed Reporting administrators and developers (if the developer has the Data Server
privilege) can edit a domain's Server and Application Path properties. By default, these
properties are initially unselected and the default Reporting Server appears in the Server
list as shown in the following image.

When the Server option is unchecked, WebFOCUS determines which server to use for report
requests and displays it in the list. Typically, the server shown is the IBI_REPORT_SERVER
value defined in the Configuration area of the WebFOCUS Administration Console in the
Reporting Server selection under Client Settings. A different server may be shown in some
customized configurations.
You can check the Server option to choose a server from the list when you have multiple
servers and want to control which server is used to run reports from this domain.

WebFOCUS Managed Reporting Administrator's Manual 45


Creating Groups

When the Application Path option is unchecked, the WebFOCUS Reporting Server determines
which application folders to search for metadata and included procedure files. The search
path is determined by a number of factors including APP PATH commands found during
server profile processing and in the report request itself. For more information about server
profile processing, see the WebFOCUS Security and Administration manual.
You can check the Application Path option to override the server's search path for reports
run from this domain. When you check this option, a request is sent to the server shown in
the Server list to retrieve the set of available applications. Depending on your security
configuration, you may be prompted for your server credentials.

Procedure: How to Specify the Application Path


1. Select the desired application(s) from the Available Applications list.
2. Click the Add icon to move the desired applications to the Selected Applications list.
Alternatively, you can double-click applications to move them to the Selected Applications
list.
You can also remove applications from the Selected Applications list by selecting the
application(s) and clicking the Remove icon.

3. To reorder items in the Selected Applications list, select an item and click the Move Up
icon or the Move Down icon.
Note: The server searches applications in top to bottom order.

4. Click Save to save the applications you specified for the Application Path.

Creating Groups
How to:
Create a Group
Add Users to a Group
Remove Users From a Group
Add or Remove Domains in a Group

The Groups tab is used by Managed Reporting Administrators to create, edit, and delete
groups. Users with Group Administration privileges have limited access to the Groups tab.
For more information, see Assigning the Group Administrator Privilege on page 50.

46 WebFOCUS
2. Creating Domains, Groups, Roles, and Users

Managed Reporting groups are used to associate users with domains. Users can not access
domain resources, including report procedures and some Report Library content, unless
they belong to groups that include those domains. An exception is users with MR
administration privileges, who always have access to all groups and domains in the system.
You can also create a customized Dashboard view for each group if you want to present
tailored presentation and content to users of these groups. For more information, see
Creating Public and Group Views on page 91.

Procedure: How to Create a Group


1. In the Managed Reporting Administration interface, click Groups.

2. Click the New icon.


3. Type a name for the Group.
4. Click Save.

Procedure: How to Add Users to a Group


1. In the Managed Reporting Administration interface, click Groups.
2. In the Existing Groups list, double-click the group to which you want to add users.
3. In the User Information field, click the Add Users tab.
4. Double-click users in the All Users list to move them to the Users to Add list.

5. When you have selected all of your users, click the Add icon.
6. Click Save.

Procedure: How to Remove Users From a Group


1. In the Managed Reporting Administration interface, click Groups.
2. In the Existing Groups list, double-click the group from which you want to remove users.
3. In the Member Information field, click the Members tab.
4. Double-click users in the This group's members box to move them to the Members to
remove from this group box.
5. Click Save.
Note: The Add and Remove buttons above the Members to remove from this group box only
add or remove users from that box, users are not added or removed from the group until
you click Save.

WebFOCUS Managed Reporting Administrator's Manual 47


Creating Users

Procedure: How to Add or Remove Domains in a Group


1. In the Managed Reporting Administration interface, click Groups.
2. In the Existing Groups list, double-click the group to which you want to add or remove
domains.
3. In the Domain Information field:
To add domains, double-click the domains in the Available Domains box to add them
to the This group's domains box.
To remove domains, double-click the domain in the This group's domains box.

4. Click Save.
Note: The Add and Remove buttons above the This group's domains box only add or remove
domains from that box, domains are not added or removed from the group until you click
Save.

Creating Users
In this section:
Searching for Users
Assigning the Group Administrator Privilege
Assigning Development Domains
Setting Up Users to Save Parameter Values
How to:
Create a User

The Users tab is used by Managed Reporting Administrators to create, edit, and delete
users. Users with Group Administration privileges have limited access to the Users tab. For
more information, see Assigning the Group Administrator Privilege on page 50.

Procedure: How to Create a User


1. In the Managed Reporting Administration interface, click Users.

2. Click the New icon.


The New User dialog box opens in the right pane.

48 WebFOCUS
2. Creating Domains, Groups, Roles, and Users

3. Enter the General Information:


User ID. Is the user ID used to sign on to this user account. This value can be a
maximum of 128 characters and cannot include spaces or double quotation marks (").
You can restrict other characters from this field. For details, see Customizing the Interface
on page 62.
You can edit the User ID value after the account is created. This is a required property.
Name. Is the description displayed for the user account in most places of Managed
Reporting and ReportCaster. If you have many users, you may consider a convention
such as Lastname, Firstname for values in this field. This will make it easier to locate
users in the lists. This is a required property.
Password/Confirm Password. You can assign a password for the user account or
leave it blank. At any time, you can reset the user's password. The user can also reset
their password themselves on the logon page. This is an optional property.
Email Address. An e-mail address is required for the Report Library, but you do not
need to include it for ReportCaster scheduling without using the Report Library.
In certain Managed Reporting security configurations, the Name, Email Address,
Password, and Confirm Password fields are disabled because WebFOCUS cannot update
password information stored in the external authentication directory. For example, when
you are configured to authenticate to LDAP/Active Directory, the Password and Confirm
Password fields are disabled because an MR Administrator cannot update your
authentication directory. Additionally, when configured for LDAP/Active Directory
authentication, RDBMS authorization, and the property USER.INFO.LOOKUP is set to
'dual', the Name and Email Address fields are also disabled because this user information
comes from your authentication directory. Your WebFOCUS Administrator controls these
settings using the WebFOCUS Administration Console. For more information, see Managed
Reporting Security Settings in the WebFOCUS Security and Administration manual.
Role. Is the Managed Reporting role. For details on roles, see User Roles Defined on
page 54.
Disable logon rights for this user. Prohibits the user from logging into Managed
Reporting.

4. Assign additional Privileges (optional).


Once you select a role, a set of privileges is automatically assigned to the user and
cannot be changed. However, you can add additional privileges as necessary. For details
on user privileges, see User Privileges Defined on page 59.

5. Select the groups for which you want the user to be a member.
To add a user to a group, double click the group in the Available Groups list to move it
to the Member of list.

WebFOCUS Managed Reporting Administrator's Manual 49


Creating Users

6. Click Save.
Note: To modify or delete a user, select user from the Users tab and click the appropriate
icon.

Searching for Users


The Managed Reporting Administration interface supports the ability to search for entries
by name or user ID. Large search result sets are broken up into a series of navigable pages
to improve performance.
In the Groups tab, you can perform pattern searches. For example, you can enter “Sa” and
it will return all of the groups that begin with those two letters. In the Users tab, you can
perform pattern searches by name or user ID.
To restore your list after performing a search, click Refresh in your browser or type an asterisk
(*) in the search text box and click the green arrow.

Assigning the Group Administrator Privilege

How to:
Assign the Group Administrator Privilege

A Managed Reporting administrator can delegate some of their administration responsibilities


to designated users. Group administration is a user privilege that enables a user to manage
one or more of the groups to which they belong. From the Managed Reporting Administration
interface, the group administrator can add or remove any user from the group(s) they
administer. However, a group administrator cannot add, remove, or change the domains
that are associated with their groups.
Group Administrators can also create users and assign them roles and privileges. However,
Group Administrators cannot:
Assign a role higher than their own role (from high to low, roles are Developer, Analytical
User, User).
Assign a privilege they do not possess.
Edit existing users if the user belongs to a group(s) that the Group Administrator does
not administer.
The Group Administrator privilege can be assigned by an administrator to any user; however,
it cannot be assigned to a role. A user can be the Group Administrator for more than one
group and there can be multiple Group Administrators for one group. Group Administrators
use the same Managed Reporting Administration interface that Administrators do, though
the features presented to them are limited.

50 WebFOCUS
2. Creating Domains, Groups, Roles, and Users

Procedure: How to Assign the Group Administrator Privilege


1. In the Managed Reporting Administration interface, click Users.

2. Select the user you want to grant the Administrator privilege to and click the Edit
icon.
3. In Group & Domain Management properties, select the Groups tab.
4. In the Member of list, select the Group to which you want the user to be the Administrator.

5. Click the Administrator icon.


An asterisk appears in the Administrator column of the Member Of list to indicate the
user is the Administrator of the group.

6. Click Save.

Assigning Development Domains


When a user is assigned the Developer role (or a role that is based on the Developer role)
the Domains tab appears in the Group & Domain Management area of the User Properties
pane.

WebFOCUS Managed Reporting Administrator's Manual 51


Creating Users

By default, the Developer in all assigned domains check box is selected. This means that
the user is a developer for all the domains for which they have access. The domains shown
in the Assigned Domains list are available in the Domain Builder interface (accessed from
the blue Managed Reporting toolbar or in Developer Studio), the Domains environment, and
from Dashboard.

If the Developer in all assigned domains check box is deselected you can specify which
domains the user can develop in. Only the domains listed in the Developer Domains list on
the right appear in the Domain Builder interface (or Developer Studio). The domains in the
Assigned Domains list on the left appear in the Domains interface and in Dashboard.

52 WebFOCUS
2. Creating Domains, Groups, Roles, and Users

Setting Up Users to Save Parameter Values

How to:
Set Up Users to Save Parameter Values

You can set up users so when they run reports they can save the parameter values they
select as a My Report. The Save Entered Values privilege enables users to save parameter
values as a My Report. The Save Entered Values privilege is not enabled by default for any
user or role. This privilege is not available for the Dashboard Public User.
The WebFOCUS Client amper auto-prompting feature inserts a Save Parameters button on
the form for users that have the Save entered values privilege. Developers can also add the
Save Parameters button to a form from the HTML Composer. For complete details, see the
WebFOCUS Managed Reporting Developer's Manual.
Note: If the report properties are changed and the Prompt for Parameters property is
deselected, the user will not see the Save Parameters button when they run the report.

Procedure: How to Set Up Users to Save Parameter Values


1. Open the Managed Reporting Administration interface.
2. For the user or role, select the Save entered values privilege.
3. Click Save to save your changes.
Note: If the user is currently logged into Managed Reporting they must log out and back
in again for the change in their privileges to take effect.

Creating Roles
In this section:
User Roles Defined
User Privileges Defined

WebFOCUS Managed Reporting supports roles, making it easier to administer large numbers
of users. A role is a collection of user privileges and each user has one role. Users inherit
the privileges that are associated with their role; in addition, they can also be assigned other
privileges as necessary. Roles are created and maintained by a Managed Reporting
Administrator. Roles can be assigned to users by MR Administrators and MR Group
Administrators.

WebFOCUS Managed Reporting Administrator's Manual 53


Creating Roles

There are several base roles (User, Analytical User, Developer, and MR Administrator) and
custom roles (Run Only User, Power User, and Content Manager) provided with Managed
Reporting. Custom roles extend base roles and provide flexibility by allowing the administrator
to add or remove certain privileges. You can create custom roles of your own as well as
customize the provided base and custom roles.
Note:
The Dashboard Role Tree and the Managed Reporting role features are not related.
Dashboard Role Tree allows an administrator to define a set of Managed Reporting reports
that can be assigned to users. One Role Tree is allowed per Managed Reporting group.
The Managed Reporting role feature allows an administrator to more easily manage
privileges assigned to users. Each user can have only one role regardless of the number
of groups to which they belong.
The base roles (User, Analytical User, Developer, and Administrator) cannot be removed
from the Managed Reporting Administration interface. You can remove any custom roles
you create, and the custom roles (Run Only User, Power User, and Content Manager)
that are included with WebFOCUS.

User Roles Defined

Reference:
User Role Matrix
Role Inheritance

Each user role has a set of default and optional privileges. The following table provides a
description of each role along with a list of associated privileges.

Role Description Privileges

Users with the User role can run Default Privileges: none
Standard Reports (in immediate and
Optional Privileges: Enable accessibility features
deferred mode) and can run shared My
(Section 508), Save entered values, Library
Reports created by other users.
The Save My Reports, Share My Reports,
Advanced, Data Server, ReportCaster
Administrator, and Schedule privileges are not
available for the User role.

54 WebFOCUS
2. Creating Domains, Groups, Roles, and Users

Role Description Privileges

The Library Only User role provides Default privileges: Library


the ability to create Dashboard users
Optional privileges: Enable accessibility features
who can only access content stored in
(Section 508)
the Report Library. This content can be
viewed in the Report Library and in a The Save My Reports, Share My Reports,
Dashboard page when displayed as a Advanced, Data Server, ReportCaster
list, launch, or output block. Library Administrator, and Schedule privileges are not
Only Users cannot run reports, view the available for the Library Only User role.
Domain Tree, view the Role Tree,
access other WebFOCUS environments,
and have limited access to Dashboard
components.

The Run Only User role is based on Default privileges: none


the Analytical User role. The Run Only
Optional privileges: Enable accessibility features
User role can do everything a user with
(Section 508), Save entered values, Library
the User role can do. In addition, this
user can access the Assistant tools The Save My Reports, Share My Reports,
and create My Reports. The Run Only Advanced, Data Server, ReportCaster
User cannot save My Reports. Administrator, and Schedule privileges are not
available for the Run Only User role.

The Analytical User role can do Default privileges: Save My Reports


everything a user with the Run Only
Optional privileges: Share My Reports,
User role can do. In addition, the user
Advanced, Enable accessibility features (Section
can save My Reports from the Assistant
508), Save entered values, Schedule, Library
tools. If granted, the user can also
share My Reports and create Custom The ReportCaster Administrator and Data Server
Reports. The user can also save privileges are not available for the Analytical
deferred output from the Deferred User role.
Status interface.

The Power User role is based on the Default privileges: Save My Reports, Share My
Analytical User role. The Power User Reports, Advanced
role is another example of how you can
Optional privileges: Enable accessibility features
customize roles. It extends the
(Section 508), Save entered values, Schedule,
Analytical User role with the Advanced
Library
and Share My Report privileges.
The Data Server and ReportCaster Administrator
privileges are not available for the Power User
role.

WebFOCUS Managed Reporting Administrator's Manual 55


Creating Roles

Role Description Privileges

The Developer role can do everything Default privileges: Save My Reports


an Analytical User can do. In addition,
Optional privileges: Share My Reports,
they have access to the Domain Builder
Advanced, Enable accessibility features (Section
where they can create Standard
508), Data Server, Save entered values,
Reports and Reporting Objects for
Schedule, Library
those domains to which they have
access. By default, users who have the The ReportCaster Administrator privilege is not
Developer role do not have access to available for the Developer role.
the Data Servers feature unless it is
granted to them explicitly or the
Developer role is changed to have Data
Server selected.

The Content Manager role is based Default privileges: Save My Reports, Share My
on the Developer role. The Content Reports, Advanced, Data Server
Manager role is an example of a
Optional privileges: Enable accessibility features
customized role. It extends the
(Section 508), Save entered values, Schedule,
Developer role with the Data Server,
Library
Advanced, and Share My Report
privileges. The ReportCaster Administrator privilege is not
available for the Content Manager role.

The MR (Managed Reporting) Default privileges: Save My Reports, Advanced,


Administrator role has unrestricted Data Server
access to Managed Reporting.
Optional privileges: Share My Reports, Save
If a user with the MR Administrator role entered values, ReportCaster Administrator,
but without the ReportCaster Schedule, Library, Enable accessibility features
Administrator privilege creates other (Section 508)
MR Administrators, the ReportCaster
Note: The Enable accessibility features (Section
Administrator privilege will not be
508) optional privilege is available beginning in
available to grant to the user.
Version 7 Release 6.5.
When the ReportCaster Administrator
privilege is assigned, the Schedule and
Report Library privileges are
automatically assigned and the
Schedule privilege cannot be
unassigned.

56 WebFOCUS
2. Creating Domains, Groups, Roles, and Users

Reference: User Role Matrix


The following table lists each user role and its corresponding default and optional privileges.
The role abbreviations below are used in the table:
LO = Library Only User
US = User
RO = Run Only User
AU = Analytical User
PU = Power User
DV = Developer
CM = Content Manager
MA = Managed Reporting Administrator

User Roles LO US RO AU PU DV CM MA

Privileges (O=Optional; D=Default; F=Fixed )

Enable accessibility (Section 508) O O O O O O O O

Advanced O D O D F

Data Server O D D

Save Entered Values (My Reports) O O O O O O O

Save Reports (My Reports) D D F F F

Share Reports (My Reports) O D O D O

Schedule (ReportCaster) O O O O O

Library (ReportCaster) F O O O O O O O

Administrator (ReportCaster) O

Note: Optional privileges are turned off initially, but can be turned on. Default privileges are
turned on initially, but can be turned off. Fixed privileges are turned on and can not be turned
off. Also, the Enable accessibility features (Section 508) optional privilege for the Managed
Reporting Administrator role is available beginning in Version 7 Release 6.5.

WebFOCUS Managed Reporting Administrator's Manual 57


Creating Roles

The following table lists the Managed Reporting functional capabilities that are provided with
the default privileges for each user role.

User Roles LO US RO AU PU DV CM MA

Functional Capabilities *

Limited dashboard component access *

Only access Report Library content *

Run other users' shared My Reports * * * * * * *

Run Standard Reports (immediate) * * * * * * *

Run Standard Reports (deferred) * * * * * * *

Access Assistant tools (see Note) * * * * * *

Advanced Graph Assistant * * *

Save My Reports from Assistant tools * * * * *

Save deferred output * * * * *

Create Standard Reports & Reporting * * *


Objects

Create Managed Reporting Users *

Manage and promote User’s My *


Reports to Standard Reports

Note: Assistant tools refers to the HTML Report Assistant, HTML Graph Assistant, and
Power Painter tools. The Power Painter license code must be specified in the WebFOCUS
Client configuration to make Power Painter accessible to users.

Reference: Role Inheritance


Inheritance between the base role and any new roles you create only occurs at the time you
create the role. If the base role is modified, changes will not be reflected in any roles you
created based on this role.

58 WebFOCUS
2. Creating Domains, Groups, Roles, and Users

For example, you want to create a new role based on the Analytical User role. The Analytical
User role is a base role that is included with WebFOCUS Managed Reporting and has the
Save My Reports privilege by default. When you create your new role, named NewRole, it
inherits the Save My Reports privilege from the Analytical User base role. You can then
customize the NewRole and add any available privileges.
If the Analytical User base role is modified after you create your NewRole, this does not
effect your NewRole since inheritance between roles only occurs at the time you create the
role.

User Privileges Defined

How to:
Create a New Role
Customize an Existing Role

Privileges effect Managed Reporting and ReportCaster user interface behavior. Generally
speaking, having a privilege means you can use the corresponding product feature. One
exception is the 'inactive' privilege, which means you are denied logon rights to Managed
Reporting. Privileges are associated with Roles. An MR Administrator or Group Administrator
can also assign privileges to users directly, though there are some limitations.
Note: When ReportCaster is not installed, the ReportCaster Schedule, Library, and
Administrator privileges are not available.
The following is a table that lists the privileges and a description of each privilege.

Privilege Description

General

Enable accessibility Specifies that a user can utilize Section 508 compliant online
features (Section 508) help, user interfaces, and tools.

WebFOCUS Managed Reporting Administrator's Manual 59


Creating Roles

Privilege Description

Advanced Only users who are assigned the Advanced privilege, regardless
of their role, are enabled to:
Create and edit Custom Reports, which appear in their own
folder under the My Reports tab in the Domains environment.
Unlike other My Reports, Custom Reports are not built from
Reporting Objects. Users build these reports with tools
including the text editor, Power Painter, Report Assistant,
and Graph Assistant. Note that only users who are assigned
the Advanced privilege can create Custom Reports.
View all data sources in the domain path when creating
dynamic parameters using the Variable Editor. Without the
Advanced privilege, users can only view data sources used
in the Reporting Objects.

Data Server Specifies whether a user can access the Domain Builder Data
Servers component. Also controls whether or not the server and
application path properties on a domain, report, or Reporting
Object can be modified by the user.

My Reports

Save Entered Values Enables users to save their selected parameter values as a My
Report. When a user runs the My Report, a launch page opens
with their parameter values already selected and they can then
run the report.

Save Reports Enables the user to create and save My Reports. The Advanced
privilege is also needed to create My Reports that are Custom
Reports.

Share Reports Is required for a user to share a My Report or Custom Report


with other users who have access to the same domain. Once a
user shares a My Report or a Custom Report, other users can
run the report and copy the report into their own My Reports tab
if they have the Save My Reports privilege. The Share My Reports
privilege does not have to be active for a user to run or copy
reports that have been shared by others.

60 WebFOCUS
2. Creating Domains, Groups, Roles, and Users

Privilege Description

ReportCaster

Administrator Designates the user as a ReportCaster Administrator.

Schedule Allows a user to schedule procedures using ReportCaster. This


capability is available only when ReportCaster is installed.

Library Allows a user to access the Report Library, which is a


ReportCaster storage and retrieval facility. This capability is
available only when ReportCaster is installed and configured
with the RDBMS repository option.

Procedure: How to Create a New Role


1. In the Managed Reporting Administration interface, click Roles.

2. Click the New icon.


The New Role dialog box opens in the right pane.

3. Type the Role Name.


4. Select the Base Role.
This is the role for which the new role is based. For details on what privileges come with
each role, see User Roles Defined on page 54.

5. Select the Privileges. For details on privileges, see User Privileges Defined on page 59.
6. Click Save.

Procedure: How to Customize an Existing Role


1. In the Managed Reporting Administration interface, click Roles.

2. Click the Edit icon.


The Selected Role - rolename dialog box opens in the right pane.

3. Make any necessary modifications and click Save.

WebFOCUS Managed Reporting Administrator's Manual 61


Customizing the Interface

Customizing the Interface


You can customize some of the behavior of the MR Administration interface by editing its
configuration file, WebFOCUS76\config\mradmin-config.xml. You can:
Alter the default session time-out of 30 minutes by editing the value of the sessionTimeout
property.
Choose to not automatically load the user list when you click on the Users tab by setting
the autoLoadUserList property to false.
Change the number of users retrieved per page from the default of 100 by changing the
value of the maxNumberOfUsersToShow property. Note that performance degrades
significantly above 200 items per page because of Java Script processing overhead.
Restrict specific characters from being entered in the User ID field when creating a new
user or editing an existing user. You can do this by editing the charFilter parameter.
Do not make other changes to this file unless instructed to do so by Customer Support.
Changes to this file are recognized each time you click one of the three tabs in the interface.

62 WebFOCUS
WebFOCUS

3 User Management

The User Management tree object in


Topics:
Domain Builder enables Managed
Reporting Administrators to view user's User Management Tree Object in
reports. All types of reports are Domain Builder
displayed, including My Reports, Custom
Reports, saved deferred output, and Managing a User's Reports
distributed ReportCaster output. Promoting a Custom Report to a
Managed Reporting Administrators can Standard Report
open, edit, run, save, and delete
Managed Reporting user's reports. Saved
and distributed output can be deleted or
have its properties changed. Both active
and inactive users are displayed and
each user displays regardless of whether
they have created any reports.

WebFOCUS Managed Reporting Administrator's Manual 63


User Management Tree Object in Domain Builder

User Management Tree Object in Domain Builder


Whenever a Managed Reporting Administrator logs into Managed Reporting, the Domain
Builder interface includes a User Management tree object. The User Management feature
enables the Managed Reporting Administrator to access each user's reports. Each user
displays regardless of whether they have created any reports. A folder is listed under each
user, and contains the domains to which the user has access.
The User Management feature displays only for Managed Reporting Administrators. It does
not display for Managed Reporting Developers.
When you open a folder, all types of user reports display, including My Reports, Custom
Reports, saved deferred output, and distributed ReportCaster output. Opening a user's
domain shows either their report folders, which can be opened or a message that no user
reports were found.
The following image shows four reports under Adam Abernathy's User's Reports folder.

64 WebFOCUS
3. User Management

The Managed Reporting Administrator can access reports made by inactive users. This is
so they can easily delete or review these reports.
The Administrator can also access Custom Reports in a User's Reports folder if the user
has advanced privileges. The available options are the same as for My Reports. These
options, shown in the following image for weekly_sales in the Custom Reports folder, are
Open, Edit Source, Run, Run Deferred, Delete, and Properties.

WebFOCUS Managed Reporting Administrator's Manual 65


Managing a User's Reports

Managing a User's Reports


From the User Management tree shown in the following image, Managed Reporting
Administrators can perform the following tasks:

Open the report. It displays in Power Painter, Report Assistant, or Graph Assistant just
as it does for the user. From there, you can make changes and then either Save to the
same file, or Save As a new file name (recommended because this leaves the original
report untouched, which the user can view for comparison).
Edit the source code for the report directly with the Java Editor. Do not alter the internal
Dialogue Manager code in the procedure or the report may not run.
Run the report.
Run the report deferred.
Delete the report. A confirmation displays before the file is removed.
View and change properties. For example, a report can be unshared.
Access deferred output using the Deferred Status option on the browser toolbar. If a
report is Run Deferred, it is run using the Managed Reporting Administrator's user ID.

66 WebFOCUS
3. User Management

Access users' Saved Parameter reports. You can edit saved parameter values that are
selected by default when the auto prompt form launches or you can edit the -DEFAULT
values for the procedure using the text editor. Note that the Edit Parameters option is
not available for auto prompt reports saved with parameter values.
Note: A report runs with the WebFOCUS Server ID of the Managed Reporting Administrator,
not the user, which may produce different report results.
For finished output such as saved deferred output and distributed ReportCaster output, the
options are different as shown below. The following image shows the Deferred Reports
Output folder open with a highlighted deferred report item displaying a pop-up menu with
two options: Delete and Properties.

The finished output cannot be opened, run, run deferred, or edited because it may contain
secured data that is only visible to the user who ran the report initially. However, it can be
deleted and its properties can be changed.

WebFOCUS Managed Reporting Administrator's Manual 67


Promoting a Custom Report to a Standard Report

Folder options include Close and Delete. The following image shows a pop-up menu for a
subfolder of the Acme Manufacturing domain that contains two options: Close and Delete.

If delete is selected, a confirmation displays before deleting all the user's reports in this
folder.
When you are logged in to Domain Builder as a Managed Reporting Administrator, you view
a snapshot of information available in User Management. However, Managed Reporting is
a dynamic system. Users, domains, and reports are constantly being added, deleted, or
changed. In order to view the most recent status, you can use the refresh options below:
Reload User Management. Refreshes the list of users.
Reload User. Refreshes the list of domains to which the user has access.
Reload Domain. Refreshes the list of reports this user has created for this domain.

Promoting a Custom Report to a Standard Report


You can promote a Custom Report to a Standard Report.
To accomplish this, a Managed Reporting administrator can copy and paste the Custom
Report from the Custom Reports folder in User Management to the Standard Reports folder.
When the Custom Report is moved into the Standard Reports folder, the properties of the
new Standard Report are the same as the Custom Report with the exception of the Share
property (since this is only available for My Reports). You can change the properties after
you move the report to the Standard Reports folder.
The report can only be moved within the same domain, not across domains.

68 WebFOCUS
WebFOCUS

4 Managing Dashboard

The following views are available within


Topics:
the WebFOCUS Business Intelligence
Dashboard: Managing Public Views
The general public view. Managing Group Views
Custom public views. Managing Library Only Views
Group views. Managing Private Views
Library Only views. Logging On to Dashboard and View
Inheritance
Private views.
Each view has different rights and Managing Users
different levels of security. Controlling the Idle Limit for
The Administrator controls the user's Authenticated and Public Users
access in the general public view, the Handling Messages
custom public view, group views, and
Library Only views. This includes the Hiding Report Types in the Domain
domains the users can view and certain Tree
functionality such as the Domain Search.
Hiding the Share Report Option for
The Administrator also controls the look Finished My Reports
of the Dashboard for all views.
Displaying Optional Properties in
Dashboard
Creating Standard Reports in
Dashboard

WebFOCUS Managed Reporting Administrator's Manual 69


Managing Public Views

Managing Public Views


In this section:
Managing Library Access in a Public View

Public views allow you to publish information on the Web and allow users to view reports
and other information without having to log in. There are two types of public views:
General public view. Contains any type of information and is intended for a wide variety
of audiences.
Custom public view. Provides detailed information targeted for specific groups of users.
Access to a custom public view is the same as the general public view, with the default
user ID and password as the authentication information. Therefore, the public user can
view reports and data that are available in the general public view and custom public
views.
Custom and public views can be made secure through the addition of Web server security.
To increase security on public views so that each public page has access only to the intended
information, you can restrict the public pages on the HTML files that display the view. For
details, see Creating Public and Group Views on page 91.
In addition, since the information in each public view (general or custom) may not be relevant
to every public user who connects to Dashboard, you may want to prohibit certain
functionalities by excluding the display of available domains from the general and custom
public views. In other words, you control the information a public user can view. To manage
access so that users only see relevant information:
Allow access to only those domains with public information.
Eliminate the display of the Domain Tree and Role Tree in the Dashboard.
Eliminate the domain search.
Restrict the ability to run reports. If there is a high volume of traffic to a public view
(general or custom), decrease the load on the Web server and the WebFOCUS Reporting
Server by restricting users from running reports that directly access data. This is useful
if a public view contains launch blocks in which the report runs automatically when the
public user opens the Dashboard.
To prevent public users from running reports, you can select only pre-built reports from
the Report Library for the Role Tree, List blocks, and Launch blocks. To allow public users
to view updated reports without having to run them, use ReportCaster to generate report
output and send the output to the Report Library. The content for public pages can be
created using reports archived in the Report Library. For more information, see the
ReportCaster Development and Administration manual.

70 WebFOCUS
4. Managing Dashboard

Managing Library Access in a Public View


Dashboard public pages include static content retrieved from the Report Library repository.
This eliminates the need for the public page to execute a report each time the page is viewed.
This functionality is implemented by increasing the capabilities of the public user from within
Dashboard.
If a Managed Reporting user, designated as a public user, has Library privileges, the
Dashboard allows those privileges to be surfaced in a public view and also when a developer
is building content pages for the public user.
A user who is designated as a public user must have Library privileges to view output. Library
content is displayed on the public page only if the content is available to the public user.
Dashboard works within the constraints applied to user access of reports and does not
override any access limitations imposed by the Report Library.
The available Library content includes the Library tab as a content page and Library content
added to a Launch, Output or List block.

Managing Group Views


Group views allow you to create a secure Dashboard view for the members of an Managed
Reporting repository group. Only members of the group can see the view. The user must
enter a valid Managed Reporting user ID and password to access the group view.
In each view, the Administrator selects a banner, the colors, composition, and content. Since
the Administrator selects the content of the group view, the user can only access certain
applications or reports.
Users will not be able to personalize a group view. This means the users cannot customize
the look or the content.
When a user logs into Dashboard, they can see the views that have been created for each
group, including a link to "My View.” They can also personalize their own Dashboard view
(not the group view).
A group member who has the Library Only User role can not access the Group View. A Library
Only Group View is available to these users.

Managing Library Only Views


The Library Only User role provides the ability to create Dashboard users who can only access
content stored in the Report Library. This content can be viewed in the Report Library and
in a Dashboard page when displayed as a list, launch, or output block. Library Only Users
cannot run reports, view the Domain Tree, view the Role Tree, access other WebFOCUS
environments, and have limited access to Dashboard components. This role is assigned in
the Managed Reporting interface. Note that the Library Only User role cannot be deleted.

WebFOCUS Managed Reporting Administrator's Manual 71


Managing Private Views

Managing Private Views


Private views are each user's personalized view of Dashboard. A user can personalize the
Dashboard by placing reports from the available domains in the Content area of the
Dashboard. Users cannot customize the look of the Dashboard.
A private view is created for users when they connect to the Dashboard with their own
Managed Reporting user ID and password. The private view is based on the general public
view or custom public view from where the user logs in. From here, the user can begin to
personalize the content in the private view.
Private views are secure in that a user must enter a valid Managed Reporting user ID and
password. Each user can only access domains that the Administrator makes available in
the Managed Reporting Administration interface.
Private views are not available to Library Only Users.

Logging On to Dashboard and View Inheritance


In this section:
Logon Process for All Users (Excluding Library Only Users)
Logon Process for Library Only Users

Dashboard users log on to Dashboard and inherit the look and content of views in different
ways depending on where they log on from, whether they are logging on for the first time or
subsequent times, and whether the GoToPersonalViewOnLogin setting in the bid-config.xml
file, located in the WebFOCUS76\worp\conf directory, is set to "true" or "false".
Users can log on to Dashboard using the:
Business Intelligence Dashboard Login link on the Welcome Page
Business Intelligence Dashboard Public Views link on the Welcome Page
Group view URL

72 WebFOCUS
4. Managing Dashboard

Logon Process for All Users (Excluding Library Only Users)


The following processing takes place when a user, who is not a Library Only User, logs on
to Dashboard.
First Time Logon to Dashboard (GoToPersonalViewOnLogin=true)
Users who:
Log on from the Business Intelligence Dashboard Login page, log on to their own
personal view and inherit the look and content of the General Public view.
Log on from a public view, log on to their own personal view and inherit the look and
content of the public view from which they logged on.
Log on by accessing a group view URL directly, log on to that group view and inherit
the look and content of that group view as their own personal view.
For all methods of logging on to Dashboard for the first time, the inherited view is copied
to the user's folder created in the worp_users directory upon logon. Additionally, users
who click the Views link have access to all of the group views accessible to them.
Subsequent Logons to Dashboard (GoToPersonalViewOnLogin=true)
Users with access to any number of, or no, group views are logged on to their own personal
view.
First Time Logon to Dashboard (GoToPersonalViewOnLogin=false)
Users with:
Access to no group views, log on from the Business Intelligence Dashboard Login
page into their own personal view and inherit the look and content of the General
Public View.
Access to one group view, log on to that group view and inherit the look and content
of that group view as their own personal view.

WebFOCUS Managed Reporting Administrator's Manual 73


Logging On to Dashboard and View Inheritance

Access to multiple group views, log on to a page displaying all of the group views
accessible to them including a link to their My View. Clicking a group view from this
page logs users on to the selected group view, and their own personal view inherits
the look and content of that group view. Clicking the My View link logs users on to
their own personal view which inherits the look and content of the General Public
View.
Note: For users with access to multiple group views who log on from a public view,
clicking the My View link logs users on to their own personal view which inherits the
look and content of that public view.
For all methods of logging on to Dashboard for the first time, the inherited view is copied
to the user's folder created in the worp_users directory upon logon.
Subsequent Logons to Dashboard (GoToPersonalViewOnLogin=false)
Users with:
No group views, log on to their own personal view.
One group view, log on to that group view.
Multiple group views, log on to a page displaying all of the group views accessible to
them.

Logon Process for Library Only Users


The following scenario shows the processing that takes place when a Library Only User logs
on to Dashboard. The behavior is the same for all logon attempts including the first logon,
subsequent logons, and whether the GoToPersonalViewOnLogin setting in the bid-config.xml
file is set to "true" or "false".
Users with:
No Library Only Views, are presented with the message, "No Library Only Group Views
available for this user."
One Library Only View, log on to this view.
Multiple Library Only Views, log on to a page displaying all of the views accessible to
them.
For all of the above methods of logging on to Dashboard for Library Only Users, a user's
folder is not created in the worp_users directory.

74 WebFOCUS
4. Managing Dashboard

Managing Users
In this section:
Setting an ID and Password for the Public User
Setting a Server User ID and Password for the Public User
How to:
Edit User Content
Reassign a User's View
Remove Users From Dashboard

You can manage user's views (public, group, and personal) from the View Builder. The
Manage Users option allows you to view and update the content of the user's personal
pages and the look of their Dashboard view.
Changing, or reassigning, a user's view and content is useful when you want to update the
look or the content of a view without having to start over from scratch. It's also useful if a
user changes groups and you need to update their view and/or content for example, from
the Human Resources group page to the Accounting group page.

The Manage Users window provides the following information:


User Name, User Description, and User Folder for users who have logged into Dashboard.
The View Folder, View Type, and View Description of the look the user currently has
assigned to them.

WebFOCUS Managed Reporting Administrator's Manual 75


Managing Users

Procedure: How to Edit User Content


1. From the View Builder, click Manage Users.
2. Select the user you want to edit content for and click Edit Content.
The Content Window opens.

3. Edit content as necessary.


4. Click Manage Users to save changes and return to the Manage Users window.
Note: You can only edit content for one view at a time.

Procedure: How to Reassign a User's View


1. From the View Builder, click Manage Users.
2. Select the user or users you want to reassign.
3. Click Reassign.
4. Select the new view look from the drop-down list.
5. If you want to replace the user's content with the content from the new view, click the
Replace User Content with View Content check box.
When you replace content, the user still has access to all of the domains (and the items
in those domains) they are assigned to. Only Dashboard specific items are replaced,
such as content pages and content blocks. The user's Favorites and Recent lists are
cleared when you select the Replace User Content with View Content check box.

6. Click Submit.

Procedure: How to Remove Users From Dashboard


Note: This only removes the user from Dashboard, not Managed Reporting. If a user is
logged in to Dashboard when you remove the user from Dashboard using the View Builder
Manage Users page, a HTTP 500 error is displayed in the browser window. If the user logs
in to Dashboard again, they will be added to the Manage Users list again.
1. From the View Builder, click Manage Users.
2. Select the user or users you want to remove.
3. Click Remove.
4. Click OK to the confirmation pop-up dialog box.

76 WebFOCUS
4. Managing Dashboard

Setting an ID and Password for the Public User

How to:
Set the Public User ID and Password

If you choose to restrict a public user's access to WebFOCUS Managed Reporting by setting
a password when the public user is created, that password must also be stored in Dashboard
to allow the user to view the public pages without entering a password. Setting the password
is optional. However, if the password is set in WebFOCUS Managed Reporting, it must also
be set in Dashboard to the same value.
Dashboard administrators can select a specific Managed Reporting user ID and password
other than Public that is used to access Dashboard Public views.
When a Public view opens in a browser, Dashboard logs into Managed Reporting with a
default user ID and password that you can set in the View Builder. The public user ID and
password are stored in the file:
ibi\webfocus\worp\conf\worp_mre.mpd
If a user attempts to login from the Dashboard login page with the Managed Reporting user
ID that has been designated as the public user in Dashboard, a message (19102) appears.
Anytime public user credentials are changed outside of Dashboard's scope, the changes
must be propagated to Dashboard using the View Builder. This includes changes to the user
ID or password used to connect the public user to Managed Reporting or the WebFOCUS
Reporting Server. If the changes are not reflected in the View Builder, the public user will
not use the updated credentials when connecting to Dashboard.
Note that Dashboard issues public sign-on requests when a public page is opened if any or
all of the following conditions are met:
The Public user is not signed on.
The /worp/conf/worp_mre.mpd was changed due to a user ID or password change in
the View Builder.
The /worp/conf/worp_eda.epd was changed due to user ID or password change in the
View Builder.

WebFOCUS Managed Reporting Administrator's Manual 77


Managing Users

Note:
You can only designate one public user per Dashboard installation.
When setting the Public user in the View Builder to a Managed Reporting user ID other
than Public, the public user ID should not be set to the administrator ID used to administer
Dashboard.
When the password for the public user is changed in the Managed Reporting Administration
interface, the password also needs to be set in the View Builder Public User window so
that Dashboard can connect the public user to the Managed Reporting repository.

Procedure: How to Set the Public User ID and Password


1. From the Public Views window in the Dashboard ViewBuilder, click Public User.

2. Type the user ID and password, and confirm the password in the designated text boxes.
3. Click Save.
Note: The user ID and password are stored in encrypted format in the worp_mre.mpd file
in the directory WebFOCUS76/worp/conf.

78 WebFOCUS
4. Managing Dashboard

Setting a Server User ID and Password for the Public User

How to:
Set the Public User ID and Password for the Server

In the View Builder, you can set a user ID and password for the public user to connect to
the default WebFOCUS Reporting Server without having to enter login information. Setting
a user ID and password is optional. However, to allow public access to the default WebFOCUS
Reporting Server through Dashboard without requiring a login window, a value must be set
here. For details on setting the WebFOCUS server user ID and password in the server profile
files, see the WebFOCUS Security and Administration manual.
The user ID and password entered here will be used for connecting to the default WebFOCUS
Reporting Server. To set a different user ID and password to connect to alternate servers,
the user ID and password must be set in the server profile. For details, see the WebFOCUS
Security and Administration manual.
Note:
The View Builder does not attempt to match the user ID and password with a valid user
ID and password for the WebFOCUS Reporting Server. This option is available to give you
a way to set the value for the Dashboard public user without setting it for all WebFOCUS
connections to the server.
If you are using a configuration with WebFOCUS Server security enabled, the Public view
is only accessible if a user ID and password are set in the View Builder. If an incorrect
user ID or password is supplied in the Server window of the View Builder, message 19101
will appear when a users attempts to access a Public view.

WebFOCUS Managed Reporting Administrator's Manual 79


Managing Users

The following image shows the WebFOCUS Server Connection window containing text boxes
for User ID, Password, and Confirm Password.

Procedure: How to Set the Public User ID and Password for the Server
1. From the View Builder, click Server.
2. Enter the user ID in the Enter User ID input box.
3. Enter the password in the Enter Password input box.
4. Enter the password again in the Confirm Password input box.
5. Click Save and a message appears indicating the user ID and password have been
successfully saved.
The user ID and password are stored in encrypted format in the worp_eda.epd file in
the directory WebFOCUS76/worp/conf.

80 WebFOCUS
4. Managing Dashboard

Controlling the Idle Limit for Authenticated and Public Users


How to:
Set the Idle Limit for Authenticated Users Using ServletExec
Set the Idle Limit for Authenticated Users Manually
Set the Idle Limit for Public Users Using ServletExec
Set the Idle Limit for Public Users Manually

You can define the number of minutes that a user's Dashboard session can be inactive
before an automatic logout occurs. The public user and the authenticated user can be
separately configured to automatically disconnect after a number of minutes, or to stay
logged in no matter how long idle. By default, the public user's connection to the Dashboard
times out after 30 minutes and the authenticated user never times out.
You can edit the idle limit directly in the web.xml file or you can use Servlet Exec.
Note:
If a user has the Report Assistant or Graph Assistant open, the idle limit is not imposed.
If the User_max_inactive and the Public_max_inactive parameters are not set for
Dashboard in the web.xml, then the Application Server session time out setting is used
in the Dashboard environment.

Procedure: How to Set the Idle Limit for Authenticated Users Using ServletExec
1. Open the ServletExec Administration tool.
2. Under Web Applications, click Manage.
3. Under WebFOCUS76 Application Name, click web.xml.
4. Under Servlets, click Manage.
5. Under Servlet Name, click WORP_Loader.
6. Under Initialization Parameters, edit the following:
name: USER_MAX_INACTIVE
value: Enter -1 (the default value) if you do not want the server to ever time out.
Otherwise, enter the number of minutes before time out occurs.
Descriptions are optional.

7. Click Submit.

WebFOCUS Managed Reporting Administrator's Manual 81


Controlling the Idle Limit for Authenticated and Public Users

8. From the Configure Web Applications window, click Reload for the WebFOCUS76
application.

Procedure: How to Set the Idle Limit for Authenticated Users Manually
1. From the WEB-INF directory, open the web.xml file.
2. Edit the param-value as desired.
<init-param>
<param-name>USER_MAX_INACTIVE</param-name>
<param-value>-1</param-value>
</init-param>
Enter -1 (the default setting) if you do not want the server to ever time out. Otherwise
enter the number of minutes before time out occurs.

3. Save and close the file.

Procedure: How to Set the Idle Limit for Public Users Using ServletExec
1. Open the ServletExec Administration tool.
2. Under Web Applications, click Manage.
3. Under WebFOCUS76 Application Name, click web.xml.
4. Under Servlets, click Manage.
5. Under Servlet Name, click WORP_Loader.
6. Under Initialization Parameters, edit the following:
name: PUBLIC_MAX_INACTIVE
value: The default setting is 30 minutes. You can change this value to any number
of minutes you want. Enter a value of -1 if you never want time out to occur.
Descriptions are optional.

7. Click Submit.
8. From the Configure Web Applications window, click Reload for the WebFOCUS76
application.

Procedure: How to Set the Idle Limit for Public Users Manually
1. From the WEB-INF directory, open the web.xml file.

82 WebFOCUS
4. Managing Dashboard

2. Edit the param-value as desired.


<init-param>
<param-name>PUBLIC_MAX_INACTIVE</param-name>
<param-value>30</param-value>
</init-param>
The default setting is 30 minutes. You can change this value to any number of minutes
you want. Enter a value of -1 if you never want time out to occur.

3. Save and close the file.

Handling Messages
A standard message appears for all HTTP 500 series errors, which reads:
"A HTTP 500 error has been returned when attempting to communicate with the WebFOCUS
web components. The application server log contains information on why this error has
occurred. Contact your WebFOCUS Administrator or Information Builders Customer Support
Services for further assistance."
All other HTTP errors are handled by the Web server.
By default, all Dashboard specific error messages are generated by WORP_Error.jsp. You
can implement your own error page by editing the "ERROR" entity in the
WebFOCUS76\worp\conf\bid-config.xml file:
<!ENTITY ERROR "&JSP;/WORP_Error.jsp">
All messages that display on the user's screen are written to the Web Application server log
file. The location of the Web Application server log file is different for different Web Application
servers. Check your Web Application server documentation for the location of the log file.

Hiding Report Types in the Domain Tree


In this section:
Hiding Report Types in the Domain Tree for All Role Types
How to:
Hide Report Types in the Domain Tree in All Views

You can customize the Domain Tree to display or hide any or all of the available report and
file types (Standard Reports, Shared Reports, My Reports, Reporting Objects, and Other
Files) for specific role types in all views. If you do not want to hide report and file types for
all users of an existing role type, you can create a new role for specific users. Note that if
you choose to hide My Reports from displaying in the Domain Tree, users will not have the
option to save parameter reports since parameter reports are a type of My Report.

WebFOCUS Managed Reporting Administrator's Manual 83


Hiding Report Types in the Domain Tree

Note: You can also hide report and file types in the Domain Tree of specific views using the
Edit Settings functionality available in the Dashboard View Builder. For more information,
see Customizing Dashboard Pages for a Public or Group View on page 99.

Procedure: How to Hide Report Types in the Domain Tree in All Views
1. In the WebFOCUS76\worp\conf directory, open the bid-config.xml file in a text editor.
2. Find the following lines to hide Standard Reports, Shared Reports, Reporting Objects,
My Reports, and Other Files:
<internal-var name="hideStandardReportsFromTheseRoles" value=""/>
<internal-var name="hideSharedReportsFromTheseRoles" value=""/>
<internal-var name="hideReportingObjectsFromTheseRoles" value=""/>
<internal-var name="hideMyReportsFromTheseRoles" value=""/>
<internal-var name="hideOtherFilesFromTheseRoles" value=""/>

3. To hide report types in the Domain Tree, add one or more role types to the value variable.
For example, to show only Standard Reports for any user ID set to the "#User" role type,
enter the following:
<internal-var name="hideSharedReportsFromTheseRoles" value="#User"/>
<internal-var name="hideReportingObjectsFromTheseRoles" value="#User"/>
<internal-var name="hideMyReportsFromTheseRoles" value="#User"/>
<internal-var name="hideOtherFilesFromTheseRoles" value="#User"/>
Note:
If the value is set to a role HREF, any user ID that has that role will not see the
specified report or file type in Dashboard. You can determine the HREF for a role by
looking at the basedir/role.htm file. To specify more than one role, separate the role
HREFs by a coma and no spaces.
Default role types include: #User, #RunOnlyUser, #LibraryOnlyUser, #AnalyticalUser,
#Developer, #ContentManager, #MRAdministrator, and #PowerUser. For more
information on user types see User Roles Defined on page 54.
Because Other Files are hidden by default from all user roles except the Developer
role, the MR Administrator role, and any custom role based on either of these two
roles, you can effectively hide Other Files from only the previously mentioned roles.

84 WebFOCUS
4. Managing Dashboard

4. Save and close the file.


After making changes to the bid-config.xml file, use the WebFOCUS Console to clear memory
cache. Until this is done, the change is not effective.

Hiding Report Types in the Domain Tree for All Role Types

How to:
Hide Report Types in the Domain Tree for All Role Types

In Dashboard, you can customize the Domain Tree to display or hide any or all of the available
report and file types (Standard Reports, Shared Reports, My Reports, Reporting Objects,
and Other Files) for all users of all role types by using the “ALL-ROLES” value in the existing
bid-config.xml file, as shown in the following procedure.

Procedure: How to Hide Report Types in the Domain Tree for All Role Types
1. In the WebFOCUS76\worp\conf directory, open the bid-config.xml file in a text editor.
2. Find the following lines to hide Standard Reports, Shared Reports, Reporting Objects,
My Reports, and Other Files, and substitute “ALL-ROLES” for the value variable for the
report or file types you want to hide:
<internal-var name="hideStandardReportsFromTheseRoles" value=""/>
<internal-var name="hideSharedReportsFromTheseRoles" value=""/>
<internal-var name="hideReportingObjectsFromTheseRoles" value=""/>
<internal-var name="hideMyReportsFromTheseRoles" value=""/>
<internal-var name="hideOtherFilesFromTheseRoles" value=""/>
For example, to hide My Reports for all users of all role types, use the following:
<internal-var name="hideMyReportsFromTheseRoles" value="ALL-ROLES"/>

3. Save and close the file.


After making changes to the bid-config.xml file, use the WebFOCUS Console to clear memory
cache. Until this is done, the change is not effective.

WebFOCUS Managed Reporting Administrator's Manual 85


Hiding the Share Report Option for Finished My Reports

Hiding the Share Report Option for Finished My Reports


How to:
Hide the Share Report Option for Finished My Reports in All Views
Hide the Share Report Option for Finished My Reports in Specific Views

You can hide the Share Report option that is displayed by default in the properties of finished
Deferred Reports Output and OLAP Reports saved in the My Reports directory. Hiding the
Share Report option provides another layer of security to safeguard sensitive content in
these types of finished reports. This functionality can be set globally in all views by editing
a variable setting in the bid-config.xml file or set in specific views using the Dashboard View
Builder.

Procedure: How to Hide the Share Report Option for Finished My Reports in All Views
1. In the WebFOCUS76\worp\conf directory, open the bid-config.xml file in a text editor.
2. To hide the Share Report option for Deferred Reports Output, edit the following variable
to change it from:
<internal-var name="showPropertiesShareOptionForDeferredReportsOutput"
value="true"/>
to
<internal-var name="showPropertiesShareOptionForDeferredReportsOutput"
value="false"/>

3. To hide the Share Report option for OLAP Reports, edit the following variable to change
it from:
<internal-var name="showPropertiesShareOptionForOLAPReports"
value="true"/>
to
<internal-var name="showPropertiesShareOptionForOLAPReports"
value="false"/>

Note: After making changes to the bid-config.xml file, use the WebFOCUS Console to clear
memory cache, or restart the application. Until this is done, the change is not effective.

86 WebFOCUS
4. Managing Dashboard

Procedure: How to Hide the Share Report Option for Finished My Reports in Specific Views
1. Log on to the Dashboard View Builder.
2. Select a view.
3. Click Edit Settings.
4. To hide the Share Report option for Deferred Reports Output, click the False option to
the right of showPropertiesShareOptionForDeferredReportsOutput in the Settings pane.
5. To hide the Share Report option for OLAP Reports, click the False option to the right of
showPropertiesShareOptionForOLAPReports in the Settings pane.
6. Click Save Settings.
7. Click Close.
For more information about using the Edit Settings functionality in the Dashboard View
Builder, see Customizing Dashboard Pages for a Public or Group View on page 99.

Displaying Optional Properties in Dashboard


How to:
Display Optional Dashboard Properties

The Dashboard Properties dialog displays the optional Created By and Last Modified By
properties based on a variable setting in the bid-config.xml file.

Procedure: How to Display Optional Dashboard Properties


To display the optional Created By and Last Modified By properties in the Dashboard
Properties dialog:
1. In the WebFOCUS76\worp\conf directory, open the bid-config.xml file in a text editor.
2. Edit the following variable to change it from:
<internal-var name="showItemPropertyCreatorModifier" value="false"/>
to
<internal-var name="showItemPropertyCreatorModifier" value="true"/>

Note: After making changes to the bid-config.xml file, use the WebFOCUS Console to clear
memory cache, or restart the application. Until this is done, the change is not effective.

WebFOCUS Managed Reporting Administrator's Manual 87


Creating Standard Reports in Dashboard

Creating Standard Reports in Dashboard


How to:
Enable the Creation of Standard Reports in All Views
Enable the Creation of Standard Reports in Specific Views

You can enable administrators and developers to create Standard Reports in Dashboard
with any of the available reporting tools. Additionally, they can create new folders under
Standard Reports and set properties at the Standard Report level. However, new domains
can only be created in the Managed Reporting Administration interface. The creation of
Standard Reports by administrators and developers can be enabled for all views by editing
a variable setting in the bid-config.xml file or enabled for specific views using the Dashboard
View Builder.

Procedure: How to Enable the Creation of Standard Reports in All Views


To enable administrators and developers to create Standard Reports in all Dashboard views:
1. In the WebFOCUS76\worp\conf directory, open the bid-config.xml file in a text editor.
2. Edit the following variable to change it from:
<internal-var name="enableExtendedMenu" value="false"/>
to
<internal-var name="enableExtendedMenu" value="true"/>

Note: After making changes to the bid-config.xml file, use the WebFOCUS Console to clear
memory cache, or restart the application. Until this is done, the change is not effective.

Procedure: How to Enable the Creation of Standard Reports in Specific Views


To enable administrators and developers to create Standard Reports in specific Dashboard
views:
1. Log on to the Dashboard View Builder.
2. Select a view.
3. Click Edit Settings.
4. Click the True option to the right of enableExtendedMenu in the Settings pane.
5. Click Save Settings.
6. Click Close.

88 WebFOCUS
4. Managing Dashboard

For more information about using the Edit Settings functionality in the Dashboard View
Builder, see Customizing Dashboard Pages for a Public or Group View on page 99.

WebFOCUS Managed Reporting Administrator's Manual 89


Creating Standard Reports in Dashboard

90 WebFOCUS
WebFOCUS

5 Creating Public and Group Views

A public view allows users to view


Topics:
information in Dashboard without
entering login information. Login What Is a Public View?
information is managed in Dashboard
from the Server and Public User windows What Is a Group View?
in the View Builder. For details, see What Is a Library Only Group View?
Customizing Dashboard on page 105.
Adding a Group or Public View
There are two types of public views,
general and custom. The general public Directing Users to a Group View Upon
view is the default public view and is Login
intended for a wide variety of audiences.
Custom public views contain detailed Adding a Library Only View
information that is relevant to more Removing a Public or Group View
specific groups.
Editing a Public or Group View
Group views are secure views that can
deliver information to a specific group of Customizing Dashboard Pages for a
users. Public or Group View
You create and manage public views Copying a Public or Group View
(general and custom) and group views
from the Public Views and Group Views Exiting the Public Views or Group
windows in the View Builder. From the Views Window
Public/Group Views windows you can
add, remove, edit or copy a public or
group view.
After you create a public or group view,
content needs to be added. For details,
see Creating Dashboard Content on page
147.
Note: Users who access any public view
(general or custom) or group view will
only be able to view information. They
will not be able to change information or
the look of the Dashboard.

WebFOCUS Managed Reporting Administrator's Manual 91


What Is a Public View?

What Is a Public View?


A public view allows public users to view information in Dashboard without having to enter
login information. A default public view is provided with Dashboard and allows you to build
additional custom public views containing specific reports and information for a particular
group of users. For example, you can create a Human Resources public view that will contain
information that is pertinent to someone who works in that group, and an Accounting public
view that will only contain information for that group.
Dashboard uses the Managed Reporting User ID "public" to gain access to Managed
Reporting content for public views. (You can change the ID used for the public user, see
Setting an ID and Password for the Public User on page 77.) Content for public views is
maintained by the Administrator in Managed Reporting User Management. The content for
public views comes from the public user's membership in a group or by the assignment of
a domain to the public user. This content is available to the Dashboard Administrator when
creating a public view.
Each public view contains different content blocks and you can create a unique customization
for each public view.
From the Welcome page, you can access the Public Views window. The Public Views window
lists all of the existing public views. From this page, users can navigate from one public view
to another by clicking the links on the page. Alternatively, you can give users one URL that
directs them to the public view intended for their group.

What Is a Group View?


A group view is a view based on WebFOCUS Managed Reporting repository groups. When a
user logs into Dashboard, they will be able to see all of the views for each group they belong
to. Users must be members of the Managed Reporting group associated with the
corresponding Dashboard group view in order to be able to login to them.
You can create a unique view for each group view. When you update a view, the view will be
updated for all members of the group, even members logged into Dashboard with personal
views.
Users cannot make any changes to group views. When a user logs into Dashboard, they can
personalize their view to add personal pages in addition to the group pages.
Users can access the group views that are accessible to them by logging on to Dashboard
and clicking the Views link. Alternatively, you can give users one URL that directs them to a
specific group.

92 WebFOCUS
5. Creating Public and Group Views

What Is a Library Only Group View?


Library Only User views are based on Group Views. MR Administrators can create a Group
View in the View Builder for an MR Group. This Group View is available for any members of
the group that are not Library Only Users. When the Group View is created, it is linked to
another Group View configured specifically for the Library Only user.
The Library Only Group View inherits the page appearance, banner location, banner links,
and toolbars from the original Group View. If there is no banner in the original Group View,
it is not shown in the Library Only Group View. Banner links are further reduced if the original
group view includes links not accessible to the Library Only User. The Logoff, Library, Views,
and Help banner links are shown by default, and the developer of the view is able to remove
any or all of these links. Additional toolbars can optionally be added to the Library Only View.
The Content window automatically includes the Library Page. The MR Administrator can
update content pages in the View Builder to add additional content pages with direct links
to list or output blocks, and Report Library content in a launch block. The Library Page can
be removed by the developer of the view.

Adding a Group or Public View


In this section:
Group Administrator Access to the View Builder
How to:
Open the View Builder to Create a Public or Group View
Add a Public View
Add a Group View

You create a public or group view from the Public Views or Group Views window in the View
Builder.
Note that the Public Views and Group Views window accessible through the View Builder are
different than the Public Views and Group Views windows you can access from the WebFOCUS
Business Intelligence Dashboard index page.
When you create a public or group view, you must supply a description for the view. The
name of your view is automatically generated and you can find it in the Link URL column.
The following folders, files, and links are created for each public and group view:
A folder using the link URL name is created in the worp_users folder.
Files named content.xml, layout.xml, and user-preferences.xml are created in the
worp_users folder.

WebFOCUS Managed Reporting Administrator's Manual 93


Adding a Group or Public View

For each public and group view, a link is added to the Public Views and Group Views windows
accessible from the WebFOCUS Business Intelligence Dashboard index page. The description
defined for the public or group view is the text for the link when the view was created.
The following image shows the Group Views window containing an available group, its
description, and URL link.

Note: When you enter the Public Views window for the first time, the default public view
displays. This view cannot be deleted although you can modify the description, look, and
content.

Procedure: How to Open the View Builder to Create a Public or Group View
1. Enter the following URL in your Web browser:
http://webserver[:portnumber]/ibi_apps/bid
where:
webserver
Indicates the name of the Web server that is running Dashboard.
portnumber
Is the Web server port where WebFOCUS is running. This is not required if it is the
default port.
The WebFOCUS Business Intelligence Dashboard Index Page opens.
Alternatively, you can enter:
http://webserver[:portnumber]/ibi_apps/bid/vblogin
to directly access the View Builder Login Page.

2. Click WebFOCUS BI Dashboard View Builder Login Page.


3. Enter your user ID and password.

94 WebFOCUS
5. Creating Public and Group Views

4. Click Logon. The Public Views window opens. To create a group view, click Group Views.

Procedure: How to Add a Public View


1. Open the View Builder.
2. Click Public Views.
3. Click Add. An input form displays at the bottom of the Public Views window.
4. Enter a description for the public view.
5. Click Submit. The new view is added to the Public Views list.

Procedure: How to Add a Group View


1. Open the View Builder.
2. Click Group Views.
3. Click Add. An input form displays at the bottom of the Group Views window.
4. Select a group name from the drop-down list.
5. Enter a description for the group view.
6. Click Submit. The new view is added to the Group Views list.

WebFOCUS Managed Reporting Administrator's Manual 95


Directing Users to a Group View Upon Login

Group Administrator Access to the View Builder


Group Administrators can access the View Builder to create and edit Group Views and Library
Views for the groups they administer. The following image shows the View Builder with access
to Group Views.

The following are applicable for all such Group Administrators when accessing the View
Builder:
Group Views is the default page displayed upon login to the View Builder.
Only Group Views the Group Administrator is administrator for are displayed in the Group
Views page.
Options for Public Views, User Views, Public User, Server, Role Tree, Toolbox, Manage
Users, and Management are not available.

Directing Users to a Group View Upon Login


How to:
Select a Group View Upon Login

You can setup login so that when a user enters their ID and password they are automatically
logged into a Group View of Dashboard or to a window where they can view the group views
that are available to them (if there are multiple views).

96 WebFOCUS
5. Creating Public and Group Views

Procedure: How to Select a Group View Upon Login


1. Back up the file /ibi/WebFOCUS76/worp/conf/bid-config.xml.
2. Open bid-config.xml using a text editor.
3. Search for the string “GoToPersonalViewOnLogin”. You will see the following code:
<internal-var name="GoToPersonalViewOnLogin" value="true"/>

4. Change the value to “false” as shown in the following code:


<internal-var name="GoToPersonalViewOnLogin" value="false"/>

5. Close and save bid-config.xml.


After the setting is changed, the following login processing is enabled:
If the user is a member of a single group view, the user is automatically logged into
that group view.
If the user is a member of multiple group views, the user is logged into a window
displaying the group views available to them.

Adding a Library Only View


If you access the View Builder and select the Library Views option, you can add, remove,
and edit LIbrary Only Group Views using the interface shown in the following image.

Both the Library Only Group View and the original Group View are available from the same
View URL. When logging on, Dashboard routes a user to the Library Only Group View if the
user is a Library Only User. All other users are routed to the original Group View.

WebFOCUS Managed Reporting Administrator's Manual 97


Removing a Public or Group View

Removing a Public or Group View


How to:
Remove a Public or Group View

From the Public Views or Group Views window, you can remove a public or group view. Note
that you can remove one or more views at a time.

Procedure: How to Remove a Public or Group View


1. Open the View Builder and click Public Views or Group Views.
2. Click the check box(es) next to the public/group view(s) you want to remove.
3. Click Remove. A message displays confirming the removal.
4. Click OK.

Editing a Public or Group View


How to:
Edit a Public or Group View's Description

After you create a public or group view, you can edit the description and the contents. For
details on editing content blocks, see Creating Dashboard Content on page 147.

Procedure: How to Edit a Public or Group View's Description


1. Open the View Builder and click Public Views or Group Views.
2. Click the check box next to the public or group view you want to edit.
3. Click Edit Content. To edit the description, delete the current description and enter a
new one.
4. Click Update.
For details on editing content blocks, see Creating Dashboard Content on page 147. For
details on editing the look of a view, see Customizing Dashboard on page 105.

98 WebFOCUS
5. Creating Public and Group Views

Customizing Dashboard Pages for a Public or Group View


From the Dashboard View Builder, Administrators and Group Administrators can customize
the Dashboard page for a selected public or group view, which overrides the default view,
without editing any files. The View Builder's Edit Setting button launches a dialog box which
provides you with a user interface to enable and disable features, display or hide types of
reports in the Domain Tree, change the appearance of the view, and perform other
customizations.
The following image shows the Settings pane in the View Settings dialog box.

The following list of variable descriptions shows the settings you can change in the Settings
pane and the default settings (where applicable), which are underlined:
Tab style - Round (display round corner tabs) or Square (display square corner tabs). To
apply globally for all views, see How to Display Square Corner Page Tabs in All Views on
page 122.
Enable Creation of Standard Reports - True (enable administrators and developers
to create Standard Reports) or False (disable this functionality). To apply globally for all
views, see How to Enable the Creation of Standard Reports in All Views on page 88.

WebFOCUS Managed Reporting Administrator's Manual 99


Customizing Dashboard Pages for a Public or Group View

New ReportCaster Scheduler - True (set report Schedule option to open the
ReportCaster single page Scheduler tool) or False (set report Schedule option to open
the multi-page ReportCaster Scheduling Wizard). To apply globally for all views, see How
to Change the ReportCaster Scheduling Tool in All Views on page 139.
Display Created By and Last Modified By Properties - True (display the Create By
and Last Modified By properties in the Dashboard Properties dialog box) or False (hide
these properties). To apply globally for all views, see Displaying Optional Properties in
Dashboard on page 87.
Show Banner Greeting - True (display welcome message) or False (hide message). To
apply globally for all views, see Displaying a Welcome Message in the Banner on page
131.
Reload Pages on Tab Navigation - True (reload pages) or False (do not reload pages).
Enable Upload Data File Feature - True (enable feature) or False (disable feature).
Enable Standard Browser Context Menu - True (enable menu) or False (disable menu).
Reload Block Content on Maximize - True (reload block) or False (do not reload block).
Show Properties Share option for Deferred Reports output - True (display Share
Report check box) or False (hide check box). To apply globally for all views, see Hiding
the Share Report Option for Finished My Reports on page 86.
Show Properties Share option for OLAP Reports - True (display Share Report check
box) or False (hide check box). To apply globally for all views, see Hiding the Share Report
Option for Finished My Reports on page 86.
Show Folder Block as Collapsible Tree - True (display folder block as a tree) or False
(display standard folder block). To apply globally for all views, see How to Display a
Collapsible Tree in the Folder Blocks of All Views on page 157.
Hide Reporting Objects from these Roles - Select from a valid list of user roles. To
apply globally for all views, see Hiding Report Types in the Domain Tree on page 83.
Hide My Reports from these Roles - Select from a valid list of user roles. To apply
globally for all views, see Hiding Report Types in the Domain Tree on page 83.
Hide Shared Reports from these Roles - Select from valid list of user roles. To apply
globally for all views, see Hiding Report Types in the Domain Tree on page 83.
Hide Other Files from these Roles - Because Other Files are hidden by default from
all user roles except the Developer role, the MR Administrator role, and any custom role
based on either of these two roles, you can effectively hide Other Files from only the
previously mentioned roles. To apply globally for all views, see Hiding Report Types in the
Domain Tree on page 83.

100 WebFOCUS
5. Creating Public and Group Views

Hide Standard Reports from these Roles - Select from valid list of user roles. To apply
globally for all views, see Hiding Report Types in the Domain Tree on page 83.
Note: The list of user roles you can select from includes Analytical User, Content Manager,
Developer, MR Administrator, Power User, Run Only User, User, any custom user roles you
have created, and the ability to select all user roles that have access to the selected view.
The following image shows the User Links pane in the View Settings dialog box, which you
can access by clicking the down-arrow to the left of User Links.

The User Links pane contains the Available Links list box and the Selected Links list box.
When a personal view is created, all banner links that were made available by the
administrator are selected to display in the view by default. You can remove links from the
Selected Links list box and add back previously removed links that are in the Available Links
list box.
The following image shows the Redirects pane in the View Settings dialog box, which you
can access by clicking the down-arrow to the left of Redirects.

WebFOCUS Managed Reporting Administrator's Manual 101


Copying a Public or Group View

The Redirects pane contains the Redirect context type drop-down menu and the Redirect
URL text box. When users log off from a view, they are redirected to the Welcome Page by
default. You can redirect users to a different logoff window by selecting context-redirect or
x-redirect from the Redirect context type drop-down list and entering the desired URL in the
Redirect URL field. The context-redirect option is the default setting and is used to add
additional segments to the default redirect URL to redirect a user to a different URL inside
the application context upon logoff. The x-redirect option is used to redirect a user to a fully
qualified URL outside the application. For more information, see Customizing the Logoff
Window on page 136.
All changes made to the selected view are saved in the following location:
\ibi\WebFOCUS76\worp\worp_users\viewname\view-config.xml
where:
viewname
Indicates the name of the customized view created in the View Builder.
When all Settings, User Links, and Redirects changes to the view are completed, click the
Save Settings button. If you click the Reset to Default button, the customized view is deleted
from the view-config.xml file and all default settings are restored. Click Close to return to the
View Builder.

Copying a Public or Group View


How to:
Copy a Public View
Copy a Group View

If there is an existing public view that contains content blocks you want to include in a new
view, you can save time by copying the existing public view. By copying a public view, a new
view is created that contains the same content blocks. When copying a group view, only the
look and feel is copied, the content blocks are not copied. After you copy an existing public
or group view, the new view has a different name and description than the old view. You can
edit the content blocks after the view is copied.
Views are copied from the Public Views or Group Views window. The text of the description
is used as the link on the Public Views and Group Views pages.

102 WebFOCUS
5. Creating Public and Group Views

Procedure: How to Copy a Public View


1. Open the View Builder and click Public Views.
2. Click the check box next to the public view to copy.
3. Click Copy. An input form displays at the bottom of the Public Views window.
4. Enter a description for the new public view.
5. Click Submit. The new public view is added to the Public Views list.
For details on content blocks, see Creating Dashboard Content on page 147.

Procedure: How to Copy a Group View


1. Open the View Builder and click Group Views.
2. Click the check box next to the group view to copy.
3. Click Copy. An input form displays at the bottom of the Group Views window.
4. Select a Group Name from the drop-down list.
5. Enter a description for the new group view.
6. Click Submit. The new group view is added to the Group Views list.
For details on content blocks, see Creating Dashboard Content on page 147.

Exiting the Public Views or Group Views Window


Exit the Public Views and Group Views window by clicking Done. After doing so, the WebFOCUS
Business Intelligence Dashboard index page opens.

WebFOCUS Managed Reporting Administrator's Manual 103


Exiting the Public Views or Group Views Window

104 WebFOCUS
WebFOCUS

6 Customizing Dashboard

You can customize the WebFOCUS Business Intelligence Dashboard by choosing colors, adding a logo,
selecting the position of the Domain Tree, Role Tree, banner, and more. To customize the WebFOCUS
Business Intelligence Dashboard, use the View Builder.
You can create a unique customized view for each public and group view.
Before you begin, you must create the public user. For details, see Before You Begin Customizing Dashboard
on page 106.
When you open the View Builder after upgrading from a previous version of Dashboard, the following
message displays:
The View Builder is now migrating
the existing customization and
personalizations to the new
version. Please wait.
Note: The Dashboard view should not be updated while users are connected to Dashboard.

Topics:
Creating a Custom Toolbar
Before You Begin Customizing Dashboard Adding a Message of the Day
Opening the View Builder Customizing the Logoff Window
Selecting a Template Changing the ReportCaster Scheduling Tool
Selecting Custom Colors Resetting the View Builder
Positioning the Domain Tree, Role Tree, and Saving Selections and Exiting a Customization
Banner
Exiting the View Builder
Inserting a Logo
Customizing the Banner

WebFOCUS Managed Reporting Administrator's Manual 105


Before You Begin Customizing Dashboard

Before You Begin Customizing Dashboard


Reference:
Public User Rights

Before you create a public or group view or begin to customize the WebFOCUS Business
Intelligence Dashboard, the public user must exist. The public user is set up to allow users
to view information without having to enter a user ID or password. In addition, the public
user has access to the WebFOCUS Managed Reporting domains you associate with that
user. The public user has limited access to Dashboard. For details, see Public User Rights
on page 106.
In most cases, the public user is automatically generated. To verify this, see the Managed
Reporting Administration interface.
You can select any Managed Reporting user ID as the Public user. See Setting an ID and
Password for the Public User on page 77.

Reference: Public User Rights


The public user can:
View and run the contents of the Standard Reports folder for the domains available to
the user. The user can only execute reports contained in this folder.
Perform a Domain Search, although the Look In option is not available to the user. You
can remove the Domain Search option from a public view.
The public user cannot:
Create content blocks or content pages.
Access reporting tools, such as Report Assistant, Graph Assistant, ReportCaster, or
Library.
Access the My Reports, Shared Reports, or Reporting Objects folders.
Save report output or report requests to a domain.
Run deferred requests or view deferred status.
Run OLAP-enabled reports. OLAP-enabled reports do not display in the Domain Tree or
Role Tree for the public user.

106 WebFOCUS
6. Customizing Dashboard

Opening the View Builder


How to:
Open the View Builder to Customize a View
Reset the View Builder

You can customize your Dashboard look by using the View Builder. From the View Builder,
you can open the following windows:
Look. Select a template for Dashboard.
Colors. Select custom colors for your template.
Composition. Select the position of the Domain Tree, Role Tree, and the banner.
Logo & Links. Select an image for the banner such as a company logo. You can also
customize the links that display in the banner of the public view.
Message. Add a customized Message of the Day to your Dashboard view.
Toolbar. Add a customized toolbar to your Dashboard view that contains any type of link
that the Internet or intranet supports, such as Web sites, other tools, applications, and
documents.
Toolbox. Create toolboxes that contain the items you want to insert in your custom
content tool bar.
Login. Select the login options, dual or single, for each public or group view.
Only one session of the View Builder can be open at any time. If you try to access the View
Builder while another administrator is using it, you will receive the following message:
A customization is currently in progress.
If you want to cancel the current customization, you can reset the View Builder. See How to
Reset the View Builder on page 109 for details.
Note: Do not use your browser's Back and Forward buttons to navigate in the View Builder.
Instead, use the links provided on the left side of the View Builder.

WebFOCUS Managed Reporting Administrator's Manual 107


Opening the View Builder

Procedure: How to Open the View Builder to Customize a View


1. Click Business Intelligence Dashboard View Builder from the WebFOCUS Welcome page
(http://webserver/ibi_apps/).
or
Click the View Builder button on the toolbar when you are in the Managed Reporting area
of Developer Studio.
or
Type the following URL in your Web browser:
http://hostname[:port]/wf_context_root/bid
where:
hostname[:port]
Is the name of the Web Server and optional port number (specified only if you are
not using the default port number) where the WebFOCUS Web application is deployed.
wf_context_root
Is the site-customized context root for the WebFOCUS Web application deployed on
your Application Server. The default value is ibi_apps.
The WebFOCUS Business Intelligence Dashboard Index page opens.
Alternatively you can type:
http://hostname[:port]/wf_context_root/bid/vblogin
to directly access the View Builder Login page (bypassing the Index page).

2. From the Index page, click WebFOCUS BI Dashboard View Builder Login Page.
If you used the alternative method to directly access the Login page, skip this step.

3. From the Login page, enter your user ID and password.


4. Click Logon to open the Public Views window.
If you want to customize a group view, click Group Views.

5. Select the check box next to the public or group view you want to customize.
6. Click Edit Look.

108 WebFOCUS
6. Customizing Dashboard

Procedure: How to Reset the View Builder


1. Click Reset View Builder from the window that displays the error message.
The Login to Reset Customization window opens.

2. Enter your user ID and password, then click Logon and the following message displays:
WebFOCUS BI Dashboard ViewBuilder customization session ended.

3. Click View Builder Login.


4. Enter your user ID and password again, then click Logon.
Note: When you disconnect the previously connected session, any customizations that were
in progress will be lost.

Selecting a Template
In this section:
Creating a Custom Template
How to:
Select a Template

You can select a template for the Dashboard interface from the Look window in the View
Builder. A different template can be selected for each public and group view.

WebFOCUS Managed Reporting Administrator's Manual 109


Selecting a Template

The following image shows the Look window divided into two parts. The top part of the window
contains thumbnails of template styles and the bottom part is the preview of a selected
template.

There are several templates available, each with different options. The options include
selecting custom colors and selecting a background image. For descriptions of all the
templates, see Dashboard Templates on page 112.

Procedure: How to Select a Template


1. From the View Builder, click Look. The Look window opens.
2. Click an image in the Look window. The selected template displays in the Preview area.
3. Click Colors to change the colors for the look. For details, see Selecting Custom Colors
on page 115.

110 WebFOCUS
6. Customizing Dashboard

Creating a Custom Template

How to:
Create a Custom Template
Reference:
Dashboard Templates

There are two templates available from the Look window in the View Builder that you can
use to create a Dashboard view that does not have a separate area for the logo embedded
in the banner.
Additionally, you can create a custom template for your Dashboard view and access it through
the View Builder.

Procedure: How to Create a Custom Template


1. Navigate to the worp_html folder in the worp directory structure.
In this directory there are folders for each of the Dashboard looks, or templates (worp0
through worp7).

2. Copy and rename one of these directories (the one that most closely resembles the
look you want to create) to a new directory under worp_html.
The new directory name should begin with "custom_", for example "custom_new".

3. In the directory for your new look, edit the file profile.prf.
This file contains two references to the directory name for the template. Change both
of these references to reflect the new directory name. If you do not make these changes,
your template will still work correctly. However, these references need to be updated
for the Dashboard Migration Utility to correctly migrate the views that use the custom
templates.

WebFOCUS Managed Reporting Administrator's Manual 111


Selecting a Template

4. Edit the HTML and CSS files as necessary to make your customizations.
The tags bg1, bg2, etc. should be maintained in these files so that the color selections
appear in the View Builder Colors page.
a. The banner.html and banner.css files control the banner display.
b. Domain.css controls the appearance of the left sidebar containing the Domain Tree
and Role Tree.
c. Ctrl.css controls the appearance of the toolbar that displays over the content blocks.
d. Content.css controls the appearance of the content blocks.
e. Ibitools.css controls the appearance of toolbar 1, and customtools.css controls the
appearance of toolbar 2.

5. Open the View Builder and select the new look, which will show up under the distributed
looks.
Note: When you make changes to the view outside of the View Builder, you will need
to go back into the View Builder and select your customized view again in order to see
your changes reflected in the template.

Reference: Dashboard Templates


Following are the templates available for Dashboard. The numbers correspond to the
thumbnail images in the Look window. If you place your mouse over the thumbnail, the name
of the template appears. For example, template 1 would appear as WORP0.
Template 1 (WORP0)
The colors for this template are customizable. The following image shows the first template
containing the white background with muted blue and mustard yellow foreground color and
text.

112 WebFOCUS
6. Customizing Dashboard

Template 2 (WORP1)
The colors for this template are customizable. You may also use an image for a wallpaper
effect in the banner background area. The following image shows the first template containing
the white background with two shades of blue and gray for foreground color and text.

Template 3 (WORP2)
The colors for this template are customizable. You may also use an image for a wallpaper
effect in the banner background area. The following image shows the first template containing
the white background with two shades of muted green and mustard yellow for foreground
color and text.

Template 4 (WORP3)
The colors for this template are customizable. You may also use an image for a wallpaper
effect in the banner background area. The following image shows the first template containing
the white background with dark shades of blue and green for foreground color and text.

Template 5 (WORP4)
The colors for this template are customizable. The following image shows the first template
containing the white background with red and mustard yellow for foreground color and text.

WebFOCUS Managed Reporting Administrator's Manual 113


Selecting a Template

Template 6 (WORP5)
The colors for this template are customizable. The following image shows the first template
containing the white background with gray and blue for foreground color.

Template 7 (WORP6)
The colors for this template are customizable. You may also use an image for a wallpaper
effect in the banner background area. This template does not require a logo.

Template 8 (WORP7)
The colors for this template are customizable. You may also use an image for a wallpaper
effect in the banner background area. This template does not require a logo and the banner
is shorter than the other templates.

114 WebFOCUS
6. Customizing Dashboard

Selecting Custom Colors


How to:
Customize the Look of the HTML Report and Graph Assistant in Dashboard
Choose Custom Colors for a Template
Create a Wallpaper Effect in a Template
Display Square Corner Page Tabs in All Views
Reference:
Banner Custom Color Areas
Toolbar Custom Color Areas
Domain Custom Color Areas
Page Tabs Custom Color Areas
Content Block Custom Color Areas
Message Custom Color Areas
Toolbar 1 and Toolbar 2 Custom Color Areas

You can customize the templates by selecting colors (or images, where applicable) for the
following areas:
Banner. You can select the background colors, and the text and link color for the banner.
If you have selected template 2, 4, or 5 you can alternatively select an image to create
a wallpaper effect for the banner background area instead of a color.
Toolbar. You can select the background color and text color for the Domain Tree, Role
Tree, and content block toolbars.
Domain. You can select the domain background color, text color, and link colors.
Page Tabs. For content pages, you can select the text color for the selected page tab,
the text color for unselected page tabs, and the background color for all page tabs when
the default round corner style page tabs are in use. When the optional square corner
style page tabs are enabled, you can select both the text color and background color for
the selected page tab and the unselected page tabs. You can enable square corner style
page tabs for specific views using the Edit Settings functionality available in the Dashboard
View Builder. For more information, see Customizing Dashboard Pages for a Public or
Group View on page 99. To enable square corner tabs for all views, see How to Display
Square Corner Page Tabs in All Views on page 122.

WebFOCUS Managed Reporting Administrator's Manual 115


Selecting Custom Colors

Content Block. You can select the content block background color and link colors. Note
that you can only select colors for list blocks and folder blocks.
Message. You can select the background color and the text color for the message.
Toolbar 1 and Toolbar 2. You can select the background colors and the link colors for
any custom tool bars you create.
Note: Depending on the template and the items selected to be included in the view, certain
items may not appear on the Custom Colors window.
The following image shows the Custom Colors window containing color choices for Banner,
Control, Domain, Page Tabs, and Content Block.

The color areas vary for each template (for example, Background 1).
For details, see:
Banner Custom Color Areas on page 118.
Toolbar Custom Color Areas on page 119.
Domain Custom Color Areas on page 120.
Page Tabs Custom Color Areas on page 120.
Content Block Custom Color Areas on page 121.
Message Custom Color Areas on page 121.

116 WebFOCUS
6. Customizing Dashboard

Toolbar 1 and Toolbar 2 Custom Color Areas on page 121.


When you select the colors and/or wallpaper for your Dashboard banner, you can also select
that these customizations be inherited by the HTML Report Assistant and Graph Assistant
(when used from the Dashboard view).

Procedure: How to Customize the Look of the HTML Report and Graph Assistant in Dashboard
1. From the View Builder, click Colors.
2. Select the colors and/or wallpaper.
Background color 1 is the top area, background color 2 is the main body area of the
tool.

3. Click the Report Assistant and Graph Assistant inherit banner colors check box.
4. Click Preview.
5. Click Save.
Note: For changes in this window to be effective, you must click Preview and Save before
you exit this window.

Procedure: How to Choose Custom Colors for a Template


1. From the View Builder, click Colors. The Custom Colors window opens.
2. Click the colored rectangle adjacent to the area for which you want to select the color.

WebFOCUS Managed Reporting Administrator's Manual 117


Selecting Custom Colors

The Color Palette window opens as shown in the following image.

3. Click a color from the palette or enter a hex value in the area provided. The hex value
is not case sensitive. You are not limited to the colors that appear in the Color Palette
window; you can use any color you want by entering the hex value.
4. Click Done to close the Color Palette window and save changes. Click Close to close the
Color Palette window without saving changes.
You return to the Custom Colors window.

5. Click Preview to see how the colors display.


6. Click Save to save changes.

Reference: Banner Custom Color Areas


The following table describes the color areas for the banner:

Custom Color Designates...


Area

Background 1 The area that does not contain a logo or links for templates 2, 3,
4, and 5. In templates 1 and 6, it is the area behind the links.

118 WebFOCUS
6. Customizing Dashboard

Custom Color Designates...


Area

Background 2 In template 1 it is the narrow bar above "Your Company LOGO".


The area behind the links in templates 2, 3, and 4. In templates
5 and 6, it is the narrow bar at the bottom of the banner.

Background 3 In templates 1 and 3 it is the narrow bar below "Your Company


LOGO". In template 2 it is the bar beneath background area 1. The
logo area in templates 3, 4, and 5. This is not applicable in
template 6.

Background 4 In template 1, the area behind "Your Company LOGO". In template


3, the line between "Your Company LOGO" and the link bar. This
is not applicable for templates 2, 4, 5, and 6.

Background 5 In template 3, the line between "Your Company LOGO" and the
message of the day. This is not applicable for templates 1, 2, 4,
5, and 6.

Link The text color for links in the banner and for the optional welcome
message.

Hover The text color for links when the cursor is positioned over the link.

Reference: Toolbar Custom Color Areas


The following table describes the color areas for the toolbar:

Custom Color Area Designates...

Background The color of the toolbar at the top of the Domain Tree, Role Tree,
and content blocks.

Text The content block name.

WebFOCUS Managed Reporting Administrator's Manual 119


Selecting Custom Colors

Reference: Domain Custom Color Areas


The following table describes the color areas for the domain:

Custom Color Area Designates...

Background The background color behind the Domain Tree. This is also the
background color for the Domain Tree that opens when a user
selects the Tree link in the banner.

Text The color of the text in the Domain Tree, including folder names.

Link The color of domain items such as links and reports.

Visited Link The color of domain items such as links and reports after being
accessed.

Hover The text color for domain items such as links and reports when
the cursor is positioned over the item.

Reference: Page Tabs Custom Color Areas


The following table describes the color areas for page tabs:

Custom Color Area Designates...

Selected Tab The background color for the selected page tabs.
Background

Unselected Tab The background color for the unselected page tabs.
Background
Note: When default round corner tabs are used, the background
color is the same for both selected and unselected tabs.

Selected Tab Text The text color for the selected page tab.

Unselected Tab The text color for the unselected page tabs.
Text

120 WebFOCUS
6. Customizing Dashboard

Reference: Content Block Custom Color Areas


The following table describes the color areas for content blocks:

Custom Color Area Designates...

Background The background color behind List and Folder blocks and Output
blocks if the block is empty. It is also the background color for
the Dashboard login page when accessed from a public or group
view.

Link The color of links displayed in List and Folder blocks.

Visited Link The text color for links in a List block after being accessed.

Hover The text color for links in a List block when the cursor is
positioned over the link.

Text Folder names in a Folder block.

Reference: Message Custom Color Areas


The following table describes the color areas for the message:

Custom Color Area Designates...

Background The background color for the Message of the Day block.

Text The color of the Message of the Day text.

Reference: Toolbar 1 and Toolbar 2 Custom Color Areas


The following table describes the color areas for toolbar 1 and toolbar 2:

Custom Color Area Designates...

Background 1 The area behind the text.

Background 2 The tool bar item outline.

Background 3 The tool bar background (area behind the items in the tool bar).

Link The text color of links in the tool bar.

WebFOCUS Managed Reporting Administrator's Manual 121


Selecting Custom Colors

Custom Color Area Designates...

Visited Link The text color for links in the tool bar after being accessed.

Hover The text color for links in the tool bar when the cursor is
positioned over the link.

Procedure: How to Create a Wallpaper Effect in a Template


1. From the View Builder, click Colors. The Custom Colors window opens.
You can add a wallpaper effect in templates 2, 4, and 5.

2. Enter the location of the image in the space provided or click Browse to search for the
image. Note that the image must be a GIF, JPG, or BMP file.
If the image is smaller than the banner area, it is repeated to fill the area.
Note: Dragging and dropping items, including images, is not supported in Dashboard.

3. Click the Click to Set Wallpaper check box only if you are changing the image or removing
the image.
4. Click Preview to view how the image displays. The Preview window must be updated
before exiting the Custom Colors window or your changes will not be saved.
The selected image file is copied to the WebFOCUS directory for access while running
Dashboard. If the image file is modified in its original location you will need to reinsert
the image from Dashboard; it will not be automatically updated.
The name of the image will not display when you re-enter the View Builder.

5. Click Save to save changes.

Procedure: How to Display Square Corner Page Tabs in All Views


1. In the WebFOCUS76\worp\conf directory, open the bid-config.xml file in a text editor.
2. Edit the following variable to change it from the default setting for round corner page
tabs:
<internal-var name="tabStyle" value="0"/>
to the following setting for square corner page tabs:
<internal-var name="tabStyle" value="1"/>

Note: After making changes to the bid-config.xml file, use the WebFOCUS Console to clear
memory cache, or restart the application. Until this is done, the change is not effective.

122 WebFOCUS
6. Customizing Dashboard

Positioning the Domain Tree, Role Tree, and Banner


In this section:
Selecting Scrolling Options for Domain Trees and Role Trees
How to:
Position the Domain Tree, Role Tree, and Banner

Select the position of the Domain Tree, Role Tree, and banner from the Composition window.
The Domain Tree and Role Tree share a column that can be placed on the right or left side
of the window, or removed. The banner can be placed at the top or bottom of the window,
or removed.
Note: The composition should not be updated when users are connected to Dashboard.
Choose to hide or display the Domain Tree, Role Tree, and banner. Display options include
the following:
Check to use Banner. When this option is selected, the banner displays in your
Dashboard view. If you deselect this option, the banner does not display. Note that if
you remove the banner, authenticated users will not have access to links they may need,
such as Login and Personalize.
Check to use Sidebar. When this option is selected, the sidebar (Domain Tree and
Role Tree) display in your Dashboard view. If you deselect this option, the sidebar is
hidden in your Dashboard view. Note that if you hide the Domain Tree/Role Tree, users
can still access the Domain Tree/Role Tree from the Tree banner link.
Check to use Frame Separator. Choose to keep or omit frame separators from the
Dashboard view. If you omit frame separators, a seamless look is created between the
banner and the sidebar (Domain/Role Tree).
Domain Tree only. This is the default selection and displays only the Domain Tree.
Role Tree only. Displays only the Role Tree.
Both Domain Tree and Role Tree. Displays the Domain Tree and the Role Tree. When
this option is selected, a button displays in the toolbar that allows the user to toggle
between the Domain Tree and the Role Tree. With this option, you also select to have
either the Role Tree or the Domain Tree as the default display list.
If you choose to display the Role Tree, you must create a Role Tree for all groups that will
use the Dashboard view that contains a Role Tree. For details, see Creating a Role Tree on
page 141.
You can also select either scroll buttons or scroll bars for the Domain Tree and Role Tree.
For details, see Selecting Scrolling Options for Domain Trees and Role Trees on page 125.

WebFOCUS Managed Reporting Administrator's Manual 123


Positioning the Domain Tree, Role Tree, and Banner

The following image shows the Composition window containing three parts: first part is the
check boxes for banner, sidebar, and frame separator, second part is the position of the
bar and sidebar, and the third part is content for the sidebar and tree link.

Procedure: How to Position the Domain Tree, Role Tree, and Banner
1. From the View Builder, click Composition. The Composition window opens.
2. To position the banner, click one of the combinations in the Composition window. The
banner can be placed at the top or bottom of the window, and the Domain Tree and
Role Tree share a column on the right or left side of the window. Not all combinations
are available for every display option.
The Preview area automatically updates when you select a combination.

3. To position the Domain Tree and Role Tree, select one of the following option buttons:
Domain Tree only. Displays only the Domain Tree.
Role Tree only. Displays only the Role Tree.
Both Domain Tree and Role Tree. Displays the Domain Tree and the Role Tree.
When this option is selected, a button displays that allows the user to toggle between
the Domain Tree and the Role Tree. With this option you also select to have either
the Role Tree or the Domain Tree as the default display list.
Note that this also controls the content that displays when a user selects the Tree
banner link.

4. Click Save to save changes.

124 WebFOCUS
6. Customizing Dashboard

Selecting Scrolling Options for Domain Trees and Role Trees

How to:
Select Scrolling Options for Domain Trees and Role Trees

You can select either scroll buttons or scroll bars for the Domain Tree and Role Tree.
When scroll buttons are enabled, up, down, left, and right arrows display in the toolbar
allowing you to navigate the Domain Tree or Role Tree.
When scroll bars are enabled, scroll bars display when content exists that cannot be viewed
within the displayed window. When this option is selected, scroll buttons do not display in
the toolbar.

Procedure: How to Select Scrolling Options for Domain Trees and Role Trees
1. From the View Builder, click Composition. The Composition window opens.
2. Select the Enable Scroll Buttons or Enable Scroll Bars option button. This controls scrolling
options in the sidebar list:
When Enable Scroll Buttons is selected, the buttons display in the Domain Tree or
Role Tree toolbar.
When Enable Scroll Bars is selected, a scroll bar displays in the sidebar list when
necessary.

Inserting a Logo
How to:
Insert a Logo
Reference:
Logo Size

From the Logo & Links window you can insert an image such as a company logo in the
banner. The selected image file is copied to the WebFOCUS directory for access while running
Dashboard. If the image file is modified in its original location, you will need to reinsert the
image from Dashboard; it will not be automatically updated.
The logo image must be a GIF, JPG, or BMP file. The logo size is determined by the size of
the available space on the banner, and therefore, is different for the various templates. For
details, see Logo Size on page 126.

WebFOCUS Managed Reporting Administrator's Manual 125


Inserting a Logo

For information on links, see Customizing the Banner on page 127.


Note: If you have selected a banner template that does not require a logo, your window
displays the title Links, rather than Logo & Links.
The following image shows the Logo & Links window containing the image filename text box
for displaying company logo with option buttons indicating a left, center or right position,
and an Available Links list box for adding links and a Selected Links list box to order the
links.

Reference: Logo Size


The following table provides information about the maximum height and width supported for
the logo in each template.

Look Template # Height (pixels) Width (pixels)

1 48 413

2 53 207

3 74 354

4 80 200

126 WebFOCUS
6. Customizing Dashboard

Look Template # Height (pixels) Width (pixels)

5 91 160

6 64 188

Procedure: How to Insert a Logo


1. From the View Builder, click Logo & Links. The Logo & Links window opens.
2. Enter the location of the image in the space provided or click Browse to search for the
image.
Note that the image must be a GIF, JPG, or BMP file.

3. Select the horizontal alignment for the logo image from the Left, Center, or Right option
buttons. The default is Center.
4. Select the vertical alignment for the logo image from the Top, Middle, or Bottom option
buttons. The default is Middle.
5. Click Preview.
6. Click Save to save changes.

Customizing the Banner


In this section:
Displaying a Welcome Message in the Banner
How to:
Add Links to the Banner
Remove Links From the Banner
Clear All Links From the Banner
Remove the Banner
Change the Banner Height

You can customize the links that display in the banner area for the public user and for Group
Views. You can also change the height of the banner, remove the banner, and display a
welcome message in the banner.

WebFOCUS Managed Reporting Administrator's Manual 127


Customizing the Banner

From the Logo & Links window in the View Builder, you can customize the display of all links
that are available to the public user and in Group Views. By default, the links available for
Group Views are Logoff, Accessibility, Tree, Tools, Recent, Favorites, Group Views, Utilities,
and Help.
When a user logs into Dashboard to their personal view (My View) all available links appear.
Note:
When creating a new Public View, by default all banner links in the Available Links list
are also in the Selected Links list. After creating a new Public View, you can change the
Selected Links by editing the Look for the view and navigating to the Logo & Links page
where you can remove any banner links that should not show in the Public View.
The Language link only displays if you have installed multiple languages.
If you have selected a banner template that does not require a logo, your window displays
the title Links, rather than Logo & Links.
The following image shows the Logo & Links window containing the image filename text box
for displaying company logo with option buttons indicating a left, center or right position,
and an Available Links list box for adding links and a Selected Links list box to order the
links.

128 WebFOCUS
6. Customizing Dashboard

Procedure: How to Add Links to the Banner


1. From the View Builder, click Logo & Links. The Logo & Links window opens.
2. Highlight the link you want to add in the Available Links list.
3. Click:
Add to add a link to the bottom of the Selected Links list.
Insert to insert a link above the highlighted position in the Selected Links list.
The order the links display in the Selected Links list is how they appear in Dashboard.
You can move the links using the up and down arrows between the Available Links and
Selected Links lists.

4. Click Preview.
5. Click Save to save changes.

Procedure: How to Remove Links From the Banner


1. From the View Builder, click Logo & Links. The Logo & Links window opens.
2. Highlight the link you want to remove from the Selected Links list.
3. Click Remove. The link is removed from the Selected Links list.
4. Click Preview.
5. Click Save to save changes.

Procedure: How to Clear All Links From the Banner


1. From the View Builder, click Logo & Links. The Logo & Links window opens.
2. Click Clear. All links in the Selected Links list clear, including the default Login link.
3. Click Preview.
4. Click Save to save changes.

Procedure: How to Remove the Banner


1. From the View Builder, click Composition.
2. Deselect the Check to use Banner check box.
3. Click Preview.
4. Click Save.

WebFOCUS Managed Reporting Administrator's Manual 129


Customizing the Banner

Procedure: How to Change the Banner Height


1. Open the profile.prf file for editing. This file is located in WebFOCUS76/worp/worp_html/
in one of the following folders:
worp0
worp1
worp2
worp3
worp4
worp5
worp6
worp7
The number of the folder depends on the template you have chosen. To determine the
number, hover your mouse over the template in the Look window. Alternatively, the
numbers are in order (0–7) from left to right starting with the top left template.

2. Edit the bannerHeight section of the file to the desired height. The number represents
the number of pixels for the banner height. The default value is 105.
Note: The banner height must be a minimum of 50 pixels in order to sufficiently display
the banner links. Some banner links, such as Help, have a drop-down menu associated
with them. If the banner height is too small, the drop-down menu will not display and
the functionality will not be available to the user.

3. Save and exit the profile.prf file.


4. Open the View Builder and select the Public or Group view that uses the banner.
5. Select the banner in the Look window for the change to be propagated to the user's
Dashboard view.

130 WebFOCUS
6. Customizing Dashboard

Displaying a Welcome Message in the Banner

How to:
Display a Welcome Message in the Banner of All Views
Display a Welcome Message in the Banner of Specific Views

A welcome message can be displayed in the left top corner of the banner, where the name
of the user logged into the view appears as “Welcome, user name”, as shown in the following
image.

The welcome message can be set to display globally in all views by editing a variable setting
in the bid-config.xml file or set to display in specific views using the Dashboard View Builder.
Note that the text in the welcome message inherits the same color used for the banner
links.

Procedure: How to Display a Welcome Message in the Banner of All Views


1. In the WebFOCUS76\worp\conf directory, open the bid-config.xml file in a text editor.
2. Edit the following variable to change it from:
<internal-var name="showBannerUserGreeting" value="false"/>
to
<internal-var name="showBannerUserGreeting" value="true"/>

Note: After making changes to the bid-config.xml file, use the WebFOCUS Console to clear
memory cache, or restart the application. Until this is done, the change is not effective.

Procedure: How to Display a Welcome Message in the Banner of Specific Views


1. Log on to the Dashboard View Builder.
2. Select a view.
3. Click Edit Settings.
4. Click the True option to the right of showBannerUserGreeting in the Settings pane.
5. Click Save Settings.

WebFOCUS Managed Reporting Administrator's Manual 131


Creating a Custom Toolbar

6. Click Close.
For more information about using the Edit Settings functionality in the Dashboard View
Builder, see Customizing Dashboard Pages for a Public or Group View on page 99.

Creating a Custom Toolbar


How to:
Create a Toolbox
Copy a Toolbox
Create a Toolbar

You can insert custom toolbars in Dashboard that can contain any type of link that the
Internet or intranet supports, such as Web sites, other tools, applications, and documents.
When a user clicks one of the links, a new browser window opens and displays the contents.
Toolbars can be placed in various positions in Dashboard and you can select different colors
for the toolbars so they fit in with your Dashboard look. For details on selecting colors, see
Selecting Custom Colors on page 115.
You can have up to two toolbars per Dashboard view. The number of items a toolbar can
contain is only limited by the display space. Toolbars do not scroll, but you can maximize
your space by positioning the toolbar appropriately (for example, a vertical toolbar can contain
more items than a horizontal toolbar in most cases).
Since toolbars are created from items in your toolbox(es), you must create a toolbox before
you create a toolbar. You can create as many toolboxes as you require and each toolbox
can contain an unlimited number of items.
Once a toolbox is created, it is available in all public and group views.

Procedure: How to Create a Toolbox


1. From the View Builder, click the Toolbox link.

132 WebFOCUS
6. Customizing Dashboard

The Toolbox window opens as shown in the following image.

2. Below the Select Toolbox list box, click Add.


The Explorer User Prompt dialog box opens.

3. Type a name for the toolbox in the Explorer User Prompt dialog box and click OK.
Note:
Toolbox names and link captions are limited to alphanumeric characters only.
Toolboxes are stored in the ibi\WebFOCUS\worp\conf directory with a .tbx file
extension. The file is given a default name based on the current date and time, so
every toolbox has a unique name. This does not effect the display name you type in
the Explorer User Prompt dialog box.

4. In the Link Caption field, type the name for the link. This is the text that displays in the
toolbar.
5. In the Link URL field, type the URL for the link in the format:
http://websitename
For example, http://www.informationbuilders.com.

6. Click Insert and the link is added to the Available Links list box.
7. Click Clear and repeat steps 4–6 to add additional items to the toolbox. The number of
items you can put in a toolbox is unlimited.
8. Click Save when you are finished.

Procedure: How to Copy a Toolbox


1. From the View Builder, click the Toolbox link.
The Toolbox window opens.

2. Highlight a toolbox from the Select Toolbox list and click Save As.
The Explorer User Prompt dialog box opens.

WebFOCUS Managed Reporting Administrator's Manual 133


Creating a Custom Toolbar

3. Type a name for the new toolbox in the Explorer User Prompt dialog box and click OK.
Note that toolbox names and link captions are limited to alphanumeric characters only.

4. Click Save when you are finished.

Procedure: How to Create a Toolbar


1. From the View Builder, select a view and click the Edit Look link.
The Look page opens.
2. Click the Toolbar link.
The Toolbar window opens as shown in the following image.

3. Select the Toolbar 1 or Toolbar 2 option.


4. Select the Check to use selected Toolbar check box.
5. Highlight a toolbox in the Select Toolbox list.
6. From the Available Links list, highlight a link and click Add.
7. Repeat steps 3 and 4 until your toolbar is complete.
8. Use the up and down arrows to the right of the Selected Links list box to position the
order of the selected links.
9. Select the toolbar position (top, bottom, left, or right) by clicking the appropriate image
at the bottom of the Toolbar window. (You may need to scroll down to view these images.)
10. Click Save when you are finished.

134 WebFOCUS
6. Customizing Dashboard

Adding a Message of the Day


How to:
Add a Message of the Day

You can add a message of the day that will display for public users and for authorized users.
You can display any text message up to 100 characters. By default, the message is included
in Dashboard. The message can be removed by deselecting the Check to use Message of
the Day check box.
You can change the message of the day outside of the View Builder by editing the
message.html file. This file is located in:
drive:\ibi\WebFOCUS76\worp\worp_custom\dirname\message.html
where:
dirname
Is public for the general public view. Otherwise it is the directory specified in the Public
Views or Group Views window.
Open this file in any HTML editor and update the message text, which is the <TD element
within the table.
The following image shows the Message of the Day window where you type the message in
a text box.

Procedure: How to Add a Message of the Day


1. From the View Builder, select a view and click the Message link.
The Message of the Day window opens.

2. Type the desired text in the Message field. The message can contain up to 100
characters.

WebFOCUS Managed Reporting Administrator's Manual 135


Customizing the Logoff Window

3. Click Preview to view the message in the preview area.


4. Click Save when you are finished.

Customizing the Logoff Window


How to:
Customize the Logoff Window for Specific Views
Customize the Logoff Window for All Views

When users log off from a view in Dashboard, they are redirected to the Welcome Page by
default. The logoff window can be customized to direct users to another page within
Dashboard or a Web page outside of Dashboard. For example, when a user clicks the Logoff
link in the Dashboard banner, you can have your company's Web site open. This functionality
can be set for specific views using the View Builder or set globally for all views by editing a
variable setting in the bidconfig.xml file.

Procedure: How to Customize the Logoff Window for Specific Views


Administrators and Group Administrators have the ability to redirect users of a specific public
or group view to a different URL upon logoff.
1. Log on to the Dashboard View Builder and select a view.
2. Click Edit Settings.
The View Settings dialog box opens.

3. Click the down arrow to the left of Redirects located in the lower left corner of the View
Settings dialog box.
The Redirects area of the dialog box appears.

4. Click the down arrow to the left of Redirect Summary.


5. Select context-redirect or x-redirect from the Redirect context type drop-down list, then
type the desired URL in the Redirect URL field.
The context-redirect option is the default setting and is used to add additional
segments to the default redirect URL to redirect a user to a different URL inside the
application context upon logoff. The default URL redirects a user to the Welcome
Page upon logoff, which is:
http://webserver[:port]/ibi_apps

136 WebFOCUS
6. Customizing Dashboard

For example, to redirect a user to the Group View login page for the aa_gbv group
view, select the context-redirect option and set the Redirect URL field to:
/bid/aa_gbv

The x-redirect option is used to redirect a user to a fully qualified URL outside the
application upon logoff. For example, to redirect a user to the IBI Web site upon
logoff, select the x-redirect option and set the Redirect URL field to:
http://www.informationbuilders.com
If the Redirect URL field is left blank, the user is redirected to the Welcome Page upon
logoff by default.

6. Click Save Settings, then click Close.

Procedure: How to Customize the Logoff Window for All Views


1. In the WebFOCUS76\worp\conf directory, open the bid-config.xml file in a text editor.
2. Search for the string "logoff-success" and then comment out the lines immediately
below it, beginning with "<context" and ending with "</context".
Add "<!-- to" begin the comment and "-->" to end the comment, as shown below.
<response-redirect request-context="logoff-success">
<!--
<context-redirect url="&REDIRECT;" hrefs-per-row="5">
<href src="&MPV;" text="mpvHREFTextShort" context-asset="true"
localize-text="true"/>
<href src="&GBV;" text="gbvHREFTextShort" context-asset="true"
localize-text="true"/>
<href src="&LOGIN;" text="loginHREFTextShort" context-asset="true"

localize-text="true"/>
<href src="&INDEX;" text="indexHREFTextShort" context-asset="true"

localize-text="true"/>
</context-redirect>
-->
</response-redirect>

3. Add the following line below the closing comment tag (-->):
<x-redirect url="my_url"/>
where:
my_url
Specifies the URL.

WebFOCUS Managed Reporting Administrator's Manual 137


Changing the ReportCaster Scheduling Tool

Your code should now look similar to this:


<response-redirect request-context="logoff-success">
<!--
<context-redirect url="&REDIRECT;" hrefs-per-row="5">
<href src="&MPV;" text="mpvHREFTextShort" context-asset="true"
localize-text="true"/>
<href src="&GBV;" text="gbvHREFTextShort" context-asset="true"
localize-text="true"/>
<href src="&LOGIN;" text="loginHREFTextShort" context-
asset="true" localize-text="true"/>
<href src="&INDEX;" text="indexHREFTextShort" context-
asset="true" localize-text="true"/>
</context-redirect>
-->
<x-redirect url="http://www.informationbuilders.com"/>
</response-redirect>
Here the URL is set to http://www.informationbuilders.com so when a user selects the
Logoff link in the banner, they are disconnected from Dashboard and the Information
Builders Web site opens.

4. Save and close the bid-config.xml file.

Changing the ReportCaster Scheduling Tool


How to:
Change the ReportCaster Scheduling Tool in All Views
Change the ReportCaster Scheduling Tool in Specific Views

When a Dashboard user selects the Schedule option for a selected report, the multi-page
ReportCaster Scheduling Wizard opens by default. The tool that opens with the Schedule
option can be changed to the ReportCaster single page Scheduler Tool, which provides all
scheduling fields and settings in one interface. The ReportCaster scheduling tool that opens
with the Schedule option can be changed globally in all views by editing a variable setting
in the bid-config.xml file or changed in specific views using the Dashboard View Builder. For
information about scheduling and distributing report output with Managed Reporting, see
the ReportCaster Development and Administration manual.

138 WebFOCUS
6. Customizing Dashboard

Procedure: How to Change the ReportCaster Scheduling Tool in All Views


To change the Schedule option for reports in all views to open the ReportCaster single page
Scheduler Tool, perform the following:
1. In the WebFOCUS76\worp\conf directory, open the bid-config.xml file in a text editor.
2. Edit the following variable to change it from:
<internal-var name="useNewScheduleURL" value="false"/>
to
<internal-var name="useNewScheduleURL" value="true"/>

Note: After making changes to the bid-config.xml file, use the WebFOCUS Console to clear
memory cache, or restart the application. Until this is done, the change is not effective.

Procedure: How to Change the ReportCaster Scheduling Tool in Specific Views


To change the Schedule option for reports in specific views to open the ReportCaster single
page Scheduler Tool, perform the following:
1. Log on to the Dashboard View Builder.
2. Select a view.
3. Click Edit Settings.
4. Click the True option to the right of useNewScheduleURL in the Settings pane.
5. Click Save Settings.
6. Click Close.
For more information about using the Edit Settings functionality in the Dashboard View
Builder, see Customizing Dashboard Pages for a Public or Group View on page 99.

Resetting the View Builder


You can reset the View Builder to the last saved version. When you click the Reset button,
the View Builder will revert to the last saved version, whether it is from the current session
or from a previous session.

Saving Selections and Exiting a Customization


After you have finished your Dashboard customizations and have previewed the Custom
Colors, Logo & Links, and Message of the Day, you can save your selections by clicking
Save in the View Builder.

WebFOCUS Managed Reporting Administrator's Manual 139


Exiting the View Builder

Note: Be sure you have clicked the Preview button in the Custom Colors, Logo & Links, and
Message windows before you click Save in the View Builder. The selections you have made
in these windows will not be saved if you have not clicked the Preview button in the respective
window.
To exit the customization, select the Public Views or Group Views link from the side menu.
You return to either the Public Views or the Group Views page.
If you click Public Views or Group Views before saving changes that were made in the Preview,
a prompt displays asking whether the changes should be saved. You can save the changes
by clicking OK, or discard the changes by clicking Cancel. These are only changes that have
been made since the last time the Save link was selected.

Exiting the View Builder


How to:
Exit the View Builder

When you log out of the View Builder, you are also logged out of Managed Reporting and
the WebFOCUS Reporting Server, and any set cookies are cleared.

Procedure: How to Exit the View Builder


1. If you are customizing a public view, click Public Views. If you are customizing a group
view, click Group Views.
Depending on which view you were customizing, the Public Views or Group Views window
opens.

2. Click Done.
The Dashboard index page opens and displays links to the Dashboard views and the
View Builder.

140 WebFOCUS
WebFOCUS

7 Creating a Role Tree

A Domain Tree contains all items in a


Topics:
domain including items from the
Reporting Objects, My Reports, and What Is a Role Tree?
Shared Reports folders. By contrast, Role
Trees are created for WebFOCUS Adding a Role Tree
Managed Reporting User Groups and Editing a Role Tree
contain some or selected items from the
domains to which the User Groups are
associated.

WebFOCUS Managed Reporting Administrator's Manual 141


What Is a Role Tree?

What Is a Role Tree?


Role Trees allow Dashboard users access to items such as reports, graphs, launch forms,
and URLs, that have been associated with their Managed Reporting User Groups. The
advantage of creating a Role Tree is that you can limit the items a user can access.
As shown in the following image, if a user belongs to the Century Corporation and Public
groups, they will only have access to the items in the Role Trees assigned to those groups.

Role Trees display in the same area of the Dashboard as the Domain Tree. For details on
managing the display of and positioning the Domain Tree and the Role Tree, see Customizing
Dashboard on page 105.
If you choose to display the Role Tree in a Dashboard view, you must create a Role Tree for
all groups that will use that view.

Adding a Role Tree


How to:
Add a Role Tree

You can create a Role Tree for any Managed Reporting User Group. To create a Role Tree,
select the:
User Group.
Domains. You can add items from more than one domain. Items are taken from the
Standard Reports folder of the respective domain.
Items (reports, graphs, launch pages, and URLs). Role Trees can only contain single
items; folders cannot be added.

142 WebFOCUS
7. Creating a Role Tree

The following image shows the Role Tree window containing the selection of Accounts as
the User Group, and Acme Manufacturing as the Domain.

Procedure: How to Add a Role Tree


1. From the View Builder, click Role Tree. The Role Tree window opens.
2. From the Group List, select a User Group.
3. From the Domain Tree, open a domain.
4. Expand the folders and click the items you want to add. Only items (reports, graphs,
launch forms, URLs) can be added to a Role Tree. Folders cannot be added.
5. To add items from another domain, select a different domain from the Domain Tree and
click Submit.
6. Expand the folders and click the items you want to add.
7. Repeat steps 5 and 6 as necessary.
8. Click Save when you have completed selecting items for the Role Tree for a particular
User Group.
9. Click Public Views or Group Views to return to the respective page. Click Done if you want
to exit the View Builder.

WebFOCUS Managed Reporting Administrator's Manual 143


Editing a Role Tree

Editing a Role Tree


How to:
Add Items to a Role Tree
Remove Items From a Role Tree
Clear Items From a Role Tree
Cancel Changes to a Role Tree

You can edit the Role Trees you have created for the User Groups by adding items, removing
items, or clearing all items. If you need to cancel the Role Tree you are creating, click Cancel
in the Role Tree window. The last saved Role Tree list opens.

Procedure: How to Add Items to a Role Tree


1. From the View Builder, click Role Tree. The Role Tree window opens.
2. From the Group List, select the User Group’s Role Tree to which you want to add items.
3. From the Domain Tree, open a domain.
4. Expand the folders and click the items you want to add. Only items (reports, graphs,
launch forms, URLs) can be added to a Role Tree. Folders cannot be added.
5. To add items from another domain, select the domain from the Domain Tree and click
Submit.
6. Expand the folders and click the items you want to add.
7. Repeat steps 5 and 6 as necessary.
8. Click Save when you have completed adding items to the Role Tree for a particular User
Group.
9. Click Public Views or Group Views to return to the respective page. Click Done if you want
to exit the View Builder.

Procedure: How to Remove Items From a Role Tree


1. From the View Builder, click Role Tree. The Role Tree window opens.
2. From the Group List, select the User Group’s Role Tree from which you want to remove
items.
3. In the Content List, click the item you want to remove. You can remove multiple items
by holding down the Shift or Control keys.

144 WebFOCUS
7. Creating a Role Tree

4. Click Remove.
5. Click Save when you have completed removing items from the Role Tree for a particular
User Group.
6. Click Public Views or Group Views to return to the respective page. Click Done if you want
to exit the View Builder.

Procedure: How to Clear Items From a Role Tree


1. From the View Builder, click Role Tree. The Role Tree window opens.
2. From the Group List, select the User Group’s Role Tree from which you want to clear all
items.
3. Click Clear. All items are removed from the Content List.
4. Click Save.
5. Click Public Views or Group Views to return to the respective page. Click Done if you want
to exit the View Builder.

Procedure: How to Cancel Changes to a Role Tree


From the Role Tree window, click Cancel. The Role Tree window remains open and displays
the last saved Role Tree list.

WebFOCUS Managed Reporting Administrator's Manual 145


Editing a Role Tree

146 WebFOCUS
WebFOCUS

8 Creating Dashboard Content

When opening Dashboard, content blocks


Topics:
display and contain launched reports,
hyperlinks to reports, hyperlinks to Creating Dashboard Content Overview
Internet resources, or output. The
following are the types of content blocks: Content Window

Launch blocks. Creating Content Pages

List blocks. Adding a Content Block

Folder blocks. Editing a Content Block

Output blocks. Creating Filters For Standard Reports

Watch list blocks. Executing a Domain Profile in


Dashboard
Selecting Content Layout

WebFOCUS Managed Reporting Administrator's Manual 147


Creating Dashboard Content Overview

Creating Dashboard Content Overview


When creating a content block, select the block type, the block contents, and the block
layout, and for administrators, the public or group view to which the block is associated.
The content blocks you create from the Public Views page are the blocks available to the
public user. The public user has limited access to Dashboard. For details, see Customizing
Dashboard Pages for a Public or Group View on page 99. Content blocks created from the
Group Views page only display to members of that group.
When accessing Dashboard, an authenticated user is able to add, edit, and remove content
blocks from their personal view using the personalize feature.
You can create content pages in order to increase content space, organize Dashboard
content, and add pages that display the ReportCaster, Report Library, Watch List, or Deferred
Status user interfaces. For details, see Creating Content Pages on page 150.

Content Window
How to:
Open the Content Window
Exit the Content Window

From the Content window, you create the content blocks that appear in a public or group
view when Dashboard opens. You can:
Create content pages that contain content blocks, or the ReportCaster, Report Library,
or Deferred Status user interfaces.
Add, remove, and edit content blocks.
Select the content layout.
When you open the Content window, a list of the current content blocks appears. When you
place your cursor over a content item, the full path of the procedure appears, including the
domain name and folder name.
Access the Content window from the Public Views or Group Views window.

148 WebFOCUS
8. Creating Dashboard Content

The following image shows a sample administrator’s Content window with three distinct
panes. The first two sections contain a description text box and buttons to add and create
content pages, and the third section contains buttons for adding, editing, or removing content
blocks.

Procedure: How to Open the Content Window


1. Type the following URL in your Web browser:
http://hostname[:port]/wf_context_root/bid
where:
hostname[:port]
Is the host name and optional port number (specified only if you are not using the
default port number) where the WebFOCUS Web application is deployed.
wf_context_root
Is the site-customized context root for the WebFOCUS Web application deployed on
your Application Server. The default value is ibi_apps.
The WebFOCUS Business Intelligence Dashboard Index page opens.

WebFOCUS Managed Reporting Administrator's Manual 149


Creating Content Pages

Alternatively, you can type:


http://hostname[:port]/wf_context_root/bid/vblogin
to directly access the View Builder Login page (bypassing the Index page).

2. Click WebFOCUS BI Dashboard View Builder Login Page to open the View Builder Login
page.
If you used the alternative method to directly access the Login page, skip this step.

3. Enter your user ID and password.


4. Click Submit to open the Public Views window.
If you want to view the Group Views window, click Group Views.

5. Select the check box next to the public or group view to which you want to add content.
6. Click Edit Content to open the Content window.

Procedure: How to Exit the Content Window


For administrators, you exit the Content window by clicking Public Views or Group Views.
Your changes are saved and you return to the Public Views or Group Views window.

Creating Content Pages


In this section:
Creating Library Content for a Public View
How to:
Create Content Pages

You can create content pages for Dashboard that contain content blocks, and the
ReportCaster, Report Library, Watch List, or Deferred Status user interfaces. Adding the
ReportCaster, Report Library, Watch List, or Deferred Status interfaces to a content page is
different than accessing them from banner hyperlinks, which open a new browser window
when the hyperlink is clicked. Each interface appears in its own content page directly in the
Dashboard.
You can add content pages for the ReportCaster, Report Library, Watch List, and the Deferred
Status interfaces to a Public view for authenticated users. When an authenticated user
inherits the Public View as their My View, they will see this content; this content is hidden
from Public Users.

150 WebFOCUS
8. Creating Dashboard Content

Content pages appear as tabs that display the name of the content page across the top of
the content area. Pages can be viewed by clicking the appropriate tab.
Using content pages enables you to:
Expand the amount of space you have to display content in Dashboard.
Organize Dashboard content.
Keep the default view that was set up by the Dashboard Administrator while simultaneously
create personalized content pages.
Content pages are optional. If you have only one content page, tabs do not appear in the
actual Dashboard view when you add content blocks.
Users can create as many content pages as they need and design the page layout.
Administrators can also customize the color of content page tabs (background and text
color). For details, see Selecting Content Layout on page 167 and Customizing Dashboard on
page 105.
When creating content pages, note that:
You can rearrange the order of the pages using the Move Left, Move Right, and Set
Default buttons in the Content window. The Set Default button promotes the current page
to the first page.
Only one output block is allowed per page.
When Dashboard opens, only the reports on the current content page execute. All other
reports execute when you click the respective content page tab.
Reports on content pages do not automatically refresh when tabbing from one page to
another. To refresh a report, click the Refresh button in the toolbar for that report.

Procedure: How to Create Content Pages


Note: When creating a content page, wait until all page items appear before using the
buttons on the page. If an error occurs due to premature use of the buttons, refresh the
page using your browser's Refresh button.
1. Select the Personalize link in the banner, then select Content from the submenu that
appears.
The Content window opens.

2. From the Content window, click:


Add Page to add a page that contains content blocks.

WebFOCUS Managed Reporting Administrator's Manual 151


Creating Content Pages

Add Library Page to add a page that contains the Report Library user interface. You
can also add the Watch List interface after adding a library page.
Add Schedules Page to add a page that contains the ReportCaster user interface.
Add Deferred Status Page to add a page that contains the Deferred Status user
interface.
Note: When creating a Public View, the Add Library, Schedules and Deferred Status
buttons are available. However, these pages are not displayed on the Public page if they
are included in the Public View. They will show for any user who inherits the Public view
as their My View when they log in to Dashboard.
Additionally, users who do not have access to Report Caster or Report Library will not
be able to view the Library or Schedule pages. The Library Page will display in Public
Views if the Public User has been given Library privileges.

3. Enter the tab name in the Page Description text box.


4. Click Update.
When a page is added, it is added as the last page. You can rearrange the order of the
content pages using the Move Left, Move Right, or Set Default buttons. The Set Default
button promotes the current page to the first page.

Creating Library Content for a Public View


When creating content for a public view, the Administrator can add a Library page to the
View. Clicking the Add Library Page button in the View Builder adds the Library tab, as shown
in the following image.

When adding a content block, the Administrator can select content from the Library to be
placed in a launch, list, output, or watch list block. An additional tab, labeled Library, is
available when adding or editing a content block that allows the Administrator to view Library
content available to the public user and select it to be added to a public view.

152 WebFOCUS
8. Creating Dashboard Content

The following image shows the Library tab that provides access to Library content.

Adding a Content Block


In this section:
Creating a Locked Content Block
Adding Report Library Content to a Content Block
Removing a Content Block
How to:
Add a Content Block
Add Items to a Content Block Using Domain Search
Display a Collapsible Tree in the Folder Blocks of All Views
Display a Collapsible Tree in the Folder Blocks of Specific Views

From the Add Block window, you can create content blocks that the public or group users
see when opening Dashboard.

WebFOCUS Managed Reporting Administrator's Manual 153


Adding a Content Block

The following are the types of content blocks you can create:
Launch blocks can contain only one item. When Dashboard opens, the item automatically
launches.
A launch block that is created to display a report in EXL2K, EXCEL, or DOC formats should
use scroll bars instead of scroll buttons.
List blocks can contain many items from one or many domains. The items can be from
any folder in any domain to which a user has access. Users can run a report or access
an Internet resource by clicking a hyperlink from the list.
Folder blocks list the entire contents of a folder (including its subfolders) that have
been created in Managed Reporting. Only one folder can be added to a folder block.
When the contents of a Managed Reporting folder are modified outside of Dashboard,
the folder block in Dashboard automatically updates to reflect any changes. You can add
folders from the Standard Reports, My Reports, and Shared Reports folders. For a public
view, you can only add folders from the Standard Reports folder.
By default, all subfolders in a folder block are expanded and cannot be collapsed.
Optionally, all subfolders can be displayed as a collapsible tree and expanded as needed.
This functionality can be set globally for all views by editing a variable setting in the bid-
config.xml file or set for specific views using the Dashboard View Builder. For details,
see How to Display a Collapsible Tree in the Folder Blocks of All Views on page 157 or How
to Display a Collapsible Tree in the Folder Blocks of Specific Views on page 158.
Output blocks may or may not contain default content. They are blocks where reports,
graphs, or Web pages appear. When a report is run or an Internet resource is accessed,
the report output or Web page appears in the output block. This is useful because a new
browser window does not open each time a report or graph is executed, or a Web page
is launched from a Domain Tree, Role Tree, List, or Folder block. Instead, the output
block refreshes with the new content.
When you create an output block, scrolling options are not available. Scroll bars appear
when necessary.
Tree blocks provide a way to add a Domain Tree to a Public or Group View page. The
Domain Tree is displayed without the sidebar frame.
Watch list blocks add the Report Library Watch List interface to a page. The watch list
block type is available only when the Library tab is selected from the Add Block page.
Note: Some Web sites bring their page to the top of a frameset when launched and take
over the browser session. When these sites are opened in a launch or output block,
Dashboard content is lost. It is recommended that these types of Web sites not be selected
for a launch or output block.

154 WebFOCUS
8. Creating Dashboard Content

When you add items to a content block, you can use the Domain Search from the Add Block
and Edit Block windows. For details, see How to Add Items to a Content Block Using Domain
Search on page 157.
Across the top of the Add Block window is a drop-down menu for selecting a domain, a
Domain Search button, and option buttons to select from Launch, List, Folder, Output, or
Tree for the Block Type. At the left side of the window is a tree view of the selected domain.
The right side of the window contains the Content List showing selected items with up and
down arrows to the right, and Remove and Clear buttons at the bottom.
Below the Content List is a text box for entering the Block Name and a series of check boxes
that are available to enable the following functionality:
Deactivate Block
Lock Block (available to administrators only)
Hide Block Toolbar
MS Office output options
Automatic Block Refresh (available to administrators only)

WebFOCUS Managed Reporting Administrator's Manual 155


Adding a Content Block

There are also option buttons to enable Scroll Buttons or Scroll Bars, and Save and Cancel
buttons. The following image shows the Add Block window.

Procedure: How to Add a Content Block


1. From the Content window, select the content page in which to add content. If you need
to add content pages, see How to Create Content Pages on page 151.
2. Click Add Block. The Add Block window opens.
3. Select the Launch block, List block, Folder block, Output block, or Tree block option
button.
4. Select a domain from the drop-down list. You can also add items to a content block
using Domain Search. See How to Add Items to a Content Block Using Domain Search
on page 157.
Note: If you are creating an Output block, adding domain items is optional since Output
blocks do not require default output.

5. Click Submit to retrieve the contents of the selected domain.

156 WebFOCUS
8. Creating Dashboard Content

6. Expand the domain folders you want to select items from by clicking the plus sign (+)
located next to the folder icon.
Note: Only one report in EXL2K PIVOT format can be active at a time. Therefore, it is
not recommended to place output of this format type into a content block. Subsequent
attempts to execute a report in this format will fail, since the original report will still be
active.

7. Click the items in the domain folders to populate the Content List.
If you are creating a List block you can position the items using the arrows next to the
Content List.

8. Accept the default Block name or change the name in the Block name text box.
Note:
If you name your content block before you select content, the block name may be
overwritten with the name of the Domain item you select. You can change the name
after selecting content.
If you create an empty launch, list, or folder block and enter a Block name, when you
click Save the name is overwritten with Empty Block. This occurs only with launch,
list, and folder blocks. Output blocks retain the name you enter.

9. Select the Enable Scroll Buttons or Enable Scroll Bar option button.
10. Click Save when you have finished selecting the content for your block.

Procedure: How to Add Items to a Content Block Using Domain Search


1. From the Add Block or Edit Block window, click Domain Search.
2. Enter the criteria for your search and then click Search.
3. From the results on the right side of the window, click on an item to add it to your content
block. View your content block to see the items you have added.

Procedure: How to Display a Collapsible Tree in the Folder Blocks of All Views
1. Open the bid-config.xml file in a text editor. For example:
C:\ibi\WebFOCUS76\worp\conf\bid-config.xml

WebFOCUS Managed Reporting Administrator's Manual 157


Adding a Content Block

2. Edit the following variable to change it from:


<internal-var name="showFolderBlockAsCollapsibleTree" value="false"/>
to
<internal-var name="showFolderBlockAsCollapsibleTree" value="true"/>

Note: After making changes to the bid-config.xml file, use the WebFOCUS Console to clear
memory cache, or restart the application. Until this is done, the change is not effective.

Procedure: How to Display a Collapsible Tree in the Folder Blocks of Specific Views
1. Log on to the Dashboard View Builder.
2. Select a view.
3. Click Edit Settings.
4. Click the True option to the right of showFolderBlockAsCollapsibleTree in the Settings
pane.
5. Click Save Settings.
6. Click Close.
For more information about using the Edit Settings functionality in the Dashboard View
Builder, see Customizing Dashboard Pages for a Public or Group View on page 99.

Creating a Locked Content Block

How to:
Create a Locked Content Block

You can create a content block for a Public View that cannot be edited or deleted by a user
after they create their personal view from the Public View.
In a user's personal view, the Edit option is not available for locked content blocks. In
addition, the option to delete or edit locked blocks from the Content window is not available.
A Dashboard user cannot remove a page containing a locked block.
The locked block is designated with a lock icon in the View Builder, Personalize content, and
Manage Users sections of Dashboard. Users receive an error message if they attempt to
remove a content page that contains a locked block.
The Lock Block check box is also available in the Manage Users area of the View Builder.

158 WebFOCUS
8. Creating Dashboard Content

Procedure: How to Create a Locked Content Block


1. From the Public Views or the Manage Users window, select the Public View you want to
add content to and click Edit Content.
2. From the Content window, select the content page in which to add content.
3. Click Add Block. The Add Block window opens.
4. Select the block type and contents.
5. Click the Lock Block check box.
6. Click Save.

Adding Report Library Content to a Content Block


Dashboard administrators and authenticated users can place Report Library content in a
content block using the View Builder or Personalize option. You can add Report Library
content to a launch, list, output, or watch list block. The latest available version of the report
always appears in the content block.
A tree of Library reports is available for selection when creating content blocks. The tree
consists of the top level domain or category. Below the domain or category is the report. In
the case of a bursted report, an intermediate level also appears.
The Report Library has two sets of reports. Dashboard can access both, the domain for
Managed Reporting users and the category for non-Managed Reporting users.
Note:
If you are adding Report Library content from the Manage Users or Group Views areas in
the View Builder, you also need to be a ReportCaster administrator.
To view Report Library content, you must have Report Library access.

Removing a Content Block

How to:
Remove a Content Block

From the Content window, you can remove a content block. Note that you can remove more
than one content block at a time.

Procedure: How to Remove a Content Block


1. From the Content window, select the content page where the content block is located.
2. Click the check box(es) next to the block(s) you want to remove.

WebFOCUS Managed Reporting Administrator's Manual 159


Editing a Content Block

3. Click Remove. An alert window appears to confirm the removal.


4. Click OK.

Editing a Content Block


In this section:
Enabling Automatic Block Refresh
Selecting Scrolling Options
Hiding the Toolbar in a Content Block
How to:
Change the Content Block Type
Remove Items From a Block
Change the Block Contents
Change the Name of a Content Block
Temporarily Remove a Content Block

From the Edit Block window, you can edit existing content blocks. When you select the edit
option, the name of the content block and its attributes appear in the Edit Block window.
You can edit the block type, block contents, block name, scrolling options, and several
optional features.
You can also deactivate a content block. This is useful when you want to temporarily remove
a content block from a Dashboard view. When a content block is deactivated, it is designated
in the Content window with a red icon. Green designates an active content block.
Across the top of the Edit Block window is a drop-down menu for selecting a domain, a
Domain Search button, and option buttons to select from Launch, List, Folder, Output, or
Tree for the Block Type. At the left side of the window is a tree view of the selected domain.
The right side of the window contains the Content List showing selected items with up and
down arrows to the right, and Remove and Clear buttons at the bottom.
Below the Content List is a text box for entering the Block Name and a series of check boxes
that are available to enable the following functionality:
Deactivate Block
Lock Block (available to administrators only)
Hide Block Toolbar
MS Office output options

160 WebFOCUS
8. Creating Dashboard Content

Automatic Block Refresh (available to administrators only)


There are also option buttons to enable Scroll Buttons or Scroll Bars, and Save and Cancel
buttons. The following image shows the Edit Block window.

Procedure: How to Change the Content Block Type


Note: When you change the content block type, all of the items in the block are removed
and the block name clears.
1. From the Content window, select the content page where the content block is located.
2. Click the check box next to the block you want to edit.
3. Click Edit Block. The Edit Block window opens.
4. Select the block type option button.
5. Click Save.

Procedure: How to Remove Items From a Block


1. From the Content window, select the content page where the block is located.

WebFOCUS Managed Reporting Administrator's Manual 161


Editing a Content Block

2. Click the check box next to the list block you want to edit.
3. Click Edit Block. The Edit Block window opens.
4. In the Content List highlight the item you want to remove.
5. Click Remove.
6. Click Save.

Procedure: How to Change the Block Contents


1. From the Content window, select the content page where the block is located.
2. Click the check box next to the block you want to edit.
3. Click Edit Block. The Edit Block window opens.
4. Select a domain from the drop-down list and click Submit.
You can also add items to a content block using Domain Search. For details, see How
to Add Items to a Content Block Using Domain Search on page 157.

5. Navigate to the item you want to add in the Domain Tree.


6. Click the item or folder to add it to the Content List.
Note: The block name may be overwritten with the name of the Domain item you select.
You can change the block name after selecting content.

7. Click Save.

Procedure: How to Change the Name of a Content Block


1. From the Content window, select the content page where the content block is located.
2. Click the check box next to the block you want to edit.
3. Click Edit Block. The Edit Block window opens.
4. In the Block name text box, type the new name for the block. This must be a unique
name within Dashboard.
5. Click Save.

Procedure: How to Temporarily Remove a Content Block


1. From the Content window, select the content page where the content block is located.
2. Click the check box next to the block you want to edit.
3. Click Edit Block. The Edit Block window opens.

162 WebFOCUS
8. Creating Dashboard Content

4. Select the Deactivate Block check box.


5. Click Save.

Enabling Automatic Block Refresh

How to:
Change the Default Minimum Refresh Value
Disable Automatic Block Refresh for All Views

Administrators can enable automatic block refresh functionality on a per block basis to
provide users with the option of setting a time interval (in seconds) when content blocks are
automatically refreshed. The Automatic Block Refresh check box is displayed to administrators
on the Edit Block and Add Block pages for all block types, and is hidden to users who are
editing content for their personal views. Note that users who log in for the first time to their
personal views, from a view that contains a block enabled for refresh, will inherit automatic
block refresh functionality from that view.
The following image shows the Automatic Block Refresh check box selected for the Human
Resources Main View content block.

Note: Selecting the Hide Block Toolbar check box disables Automatic Block Refresh
functionality for the selected block.

WebFOCUS Managed Reporting Administrator's Manual 163


Editing a Content Block

When automatic block refresh functionality is enabled for a content block, a Refresh check
box and refresh time interval field are displayed in the block toolbar. The Refresh check box
is unselected by default every time a user logs in to the view. Users have the option to set
automatic block refresh by entering a refresh value in seconds (or using the default value)
and then selecting the Refresh check box, as shown in the following image:

The minimum refresh value is set to 30 (seconds) by default. The default minimum refresh
value can be changed by editing the bid-config.xml file. For details, see How to Change the
Default Minimum Refresh Value on page 164.
If a user enters a non-integer value or a value less than the minimum refresh value, an
appropriate error message is generated. When a user selects the Refresh check box, the
refresh time interval field is disabled, which prevents the value from being changed.
Deselecting the Refresh check box enables the refresh time interval field again.

Procedure: How to Change the Default Minimum Refresh Value


You can change the default minimum refresh value that appears in the block toolbar for all
content blocks that have automatic block refresh functionality enabled. Users will not be
able to set a refresh time interval value that is less than the default minimum value.
1. Open the bid-config.xml file in a text editor. For example:
C:\ibi\WebFOCUS76\worp\conf\bid-config.xml

2. Edit the following variable to change the minimum refresh value, which is set to 30
(seconds) by default:
<internal-var name="autoReloadMinInterval" value="30"/>

164 WebFOCUS
8. Creating Dashboard Content

The autoReloadMinInterval value must be an integer value that represents the minimum
number of seconds when content blocks can be set to automatically refresh. For example,
to set the default minimum refresh value to 2 minutes, enter 120 for the value of this
variable.

Procedure: How to Disable Automatic Block Refresh for All Views


Automatic Block Refresh functionality can only be enabled by administrators on the Edit
Block and Add Block pages for all block types. If your organization wants to disable this
functionality for all views, perform the following.
Note: The Automatic Block Refresh check box will still be visible to administrators, but not
selectable.
1. Open the bid-config.xml file in a text editor. For example:
C:\ibi\WebFOCUS76\worp\conf\bid-config.xml

2. Edit the allowAutoReload variable and set the value to false, as shown in the following
code:
<internal-var name="allowAutoReload" value="false"/>

Note: After making changes to the bid-config.xml file, use the WebFOCUS Console to clear
memory cache, or restart the application. Until this is done, the change is not effective.

Selecting Scrolling Options

How to:
Select Scrolling Options for a Content Block

You can select either scroll buttons or scroll bars for launch blocks, list blocks, and folder
blocks. Scroll buttons cannot be selected for output blocks and launch blocks that launch
Web pages. Output blocks automatically contain scroll bars when necessary.
When scroll buttons are enabled, up, down, left, and right arrows display in the toolbar
allowing you to navigate the content block. Up and down arrows display for all content block
types. Left and right arrows only display for launch blocks. In folder blocks and list blocks
information automatically wraps, therefore eliminating the need to scroll to the left or right.
When scroll bars are enabled, scroll bars display when content exists that cannot be viewed
within the displayed window. When this option is selected, scroll buttons do not display in
the toolbar.
Note: A launch block that is created to display a report in EXL2K, EXCEL, or DOC formats
should use scroll bars instead of scroll buttons.

WebFOCUS Managed Reporting Administrator's Manual 165


Editing a Content Block

Procedure: How to Select Scrolling Options for a Content Block


1. From the Content window, select the content block you want to add scrolling options for
and click Edit Block. The Edit Block window opens.
2. Select the Enable Scroll Buttons or Enable Scroll Bars option button.
3. Click Save.

Hiding the Toolbar in a Content Block

How to:
Hide the Toolbar in a Content Block

When you hide the content block toolbar, automatic block refresh functionality is not available.
Additionally, scrolling is automatically set to use scroll bars because scroll buttons are not
available when the block toolbar is hidden.

Procedure: How to Hide the Toolbar in a Content Block


1. From the Add Block or Edit Block window, select the Hide Block Toolbar check box.

Note: The Lock Block and Automatic Block Refresh check boxes are available to
administrators only.

166 WebFOCUS
8. Creating Dashboard Content

2. Click Save.

Creating Filters For Standard Reports


Filters allow users to apply pre-defined criteria to a report at the time of execution. Filters
are created by a Developer or Administrator when the report is built. These types of reports
are created as Reporting Objects and given the property "Show as Standard Report" so a
Dashboard user can view the report in their Domain Tree.
For details on creating filters, see the WebFOCUS Managed Reporting Developer's Manual.
For details on using filters in Dashboard, see the WebFOCUS Managed Reporting End User's
Manual.

Executing a Domain Profile in Dashboard


Every time a user opens a domain in the Domain Tree, a domain profile executes. The domain
profile can display an HTML page or the results of a WebFOCUS procedure prior to entering
a domain.
You create a domain profile by either writing a WebFOCUS procedure (.fex) or defining an
HTML page (.htm). For example, you can write a WebFOCUS procedure that displays a report
or defines an HTML page that displays company information each time a user opens a
particular domain. The profile is not run each time a user submits a request to the WebFOCUS
Reporting Server.
For complete details on domain profiles, see the WebFOCUS Managed Reporting Developer's
Manual.

Selecting Content Layout


How to:
Add a Column
Adjust Column Width

By default, content blocks are displayed in one column in Dashboard. From the Layout
window, you can change the content block layout. You can select a different layout for each
content page. When selecting the layout for your content page, you can:
Add/remove columns.
Specify column width.
Rearrange column order.

WebFOCUS Managed Reporting Administrator's Manual 167


Selecting Content Layout

The following image shows a sample Layout window. There are list boxes for the contents
of Column 1 and Column 2 with up/down and right/left arrows. The Column 1 list box includes
a text box and plus (+) and minus (-) controls to adjust column width. There are buttons to
Add Column, Remove Column, Move Column Left and Move Column Right, as well a Content
button to return to the Content window.

Note: If you remove all content blocks from a column, the column is not automatically
removed from the Dashboard View. If there are no content blocks in a column, empty
space is shown in the Dashboard View.

Procedure: How to Add a Column


1. From the Content window, select a content page and then click Page Layout.
2. Click Add Column. To move:
Items from one column to another, highlight the item and use the left and right arrows
between the columns.
The position of a column, select the column and click Move Column Left or Move
Column Right.

3. Click Content to return to the Content window.

168 WebFOCUS
8. Creating Dashboard Content

Procedure: How to Adjust Column Width


1. From the Content window, select a content page and click Page Layout.
2. Click the plus (+) or minus (-) signs in the column to adjust column width.
Note that you cannot adjust the width for the last column. Since column width total must
equal 100%, the last column is always the remainder of all the other columns. For
example, if you have 3 columns and column 1 is 50% and column 2 is 25%, column 3
is 25%.
Note: If you make your content blocks too small, the popup menu may not fully display.

3. Click Content to return to the Content window.

WebFOCUS Managed Reporting Administrator's Manual 169


Selecting Content Layout

170 WebFOCUS
WebFOCUS

9 Managed Reporting Extract Utility

The Managed Reporting Extract utility


Topics:
allows you to extract data from your
Managed Reporting Repository in order Managed Reporting Extract Utility
to generate reports about users, groups,
domains, and domain content. Running the Managed Reporting
Extract Utility
Note: You can now also extract
metadata remotely using the Change Managed Reporting Extract Utility
Management interface. For details, see Output Files
Change Management on page 189.
Master Files and Sample Procedure
Reporting From Extract Files
Property Flags

WebFOCUS Managed Reporting Administrator's Manual 171


Managed Reporting Extract Utility

Managed Reporting Extract Utility


You can extract and process the following types of information from the Managed Reporting
Repository using the Managed Reporting Extract utility:
User information and the groups to which they belong.
Role information.
Group information and the domains to which they are associated.
Domain information.
Domain content information.
The Managed Reporting Extract utility is based on the Managed Reporting Java API. The
source code for this utility is available on demand through Information Builders' Customer
Support. It can be helpful to evaluate how the Managed Reporting API can be used.

Running the Managed Reporting Extract Utility


How to:
Run the Managed Reporting Extract Utility
Call IBIExtractRepos Programmatically

The Managed Reporting Extract utility is run on the machine where WebFOCUS is installed.
You can use Telnet or another form of remote access to execute the utility when it is not
possible to physically be at the WebFOCUS machine. For convenience, a batch file is provided
to call the utility with standard arguments.
Note: If you are using the Realm Driver to authenticate to another directory, you need to
modify the batch file (mrextract.bat) so that the classpath includes the necessary .jar files.

Procedure: How to Run the Managed Reporting Extract Utility


1. Navigate to the WebFOCUS76/utilities directory.
2. Execute the mrextract.bat file (Windows systems) or mrextract file (UNIX systems).

172 WebFOCUS
9. Managed Reporting Extract Utility

A series of messages appear:


-----------------------------------------------
Managed Reporting Repository Extract Utility
WebFOCUS Release 7
-----------------------------------------------
Extracting MR User Data...
Extracting MR Role Data...
Extracting MR Group Data...
Extracting MR Domain Data...
Extracting MR Domain Content Data...
Finished.
Press any key to continue . . .
The utility creates the output files in the WebFOCUS76/utilities directory. For information
about the format of these files, see Managed Reporting Extract Utility Output Files on
page 174. For information about reporting from these files with WebFOCUS, see Reporting
From Extract Files on page 182.

Syntax: How to Call IBIExtractRepos Programmatically


The underlying program that extracts information from the Managed Reporting Repository is
written in Java and is contained in the archive WebFOCUS76/utilities/IBIExtractRepos.jar.
You call the program by using the following arguments
java –cp archivepath ibi.util.IBIExtractRepos configpath option [option]
> outputfile
where:
archivepath
Is the full or relative path to the IBIExtractRepos.jar file and a number of other supporting
jar files, depending on your configuration. For details, please review the contents of
mrextract.bat (mrextract on UNIX) in the WebFOCUS76\utilities directory.
configpath
Is the full or relative path to the directory containing the WebFOCUS Web application's
deployment descriptor web.xml (for example,
d:\ibi\WebFOCUS76\webapps\webfocus76\WEB-INF). From this file, the value of
webfocus_client_root is read and used to determine the location of the WebFOCUS script
files.
option
Program options include [-users] [-roles] [-groups] [-domains] [-domaincontent].
>
Redirects the utility's output to a file.

WebFOCUS Managed Reporting Administrator's Manual 173


Managed Reporting Extract Utility Output Files

outputfile
The name of the output file.
You can tailor the extract utility for your own purposes.

Managed Reporting Extract Utility Output Files


Output files extracted by the Managed Reporting Extract utility contain comma-delimited
information.

Example: Extracting User Information


When you generate an output file for user information, the data is written in the following
format:
"user_htm","mr_id","user_properties","user_description","group_href"
One line is generated in the output file for each group to which the user belongs. For example,
"wfuser.htm","wfuser","active,htmluser,","user descript.","#default"
"abcuser2.htm","abcuser2","active","ABC User 2 Desc","#abccommongro"
"abcuser2.htm","abcuser2","active","ABC User 2 Desc","#abcgroup2"
"abcuser1.htm","abcuser1","active","ABC User 1 Desc","#abccommongro"
"abcuser1.htm","abcuser1","active","ABC User 1 Desc","#abcgroup1"
"verylong.htm","verylongusernameindeed","active","jim
smith","#abccommongro"
"admin.htm","admin","admin,robot,robot,shared,sync","default
user","#default"
"phil.htm","phil","active,shared,robot","phil","#default"
"phil.htm","phil","active,shared,robot","phil","#verylonggrou"
"javauser.htm","javauser","active,robot,shared","javauser","#default"
"javauser.htm","javauser","active,robot,shared","javauser","#verylonggrou
"

Example: Extracting Group Information


When you generate an output file for group information, the data is written in the following
format:
"group_href","group_description","domain_htm"

174 WebFOCUS
9. Managed Reporting Extract Utility

For example,
"#verylonggrou","verylonggroup name indeed","untitled/untitled.htm"
"#verylonggrou","verylonggroup name indeed","a77q8wik/a77q8wik.htm"
"#verylonggrou","verylonggroup name indeed","jimv0o1e/jimv0o1e.htm"
"#abccommongro","ABC Common Group","abccommo/abccommo.htm"
"#default","default group","untitled/untitled.htm"
"#abcgroup2","ABC Group 2","a77q8wik/a77q8wik.htm"
"#abcgroup2","ABC Group 2","db5cwlin/db5cwlin.htm"
"#abcgroup1","ABC Group 1","abcdomai/abcdomai.htm"
"#mrgroup2","MR Group 2","samplere/samplere.htm"
"#mrgroup1","MR Group 1","salesrep/salesrep.htm"

Example: Extracting Domain Information


When you generate an output file for domain information, the data is written in the following
format:
"domain_htm","domain_properties","domain_description"
For example,
"jimssumm/jimssumm.htm","disabled","Jim's Summit Domain"
"untitled/untitled.htm","none","zzManagement Reporting (Development
Area)"
"db5cwlin/db5cwlin.htm","none","ABC Domain 2"
"samplere/samplere.htm","none","zzSales Reporting (Development Area)"
"philipse/philipse.htm","none","Company Reporting"
"abccommo/abccommo.htm","none","ABC Common Domain"
"a77q8wik/a77q8wik.htm","none","ABC Domain 2 (test)"
"salesrep/salesrep.htm","none","Sales Reporting"
"jimv0o1e/jimv0o1e.htm","","jim"
"abcdomai/abcdomai.htm","none","ABC Domain 1"

Example: Extracting Domain Content Information


When you generate an output file for domain content information, the data is written in the
following format:
"domain_htm","record_type","record_subtype","item_href","item_description",
"item_flags","item_folder"
Note:
The record_type indicates the type of item found. Possible values are: HELP, PROFILE,
OTHER (Others Files), STDRPT (Standard Report), or RPTOBJ (Reporting Object).
The record_subtype indicates the type of Standard Report or Reporting Object item found.
Possible values are: ITEM or FOLDER. If the type is not ITEM or FOLDER, record_subtype
is empty.

WebFOCUS Managed Reporting Administrator's Manual 175


Master Files and Sample Procedure

The item_href is the item's reference. This is prefixed with the following characters
depending on its type:
#foldername when the item is a folder.

app/standardreportname.fex when the item is a Standard Report.

mrv/reportingobjectname.fex when the item is a Reporting Object.

For example,
"domain01/domain01.htm","HELP","","app/help.htm","Help","",""
"domain01/domain01.htm","STDRPT","FOLDER","#dailyreports","Daily
Reports","belongsto=#salesreports","#salesreports"
"domain01/domain01.htm","STDRPT","ITEM","app/salestra.fex","Sales
Transactions","node=UNIXSRV8E,appname=salesdtl","#dailyreports"
"domain01/domain01.htm","STDRPT","FOLDER","#salesreports","Sales
Reports","none",""
"domain01/domain01.htm","STDRPT","FOLDER","#weeklyreport","Weekly
Reports","belongsto=#salesreports","#salesreports"
"domain01/domain01.htm","STDRPT","ITEM","app/salesana.fex","Sales
Analysis","runasolap","#weeklyreport"
"domain01/domain01.htm","STDRPT","ITEM","app/salesbyb.fex","Sales by
Branch","none","#weeklyreport"
"domain01/domain01.htm","RPTOBJ","FOLDER","#salesdatau5t","Sales
Data","none",""
"domain01/domain01.htm","RPTOBJ","ITEM","mrv/
customer.fex","Customers","suffix","#salesdatau5t"
"domain02/domain02.htm","HELP","","app/help.htm","Help","",""
"domain02/domain02.htm","STDRPT","FOLDER","#inventoryrep","Inventory
Reports","none",""

Master Files and Sample Procedure


Reference:
IBIMRUSR.MAS
IBIMRROL.MAS
IBIMRGRP.MAS
IBIMRDOM.MAS
IBIMRDMC.MAS

The following Master Files (.MAS) and sample procedures (.FEX) are provided for your
reference:
IBIMRUSR.MAS on page 177

176 WebFOCUS
9. Managed Reporting Extract Utility

IBIMRROL.MAS on page 177


IBIMRGRP.MAS on page 178
IBIMRDOM.MAS on page 178
IBIMRDMC.MAS on page 179
Using the MRSAMP01 Procedure to Relate Users to Domains on page 180
Using the MRSAMP02 Procedure to List Domain Contents on page 181
On Windows systems, these files are found in the drive:\ibi\apps\ibisamp directory. On
UNIX systems, these files are found in the /ibi/apps/ibisamp directory. The IBISAMP
application is configured as the server's default search path.
On z/OS systems, the Master Files are in the library allocated to EDAMFD and the FOCEXEC
files are in the library allocated to EDARPC.

Reference: IBIMRUSR.MAS
IBIMRUSR.MAS Master File
$-----------------------------------------------------------------------
$ IBIMRUSR.MAS
$-----------------------------------------------------------------------
FILE=IBIMRUSR, SUFFIX=COM
SEGNAME=IBIMRUSR, SEGTYPE=S0
FIELD=USER_HTM, ALIAS=E01, ACUTAL=A12, USAGE=A12, $
FIELD=USER_ID, ALIAS=E02, ACUTAL=A48, USAGE=A48, $
FIELD=ROLE_HREF, ALIAS=E06, ACUTAL=A48, USAGE=A48, $
FIELD=USER_PROP, ALIAS=E03, ACUTAL=A256, USAGE=A256, $
FIELD=USER_DESC, ALIAS=E04, ACUTAL=A256, USAGE=A256, $
FIELD=GROUP_HREF, ALIAS=E05, ACUTAL=A13, USAGE=A13, $

Reference: IBIMRROL.MAS
IBIMRUSR.MAS Master File
$-----------------------------------------------------------------------
$ IBIMRROL.MAS
$-----------------------------------------------------------------------
FILE=IBIMRROL, SUFFIX=COM
SEGNAME=IBIMRROL, SEGTYPE=S0
FIELD=ROLE_HREF, ALIAS=E01, ACUTAL=A48, USAGE=A48, $
FIELD=ROLE_NAME, ALIAS=E02, ACUTAL=A48, USAGE=A48, $
FIELD=FIX_PROP, ALIAS=E03, ACUTAL=A255, USAGE=A255, $
FIELD=OPT_PROP, ALIAS=E04, ACUTAL=A255, USAGE=A255, $
FIELD=SEL_PROP, ALIAS=E05, ACUTAL=A255, USAGE=A255, $

WebFOCUS Managed Reporting Administrator's Manual 177


Master Files and Sample Procedure

Reference: IBIMRGRP.MAS
IBIMRGRP.MAS Master File
$-----------------------------------------------------------------------
$ IBIMRGRP.MAS
$-----------------------------------------------------------------------
FILE=IBIMRGRP, SUFFIX=COM
SEGNAME=IBIMRGRP, SEGTYPE=S0
FIELD=GROUP_HREF, ALIAS=E01, ACUTAL=A13, USAGE=A13, $
FIELD=GROUP_DESC, ALIAS=E02, ACUTAL=A256, USAGE=A256, $
FIELD=DOMAIN_HTM, ALIAS=E03, ACUTAL=A21, USAGE=A21, $

Reference: IBIMRDOM.MAS
IBIMRDOM.MAS Master File
$-----------------------------------------------------------------------
$ IBIMRDOM.MAS
$-----------------------------------------------------------------------
FILE=IBIMRDOM, SUFFIX=COM
SEGNAME=IBIMRDOM, SEGTYPE=S0
FIELD=DOMAIN_HTM, ALIAS=E01, ACUTAL=A21, USAGE=A21, $
FIELD=DOMAIN_PROP, ALIAS=E02, ACUTAL=A40, USAGE=A40, $
FIELD=DOMAIN_DESC, ALIAS=E03, ACUTAL=A256, USAGE=A256, $

178 WebFOCUS
9. Managed Reporting Extract Utility

Reference: IBIMRDMC.MAS
IBIMRDMC.MAS Master File;Master Files:IBIMRDMC.MAS
$------------------------------------------------------------------
$ IBIMRDMC.MAS
$------------------------------------------------------------------
FILE=IBIMRDMC, SUFFIX=COM, REMARKS='MR Domain Content Data',
SEGNAME=IBIMRDMC, SEGTYPE=S0
FIELD=DOMAIN_HTM, ALIAS=E01, ACTUAL=A21, USAGE=A21,
TITLE='Domain,Reference',
DESC='Joins many to one with DOMAIN_HTM in domains extract.',$
FIELD=REC1, ALIAS=E02, ACTUAL=A6, USAGE=A6, TITLE='Record,Type',
DESC='Values: HELP, OTHER, STDRPT, RPTOBJ, or PROFILE', $
FIELD=REC2, ALIAS=E03, ACTUAL=A6, USAGE=A6, TITLE='Record,Sub-type',
DESC='Values: ITEM, FOLDER, or null', $
FIELD=ITEM_HREF, ALIAS=E04, ACTUAL=A16, USAGE=A16,
TITLE='Item,Reference',
DESC='Item reference', $
FIELD=ITEM_DESC, ALIAS=E05, ACTUAL=A256, USAGE=A256, TITLE='Item Name',
DESC='Item description.',$
FIELD=ITEM_PROP, ALIAS=E06, ACTUAL=A256, USAGE=A256,
TITLE='Item,Properties',
DESC='The properties for this item.',$
FIELD=ITEM_FOLDER, ALIAS=E07, ACTUAL=A13, USAGE=A13, TITLE='Item Folder',
DESC='Folder href this item belongs in.',$

WebFOCUS Managed Reporting Administrator's Manual 179


Master Files and Sample Procedure

Example: Using the MRSAMP01 Procedure to Relate Users to Domains


SET PCOMMA=ON
-* Windows/UNIX: edit FILEDEFs below as appropriate or put in
EDASPROF.PRF instead
FILEDEF IBIMRUSR DISK c:\ibi\WebFOCUS76\utilities\IBIMRUSR.TXT
FILEDEF IBIMRGRP DISK c:\ibi\WebFOCUS76\utilities\IBIMRGRP.TXT
FILEDEF IBIMRDOM DISK c:\ibi\WebFOCUS76\utilities\IBIMRDOM.TXT
-* z/OS: remove FILEDEFs, uncomment and edit DYNAMs below as appropriate
-* DYNAM ALLOC FILE IBIMRUSR DSN 'hlq.IBIMRUSR.TXT' SHR REU
-* DYNAM ALLOC FILE IBIMRGRP DSN 'hlq.IBIMRGRP.TXT' SHR REU
-* DYNAM ALLOC FILE IBIMRDOM DSN 'hlq.IBIMRDOM.TXT' SHR REU
-RUN
SET ALL=ON
TABLE FILE IBIMRUSR
PRINT
ON TABLE HOLD AS USERINFO FORMAT FOCUS INDEX GROUP_HREF
END
-RUN
TABLE FILE IBIMRDOM
PRINT *
ON TABLE HOLD AS DOMINFO FORMAT FOCUS INDEX DOMAIN_HTM
END
-RUN
TABLE FILE IBIMRGRP
PRINT *
ON TABLE HOLD AS GROUP FORMAT FOCUS INDEX GROUP_HREF
END
-RUN
JOIN GROUP_HREF IN USERINFO TO ALL GROUP_HREF IN GROUP AS J1
JOIN DOMAIN_HTM IN USERINFO TO DOMAIN_HTM IN DOMINFO AS J2
-RUN
TABLE FILE USERINFO
PRINT
DOMAIN_HTM
BY USER_ID
BY USER_DESC
BY GROUP_DESC
BY DOMAIN_DESC
END
Note: The SET PCOMMA=ON command is required to report from these files. It can be set
in the procedure (as it is in the sample report) or in the WebFOCUS Reporting Server's profile.

180 WebFOCUS
9. Managed Reporting Extract Utility

Example: Using the MRSAMP02 Procedure to List Domain Contents


* ---------------------------------------------------------------
-* MRSAMP02.FEX
-* For use with MR Extract utility. See MR administrator documentation.
-* ----------------------------------------------------------------
SET PCOMMA=ON
-* Windows/UNIX: edit FILEDEFs below as appropriate or put in
EDASPROF.PRF
FILEDEF IBIMRDOM DISK c:\ibi\WebFOCUS76\utilities\IBIMRDOM.TXT
FILEDEF IBIMRDMC DISK c:\ibi\WebFOCUS76\utilities\IBIMRDMC.TXT
-* z/OS:remove FILEDEFs,uncomment and edit DYNAMs below as appropriate
-* DYNAM ALLOC FILE IBIMRDOM DSN 'hlq.IBIMRDOM.TXT' SHR REU
-* DYNAM ALLOC FILE IBIMRDMC DSN 'hlq.IBIMRDMC.TXT' SHR REU
-RUN
SET ALL=ON
TABLE FILE IBIMRDOM
PRINT *
ON TABLE HOLD AS DOMINFO FORMAT FOCUS INDEX DOMAIN_HTM
END
-RUN
TABLE FILE IBIMRDMC
PRINT *
ON TABLE HOLD AS CONTENT FORMAT FOCUS INDEX DOMAIN_HTM
END
-RUN
JOIN DOMAIN_HTM IN DOMINFO TO ALL DOMAIN_HTM IN CONTENT AS J1
-RUN
TABLE FILE DOMINFO
PRINT
ITEM_HREF ITEM_FOLDER ITEM_PROP
BY DOMAIN_DESC
BY REC1
BY REC2
BY ITEM_DESC
END

WebFOCUS Managed Reporting Administrator's Manual 181


Reporting From Extract Files

Reporting From Extract Files


In this section:
Sending the Data Files
Allocating the Extract Files to the WebFOCUS Reporting Server
Output File Relationships

You can use WebFOCUS to report from the Managed Reporting extract files (for example,
ibimrusr.txt, ibimrgrp.txt, ibimrdom.txt), provided that:
The extract files reside on the WebFOCUS Reporting Server.
File allocations (FILEDEF or DYNAM ALLOC) are either:
Specified within the procedure.
Specified within a WebFOCUS Reporting Server profile.
You set PCOMMA=ON in your WebFOCUS request since the extract data is
comma-delimited with double-quotation marks around each value.

Sending the Data Files


If you are running the WebFOCUS Client and WebFOCUS Reporting Server on different
machines, you must FTP the extract files to the WebFOCUS Reporting Server machine.
Perform this in ASCII mode using the FTP utility of your choice.
Note: If you are sending the files to an z/OS-based system, your system administrator may
have configured the FTP server to truncate incoming data at a fixed width, such as 128
characters. Your IBIMRUSR.TXT file may exceed 128 characters per line. During FTP, take
note of the command log to see if the data was truncated. If this is the case, issue the
following command at the FTP prompt:
QUOTE SITE LRECL=nnn
where:
nnn
Is the number of characters to set for the maximum line width.
Reissue the FTP PUT command and verify that the data was not truncated.

182 WebFOCUS
9. Managed Reporting Extract Utility

Allocating the Extract Files to the WebFOCUS Reporting Server

How to:
Allocate Extract Files on Windows Systems
Allocate Extract Files on UNIX-Based Systems
Allocate Extract Files on z/OS-Based Systems
Allocate Extract Files on OpenVMS and AS/400-Based Systems

Depending on the platform on which your WebFOCUS Reporting Server is running, the
command syntax is different. However, in all cases you may place the commands individually
within each report procedure or globally in a WebFOCUS Reporting Server profile.

Syntax: How to Allocate Extract Files on Windows Systems


IBIMRDMC.MAS Master FileFILEDEF IBIMRUSR DISK drive:\path\IBIMRUSR.TXT
FILEDEF IBIMRROL DISK drive:\path\IBIMRROL.TXT
FILEDEF IBIMRGRP DISK drive:\path\IBIMRGRP.TXT
FILEDEF IBIMRDOM DISK drive:\path\IBIMRDOM.TXT
FILEDEF IBIMRDMC DISK drive:\path\IBIMRDMC.TXT
where:
drive:\path
Is the disk location of the files.

Syntax: How to Allocate Extract Files on UNIX-Based Systems


FILEDEF IBIMRUSR DISK /path/IBIMRUSR.TXT
FILEDEF IBIMRROL DISK /path/IBIMRROL.TXT
FILEDEF IBIMRGRP DISK /path/IBIMRGRP.TXT
FILEDEF IBIMRDOM DISK /path/IBIMRDOM.TXT
FILEDEF IBIMRDMC DISK /path/IBIMRDMC.TXT
where:
path
Is the disk location of the files.

WebFOCUS Managed Reporting Administrator's Manual 183


Reporting From Extract Files

Syntax: How to Allocate Extract Files on z/OS-Based Systems


DYNAM ALLOC FILE IBIMRUSR DSN 'hlq.IBIMRUSR.TXT' SHR REU
DYNAM ALLOC FILE IBIMRROL DSN 'hlq.IBIMRROL.TXT' SHR REU
DYNAM ALLOC FILE IBIMRGRP DSN 'hlq.IBIMRGRP.TXT' SHR REU
DYNAM ALLOC FILE IBIMRDOM DSN 'hlq.IBIMRDOM.TXT' SHR REU
DYNAM ALLOC FILE IBIMRDMC DSN 'hlq.IBIMRDMC.TXT' SHR REU
where:
hlq
Is the high-level qualifier for the extract files.

Syntax: How to Allocate Extract Files on OpenVMS and AS/400-Based Systems


filedef ibimrusr disk disk$pm:[ibimrusr.txt]
filedef ibimrrol disk disk$pm:[ibimrrol.txt]
filedef ibimrgrp disk disk$pm:[ibimrgrp.txt]
filedef ibimrdom disk disk$pm:[ibimrdom.txt]
filedef ibimrdmc disk disk$pm:[ibimrdmc.txt]
where:
disk$pm
Is the disk location of the files.

Output File Relationships


The following diagram illustrates the relationships between the output files:

A user appears in the IBIMRUSR data multiple times if they belong to multiple groups.
Similarly, a group appears in the IBIMRGRP data multiple times if it contains multiple domains.
A domain only appears once in the IBIMRDOM data. A domain always appears more than
once in the IBIMRDMC data because each item record is qualified with its domain.

184 WebFOCUS
9. Managed Reporting Extract Utility

Property Flags
Reference:
User.htm and Role.htm Flags
Mrrepos.htm Flags
Domainname.htm Flags

The WebFOCUS Client writes property flags to the user.htm, role.htm, mrrepos.htm, and
domain.htm files to control the behavior of Managed Reporting. Knowledge of these flags
can help administrators to better understand reports written from the extract files.

Reference: User.htm and Role.htm Flags


The following table describes the flags that may be encountered in the USER_PROP field in
the IBIMRUSR.MAS Master File as well as the FIX_PROP, OPT_PROP, and SEL_PROP fields
of the IBIMRROL.MAS file.

Flag Description

admin Indicates the user has Managed Reporting


Administrator privileges.

advanced Indicates the user has the Advanced privilege.

auser Indicates the Analytic User can save reports and


create My Reports.

dadomains=untitled%2csalesdom Indicates the developer is restricted to


administering only the default domain, which has
the internal reference "untitled," and the Sales
Domain. The characters %2c delimit the domains
when there is more than one domain.

dataserver Indicates the developer has access to the Data


Servers feature and can set the server and
application path properties of a Domain.

domadmin Indicates the user is a developer.

email=address Used with ReportCaster library.

WebFOCUS Managed Reporting Administrator's Manual 185


Property Flags

Flag Description

gagroups=group%2cgroup Indicates that the user is a group administrator


for the Default Group, which has the internal
reference "default." The characters %2c delimit
multiple group values similar to the dadomains
flag.

inactive Indicates the user account is disabled.

is508 Indicates to the Managed Reporting Dashboard


user interface to invoke tools and online help that
are in compliance with federal Section 508
accessibility regulations. For more information,
see Handicapped Accessibility in WebFOCUS in the
Developing Reporting Applications manual.

library User can use ReportCaster Library.

parmrpt Indicates that a user can save the parameter


values entered in a form into a new My Report.

rcadmin ReportCaster Administrator.

robot Indicates the user has scheduling privileges.

savemyreports Indicates an Analytical User can Save My Reports.

shared Indicates the user can share reports.

user Basedir in Managed Reporting. Cannot use tools;


can only run reports.

Note: The user flags are not order-dependent. The flags display based upon the order they
were added from within the Managed Reporting Administration interface.

186 WebFOCUS
9. Managed Reporting Extract Utility

Reference: Mrrepos.htm Flags


The following table describes the flags that may be encountered in the DOMAIN_PROP field
in the IBIMRDOM.MAS Master File:

Flag Description

'' or 'none' Indicates the domain is active.

disabled Indicates the domain was deleted.

Reference: Domainname.htm Flags


Each Domain has its own control file, which maintains the metadata for its resources. The
following table describes the flags that are in the control files.

Flag Description

appname=application_path Application path. Series of one or more application


names, separated by encoded spaces. For example,
appname=financials%20inventory

belongsto=#parentfoldername Parent of subfolder.

createdby User who last modified a property item. The encoded


value of a user name concatenated with a user ID, such
as lastmodby=Doe%2C+John+%28jd12345%29.

createdon Date and time when a user created a property item.


Specifies elapsed milliseconds since 1970, which is
translated into the appropriate date and time format.

dragdrill Run with drag and drill.

filter Filter is present in request.

hidden Report is hidden from view.

lastmodby User who last modified a property item. The encoded


value of a user name concatenated with a user ID, such
as lastmodby=Doe%2C+John+%28jd12345%29.

launch Published launch file.

WebFOCUS Managed Reporting Administrator's Manual 187


Property Flags

Flag Description

node=servernodename WebFOCUS Reporting Server.

none No flags are set.

olapreport A saved OLAP report.

ptmfex=applicationname Link to Two-Way Email procedure.


/fexname.fex

runasolap OLAP enables a report.

showasreport Allows the Reporting Object to appear as a Standard


report.

showonlyreport Shows a Reporting Object only as a report.

skipamper Does not prompt for parameter.

splithorizontal Used with a TABLE and GRAPH combination to specify


to split the frame.

suffix Reporting Object contains a suffix.

tellme Request is for Two-Way Email.

url Specifies that a Standard Report is a URL.

188 WebFOCUS
WebFOCUS

10 Change Management

Change management is the process of


Topics:
moving application components between
WebFOCUS environments. Typically, Understanding the Change
Management Process
Developers move components
between development and testing Managed Reporting Development
environments. Environment
Systems or production control Understanding Internal Managed
professionals move components Reporting References
between testing and production
environments. Managed Reporting Change
Management Features
There are features and methodologies
in Managed Reporting that can be used Change Management Extract Utility
to facilitate these important tasks.
Change Management Load Utility
For more information about configuring
multiple WebFOCUS environments, see Dashboard Change Management
the Best Practices guide titled Enterprise
Implementation Considerations for
WebFOCUS Reporting.

WebFOCUS Managed Reporting Administrator's Manual 189


Understanding the Change Management Process

Understanding the Change Management Process


Developing an application is an iterative process. Developers are constantly revising pieces
of their application and periodically moving these components to the test environment for
feedback. At some point, user feedback must be solicited and the application must be
stabilized. After an application is released for general use, problems must be fixed, tested,
and incorporated into the production environment. This is the essence of change
management, which is also sometimes referred to as configuration management or production
control.
Organizations vary widely in how they approach change management. Some delegate much
of the responsibility to developers while others establish separate organizations to maintain
a higher degree of control. Typically, developers prefer to stay in their development tool
environment to perform these duties while change management professionals prefer batch-
oriented and API-based methods to move application components between environments.
Developers may be required to implement a user-developed change management application
in order to initiate changes after the application is moved to production. A combination of
these approaches is often used in larger companies.
The examples that follow illustrate two different change management processes that might
be found in a company. These sections describe product features and methodologies that
can be utilized by companies to meet their change management objectives with Managed
Reporting.

Example: Moving Application Files: A Simple Change Management Process


As shown in the following image, developers move application files between the development
and test environments using their development tool. When the application is finished, a
systems person copies the application from test to production using operating system
utilities. There may only be a single test environment.

190 WebFOCUS
10. Change Management

Example: Moving Application Files: A Comprehensive Change Management Process


In this example, four WebFOCUS environments are established to increase the level of control
over the process. Developers use the Explorer window in Managed Reporting Developer for
Windows and Developer Studio to move application files from development to test. Developers
then sign on to the Change Management Extract Utility when they are ready to move their
changes to the user acceptance test environment. The Change Management Extract Utility
allows the Developer to select the file(s) to be moved and creates a change package on the
Web platform that an administrator can subsequently insert into an acceptance test using
the Change Management Load Utility or (Java) Load Program called IBILoadRepos. Some
organizations may choose to call the Load program from an automated process in order to
achieve better integration with their business processes.
As shown in the following image, when the application is deemed ready for release, the
change management organization initiates a file system copy of the application to the
production environment. Users begin using the application and the change management
process shifts into an application maintenance support role. From this point forward,
incremental updates to production are facilitated by administrators using the CM Load
program.

Managed Reporting Development Environment


When you are developing a Managed Reporting application, you are working with files that
are controlled by the WebFOCUS Client and stored in a centralized location called the Managed
Reporting Repository. There is no decentralized local developer copy of this repository or of
Managed Reporting files. Regardless of whether the Developer is using the Java applet or
Developer Studio tools, the process entails retrieving a copy of the file(s), making changes
to the file, and saving the files back to the repository.
All Managed Reporting developers work in a common repository simultaneously and move
their application components to a common test environment. Managed Reporting enables
two or more developers to work on different parts of the application simultaneously, without
affecting each other. However, when two or more developers are working on files in a single
Domain, the responsibility is on the developers to coordinate their changes. For example,
if two developers are working on the same report file at the same time, the last one saving
the file overwrites any changes the first developer may have made.

WebFOCUS Managed Reporting Administrator's Manual 191


Understanding Internal Managed Reporting References

Understanding Internal Managed Reporting References


Developers and end users see and use Descriptions to navigate their way about Managed
Reporting. Managed Reporting uses internal references instead to locate and process
requests for Managed Reporting resources.
At any time, developers are free to change these Descriptions. Users will see changes the
next time they log on to Managed Reporting (or refresh their view). A Description change
does not affect how the file is processed, since the internal reference remains the same.
The following are internal references for Managed Reporting objects:
Domain. Visible on the Domain Properties dialog box (for example, untitled/untitled.htm).
Standard Report. Visible on the Report Properties dialog box (for example,
app/prospect.fex or app/launchpa.htm).
Reporting Object. Visible on the Reporting Object Properties dialog box (for example,
mrv/salesdat.fex).
Folders and Sub-Folders. Visible on the object's Property dialog box (for example,
#westernregio).
Repository. This is not visible from within the Java applet tools, but you can specify to
override the default value on the signon page. Developers using Developer Studio can
specify the repository within the WebFOCUS Environment Properties dialog box. (For more
information, see the Developing Reporting Applications With Graphical Tools manual.) The
variable MR_BASE_DIR specifies the full operating system path to the root of the Managed
Reporting Repository (for example, d:\ibi\WebFOCUS76\basedir) and is defaulted in the
WebFOCUS script file, cgivars.wfs.
When you create a Domain, Report, or Folder with the tools, Managed Reporting generates
the internal reference for the object and stores it. The Description you provided is used to
create the reference.
Note: When you create a Description, spaces and special characters are removed and the
reference is truncated to a fixed length.
If you create another object with a similar Description, Managed Reporting will randomly
generate the reference to ensure that each reference is unique within its namespace.
Products and features that use internal Managed Reporting references include:
Published Launch pages (inside or outside the repository).
ReportCaster (to retrieve the report at execution time).
Drill down links.
End user My Reports.

192 WebFOCUS
10. Change Management

When moving files between Managed Reporting Repositories, such as between your
development and test environments, it is critical that these references (and the Descriptions)
remain the same. This can be accomplished by:
Creating the domains in each of your environments in the same order. The internal
references will be created the same in each.
Using the Properties dialog box to check references.
Paying attention to alert windows when copying files.
Testing your application before moving it into the production environment.
Using the CM Extract and CM Load program to move Domain files between environments.

Managed Reporting Change Management Features


In this section:
Copying Files Between Environments Using Developer Studio
Copying a Domain Between Environments Using Developer Studio

The following sections describe features or methodologies that can help organizations
achieve their change management objectives with Managed Reporting.

WebFOCUS Managed Reporting Administrator's Manual 193


Managed Reporting Change Management Features

Copying Files Between Environments Using Developer Studio


From the Windows Explorer window, you can drag and drop (or copy/paste) a modified
procedure called Prospecting Activity from your Development environment to the Western
Region folder of the User Test environment as shown in the following image.

194 WebFOCUS
10. Change Management

A status window shows the progress of the copy operation. Note the internal folder reference,
#westernregio, of the procedure being copied as shown in the following image.

If the procedure already exists in the destination (meaning that this procedure's internal
reference is already being used), an alert window appears to confirm replacing the existing
procedure as shown in the following image.

If you are sure that the procedure you are copying is an update of the one in the target, click
Yes (or Yes to All) and it will be updated. If you click No, your file will be copied to the target
Repository and a new internal reference will be generated for it. In this case, it is your
responsibility to resolve problems with other products and features that may be relying on
this reference, which you have agreed to change. See Understanding Internal Managed
Reporting References on page 192.

WebFOCUS Managed Reporting Administrator's Manual 195


Managed Reporting Change Management Features

Copying a Domain Between Environments Using Developer Studio


From the Explorer window, you can drag and drop (or copy/paste) the contents of an entire
Domain called Sales from your Development environment to the Domains folder of the User
Test environment as shown in the following image.

A status window shows the progress of the copy operation. Note the internal reference,
salesrep/salesrep.htm, of the Domain being copied.
If the Domain already exists in the destination (meaning that this Domain's internal reference
is already being used), an alert window appears.
If you are sure that the Domain you are copying is a complete replacement for the one in
the target, click Yes or Yes to All and it will be updated. If you click No, your Domain will be
copied to the target Repository and a new internal reference will be generated. In this case,
it is your responsibility to resolve problems with other products and features that may be
relying on this reference, which you have agreed to change. See Understanding Internal
Managed Reporting References on page 192 for more information.

196 WebFOCUS
10. Change Management

Change Management Extract Utility


How to:
Access and Use the Change Management Extract Utility
Reference:
Extracting Repository Metadata

Many organizations do not grant developers write access to the user acceptance test and
production environments. Access to these environments is controlled and granted only to
administrators and/or automated change management processes. Yet only developers know
which changes are ready to be moved into test. The Change Management Extract Utility
presents developers with a graphical view of the Managed Reporting domains they manage
and allows them to build a change package. This package is then loaded into another
environment by a Managed Reporting Administrator using the Change Management Load
Utility or the (Java) Load Program named IBILoadRepos.

Procedure: How to Access and Use the Change Management Extract Utility
1. Launch the WebFOCUS Welcome Page in the environment where you want to create a
change package with the Change Management Extract Utility.
http://hostname[:port]/ibi_apps/
where
hostname[:port]
Is the name of the Web server and optional port number (specified only if you are
not using the default port number) where the WebFOCUS Web application in the
desired environment is deployed.

2. Click the Managed Reporting Change Management Extract link.


3. Type your Managed Reporting Administrator or Developer user ID and password and
click Logon.
The Change Management Extract Utility loads and displays the Domains to which the
developer or administrator has access.

WebFOCUS Managed Reporting Administrator's Manual 197


Change Management Extract Utility

The following image shows the Change Management Extract Utility available to
administrators, which displays the Domains Tree pane on the left and the Selected Files
and Domains pane on the right. The available options include Download File (default)
and Save on Server.

Note: The Extract Repository Metadata button only displays for administrators. For more
information, see Extracting Repository Metadata on page 200.

4. Expand the folders in the Domains Tree pane. You can select individual items from a
domain or the contents of an entire domain for your change package.
You can single-click (or drag and drop) one or more items from a domain. You can also
select the domain's help and profile files.
You can also double-click (or drag and drop) a domain to conveniently select all of the
content from this domain. Properties of the domain, for example, its Server and/or
Application Path, are not propagated by the change management process. Note that a
selected domain is a collection of the domain's content, not a complete clone of the
original domain.
When you select an item or domain, it appears in the Selected Files and Domains list.
If you select duplicate items or domains, they are only added to the change package
once. You should not select individual items from a domain that is already selected.

5. If you need to remove an item or domain from the Selected Files and Domains list,
select the item and press the Delete key.
To remove all items and domains from the Selected Files and Domains list, click the
Clear File List button.

198 WebFOCUS
10. Change Management

6. By default, the Download File option is selected. Click Create Change Package to download
the change package to your browser. You will then have the option to open it or save it
locally, as shown in the following image.

The naming format for the change package is: YYYYMMDD_admin_HHMMSS.zip. The
format is Java Zip (which is WinZip compatible). If you have WinZip installed locally, open
the change package. To ensure that the Change Management utility recognizes the file
and processes it correctly, do not change the file name or the .zip file extension.
The contents of the change package includes the extracted file(s) and a cmRepos.xml
document that contains metadata about the file(s), such as their internal references
and properties, as shown in the following image.

If the Save on Server option is selected, the following window opens to provide you with
the name of the change package created on the server.

WebFOCUS Managed Reporting Administrator's Manual 199


Change Management Extract Utility

Consider whether you want developers to download and e-mail change packages to a
coordinator, or create the packages on the Web server platform. Packages created on
the server are written to install_dir/WebFOCUS76/utilities/cm/extract. You can change
this location by editing the WebFOCUS deployment descriptor (web.xml) and changing
the value of the context-parameter MRCMEXTRACTDIR. The directory specified by this
setting must exist and be writable by the servlet container. You may want to have
developers create the package on the server, and also download and e-mail them to a
coordinator. This may help audit the change process since you have a record of the
Developer's intent, and can load the packages from a controlled location.
Note: To ensure that the contents of a change package are not altered in any way,
Information Builders recommends that you always load change packages that were
created on the server.

Reference: Extracting Repository Metadata


The Extract Repository Metadata link takes you to a pane where you can extract metadata
from the Repository for analysis. Administrators can query the Repository for metadata from
this page. This may be helpful in planning or debugging. For more information about the
output generated from these options (Users, Roles, Groups, Domains, Domains Contents),
see Managed Reporting Extract Utility on page 171. To return to the Change Management
Extract Utility, click Return to Change Package Window.
The following image shows the Extract Repository Metadata pane containing metadata
information for Extract Roles.

200 WebFOCUS
10. Change Management

Note: For additional convenience, the MR Change Management Extract Utility is also available
from the Administration Console in the Utilities section of the main menu. The interface is
slightly different, but the functionality is the same. For more information, see the WebFOCUS
Security and Administration manual.

Change Management Load Utility


In this section:
Alternate Change Management Load Program
How to:
Access and Use the Change Management Load Utility
Reference:
Change Management Load Utility Options

The Change Management Load Utility enables Managed Reporting administrators to load
specific change packages created with the Change Management Extract Utility into another
environment.
Change packages are loaded into the target repository using a Java program called
IBILoadRepos. If an item's domain does not exist during the load process, the Change
Management Load Utility creates the domain automatically and a message is written to the
cmevent.log file.
It is recommended that you create domains in the development environment using the
Domain Builder and allow the Change Management Load Utility to automatically create
domains in your test and production environments. This is beneficial because creating and
then deleting a domain in the target repository results in the Change Management Load
Utility being unable to load items into it. When a domain is deleted, its entry in mrrepos.htm
is set to disabled instead of being deleted. The Change Management Load Utility is unable
to load items into a disabled domain and cannot create a new domain with the correct HREF.
In this situation, an error is written to the cmevent.log file and the item is not loaded.

Procedure: How to Access and Use the Change Management Load Utility
1. Move the desired change packages from the source \utilities\cm\extract directory or
other specified location, to the target environment's \utilities\cm\load directory or any
of the subdirectories of \utilities\cm.
Note: If the Realm Driver is being used in the target environment to authenticate and/or
authorize to a relational DBMS, make sure that the path to the JDBC drivers are defined
in your application server classpath. For example, if using MSSQL Server for MR
authentication, the path to the drivers would be defined in the Java Classpath for Tomcat.

WebFOCUS Managed Reporting Administrator's Manual 201


Change Management Load Utility

2. Go to the WebFOCUS Welcome Page on the target environment where you want to load
the change package created with the Change Management Extract Utility.
http://hostname[:port]/ibi_apps/
where
hostname[:port]
Is the name of the Web server and optional port number where the WebFOCUS Web
application in the desired target environment is deployed.

3. Click the Managed Reporting Change Management Load link.


4. Type your Managed Reporting Administrator user ID and password and click Logon.
The Change Management Load Utility loads and displays any folders in the \utilities\cm
directory that contain .zip files.

5. Select a desired .zip file change package in the Available Change Packages pane to
copy it to the Selected Change Packages pane. You can single-click, double-click, or
drag and drop the change package as shown in the following image.

The options you can select include Overwrite duplicates (default), Backup packages
(available only when Overwrite duplicates is selected), Preserve Creation info, and
Preserve Modifier info. For details, see Change Management Load Utility Options on page
203.

202 WebFOCUS
10. Change Management

6. To remove a selected change package from the Selected Change Packages list, select
the item and press the Delete key. To remove all selected change packages, click the
Clear File List button.
7. Click Load Change Package to load the change package into the MR repository of your
target environment.
A pop-up message appears when the load process is completed. Click Open Log File to
view the contents of the cmevent.log file that was created in the \utilities\cm\ directory.
The log file displays helpful information about the success or failure of the load process.

Note: For additional convenience, the MR Change Management Load Utility is also available
from the WebFOCUS Adminstration Console in the Utilities section of the main menu. For
more information, see the WebFOCUS Security and Administration manual.

Reference: Change Management Load Utility Options


The following describes the options you can apply when using the Change Management Load
Utility to load change packages into an environment.
Overwrite duplicates - If any files have the same internal reference in the source and
target repositories, this option determines whether or not the internal reference is
preserved when the change package is loaded. For example, if a report with the description
"Sales Report" and internal reference "app/salesrep.fex" already exists in the target
repository, enabling the Overwrite duplicates option allows the report to be loaded with
the same description and internal reference. If Overwrite duplicates is unselected, a new
report file is created with the description "Sales Report (Copy 1)" and a new internal
reference, for example, "app/gwrwko31.fex."
Backup packages - This option is only available if the Overwrite duplicates option is
enabled. If selected, a back-out package is created that contains the original versions
of the files that are about to be overwritten. The back-out package is created in the
\utilities\cm\backout directory with the same name as the package being loaded.
Preserve Creation Info - This option retains the report creation date and time, and the
name (and user ID) of the person who created the report, by preserving the createdon
and createdby flags found in the change package.
Preserve Modifier Info - This option retains the last modification date and time for the
items in the change package by preserving the lastmodby flag that is found in the package.

WebFOCUS Managed Reporting Administrator's Manual 203


Change Management Load Utility

Alternate Change Management Load Program

How to:
Run the Alternate Change Management Load Program
Reference:
Preparing to Run the Alternate Change Management Load Program
IBILoadRepos Usage

The following topics explain how to prepare for, and how to run, the alternate Change
Management Load program.

Reference: Preparing to Run the Alternate Change Management Load Program


In some cases you must edit the script file that calls IBILoadRepos before running the utility.
This script file is found in the inst_dir\WebFOCUS76\utilities\cm directory and is named
cmload.bat (cmload on UNIX).
1. Verify that the setting MRID=admin is valid for your installation. You must set the variable
MRID inside this script to a valid Managed Reporting (MR) user ID. Initially, this variable
is set to admin to match the default MR administrator account. The ID specified does
not need to have MR administration privileges; it must be a valid MR ID.
2. Set JDBC_DRIVER_JARS, if necessary. When using the Realm Driver to authenticate
and/or authorize to a relational DBMS system you must set JDBC_DRIVER_JARS to the
full path to your driver's Jar file(s). If your driver is made up of multiple files, use the
semi-colon ';' as a separator on Windows and a colon ':' as the separator on UNIX.
3. If you are using a custom Realm Driver extension, you may need to include additional
Jar file(s) in the class path of this utility to use it. Simply append these to the
JDBC_DRIVER_JARS variable.

Procedure: How to Run the Alternate Change Management Load Program


1. Move the desired change packages from your source environment's /utilities/cm/extract
directory to the target environment's /utilities/cm/load directory. By default, all change
packages in this directory will be loaded. Make sure that only the change packages you
want to process are located here.
2. Navigate to the WebFOCUS76/utilities/cm directory.

204 WebFOCUS
10. Change Management

3. Execute the cmload.bat file (Windows systems) or cmload file (UNIX systems). A series
of messages appear:
-------------------------------------------------
Managed Reporting Change Management Load Utility
WebFOCUS Release 7
-------------------------------------------------
Finished.
Press any key to continue . . .
A log file, WebFOCUS76/utilities/cm/cmevent.log, is created with helpful information
about the load. Each time a package is loaded, information is appended to cmevent.log
file.

Reference: IBILoadRepos Usage


The underlying program that loads change packages into a Managed Reporting Repository
is written in Java and is contained in the archive WebFOCUS76/utilities/cm/IBILoadRepos.jar.
You call the program directory (or modify the cmload batch file) by using the following usage
reference.
java [options] -cp archivepath ibi.srv.cm.IBILoadRepos
arguments-createBackout
-backoutDir
-preserveCreationInfo
-preserveModifierInfo
where options include:
-DinfoLogType={FILE|CON|OFF}
Optional. If you want informational messages associated with the load to be logged,
select FILE to write them to cmevent.log in the current directory. Each time the load
program is run, messages are appended to this file. If you want these messages echoed
to the command console, select CON, otherwise select OFF. Not specifying this option
is equivalent to selecting CON.
-DerrorLogType={FILE|CON|OFF}
Optional. If you want error messages associated with the load to be logged, select FILE
to write them to cmevent.log in the current directory. Each time the load program is run,
messages are appended to this file. If you want these messages echoed to the command
console, select CON, otherwise select OFF. Not specifying this option is equivalent to
selecting CON.

WebFOCUS Managed Reporting Administrator's Manual 205


Change Management Load Utility

where:
archivepath
Is the full or relative path to the IBILoadRepos.jar file, and the following supporting files:
ibi_resolver_1_1.jar, ibi_xalan_2_7_0.jar, ibi_xalan_2_7_0_serializer.jar,
ibi_xerces_2_7_1.jar, and ibi_xml_apis_1_3.jar. If you are using the Realm Driver, you
must also include uas.jar and supporting files (if any) such as your JDBC .jar files if the
Realm Driver is using an RDBMS.
where arguments include:
-user userid
Required. The ID specified is required to initialize the IBILoadRepos program. This ID
does not need to have MR administration privileges; it just needs to be a valid MR ID.
-confDir configpath
Required. Specifies the full or relative path to the directory containing the WebFOCUS
deployment descriptor file (web.xml). IBILoadRepos reads this file to locate several
settings necessary to initialize itself, including webfocus_client_root and WFENCR (optional
encryption setting). With some application servers, this web.xml file is deployed to a
different location in the file system. In this case, you may need to keep these files
synchronized or point -confDir to the deployed file.
-d loaddirectory | -f loadfile
Either -d or -f is required. Specifies the absolute or relative path to the directory containing
the change package .zip files or a single .zip file (depending on selection). If -d is selected,
all .zip files in the specified directory are loaded (in sort order).
-noOverwrite
Optional. If specified, files found with the same internal reference are not overwritten
during the load, and are loaded with a new internal reference instead. For example, if a
report with the description "Sales Report" and internal reference "app/salesrep.fex" is
being loaded with the -noOverwrite option and the same file already exists in the target
repository, a new file is created with the description "Sales Report (Copy 1)" and new
internal reference, for example, "app/gwrwko31.fex".
A back-out package containing the original versions of the files you are about to update can
be created during the load. Open the batch file that calls IBILoadRepos and add:
-createBackout
By default, the back-out package is created in the backout subdirectory of the current
directory. If the backout directory does not exist, the utility creates it automatically. The
name of the back-out package is the same name as the package being loaded, this is why
the load and back-out directories must be different.

206 WebFOCUS
10. Change Management

To specify a different directory, include the following with either a fully qualified or relative
path:
-backoutDir
This directory must exist or an error is written to the log file and the item is not loaded.
To back-out a change, move the back-out package into the load directory and rerun the Load
program.
You should create a different batch file for backing out changes because you do not want
to specify the -createBackout option when running the utility to back out a change. If the
items being added do not yet exist in the target environment, there will be no corresponding
items in the back-out package, and you must use the GUI tools to back-out the added items.
To preserve change history creation information, include:
-preserveCreationInfo
This retains the report creation date and time, and the name (and user ID) of the person
who created the report, by preserving the createdon and createdby flags found in the change
package.
To preserve change history modifier information, include:
-preserveModifierInfo
This retains the last modification date and time for the report by preserving the lastmodby
flag found in the change package.

Dashboard Change Management


How to:
Access the Dashboard Change Management Utility
Export Dashboard Files
Import Dashboard Files

Dashboard Change Management enables administrators to move Dashboard Views from


one environment to another (for example, from a development environment to a testing
environment). Dashboard Change Management enables you to selectively move individual
pieces of your Dashboard (customizations, personalizations, Public/Group views, and so
on) so that you can introduce incremental updates from one environment to another.
Dashboard Change Management works in conjunction with Managed Reporting Change
Management. You move procedures using Managed Reporting Change Management, and
Dashboard views using Dashboard Change Management.

WebFOCUS Managed Reporting Administrator's Manual 207


Dashboard Change Management

All Dashboard Change Management export and import files are stored in the
WebFOCUS\worp\management directory.

Procedure: How to Access the Dashboard Change Management Utility


You must be an administrator to access the Dashboard Change Management utility. Also
note that the Change Management Utility is a single-user system and shares logon information
with the Dashboard View Builder. Therefore, if someone is logged on the View Builder, another
user will not be able to run the Change Management utility on that system.
1. Access the Dashboard Change Management utility from the:
WebFOCUS Welcome page (http://server/ibi_apps/). Click Business Intelligence
Dashboard Change Management in the Dashboard and Managed Reporting category.
Dashboard View Builder. Click Management.
URL http://server/ibi_apps/bid/bidcmlogin
The Login page opens.

2. Enter your user ID and password and click Logon.

Procedure: How to Export Dashboard Files


1. In the Dashboard Change Management utility, click the Export tab.
2. Select the Automatically select Users assigned to selected View check box to automatically
select users assigned to any views you select for export.
3. Open each category (Public Views, Group Views, Users, Role Tree, Toolboxes, Templates)
and select the check box adjacent to the files you want to export.
4. Click Export Selected. The file is named time_date.zip.
5. From the list of available WebFOCUS BID Management files, select your file and click
Download File to save the file to a local directory.
The Save As dialog box opens.

6. Navigate to the location where you want to save the file and click Save.
Note: Both the file name and the .zip file extension should not be changed in order for the
Dashboard Change Management utility to recognize the file and process it correctly.

208 WebFOCUS
10. Change Management

Procedure: How to Import Dashboard Files


1. Log in to the Change Management utility or the Dashboard View Builder for the target
system.
2. In the Dashboard Change Management utility, click the Import tab.
Note: You can also use FTP to import files from one system to another. If you use this
method, place the file to import in the WebFOCUS\worp\management directory of the
target system. The file must be transferred in binary format.

3. If the file you want to import is not already listed in the list of available WebFOCUS BID
Management files:
a. Click the Browse button and navigate to the file.
b. Click Upload File.
The file appears in the list of available WebFOCUS BID Management files.

4. Select the file to import from the list of available WebFOCUS BID Management files and
click Import File.
5. Select the items from the file you want to import. Select the Check to automatically select
Users assigned to selected View check box to automatically select users assigned to any
views you select for import.
6. Click Import Selected.
Note: Importing a large Change Management file may result in an HTTP500 error. If the
error occurs, recreate the Change Management extract file as multiple files and import
each file separately.

WebFOCUS Managed Reporting Administrator's Manual 209


Dashboard Change Management

210 WebFOCUS
WebFOCUS

11 Additional Administration Topics

These topics contain additional


Topics:
information for administrators about
ReportCaster, debugging, setting up Selecting the Tool Type for
traces, repository file names, and ReportCaster
obtaining a list of Master Files.
Debugging
Setting Up Traces for Managed
Reporting User Requests
Repository File Name Processing
Obtaining a List of Available Master
Files

WebFOCUS Managed Reporting Administrator's Manual 211


Selecting the Tool Type for ReportCaster

Selecting the Tool Type for ReportCaster


How to:
Configure Managed Reporting Tool Types

You can configure tool types for a Managed Reporting Administrator, Developer, and Analytical
User. The selections include ReportCaster Scheduling Wizard and HTML User Interface or
the Java Web Start-based ReportCaster Development and Administration Interface. This
selection is not applicable to Analytical Users as they use the ReportCaster HTML user
interfaces.

Procedure: How to Configure Managed Reporting Tool Types


1. In the WebFOCUS Administration Console, click Utilities.
The MR Tool Type Selection options appear.

2. Select Administrator, Developer, or Analytical User.


If you select Administrator or Developer, the MR Tool Type Selection window appears
with the following defaults.

Note: The ReportCaster User Interface cannot be configured for Managed Reporting
Analytical Users, who must use the HTML-based Scheduling Wizard and User Interface.

3. To configure a Managed Reporting Administrator or Developer to use the HTML-based


Scheduling Wizard and User Interface, select the HTML option button.
4. Click Save to save your changes.
If you are using the WebFOCUS Servlet, you must reload your WebFOCUS Web application
in order for your changes to take effect. In addition, users must log out of Managed Reporting
and log back in.

212 WebFOCUS
11. Additional Administration Topics

Debugging
In this section:
Your Browser's Java Console
Tracing the Java Applets
Tracing the WebFOCUS Client
Enabling Tracing Options in Dashboard

These topics describe how you can access debugging information and enable tracing options.

Your Browser's Java Console


When you encounter problems with Java applets in the Internet Explorer, you can receive
valuable debugging information by looking in the Internet Explorer Java Console. Access this
from the menu bar by clicking View and then Java Console. The Java Console (as shown in
the following image) shows you which Microsoft Java Virtual Machine release you are using.
You can also see messages from the IBI Java code, such as the Managed Reporting Java
Gen number. Information Builders Customer Support Service (CSS) may ask you to check
for specific messages in this console to aid in problem determination.

If the Java Console does not appear in your View menu, you may need to activate it. The
way to activate this varies with each Internet Explorer release. In Internet Explorer version
6.0, enable the Java Console by selecting Tools, Internet Options, Advanced, Microsoft VM,
and Java Console enabled. You must restart your browser for the changes to take effect.

WebFOCUS Managed Reporting Administrator's Manual 213


Debugging

Tracing the Java Applets

How to:
Trace the Domain Builder Applet

It is possible to increase the level of trace messages written to the Internet Explorer Java
Console. This can be helpful for debugging purposes. Before carrying out the following steps,
you should back up your mr_ie.htm file in case you accidentally corrupt it.

Procedure: How to Trace the Domain Builder Applet


1. Edit webfocus76/ibi_html/workbnch/mr_ie.htm and search for the JavaScript function:
function showDomainAdmin()

2. Under this function, uncomment the following lines (remove the two slashes):
// innerHTML += "<PARAM NAME=FOCUStrace value='true'>";
// innerHTML += "<PARAM NAME=PROGRAMtrace value='true'>";

3. Save the file and either log onto Managed Reporting again or click your browser's Refresh
button (if you are already logged on). You now see detailed trace messages in your Java
Console.
Note: While tracing is on and the Java Console is open, applet performance will be
decreased. Keep the Java Console closed until you have reproduced the steps you are
debugging in order to improve performance.
You can copy the following trace lines to other JavaScript functions in order to trace the
behavior of other applets:
showUserAdmin() - the User Administration applet
showDomains() - the Domains applet

Tracing the WebFOCUS Client


See the WebFOCUS Security and Administration manual. To turn tracing on, set Trace=ON.

214 WebFOCUS
11. Additional Administration Topics

Enabling Tracing Options in Dashboard

How to:
Add the TRACE_LEVEL Parameter for Windows
Add the TRACE_LEVEL Parameter for UNIX and z/OS
Remove or Modify the TRACE_LEVEL Parameter for Windows
Remove or Modify the TRACE_LEVEL Parameter for UNIX and z/OS
Turn On Dynamic Tracing in Dashboard
Reference:
Dashboard Trace File Names
Dashboard Trace File Contents

By default, the Dashboard tracing option is not turned on. Tracing should only be turned on
when requested to do so by an Information Builders representative.
Tracing is only active when the TRACE_LEVEL parameter exists with a valid value. To turn
the Dashboard tracing option on, add the TRACE_LEVEL initialization parameter in the servlet
engine configuration. For details, see How to Add the TRACE_LEVEL Parameter for Windows
on page 215 and How to Add the TRACE_LEVEL Parameter for UNIX and z/OS on page 216.
All trace files are created under the ibi\WebFOCUS76\worp\log directory. A trace file is
created for every session, therefore it is possible to have many trace files generated for one
user.
You can turn on traces dynamically by editing the bid-config.xml file. See How to Turn On
Dynamic Tracing in Dashboard on page 217.

Procedure: How to Add the TRACE_LEVEL Parameter for Windows


1. Open the ServletExec Administration tool.
2. Under Web Applications, click Manage.
3. Under WebFOCUS76 Application Name, click web.xml.
4. Under Servlets, click Manage.
5. Under Servlet Name, click WORP_Loader.
6. Under Initialization Parameters, add the following:
name: TRACE_LEVEL

WebFOCUS Managed Reporting Administrator's Manual 215


Debugging

value: FATAL, ERROR, WARN, INFO, or DEBUG. FATAL is for minimum tracing, DEBUG
is for maximum tracing, and OFF turns the tracing option off.
Descriptions are optional.

7. Click Submit.
8. From the Configure Web Applications window, click Reload for the WebFOCUS76
application.

Procedure: How to Add the TRACE_LEVEL Parameter for UNIX and z/OS
1. From the WEB-INF directory, open the web.xml file.
2. Add the following immediately preceding the line </servlet>:
<init-param>
<param-name>TRACE_LEVEL</param-name>
<param-value>DEBUG</param-value>
</init-param>

3. Save and close the file.

Procedure: How to Remove or Modify the TRACE_LEVEL Parameter for Windows


1. Open the ServletExec Administration tool.
2. Under Web Applications, click Manage.
3. Under WebFOCUS76 Application Name, click web.xml.
4. Under Servlets, click Manage.
5. Under Servlet Name, click WORP_Loader.
6. Under Initialization Parameters, delete the TRACE_LEVEL parameter, or change the value
to OFF.
7. Click Submit.
8. From the Configure Web Applications window, click Reload for the WebFOCUS76
application.

Procedure: How to Remove or Modify the TRACE_LEVEL Parameter for UNIX and z/OS
1. From the WEB-INF directory, open the web.xml file.

216 WebFOCUS
11. Additional Administration Topics

2. Change the value in the TRACE_LEVEL parameter to OFF, as follows:


<init-param>
<param-name>TRACE_LEVEL</param-name>
<param-value>OFF</param-value>
</init-param>
Alternatively, you can delete the lines that were added for TRACE_LEVEL in the web.xml
file.

3. Save and close the file.

Procedure: How to Turn On Dynamic Tracing in Dashboard


1. In the WebFOCUS76\worp\conf directory, open the bid-config.xml file in a text editor.
Find the following line:
<trace-option trace-flag="false" trace-level="DEBUG"/>

2. Change the value to true.


3. Save and close the file.
You do not need to reload the servlet.

Reference: Dashboard Trace File Names


Trace files are named as follows:
<username>_<date>_<timestamp>.log
ADMIN_20010829_140159.log
where:
username
Is the name that the user logged in with, not the description in Managed Reporting.
date
Is the date in yyyymmdd format. For example, 20010829.
timestamp
Is the time using 24-hour time. For example, 24hhmmss, such as 14015959.
The log file for a user logged in as ADMIN on Aug 29th, 2001 at 2:01:59 PM would be:
ADMIN_20010829_140159.log

WebFOCUS Managed Reporting Administrator's Manual 217


Setting Up Traces for Managed Reporting User Requests

Reference: Dashboard Trace File Contents


Trace files contain the following information:
<thread number> <date> <time> <level> <location> <message>
where:
thread number
Is the number generated for each new task performed in the servlet
date
Is the date when the line of trace code is created. The format is MM/DD/YYYY.
time
Is the time when the particular trace code has been written to the trace file. The format
is hh:mm:ss:nnn.
level
Is the TRACE_LEVEL defined in the servlet parameters. Valid entries are FATAL, ERROR,
WARN, INFO, DEBUG or OFF.
location
Is the internal location called by the Dashboard. The format is <Java class name>.<Java
method name>.
message
Is the internal trace text.

Setting Up Traces for Managed Reporting User Requests


The MRUSERLOG and cgi_mrreq_log traces are available for logging Managed Reporting user
requests.
MRUSRLOG determines whether a log file of user actions is created and, if so, how frequently.
The cgi_mrreq_log trace can be used to detect which applications are still making calls to
the CGI or ISAPI to run Managed Reporting requests. For complete details see Technical
Memo 4575: WebFOCUS Managed Reporting and CGI/ISAPI Requests.
For complete details on tracing, see the WebFOCUS Security and Administration manual.

Repository File Name Processing


The Managed Reporting Repository supports long file names for My Reports, Standard
Reports, Reporting Objects, and Other files. The maximum length of a file name is 64
characters followed by a dot and an extension of up to 5 additional characters.

218 WebFOCUS
11. Additional Administration Topics

File names are created by Managed Reporting when procedures are copied into a Domain
from Data Servers, imported from the file system, or created by a tool. The file name is
based on the report description when created by a tool, or the file name when importing a
procedure. When a file name is being created, only lowercase alphanumeric characters,
underscores, and spaces are retained (all other characters are removed). Spaces are
converted to underscores, and repeating underscores are replaced by a single underscore.
The result is trimmed to 64 characters and the file extension is applied.
If this file name is unique, the file is written. If the file name is not unique, a random string
containing alpha and numeric characters is created and added to the file name, and the file
name is tested again for uniqueness. After a file name is created, it becomes the report
HREF referenced by launch pages, drill-downs, includes, and schedules.

Obtaining a List of Available Master Files


You can obtain a list of available Master Files more quickly while you work in the Managed
Reporting or Data Servers areas if you do not retrieve information based on the REMARKS
attribute that is stored within the Master File.
By default, Developer Studio opens and parses all available Master Files and determines if
the REMARKS attribute is available in order to display information in the Table List dialog
box. You can change this behavior and decrease the time required to display the list of
available tables because each table will not be opened and parsed for available remarks.
If you do not want Developer Studio to check for the REMARKS attribute, modify the
ibiapplets.txt file, typically located in the following directory:
install_drive:\IBI\WebFOCUS76\ibi_html\javaassist
In the ibiapplets.txt file, change the following text from
TABLE FILE SYSTABLE
PRINT REMARKS AS '
BY NAME AS ''
to:
TABLE FILE SYSTABLE
-*PRINT REMARKS AS ''
-*BY NAME AS ''
PRINT NAME AS ''

WebFOCUS Managed Reporting Administrator's Manual 219


Obtaining a List of Available Master Files

220 WebFOCUS
WebFOCUS

12 Application Integration Topics

This topic describes application


Topics:
integration topics.
Invoking the Deferred Report Status
Interface Directly
Managed Reporting Browser Window
Feature
Using Launch Pages Outside the
Default Repository

WebFOCUS Managed Reporting Administrator's Manual 221


Invoking the Deferred Report Status Interface Directly

Invoking the Deferred Report Status Interface Directly


You can invoke the Deferred Report Status Interface directly using an HTML page that calls
the WebFOCUS Client. Note that Deferred Receipt is a Managed Reporting feature.
Deferred Receipt functionality leverages the WebFOCUS and Managed Reporting security
and repository for storage and access to deferred output. The following guidelines should
be followed:
Valid Managed Reporting and WebFOCUS Signon must be done before invoking the
Deferred Status Interface.
The Deferred Status Interface Save option displays for all Managed Reporting users who
are assigned the Administrator, Developer, or Analytical User role and have the privilege
to create and save My Reports.

Example: Invoking the Deferred Report Status Interface


The following HTML page calls the WebFOCUS Client (configured with Servlet) and places a
"Deferred Status" button on the page that when clicked, invokes the Deferred Status
Interface.
<html>
<! --HTML to call Deferred Status interface -->
<title>Deferred Status </title>
<BODY BGCOLOR="White"LEFTMARGIN=0 TOPMARGIN=0>
<TABLE
<TR>
<TD><FONT FACE="Arial,Helvetica,sans-serif" SIZE="2">
<A HREF=/ibi_apps/WFServlet?IBIMR_action=MR_DEFER&IBIMR_return=
html&IBIMR_sub_action=MR_DEFER_CONTROL&>Deferred Status </A>
</TD>
</TR>
</TABLE>
</body>
</html>

222 WebFOCUS
12. Application Integration Topics

Managed Reporting Browser Window Feature


In this section:
WebFOCUS Managed Reporting Implementation
Site Customization
Browser Window Options
Browser Window Exceptions
Customizing the Amper Auto-Prompting Facility

You can utilize all available JavaScript options for controlling the way a browser window
looks. This allows you to customize Web browser windows so that they conform to their
application and organizational standards.
This feature does not change the default appearance or functionality of WebFOCUS Managed
Reporting. It specifically enables you to control the browser window look and options.
Note: This feature is only available when using an Internet Explorer browser.

WebFOCUS Managed Reporting Implementation

Reference:
JavaScript Code

You can control the way a browser window looks in Managed Reporting with the addition of
JavaScript code to the following:
Managed Reporting logon page—mr_ie.htm is located under /ibi_html/workbnch/ on
the server where WebFOCUS is installed.
Note: This technique applies to the HTM Managed Reporting logon pages. The JSP
Managed Reporting logon pages dynamically create the Managed Reporting logon page
so this technique is not available if you are using the JSP Managed Reporting logon
pages.
OLAP Control Panel file—drill.html is located under /ibi_html/javaassist on the server
where WebFOCUS is installed.
Deferred Report Status Interface—xxmrchft.def is located under
drive:\ibi\WebFOCUS76\client76\conf\etc on the server where the WebFOCUS Client
is installed. Note that xx is the 2 letter abbreviation for the language you select when
you log on to Managed Reporting.

WebFOCUS Managed Reporting Administrator's Manual 223


Managed Reporting Browser Window Feature

Reference: JavaScript Code


The following JavaScript code, located in the heading of the HTML logon pages for Managed
Reporting and the OLAP Control Panel file, launches the default browser window look and
options.
<SCRIPT LANGUAGE=JAVASCRIPT>
function doShowDoc(u,t)
{
t=t.replace(' ','A');
window.open(u,t);
}
</SCRIPT>
where:
u
Is the URL where the HTML for the browser window is located.
t
Is the new browser window name.
Caution: These parameters are set internally by WebFOCUS and must not be changed.

Site Customization

How to:
Control a Browser Window in the Deferred Report Status Interface

To customize the look of a window created by WebFOCUS Managed Reporting, you must
make manual changes to the JavaScript code and migrate them to any future version of
WebFOCUS.
To customize the browser window, determine the desired browser window options (for more
information, see Browser Window Options on page 226) and JavaScript code additions, and
add them after the last parameter in the JavaScript window.open call.

224 WebFOCUS
12. Application Integration Topics

Example: Customizing a Browser Window


If you want to suppress all browser controls, including the location bar (address or URL),
the JavaScript code presented in JavaScript Code on page 224 must be changed as follows:
window.open(u,t);
to
window.open(u,t,"location=0");
The following image shows the browser window without controls such as location bars,
toolbars, and scrollbars.

If you want to suppress the location bar and status bar but display the scroll bars, you must
change the JavaScript code presented in JavaScript Code on page 224 as follows:
window.open(u,t);
to
window.open(u,t,"location=0,status=0,scrollbars=1");

WebFOCUS Managed Reporting Administrator's Manual 225


Managed Reporting Browser Window Feature

Procedure: How to Control a Browser Window in the Deferred Report Status Interface
1. Make a backup or copy of xxmrchft.def, located in
drive:\ibi\WebFOCUS76\client76\conf\etc.
Where xx is the 2 letter abbreviation for the language you select when you log on to
Managed Reporting.

2. Edit xxmrchft.def, located in drive:\ibi\WebFOCUS76\client76\conf\etc.


3. Search for the following string:
window.open

4. Add the browser option ("location=0") to the window.open options before the last closing
parenthesis. For example, change:
nl,text,window.open(fixurl(aa),name);
to
nl,text,window.open(fixurl(aa),name,"location=0");
Note:
There are several instances of window.open. Apply this change to each instance.
The xxmrchft.def file is a WebFOCUS internal script file. Each line or continuation of
a line must begin with the text “nl,text”.

5. Clear the browser cache prior to testing.

Browser Window Options


You can modify the following browser window options:
Menu bar
Toolbar
Location bar
Directories bar
Status line
Scroll bars
Ability to resize the window
Closing a child window when a parent window closes
Width (in pixels)

226 WebFOCUS
12. Application Integration Topics

Height (in pixels)


Screen alignment (from the left of the screen, from the top of the screen)
When using JavaScript, you must specify all the options you want in your Managed Reporting
browser window. Once an option is specified, there are no default values assumed.
Caution: The first two parameters (u and t) in the window.open call are set internally by
WebFOCUS and must not be changed.

Example: Setting Browser Window Options


The following example shows how to open a new window, called open_window, in the upper
left corner of the window that displays the front page of Managed Reporting. The size of the
new window will be 640x480 pixels. To accomplish this, include the following HTML code
in the head of the original document:
<SCRIPT LANGUAGE=JAVASCRIPT>
function doShowDoc(u,t)
{
t=t.replace(' ','A');
window.open(u,t,menubar,toolbar,location,directories,status,scrollbars,
resizable,dependent,width=640,height=480,left=0,top=0);
}
</SCRIPT>

Browser Window Exceptions


WebFOCUS Managed Reporting does not create a new browser window when you:
Right-click a drill-down link in a WebFOCUS report and select Open.
Use the Ctrl+N sequence to create a new browser instance.
Access the following administrator tools from Managed Reporting:
The ReportCaster Console. When you run a log report from the Console, the browser
options cannot be controlled, since the applet does not create the browser window.
Two-Way Email. When you run the Job Log or Event Log from the Managed Reporting
Two-Way Email option on the blue toolbar, the browser options cannot be controlled,
since the applet does not create the browser window.

Customizing the Amper Auto-Prompting Facility


You can customize the look and feel of the amper auto-prompting facility by editing the
launch page template file you are using. All of the available launch page templates are
located in the ibi\WebFOCUS76\ibi_html\javaassist\ibi\html\describe directory. The default
template is autoprompt_top.css.

WebFOCUS Managed Reporting Administrator's Manual 227


Using Launch Pages Outside the Default Repository

If you want to customize the banner, create an image, save it in the describe directory, and
change the background-image property, which is shown in bold type in the following Cascading
Style Sheet (CSS) code:
#idBannerDiv {
height:45px;
background-image: url(logo_banner.gif);
background-position: top left;
background-repeat: no-repeat;
margin: 0;
margin-top:2px;
cursor:hand;}
The option to select different launch page templates can be set in the WebFOCUS
Administration Console using the Parameter Prompting selection under Client Settings, where
you can set the IBIF_describe_xsl value to one of the launch page templates.
You can also enter the name of the desired launch page template in a FOCEXEC using the
following code:
<describe_xsl>template</describe_xsl>
where:
template
Is set to one of the following launch page template values:
autoprompt_top - Displays the parameters horizontally at the top of the page and is
the default template value.
autoprompt_top_checked - Same as autoprompt_top, but the Run in a new window
check box is pre-selected.
autoprompt - Displays the parameters vertically at the left side of the page.
autoprompt_checked - Same as autoprompt, but the Run in a new window check box
is pre-selected.
autoprompt_simple - Basic input form.

Using Launch Pages Outside the Default Repository


Most sites will only use the Managed Reporting Repository directory, basedir, created by
the installation program, which is found under install_dir/WebFOCUS76. This repository is
referred to as the default repository because it is referenced by the variable MR_BASE_DIR
in the WebFOCUS script file named install_dir/WebFOCUS76/client76/wfc/etc/cgivars.wfs.
If you modify your Managed Reporting signon page to include the MR_BASE_DIR variable for
the purpose of overriding this setting, your launch pages will generate an error because they
assume that the Standard Report will be found in the default repository.

228 WebFOCUS
12. Application Integration Topics

You can make these launch pages work by adding the MR_BASE_DIR variable to your launch
pages as shown in the following example:
<INPUT TYPE="HIDDEN" NAME="MR_BASE_DIR"
VALUE="e:\ibi\WebFOCUS76\basedir_alt">
For more information on customizing signon pages, see Customizing the User Interface in
Working with Localized Versions in the National Language Support for International Computing
manual.

WebFOCUS Managed Reporting Administrator's Manual 229


Using Launch Pages Outside the Default Repository

230 WebFOCUS
WebFOCUS

13 Two-Way Email Administration

As a Managed Reporting Administrator


Topics:
and ReportCaster Administrator, you use
the Two-Way Email Administrator console Accessing the Administrator Console
to manage subscriber information,
monitor the execution of report requests, Adding or Deleting a Subscriber
cancel requests, and perform other Maintaining an E-mail Address
administrative tasks.
Refreshing a User's Templates
For information on developing Two-Way
Email templates, see the WebFOCUS Using the Job Log
Managed Reporting Developer's Manual.
Using the Event Log
Checking the Status of a Job or
Canceling a Job

WebFOCUS Managed Reporting Administrator's Manual 231


Accessing the Administrator Console

Accessing the Administrator Console


How to:
Access the Console and View Current Subscribers

The Two-Way Email Administrator console enables the Managed Reporting Administrator to
perform the following:
View Managed Reporting users currently subscribed to Two-Way Email and their e-mail
addresses.
Add a new subscriber or delete an existing one.
Maintain a user's e-mail address.
Re-send all templates to a user. This feature is called refreshing the templates.
View the status of an executed job using the Job Log and purge the Job Log.
Monitor e-mail traffic using the Event Log and purge the Event Log.
Check the status of an executing job or a queued job (one that is waiting to be sent to
the WebFOCUS Reporting Server for execution). You can also cancel a queued job.

Procedure: How to Access the Console and View Current Subscribers


In the Managed Reporting browser's blue toolbar, click Two-Way Email. In the Developer
Studio Explorer, click the Two-Way Email Administrator button in the toolbar.

232 WebFOCUS
13. Two-Way Email Administration

The Two-Way Email Administrator console opens in a scrollable window as shown in the
following image.

The console displays the following:


All Managed Reporting users currently subscribed to Two-Way Email, listed on the left
under Two-Way Email subscribers.
All e-mail addresses for a selected user, listed on the right under Addresses for subscriber.
You can only select one user at a time from the left-hand list. However, you can select more
than one address from the right-hand list when you are deleting multiple addresses or
selecting addresses for a refresh task.

Adding or Deleting a Subscriber


How to:
Add a New Subscriber
Delete an Existing Subscriber

Use the Administrator console to add a new subscriber to the Two-Way Email database or
delete an existing subscriber from the database.
When a Managed Reporting Administrator adds a new subscriber using the Two-Way Email
Administrator console, the subscriber receives a confirmation message from Two-Way Email,
acknowledging the subscription request. The user must reply to the message. The subscription
is activated once the confirmation process is complete.

WebFOCUS Managed Reporting Administrator's Manual 233


Adding or Deleting a Subscriber

Procedure: How to Add a New Subscriber


1. Select Two-Way Email on the Managed Reporting browser's blue toolbar to access the
Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way
Email Administrator button in the toolbar.
2. Click Add user. The Add Two-Way Email Subscriber window opens as shown in the
following image.

3. Enter the Managed Reporting user ID and password.


4. Enter the WebFOCUS Reporting Server user ID and password. To use default values
specified in the Two-Way tab in the ReportCaster Server Configuration Tool, click Use
default credentials.
5. Enter the user's e-mail address in the field under Two-Way Email Subscription. Click Add
and Two-Way Email will list the new user under Two-Way Email subscribers.
If the user already has a Two-Way Email account, you receive a message informing you
that the subscription procedure failed for that reason.
If you make a typing error on the window, click Reset to clear the fields and start over.

234 WebFOCUS
13. Two-Way Email Administration

Procedure: How to Delete an Existing Subscriber


1. Select Two-Way Email on the Managed Reporting browser's blue toolbar to access the
Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way
Email Administrator button in the toolbar.
2. Select the name of the subscriber you want to delete from the list on the left, under
Two-Way Email subscribers.
Click Delete user. A window opens, with the name of the selected subscriber.

3. Click Delete to remove the subscriber from the Two-Way Email database.

Maintaining an E-mail Address


How to:
Add a New E-mail Address
Delete an Existing E-mail Address

For any Two-Way Email user, you can:


Add a new e-mail address to the Two-Way Email database.
Delete an existing e-mail address from the Two-Way Email database. You can delete
multiple addresses at one time.
When you add a new e-mail address, the user receives a confirmation message at the new
address from Two-Way Email and must reply to it. The new address is activated once the
confirmation process is complete.

Procedure: How to Add a New E-mail Address


1. Select Two-Way Email on the Managed Reporting browser's blue toolbar to access the
Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way
Email Administrator button in the toolbar.
2. Using the console, select the user from the list on the left, under Two-Way Email
subscribers.
3. Click Add Email.
4. On the next dialog box, type the new e-mail address in the field. Click Add.

WebFOCUS Managed Reporting Administrator's Manual 235


Refreshing a User's Templates

Procedure: How to Delete an Existing E-mail Address


1. Select Two-Way Email on the Managed Reporting browser's blue toolbar to access the
Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way
Email Administrator button in the toolbar.
2. Using the console, select the user from the list on the left, under Two-Way Email
subscribers.
3. Select the address, or addresses, you want to remove from the list on the right, under
Addresses for subscriber.
4. Click Delete Email.
5. On the next dialog box, click Delete.
If you delete the only e-mail address associated with a user, the user's subscription to
Two-Way Email (that is, the user's account) is cancelled. You have an opportunity to
proceed with that action or discontinue the procedure.

Refreshing a User's Templates


How to:
Refresh a User's Templates

You can re-send a user's templates to a single e-mail address or to multiple addresses for
that user.

Procedure: How to Refresh a User's Templates


1. Select Two-Way Email on the Managed Reporting browser's blue toolbar to access the
Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way
Email Administrator button in the toolbar.
2. Using the console, select the user from the list on the left, under Two-Way Email
subscribers.
3. Select the address, or addresses, that the templates will be sent to using the list on
the right, under Addresses for subscriber.
4. Click Refresh Templates.
5. Click OK to re-send the templates the subscriber is authorized to use.

236 WebFOCUS
13. Two-Way Email Administration

Using the Job Log


In this section:
Viewing the Status of an Executed Job
Purging the Job Log

Use the Job Log to view information about a job (Standard Report procedure) sent to the
WebFOCUS Reporting Server for execution.
The Job Log is an HTML page that opens in a browser window.

Viewing the Status of an Executed Job

How to:
View the Status of an Executed Job

The Job Log displays information about the activities that occurred during the execution and
distribution of a report. It enables you to confirm that a report was executed and distributed
successfully. If a job does not conclude as expected, the Job Log states the reason why.
The following image is a sample entry from a Job Log.

It includes the following:


Two-Way Email Job Description. The name of the template associated with the job.
Server User. The WebFOCUS Reporting Server user ID.
Managed Reporting User. The Managed Reporting user ID.
Process. A unique, system-generated key that identifies a specific execution of the
template.

WebFOCUS Managed Reporting Administrator's Manual 237


Using the Job Log

Job Name. The name of the Managed Reporting Standard Report procedure, preceded
by app and the delimiter /.
Start Time. The date and time the job started running.
End Time. The date and time the job finished running.
Messages. Details on the activities that took place during job execution and distribution.

Procedure: How to View the Status of an Executed Job


1. Select Two-Way Email on the Managed Reporting browser's blue toolbar to access the
Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way
Email Administrator button in the toolbar.
2. Click the Job Log button on the left to display the Job Log Report information as shown
in the following image.

238 WebFOCUS
13. Two-Way Email Administration

3. Apply selection criteria to define the information that will be retrieved:


Use the drop-down lists for Start Date and Start Time to specify the beginning of the
time frame. Information on all jobs run from that date and time up to the current date
and time will be retrieved.
Enter the name of a specific Two-Way Email template in the Job Description field.
Information only for the jobs associated with that template during the specified time
frame will be retrieved.
Select Yes for Last Executed. Information only for the most recently executed job
associated with the template (Job Description) during the specified time frame will
be retrieved.

4. Click Click to View to display the Job Log report.

Purging the Job Log

How to:
Purge the Job Log

Because the Job Log accumulates information and can become difficult to navigate, it is a
good idea to periodically purge it to conserve space.
You can control automatic purging of the Job Log at predefined intervals of time. Edit the
parameter LOG_PURGE_PERIOD in the schedule section of the Distribution Server's
bkrsched.cfg file.
For example, to automatically purge Job Log reports every two days, enter:
LOG_PURGE_PERIOD 2
This parameter applies to the Two-Way Email Job Log and the ReportCaster Job Log. For
more information, see the ReportCaster Development and Administration manual.

Procedure: How to Purge the Job Log


1. Select Two-Way Email on the Managed Reporting blue toolbar to access the Two-Way
Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email
Administrator button in the toolbar.

WebFOCUS Managed Reporting Administrator's Manual 239


Using the Event Log

2. Click the Job Log button on the left to display the Job Log Report information as shown
in the following image.

3. Using the drop-down lists for Ending Date, specify a date through which the Job Log will
be purged.
4. Click Click to Purge. Respond to the confirmation message on the next dialog box.
Two-Way Email will delete all reports from the beginning of the Job Log through the
specified ending date.

Using the Event Log


In this section:
Monitoring E-mail Traffic
Purging the Event Log

Use the Event Log to monitor the status of a Two-Way Email request as it is received,
assessed for security, sent to the WebFOCUS Reporting Server for execution, and distributed
as a report.
The Event Log is an HTML page that opens in a browser window.

240 WebFOCUS
13. Two-Way Email Administration

You can customize the content of the Event Log. Edit the parameter EVENTLOG in the Two-
Way Email tab window of the Distribution Server's file as shown in the following image.

The descriptions for each setting are outlined in the following table.

Setting Description

OFF Turns off the Event Log. Nothing is displayed.

ERROR Displays only errors.

ON Displays all events.

WebFOCUS Managed Reporting Administrator's Manual 241


Using the Event Log

Monitoring E-mail Traffic

How to:
Monitor E-mail Traffic

The following image shows sample entries from an Event Log that displays only errors.

Each entry includes the following:


Time. The date and time the event occurred.
Server User. The WebFOCUS Reporting Server user ID.
Managed Reporting User. The Managed Reporting user ID.
Email Address. The user's e-mail address.
Message. Description of the error that occurred.

Procedure: How to Monitor E-mail Traffic


1. Select Two-Way Email on the Managed Reporting browser's blue toolbar to access the
Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way
Email Administrator button in the toolbar.

242 WebFOCUS
13. Two-Way Email Administration

2. Click the Event Log tag on the left to display the Event Log Report information as shown
in the following image.

3. Apply selection criteria to define the information that will be retrieved:


Use the drop-down lists for Start Date to specify the beginning of the time frame that
you are interested in. Information on all events that occurred from that date up to
the current date will be retrieved.
Enter an Managed Reporting user ID in the Managed Reporting User field. Information
only for the events associated with that user ID during the specified time frame will
be retrieved.
Enter a WebFOCUS Reporting Server user ID in the WebFOCUS User field. Information
only for the events associated with the supplied Managed Reporting user ID and
WebFOCUS Reporting Server user ID during the specified time frame will be retrieved.
Enter an e-mail address in the Email Address field. Information only for the events
associated with the supplied IDs and address during the specified time frame will
be retrieved.

4. Click Click to View to display the Event Log report.

WebFOCUS Managed Reporting Administrator's Manual 243


Using the Event Log

Purging the Event Log

How to:
Purge the Event Log

Because the Event Log accumulates information and can become difficult to navigate, it is
a good idea to periodically purge it to conserve space.

Procedure: How to Purge the Event Log


1. Select Two-Way Email on the Managed Reporting browser's blue toolbar to access the
Two-Way Email Administrator console. In the Developer Studio Explorer, click the Two-Way
Email Administrator button in the toolbar.
2. Click the Event Log tag on the left to display the Event Log Report information as shown
in the following image.

3. Using the drop-down lists for Ending Date, specify a date through which the Event Log
will be purged.
4. Click Click to Purge. Respond to the confirmation message on the next dialog box.
Two-Way Email will delete all reports from the beginning of the Event Log through the
specified ending date.

244 WebFOCUS
13. Two-Way Email Administration

Checking the Status of a Job or Canceling a Job


How to:
Check the Status of a Job
Cancel a Queued Job

You can check the status of an executing job or one that is waiting to be sent to the
WebFOCUS Reporting Server for execution (a queued job). You can also cancel a queued
job.

Procedure: How to Check the Status of a Job


1. Select Two-Way Email on the Managed Reporting blue toolbar to access the Two-Way
Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email
Administrator button in the toolbar.
2. Click the Job Status button on the left to display a scrollable window as shown in the
following image.

Jobs currently running on the WebFOCUS Reporting Server are displayed at the top of
the window, under Running Jobs.
Jobs waiting to be sent to the WebFOCUS Reporting Server for execution are displayed
near the bottom of the window, under Queued Jobs.

WebFOCUS Managed Reporting Administrator's Manual 245


Checking the Status of a Job or Canceling a Job

The following information identifies a job:


Job Number. The unique, system-generated key for a specific execution of a report.
Started On (under Running Jobs). The date and time the job started running on
the WebFOCUS Reporting Server.
Submitted (under Queued Jobs). The date and time the job was submitted to the
WebFOCUS Reporting Server for execution.
Two-Way Fex. The name of the procedure for the Managed Reporting Standard
Report.
Originator. The e-mail address from which the request originated.

3. The option Refresh this window every n seconds is checked by default, retrieving the
latest information after the specified interval of time. You can accept the default interval
of 10, as shown in the following image, or supply the interval in seconds. Click Refresh
to immediately retrieve the latest information.

Procedure: How to Cancel a Queued Job


1. Select Two-Way Email on the Managed Reporting blue toolbar to access the Two-Way
Email Administrator console. In the Developer Studio Explorer, click the Two-Way Email
Administrator button in the toolbar.
2. Click the Job Status button on the left.
3. Select one or more jobs from the list under Queued Jobs. Click Delete to cancel execution.

246 WebFOCUS
WebFOCUS

14 Managing Deferred Tickets

The topics in this chapter contain


Topics:
information to help Managed Reporting
Administrators manage deferred Managing Deferred Workload
workload and the Deferred Ticket
Cleanup Utility. Managing the Deferred Ticket Cleanup
Utility

WebFOCUS Managed Reporting Administrator's Manual 247


Managing Deferred Workload

Managing Deferred Workload


In this section:
Understanding Alternate Deferred Servers
Configuring Deferred Services
Deferred Report Expiration Setting
Reading Saved Deferred Output Created by WebFOCUS CGI/ISAPI Client

You can connect from a single WebFOCUS Client installation to multiple WebFOCUS Reporting
Servers. This means that it is possible for a single user to have deferred tickets for output
residing on multiple servers. Moreover, these servers can be on different platforms and may
require different user IDs. Users have access to all deferred output, regardless of location,
and are prompted for credentials automatically as needed.
There are administrator settings for managing deferred workload. There can be up to one
alternate deferred server per immediate server to separate interactive and deferred
processing. You can limit the number of server agents allocated to handling deferred requests
and the number of deferred requests a given user can process at one time (these features
are not available on OS/390 MVS). On OS/390 MVS, the UNIQUE global keyword restricts
simultaneous server connections to one per logon ID, which can be used to manage both
deferred and interactive workload when server authentication is used.

Understanding Alternate Deferred Servers


You can configure an alternate deferred server for one or more of your interactive servers.
This causes deferred requests to run against a specific server and be routed to another
server for processing. For example, if you are building a report in a domain that has a server
set to HPUXPROD, as shown in the following image, and you do not change this setting.

248 WebFOCUS
14. Managing Deferred Tickets

The report will run against HPUXPROD, but will run deferred against HPPRODDF because of
the relationship configured in the WebFOCUS Administration Console, as shown in the
following image.

Configuring alternate deferred servers is one way to manage deferred workload. Typically,
the alternate deferred server is given fewer processing resources since users are not waiting
interactively for the request to finish. This allows the interactive servers to have relatively
more processing resources.
If you do not have access to the WebFOCUS Administration Console, contact your WebFOCUS
Administrator or see the WebFOCUS Security and Administration manual.

Configuring Deferred Services


You can also manage the resources allocated to processing deferred requests without
configuring additional servers. The WebFOCUS Server Web Console for a specific server
allows you to configure workload settings for deferred requests independently of interactive
requests.

WebFOCUS Managed Reporting Administrator's Manual 249


Managing Deferred Workload

As an example shown in the following image, you can set the max_connections_per_user
to 1 for the Deferred Service while allowing users to submit unlimited concurrent interactive
requests.

If you do not have access to the WebFOCUS Server Web Console, contact your WebFOCUS
Server Administrator or see the Server Administration for UNIX, Windows, OpenVMS, i5/OS,
and z/OS manual.

Deferred Report Expiration Setting

How to:
Control Purging of Deferred Output

The WebFOCUS Reporting Server has an output expiration setting that controls when deferred
output is purged from the WebFOCUS Reporting Server. This setting is made in the server
configuration file (Windows and UNIX) and the deferred receipt listener node block (on z/OS).

250 WebFOCUS
14. Managing Deferred Tickets

Syntax: How to Control Purging of Deferred Output


dfm_maxage={0|n}
where:
0
Indicates no expiration is configured.
n
Indicates n days until expiration.
No setting means that the default of 30 days will be in effect.
The number of days until expiration are displayed next to each report. On the last day, the
value Today is displayed.
Note: Cleanup of deferred output stored on the WebFOCUS Reporting Server is facilitated
by the Deferred Management listener, which checks every time it wakes up. The listener's
sleep interval is defined by the dfm_int_max parameter which defaults to 30 seconds if not
specified. For more information about this and related parameters, click Deferred, followed
by Keyword Reference under the WebFOCUS Reporting Server's Web Console Help link.
If a deferred report is not saved or deleted prior to its expiration, the output is automatically
deleted from the WebFOCUS Reporting Server's dfm_dir directory and the deferred report is
moved to the Unknown category in the Deferred Report Status Interface. From here, the user
can only delete the orphaned report. For more information about cleaning up orphaned
deferred tickets, see Managing the Deferred Ticket Cleanup Utility on page 252.

Reading Saved Deferred Output Created by WebFOCUS CGI/ISAPI Client


In previous releases, when WebFOCUS was configured to use the CGI/ISAPI client, deferred
output saved to a user's My Reports folder in the Managed Reporting Repository was written
in a format that was incompatible with the WebFOCUS Servlet (WFServlet). This meant that
if you upgraded to WebFOCUS Version 7 Release 1, which required the WFServlet configuration
for Managed Reporting, you could not access your saved deferred output. The WFServlet
now detects and reads the legacy output format, while continuing to read and write with the
newer format.
The WF_CGI_ENDIANNESS setting is located in the Managed Reporting section of the
Configuration menu of the WebFOCUS Administration Console. This setting is used by
WFServlet to determine the byte order of the deferred output. If your legacy saved deferred
output was created on a platform with a little-endian byte order, such as Intel x86, you should
keep the default setting of LITTLE. If the output was created on a big-endian platform such
as IBM S/390, z/Series, and some UNIX and Linux systems, you should change the setting
to BIG. Some platforms can be configured either way so consult with your administrator or
experiment if you are unsure of the proper setting for your environment.

WebFOCUS Managed Reporting Administrator's Manual 251


Managing the Deferred Ticket Cleanup Utility

Because WFServlet runs on Java™ technology, which is always big-endian, new deferred
output will always be written in big-endian format. WF_CGI_ENDIANNESS is therefore used
by WFServlet only to know which way to read legacy saved deferred output created by the
WebFOCUS CGI/ISAPI Client.

Managing the Deferred Ticket Cleanup Utility


In this section:
Deferred Ticket Cleanup Utility Processing
MR Repository and User Credentials
WebFOCUS Reporting Server and User Credentials
Log File and Backup of User HTM File
Running the MR Deferred Ticket Cleanup Utility
Processing Multiple MR Repositories in Silent Mode
Troubleshooting

The Managed Reporting (MR) Deferred Ticket Cleanup Utility (mrdtcleanup) enables a Managed
Reporting Administrator to clean up (delete) deferred tickets across all MR users that do
not have corresponding report output on the WebFOCUS Reporting Server to which the
deferred request was submitted. Running this utility cleans up the deferred tickets (within
the specified Managed Reporting Repository) for deferred report output deleted by the
WebFOCUS Reporting Server as specified by the dfm_maxage deferred management
parameter. The dfm_maxage parameter defines the maximum number of days that deferred
reports are kept on the WebFOCUS Reporting Server after they are created.
Additionally, deferred requests submitted to WebFOCUS Reporting Servers that are not
defined in the WebFOCUS Client configuration file (odin.cfg) are also deleted. Before running
this utility, it is important to confirm that there have not been any WebFOCUS Reporting
Server nodes temporarily removed from the WebFOCUS Client's odin.cfg file.
The Deferred Ticket Cleanup Utility (mrdtcleanup) is located in the /ibi/WebFOCUS76/utility
directory. On Windows, there is a mrdtcleanup.bat file and on UNIX-based platforms there
is a mrdtcleanup script file. You can run the Deferred Ticket Cleanup Utility in interactive
mode, silent mode, or help mode. Silent mode is useful for overnight batch processing. For
information on running the utility in all modes, see Running the MR Deferred Ticket Cleanup
Utility on page 259.

252 WebFOCUS
14. Managing Deferred Tickets

Deferred Ticket Cleanup Utility Processing


The Deferred Ticket Cleanup Utility processes the information within a Managed Reporting
Repository. Multiple MR repositories can be processed, but each MR Repository is processed
individually. All active and inactive MR users' deferred tickets within the specified Managed
Reporting Repository are processed.
Each MR user's deferred reports are processed individually, making a single connection to
each WebFOCUS Reporting Server to which the user has submitted deferred tickets. If the
WebFOCUS Reporting Server is not defined in the WebFOCUS Client Configuration file
(odin.cfg), the deferred tickets submitted to that node are deleted from the Managed Reporting
Repository because the WebFOCUS Client cannot make a connection to that server to process
the user's deferred tickets.
When a successful connection is made to the WebFOCUS Reporting Server, it returns status
information for each of the user's deferred tickets submitted to that server. The WebFOCUS
Client processes the status information to confirm the existence of deferred report output.
Deferred tickets, for which report output does not exist, are deleted from the Managed
Reporting Repository.
If the WebFOCUS Reporting Server is defined in the WebFOCUS Client Configuration file
(odin.cfg), but the WebFOCUS Client cannot establish a connection, the user's deferred
tickets for that WebFOCUS Reporting Server are not deleted. Deferred tickets are only deleted
upon confirmation that deferred report output does not exist.
Each time the Deferred Ticket Cleanup Utility runs, a log file and a backup of each MR user's
HTML file are created. For information on the log file and backup files the Deferred Ticket
Cleanup utility creates, see Log File and Backup of User HTM File on page 256.

MR Repository and User Credentials


The Deferred Ticket Cleanup Utility processes the default MR Repository in the WebFOCUS
Client configuration (MR_BASE_DIR). When running in interactive mode, the utility prompts
you for the location of the MR Repository so you can specify a different MR Repository
location.
When running in silent mode, edit the mrdtcleanup utility file in the WebFOCUS Client /utilities
directory and set the REPOS variable to the fully qualified path of the MR Repository to be
processed. If you want to process multiple MR repositories in silent mode, make a copy of
the mrdtcleanup utility file for each MR Repository you want to process, and set the REPOS
variable in each to the MR Repository to be processed. For information on how to create a
utility file to process multiple MR repositories when running in silent mode, see Processing
Multiple MR Repositories in Silent Mode on page 269.

WebFOCUS Managed Reporting Administrator's Manual 253


Managing the Deferred Ticket Cleanup Utility

The user running the Deferred Ticket Cleanup Utility must be a Managed Reporting
Administrator. When running in interactive mode, the utility prompts for MR credentials.
When running in silent mode, the MR credentials must be passed as parameters to the
utility. For more information, see Running the MR Deferred Ticket Cleanup Utility on page 259.

WebFOCUS Reporting Server and User Credentials

How to:
Specify Server Credentials in Site.wfs
Reference:
Validation of Server Credentials in Silent Mode
WebFOCUS Reporting Server Processing
Trusted Reporting Server Connection Restriction

One or more WebFOCUS Reporting Servers and user credentials can be optionally specified
in the site.wfs file for running in interactive mode, and these are required in site.wfs for
running in silent mode. You can edit the site.wfs settings in the WebFOCUS Administration
Console from the Custom Settings panel under the Configuration menu. There is an option
in the console to encrypt the site.wfs file, which is recommended to secure the user
credentials.

Syntax: How to Specify Server Credentials in Site.wfs


Edit the site.wfs file using the following syntax:
<ifdef> IBIMR_dtcleanup
WF_CCREDENTIALS=node1:id1:pwd1|node2:id2:pwd2|...
<endif>
where:
node1
Is a WebFOCUS Reporting Server node name (NODE) that must be defined in the
WebFOCUS Client's odin.cfg configuration file (/ibi/WebFOCUS76/client76/etc/odin.cfg).
This file is accessible in the WebFOCUS Administration Console from the Remote Services
panel under the Reporting Servers menu.
You can use an asterisk (*) for the node name if you want to specify the same user ID
and password for all server nodes. This is useful if there are servers in a cluster. You
can also use a combination of * and specific node names for some WebFOCUS Reporting
Servers.

254 WebFOCUS
14. Managing Deferred Tickets

id1
Specifies the WebFOCUS Reporting Server user ID for the first server node specified.
pwd1
Specifies the password for the WebFOCUS Reporting Server user ID.
The Deferred Ticket Cleanup Utility reads the odin.cfg file to obtain the WebFOCUS Reporting
Server node connection information. In interactive mode, the user may specify a different
WebFOCUS Reporting Server user ID and password and additional WebFOCUS Reporting
Server node names and credentials than those specified in the site.wfs file. In silent mode,
the WebFOCUS Client automatically attempts to log on to the WebFOCUS Reporting Servers
without prompting for credentials.

Reference: Validation of Server Credentials in Silent Mode


Validation of WebFOCUS Reporting Server credentials is not performed when a user specifies
credentials initially. This is because the WebFOCUS Reporting Servers to which the deferred
tickets were submitted are not determined until the utility processes MR user deferred report
information. Additionally, there may be WebFOCUS Reporting Servers running that are not
in secure mode, making credentials unnecessary for establishing a connection. Not performing
validation when the utility begins processing eliminates the unnecessary overhead of
connecting to servers to which no MR users have submitted deferred requests.

Reference: WebFOCUS Reporting Server Processing


Each MR user's HTM file is separately processed to obtain deferred ticket information. The
number of times a connection is made to a WebFOCUS Reporting Server depends on the
number of MR users that have deferred tickets for that server. Only one connection is made
per user for the processing of deferred tickets for each server.

Reference: Trusted Reporting Server Connection Restriction


Because the Deferred Ticket Cleanup Utility is a standalone program, you cannot run the
utility in an environment that uses a Trusted connection to the Reporting Server. As a
standalone program, the Deferred Ticket Cleanup Utility is unable to retrieve credentials to
connect to the Reporting Server. If you must cleanup deferred tickets with a Trusted Reporting
Server connection, use the Deferred Status Interface. For more information, see the Using
the Deferred Report Status Interface chapter in the WebFOCUS Managed Reporting End User's
Manual.

WebFOCUS Managed Reporting Administrator's Manual 255


Managing the Deferred Ticket Cleanup Utility

Log File and Backup of User HTM File

Reference:
Log File
Backup of MR User HTM File

Each time the Deferred Ticket Cleanup Utility runs, the WebFOCUS Client creates a log file
and a backup of each MR user HTM file.

Reference: Log File


The log file contains processing details such as timestamp information at the beginning of
each file. All information appears, and if MR user credentials are written to the file, the
password is masked for security reasons. The file name of the log file is in the following
form:
mrdtcleanup_date_time.log
where:
date
Is the date the log file was created in Year Month Day (YYYY-MM-DD) format.
time
Is the time the log file was created in Hour Minute Second (HMS) format.

256 WebFOCUS
14. Managing Deferred Tickets

Log files are created in the drive:\ibi\WebFOCUS\logs directory and can be viewed by clicking
the MR Deferred Ticket Cleanup Utility option on the Traces menu under the Diagnostics
section of the WebFOCUS Administration Console, as shown in the following image.

To view information for a log file, click the link with the desired date and time that has a .log
file extension listed in the right pane of the console. To delete a log file, select the check
box next to the file and click the Delete button at the bottom of the console. You can also
use the Select All and Deselect All options as needed, or click the Refresh option to ensure
that the latest information appears in the console.
For an example of a log file created in interactive mode, see Sample Log File Created in
Interactive Mode on page 258.

WebFOCUS Managed Reporting Administrator's Manual 257


Managing the Deferred Ticket Cleanup Utility

Example: Sample Log File Created in Interactive Mode


:================================================================
1: user log opened Wed Mar 29 13:43:32 EST 2006
2:===============================================================
3:createWFLog(WFContext.java:1712):Starting WebFOCUS log-file for mrdrdel
MRDTCleanup : 1 argument(s) has been received :
-cd:\ibi\webfocus76\webapps\webfocus76\WEB-INF
4:main(MRDTCleanup.java:104):The Utility to delete Unknown Deferred
Report Tickets has started...
5:isSilentMode(MRDTCleanup.java:174):as there was no option "-s" passed
checking if silent mode is set in site.wfs file.
6:isSilentMode(MRDTCleanup.java:176):MRDT_AUTODELETE is set to : null
7:main(MRDTCleanup.java:116):Utility is running in interactive mode
8:runInInteractiveMode(MRDTCleanup.java:367):MR Default Repository will
be processed
9:runInInteractiveMode(MRDTCleanup.java:378):Authenticating MR user
against specified Repository.
10:runInInteractiveMode(MRDTCleanup.java:381):authenticating MR User
:admin
11:runInInteractiveMode(MRDTCleanup.java:382):for MR Repository :
12:checkWFCCredentials(MRDTCleanup.java:487):Checking WF credentials
information...
13:checkWFCCredentials(MRDTCleanup.java:501):No WF Server credentials
specified in site.wfs WF configuration file.
14:checkWFCCredentials(MRDTCleanup.java:502):The Utility will prompt for
the credentials to be provided by user
15:deleteUnknownDeferTickets(WFMRRepository.java:2055):
Processing of MR repository D:/ibi/WebFOCUS76/basedir starting.
16:deleteUnknownDeferTickets(WFMRRepository.java:2067):Getting a list of
users on the repository
17:deleteUnknownDeferTickets(WFMRRepository.java:2078):Processing
deferred tickets for admin
18:deleteUnknownDeferTickets(WFMRRepository.java:2090):Creating a backup
of user's html file admin.htm
19:deleteUnknownDeferTickets(WFMRRepository.java:2114):user's html file
exists, - copying it to D:/ibi/WebFOCUS76/
basedir\admin_mrdrdel_060329_134332.bak
20:readFile(WFFileUtil.java:667):reading file D:/ibi/WebFOCUS76/
basedir\admin.htm
21:readFile(WFFileUtil.java:758):new FileInputStream is created to read
the file admin.htm
22:readFile(WFFileUtil.java:765):Successfully finished reading file
admin.htm
.
.
.
42:deleteUnknownDeferTickets(WFMRRepository.java:2197):MR user admin
processing ended

258 WebFOCUS
14. Managing Deferred Tickets

Reference: Backup of MR User HTM File


A backup is created for each MR user HTM file processed in the MR Repository being
accessed. The default MR Repository is specified by the MR_BASE_DIR variable in the
WebFOCUS Client configuration file (cgivars.wfs). OS level tools can be used to view the
contents of the MR user HTM backup file or restore the user's working file with the backup
file. After restoring the user's working file, the WebFOCUS Client Memory must be refreshed,
which can be done via the WebFOCUS Administration Console.
The file name of the MR user HTM backup file is in the following form:
user_mrdrdel_date_time.bak
where:
user
Is the MR user's HREF value.
date
Is the date in YYMMDD format.
time
Is the time in HHMMSS format.
MR user HTM backup files must be deleted manually.

Running the MR Deferred Ticket Cleanup Utility

How to:
Run the MR Deferred Ticket Cleanup Utility
Run the MR Deferred Ticket Cleanup Utility in Silent Mode
Run the MR Deferred Ticket Cleanup Utility in Interactive Mode
Run the MR Deferred Ticket Cleanup Utility in Help Mode
Reference:
Requirements for Running the Deferred Ticket Cleanup Utility
MR Deferred Ticket Cleanup Utility File Comments

The Deferred Ticket Cleanup Utility is an operating system-specific command program


(mrdtcleanup) that calls Java program MRDTCleanup and is installed in the /utilities directory
under the WebFOCUS Client installation.

WebFOCUS Managed Reporting Administrator's Manual 259


Managing the Deferred Ticket Cleanup Utility

In a Windows environment, to run in interactive mode, select from the Programs menu
(Information Builders, WebFOCUS76, Utilities, and then Cleanup Unknown Deferred Tickets).
To run in silent mode or obtain help information on the Java program (MRDTCleanup),
open a command window and navigate to the installation_drive:\ibi\WebFOCUS76\utility
directory. For parameter values to specify for running in silent mode, or to obtain help
information for Java program (MRDTCleanup) arguments, see How to Run the MR Deferred
Ticket Cleanup Utility on page 262.
In a UNIX environment, to run in interactive mode, select the mrdtcleanup script file,
which is located in the /ibi/WebFOCUS76/utility directory. The UNIX script file only
supports lowercase letters (-I, -s, -h) as the first parameter for each argument. For
parameter values to specify for running in silent mode, or for information on Java program
(MRDTCleanup) arguments, see How to Run the MR Deferred Ticket Cleanup Utility on
page 262.

Reference: Requirements for Running the Deferred Ticket Cleanup Utility


The following are the requirements for running the Deferred Ticket Cleanup Utility:
The user must be a Managed Reporting Administrator.
The application server on which the WebFOCUS Client is installed and configured must
be available. The WebFOCUS Client is called by the application server for MR security
authorization and authentication, deferred reporting, and communication to WebFOCUS
Reporting Servers.
The fully qualified path to the location of web.xml in the WebFOCUS Client installation
directory must be provided.
The user ID that is running the Deferred Ticket Cleanup Utility must have read and write
access to read and delete deferred tickets and to create the backup HTML file for each
MR user repository file that is processed.
When WebFOCUS is configured for Managed Reporting Realm Driver for DBMS External
Authentication and/or DBMS External Authorization, the path to the JDBC driver needs
to be supplied. Set the JDBC_DRIVER_JARS variable to the full path to the JDBC driver
jar file(s).
If your JDBC driver consists of more than one Jar file, separate the multiple jar file paths
with a semi-colon in a Windows environment, or a colon in a UNIX environment. For
example:
JDBC_DRIVER_JARS=C:\Program Files\Microsoft SQL Server 2000 Driver for
JDBC\lib\mssqlserver.jar;C:\Program Files\Microsoft SQL Server 2000
Driver for JDBC\lib\msutil.jar;C:\Program Files\Microsoft SQL Server
2000 Driver for JDBC\lib\msbase.jar

260 WebFOCUS
14. Managing Deferred Tickets

When running in silent mode:


WebFOCUS Reporting Server node names and credentials must be specified in the
WebFOCUS Client configuration file, site.wfs. For information on specifying server and
user credentials in site.wfs, see WebFOCUS Reporting Server and User Credentials on
page 254.
The MR Administrator user ID and password must be specified as parameters on the
call to the mrdtcleanup utility. For information on specifying the MR Administrator user
ID and password values as parameters, see How to Run the MR Deferred Ticket
Cleanup Utility on page 262.

Reference: MR Deferred Ticket Cleanup Utility File Comments


The .bat and UNIX script files contain comments with the following sections clearly identified:
Parameters - Contains information on parameters accepted by the utility from the command
line.
Purpose - Explains functional purpose of the utility.
Requirements - Explains information required for running the utility, and user authorization
and authentication requirements.
Usage Notes - Contains information on arguments the Java program (MRDTCleanup) accepts.
You can obtain the help information by specifying '-h' as the first parameter. See Additional
Administration Topics on page 211.
Variable Definition - Variables created and used by the utility, including:
Mode in which the utility is running (interactive, silent, help).
MR Repository.
MR user credentials for running in silent mode.
Directory path information. Note that the variable name WFJAVAASSIST uses relative
referencing, so it is recommended that you run the utility from the /utilities directory
under the WebFOCUS Client installation.
CLASSPATH the Java program (MRDTCleanup) will use.
Interactive Mode - Command block for running in interactive mode. This is the default
mode of execution.
Silent Mode - Command block for running in silent mode.
Help Mode - Command block for running in help mode to get usage information for the Java
utility.

WebFOCUS Managed Reporting Administrator's Manual 261


Managing the Deferred Ticket Cleanup Utility

Interactive Mode - Command block for running in interactive mode. This is the default
mode of execution.
Silent Mode - Command block for running in silent mode.
Help Mode - Command block for running in help mode to get usage information for the Java
utility.

Procedure: How to Run the MR Deferred Ticket Cleanup Utility


To run the MR Deferred Ticket Cleanup Utility in silent mode or help mode, you must supply
appropriate parameters. If no parameters are supplied, the utility runs in interactive mode
and you are prompted for each parameter.
From the /utilities directory under the WebFOCUS Client installation (for example, on UNIX:
/ibi/WebFOCUS76/utility), enter the following on the operating system command line:
mrdtcleanup parm1 parm2 parm3
where:
parm1
Is the mode in which the utility is run. If no value is entered, the default is interactive
mode.
-i runs the utility in interactive mode.

-s runs the utility in silent mode.

-h returns argument information for the Java program (MRDTCleanup).

parm2
Is the value of the MR Administrator user ID, which is required for silent mode.
parm3
Is the password for the MR Administrator user ID, which is required for silent mode.

Procedure: How to Run the MR Deferred Ticket Cleanup Utility in Silent Mode
When you run the Deferred Ticket Cleanup Utility in silent mode, the MR Administrator user
ID and password and the WebFOCUS Reporting Server node names and user credentials,
must be provided because there is no user interaction while the utility is running.
By default, the MR Repository specified by the WebFOCUS Client variable MR_BASE_DIR is
the one that is processed. To process a different MR Repository, make a copy of the
mrdtcleanup utility file. Edit the copied file and set the REPOS variable to the fully qualified
path of the directory of the MR Repository to be processed.

262 WebFOCUS
14. Managing Deferred Tickets

To run the utility in silent mode, from the /utilities directory under the WebFOCUS Client
installation (for example: /ibi/WebFOCUS76/utility on UNIX), enter the following on the
operating system command line:
mrdtcleanup -s parm2 parm3
Informational messages appear, informing you of processing status. Review the log file
created by the utility to confirm that processing completed successfully.
Note: For information on how to create a utility file to process multiple MR repositories when
running in silent mode, see Processing Multiple MR Repositories in Silent Mode on page 269.

Procedure: How to Run the MR Deferred Ticket Cleanup Utility in Interactive Mode
When you run the Deferred Ticket Cleanup utility in interactive mode, it provides prompts
and informational messages to help guide you through each step of the process of deleting
unknown deferred tickets. To run the utility in interactive mode, perform the following steps.
1. On Windows, select the following from the Programs menu:Information Builders,
WebFOCUS76, Utilities, and then Cleanup Unknown Deferred Tickets.
On UNIX, from the /utilities directory under the WebFOCUS Client installation
(/ibi/WebFOCUS76/utility directory), on the operating system command line enter:
mrdtcleanup
The following messages appear:
Managed Reporting utility to delete Unknown Deferred Report tickets is
being called in Interactive Mode.
The Utility to delete Unknown Deferred Report Tickets has started.

2. The utility prompts you to enter MR Repository information.


Enter MR Repository location to cleanup (press Enter to use the
default MR Repository):
The default MR Repository is specified by the MR_BASE_DIR variable in the WebFOCUS
Client configuration file (cgivars.wfs). The utility validates that the directory path entered
is a valid MR Repository by confirming that the user.htm and mrrepos.htm files reside
in that directory. If confirmation is not successful, the following message appears and
the utility continues to prompt for MR Repository information:
Location specified <location> is not a valid MR Repository.

WebFOCUS Managed Reporting Administrator's Manual 263


Managing the Deferred Ticket Cleanup Utility

3. The utility displays the following prompts for MR user ID and password (with masking
on the password) and validates that the credentials entered belong to an MR
Administrator.
Enter valid MR Administrator user ID for repository specified:
<value> (must be a non-blank value)

Enter password for MR Administrator user


(press Enter for empty password value):*
* (blank value permitted and value entered is masked by * for each
character entered)

Please, re-enter password for MR Administrator user


(press Enter for empty password value):*
* (blank value permitted and value entered is masked by * for each
character entered)
If credentials are not successfully validated, the following messages appear:
The passwords you typed do not match.
Please enter your password again.

Enter password for MR Administrator user


(press Enter for empty password value):*
* (blank value permitted and value entered is masked by * for each
character entered)

Please, re-enter password for MR Administrator user


(press Enter for empty password value):*
* (blank value permitted and value entered is masked by * for each
character entered)

264 WebFOCUS
14. Managing Deferred Tickets

If the MR user credentials do not belong to a valid MR Administrator, the following


messages appear and the utility continues to prompt for MR Administrator credentials:
Enter valid MR Administrator user ID for repository specified:
<user ID>

Enter password for MR Administrator user


(press Enter for empty password value):*

Please, re-enter password for MR Administrator user


(press Enter for empty password value):*
*Authenticating MR User: <user ID>

Provided user is not an MR Administrator.


Would you like to enter another MR User ID and password?(yes/no)
Enter "no" to skip processing of this repository or
press Enter to continue with "yes" value:

Enter valid MR Administrator user ID for repository specified:


<user ID>

Enter password for MR Administrator user


(press Enter for empty password value):*
When credentials are validated, the following message appears:
MR Administrator credentials successfully authenticated

4. The WebFOCUS Reporting Server node names are read from the WebFOCUS Client's
odin.cfg file and verified in the “indef” block of the site.wfs file, which defines the valid
WebFOCUS Reporting Servers and user credentials that can be used by this utility. The
following prompt appears:
Checking for WF Server credentials optionally specified
in WF Client configuration file (site.wfs)...

Following WF Server is configured in odin.cfg:

Node name : <server name> Host name : <host name>


If server nodes are not defined in site.wfs, the following prompt appears:
No WF Server credentials specified in site.wfs WF configuration file.
Would you like to provide credentials for WF Servers? (yes/no)
Press Enter to continue with "yes" value:

WebFOCUS Managed Reporting Administrator's Manual 265


Managing the Deferred Ticket Cleanup Utility

If server nodes are defined in site.wfs, the following prompt appears:


The following WF Servers have credentials specified in site.wfs:
<server1 name>

Would you like to change existing WF Server credentials or


provide credentials for additional WF Servers?(yes/no)
Press Enter to continue with "yes" value:
If you want to provide additional WebFOCUS Reporting Server node names and user
credentials, enter the appropriate information when the following prompts appear:
Enter WF Server name: <server name>

Enter user ID for WF Server: <user id>

Enter password for WF user


(press Enter for empty password value):*******

Please, re-enter password for WF user


(press Enter for empty password value):*******

Would you like to provide credentials for another WF server? (yes/no)


Press Enter to continue with "yes" value:

5. When you are finished entering and validating WebFOCUS Reporting Server node names
and user credentials, the utility begins processing each MR user's HTM file in the MR
Repository. The following messages appear on the screen in both interactive and silent
modes.
WF Server credentials have been checked/updated.
Starting processing MR repository...

Processing of MR repository d:/ibi/WebFOCUS76/basedir starting.


Processing the repository for all users

MR user admin processing started.


Creating a backup of user's html file admin.htm

Successfully created user's backup file:


d:/ibi/WebFOCUS76/basedir\admin_mrdrdel_<date>_<time>.bak

Retrieving deferred report information and verifying status...

MR user admin processing ended

266 WebFOCUS
14. Managing Deferred Tickets

6. When all MR users' HTM files are processed, the following information appears:
Processing completed for MR repository d:/ibi/WebFOCUS76/basedir
Review log file mrdrdel_<date>_<time>.log located in
/logs directory under WF Client install to confirm status of
processing

Processing completed for MR repository


Would you like to process another MR repository? (yes/no)
Enter "no" to finish processing or
Press Enter to continue with "yes" value:

Procedure: How to Run the MR Deferred Ticket Cleanup Utility in Help Mode
To run the MR Deferred Ticket Cleanup Utility in help mode, from the /utilities directory under
the WebFOCUS Client installation (for example: /ibi/WebFOCUS76/utility on UNIX), enter
the following on the operating system command line:
mrdtcleanup -h
The screen displays help information for Java program (MRDTCleanup) arguments. If additional
arguments are included, they are ignored.
The argument information returned by the Java program (MRDTCleanup) provides information
on the requirements and options for running the program. With this information, you can
create a site-customized utility file to process your MR deferred report tickets to perform
tasks such as processing multiple MR repositories in silent mode.

WebFOCUS Managed Reporting Administrator's Manual 267


Managing the Deferred Ticket Cleanup Utility

The following is an example of what is displayed when the MR Deferred Ticket Cleanup Utility
is run in help mode:
Managed Reporting utility to delete Unknown Deferred Report tickets
is being called with -h argument to request usage information.
ECHO is off.
USAGE :
java MRDTCleanup [-?] [-s] -c(confpath) [-r[reposlocation.userID.pass[+...]]]

ARGUMENT (args) FORMAT:


-(?/h) Get help; if no arguments, help information is displayed
If more args after '-?' or '-h', they are ignored.

-s If present, turns on the silent mode.


MR repository location MUST be specified using -r argument.
WF Server credentials MUST be specified in site.wfs as:
<ifdef> IBIMR_dtcleanup
WF_CCREDENTIALS=edanode1:id:pass|edanode2:id:pass|...
<endif>
Credentials information MUST be provided for each WF Server
node in odin.cfg that deferred tickets have been submitted to.

-c(confpath) Fully qualified path to the installation directory where


WebFOCUS application configuration file, web.xml, is located.
This parameter MUST be provided.
-cC:\ibi\WebFOCUSXX\webapps\webfocusXX\WEB-INF
where 'XX' is a WebFOCUS release number.

-r(reposlocation.id.pwd[+reposlocation.id.pwd[+...]])
This argument is ignored if this utility is run in interactive mode!
MR repository location(s) as well as MR Administrator
credentials (id and password) for each location.
MR repository value is optional.
When not specified, default MR repository (MR_BASE_DIR)
is processed.
When specified, is fully qualified path to location of the MR
repository to be processed.
MR credentials MUST be a MR Administrator.
Multiple sets can be specified using '+' char as a separator
between repository and MR credential sets.
Format processing default MR repository with MR credentials
specified:
-r.id.password
Format specifying single MR repository:
-rrepositorylocation.id.password
Format for multiple repository and credential sets:
-rrepositorylocation.id.password+repositorylocation.id.password

268 WebFOCUS
14. Managing Deferred Tickets

Processing Multiple MR Repositories in Silent Mode


To process multiple MR repositories in silent mode, you can create your own site-customized
utility file to call the Java program (MRDTCleanup). For argument information for the Java
program (MRDTCleanup), see How to Run the MR Deferred Ticket Cleanup Utility in Help Mode
on page 267.
When running the Java program (MRDTCleanup), your CLASSPATH must include the following
files from the WebFOCUS Client installation:
installation_drive:\ibi\WebFOCUS76\webapps\webfocus76\WEB-INF\lib\tools.jar
installation_drive:\ibi\WebFOCUS76\webapps\webfocus76\WEB-INF\lib\srv.jar
installation_drive:\ibi\WebFOCUS76\webapps\webfocus76\WEB-INF\lib\uas.jar

installation_drive:\ibi\WebFOCUS76\webapps\webfocus76\WEB-INF\lib\nlslt.jar
installation_drive:\ibi\WebFOCUS76\ibi_html\javaassist\WFAPI.jar
The command to call the Java program (MRDTCleanup) and process multiple repositories
in silent mode is:
java MRDTCleanup -s -cconfpath
-rreposlocation1.id1.pass1+reposlocation2.id2.pass2+...
where:
confpath
Specifies the fully qualified path to the installation directory where the WebFOCUS
application configuration file, web.xml, is located. This value must be provided. The path
to the web.xml file is installation_drive:\ibi\WebFOCUS76\webapps\webfocus76\WEB-
INF. For related information, see CONFPATH Error on page 271.
reposlocation1.id1.pass1+reposlocation2.id2.pass2+...
When reposlocation1 is specified, it is the fully qualified path to the location of the
MR Repository to be processed (the default MR Repository, MR_BASE_DIR, is used when
you do not specify this value). Specify MR credentials (id1 and pass1) using a '.'
character as a separator after the repository location. These credentials must be those
of an MR Administrator. You can specify multiple sets using a '+' character as a separator
between repository and credential sets.
For example, the following parameter value specifies two MR repositories and MR user
credentials for each repository:
d:\ibi\WebFOCUS76\basedir.mradminid1.adminpass1+
d:\ibi\WebFOCUS76\testenvir.mradmin2.adminpass2
To process the default MR Repository, MR_BASE_DIR, do not specify a value for
reposlocation1 and use the '.' separator to specify MR credentials. For example:
.mradminid1.adminpass1+d:\ibi\WebFOCUS76\testenvir.mradmin2.adminpass2

WebFOCUS Managed Reporting Administrator's Manual 269


Managing the Deferred Ticket Cleanup Utility

Troubleshooting

Reference:
Trace File
CONFPATH Error
WebFOCUS Reporting Server Connection Failure
Silent Mode Failure

The following topics will help you troubleshoot possible error codes, exception messages,
and connection failures when running the Deferred Ticket Cleanup Utility.

Reference: Trace File


A trace file is available in the WebFOCUS Administration Console to view processing details
for the Deferred Ticket Cleanup Utility. You must first turn on the WFServlet trace option,
which is turned off by default. A trace file is created each time the utility is executed.
The file name of the trace file is in the following form:
00100_mrdtcleanup_WFAPI_date_time.trace
where:
date
Is the date the trace file was created in Year Month Day (YYYY-MM-DD) format.
time
Is the time the trace file was created in Hour Minute Second (HMS) format.

270 WebFOCUS
14. Managing Deferred Tickets

To view the resulting trace files, click the MR Deferred Ticket Cleanup Utility option on the
Traces menu under the Diagnostics section of the WebFOCUS Administration Console, as
shown in the following image.

To view information for a trace file, click the link with the desired date and time that has a
.trace file extension listed in the right pane of the console. To delete a trace file, select the
check box next to the file and click the Delete button at the bottom of the console. You can
also use the Select All and Deselect All options as needed, or click the Refresh option to
ensure that the latest information appears in the console.

Reference: CONFPATH Error


The WebFOCUS Client installation program installs the mrdtdcleanup files to the /utilities
directory under the WebFOCUS76 directory and substitute the {confpath} value.
When running the MR Deferred Ticket Cleanup Utility, if the value of CONFPATH is not the
valid directory path to web.xml, the utility displays error exception information including a
reference to the CONFPATH location and a message indicating that the utility encountered
an error. There is no log file available for troubleshooting because the log file is only created
upon successful initialization of the utility.
If you encounter this error, from the command line edit the mrdtcleanup.bat file on Windows,
or the mrdtcleanup script file on UNIX, and manually correct the CONFPATH variable setting
to be:
set CONFPATH=installation_drive:\ibi\webfocus76\webapps\webfocus76\WEB-INF

WebFOCUS Managed Reporting Administrator's Manual 271


Managing the Deferred Ticket Cleanup Utility

Reference: WebFOCUS Reporting Server Connection Failure


When deferred tickets are processed and the credentials provided are not valid, the
WebFOCUS Reporting Server is unavailable, or there are no available agents on the server,
no tickets for that server are deleted. The log information informs the MR Administrator that
processing for that server failed by stating that a connection could not be made to the
WebFOCUS Reporting Server. The MR Administrator can then investigate the processing
failure, make adjustments, and run the utility again.
The Deferred Ticket Cleanup Utility receives the standard error codes and exception messages
returned to the WebFOCUS Client for failed connections. The WebFOCUS Client file
/ibi/WebFOCUS76/client76/wfc/etc/xxib00e.htm (where xx is the language prefix) maps
each error code with an explanation. For example, the following sample log file contains
error code 32033, which appeared when attempting to connect to WebFOCUS Reporting
Server EDASERVE:
27:deferredExecution(WFMRActions.java:3011):executing deferredGetStatus()
failed for the WF Server EDASERVE
28:deferredExecution(WFMRActions.java:3012):WFErrorException has been
thrown!
29:deferredExecution(WFMRActions.java:3013):Exiting deferredExecution()
with the error code 32033
30:deleteUnknownDeferTickets(WFMRRepository.java:2168):deleteUnknownDefer
Tickets: MR Error has occurred!
31:deleteUnknownDeferTickets(WFMRRepository.java:2169):WFMRError code :
32033
32:deleteUnknownDeferTickets(WFMRRepository.java:2170):WFMRError message
: Error occurred, rc = 32033
<ERROR 32033>
<ERROR 32034>
<HTML>
<HEAD><Title>WebFOCUS Message: Security Violation
</Title></Head>
<Body>
<H2>
Invalid Credentials
</H2>
</Body>
</HTML>
</ERROR>

272 WebFOCUS
14. Managing Deferred Tickets

In the WebFOCUS Client error file D:\ibi\WebFOCUS76\client76\wfc\etc\isib00e.html,


search for the error code to view more detailed information about the error.
<ERROR 32033>
<ERROR 32034>
<HTML>
<HEAD><Title>WebFOCUS Message: Security Violation
</Title></Head>
<Body>
<H2>
Invalid Credentials
</H2>
</Body>
</HTML>
</ERROR>

Reference: Silent Mode Failure


When you run the utility in silent mode and the WebFOCUS Client configuration file site.wfs
does not contain WebFOCUS Reporting Server node name information, the log file contains
the following information. Review the site.wfs file and confirm the following:
There are no errors in the syntax of the <ifdef> IBIMR_dtcleanup block.
The WebFOCUS Reporting Server node name is the value of the NODE variable in the
WebFOCUS Client odin.cfg file.

WebFOCUS Managed Reporting Administrator's Manual 273


Managing the Deferred Ticket Cleanup Utility

Example: Sample Log File Created in Silent Mode


The following is an example of a log file created in silent mode:
0:=================================================================
1: user log opened Mon Sep 25 06:32:00 EDT 2006
2:=================================================================
3:createWFLog(WFContext.java:1728):Starting WebFOCUS log-file for
mrdtcleanup
4:main(MRDTCleanup.java:135):The Utility to delete Unknown Deferred
Report Tickets has started...
5:isSilentMode(MRDTCleanup.java:253):as option "-s" is passed the Utility
is going to work in the silent mode.
6:isSilentMode(MRDTCleanup.java:254):This mode requires all the
parameters/credentials being pre-set.
7:main(MRDTCleanup.java:154):Utility is running in the silent mode
8:runInSilentMode(MRDTCleanup.java:324):NO WF Server credentials provided!
9:runInSilentMode(MRDTCleanup.java:325):Deferred status information can
only be retrieved from unsecured servers.
10:runInSilentMode(MRDTCleanup.java:361):retrieved MR Repository to be
processed : d:\ibi\WebFOCUS71\basedir
11:runInSilentMode(MRDTCleanup.java:364):Files "mrrepos.htm" and
"user.htm" have been found in the specified location
12:runInSilentMode(MRDTCleanup.java:365):MR Repository location is valid,
continue processing...
13:runInSilentMode(MRDTCleanup.java:390):MR Default Repository being
processed d:\ibi\WebFOCUS71\basedir
14:runInSilentMode(MRDTCleanup.java:406):authenticating MR User :admin
15:isMRAdministratorUser(MRDTCleanup.java:650):Authenticating MR User:
admin
16:runInSilentMode(MRDTCleanup.java:420):MR Administrator user is
authenticated for MR Repository :d:\ibi\WebFOCUS71\basedir
17:runInSilentMode(MRDTCleanup.java:421):The utility will proceed to
process Unknown Deferred Tickets for this repository...
18:deleteUnknownDeferTickets(WFMRRepository.java:2058):
Processing of MR repository d:\ibi\WebFOCUS71\basedir starting.

274 WebFOCUS
14. Managing Deferred Tickets

19:deleteUnknownDeferTickets(WFMRRepository.java:2070):Getting a list of
users on the repository
20:deleteUnknownDeferTickets(WFMRRepository.java:2081):Processing
deferred tickets for admin
21:deleteUnknownDeferTickets(WFMRRepository.java:2093):Creating a backup
of user's html file admin.htm
22:deleteUnknownDeferTickets(WFMRRepository.java:2117):user's html file
exists, copying it to
d:\ibi\WebFOCUS71\basedir\admin_mrdtcleanup_060925_063200.bak
23:readFile(WFFileUtil.java:678):reading file
d:\ibi\WebFOCUS71\basedir\admin.htm
24:readFile(WFFileUtil.java:758):new FileInputStream is created to read
the file admin.htm
25:readFile(WFFileUtil.java:765):Successfully finished reading admin.htm
26:writeFile(WFFileUtil.java:1323):file
admin_mrdtcleanup_060925_063200.bak does NOT exist, - create one...
27:writeFile(WFFileUtil.java:1332):created the file
admin_mrdtcleanup_060925_063200.bak
28:writeFile(WFFileUtil.java:1352):writing the file
admin_mrdtcleanup_060925_063200.bak
29:writeFile(WFFileUtil.java:1366):successfully wrote content into the
file admin_mrdtcleanup_060925_063200.bak
30:deleteUnknownDeferTickets(WFMRRepository.java:2133):Successfully
created user's backup file
d:\ibi\WebFOCUS71\basedir\admin_mrdtcleanup_060925_063200.bak
31:deferredExecution(WFMRActions.java:3026):executing deferredGetStatus()
failed for the WF Server EDASERVE
32:deferredExecution(WFMRActions.java:3027):WFErrorException error code
32033
33:deferredExecution(WFMRActions.java:3026):executing deferredGetStatus()
failed for the WF Server DEFERRED
34:deferredExecution(WFMRActions.java:3027):WFErrorException error code
32033
35:deleteUnknownDeferTickets(WFMRRepository.java:2200):MR user admin
processing ended ...
(between lines 35 and 60 additional MR users are processed)
60:deleteUnknownDeferTickets(WFMRRepository.java:2218):Processing
completed for MR repository d:\ibi\WebFOCUS71\basedir
61:main(MRDTCleanup.java:158):MRDTCleanup utility finished processing.
62:=================================================================
63: user log closed Mon Sep 25 06:32:01 EDT 2006
64:=================================================================

WebFOCUS Managed Reporting Administrator's Manual 275


Managing the Deferred Ticket Cleanup Utility

276 WebFOCUS
WebFOCUS

Index
A banners (continued)
welcome message 131
accessing metadata 18 bid-config.xml 83, 84, 86, 131, 136, 139, 217
Add Block window 153 browser windows 99, 223, 224, 225, 226, 227
customizing 223, 224, 225, 226, 227
Add Two-Way Email Subscriber dialog box 233, 234 enabling context menu 99
adding a column 168
adding items to Role Trees 144 C
allocating extract files 183 cancelling changes to Role Trees 145
alternate deferred servers 248 change management 190, 191, 192, 193, 194,
amper auto-prompting 53, 227 196, 207
customizing launch pages 227 copying domains 196
launch page templates 227 copying files 194
in Dashboard 207
amper variables 227
internal references 192
applets 214 Managed Reporting Repository and 191
application files 190 moving files 190
moving 190 changing a user's Dashboard view 75
Application Path 45, 46
changing the public user ID 77
properties 45
specifying 46 Color Palette window 115, 117
assigning domains 51 Color Scheme window 115
auto-prompting 227 colors 115, 117
launch page templates 227 background 115
of content blocks 115
B of domains 115
of messages 115
back-out packages 206 of text 115
columns 168, 169
background images 115, 122 adjusting width 169
banners 115, 118, 123, 124, 127, 129, 130, 131 positioning 168
adding links 129 components 190
adjusting height for 127, 130
customizing colors 115, 118 Composition window 123, 124
deleting 127, 129 content block types 153
positioning 123, 124

WebFOCUS Managed Reporting Administrator's Manual 277


Index

content blocks 115, 121, 147, 148, 150, 152, customizations 139
153, 157, 159, 160, 161, 162, 166, saving 139
167, 168, 169 customizing browser windows 223, 224, 225,
adding 153 226, 227
adding items 160 restrictions 227
adding items from domain search 157 customizing Dashboard 148
and EXL2K PIVOT format 157
changing names of 162 customizing Dashboard logoff window 136
creating 148, 153 customizing error messages in Dashboard 83
custom color areas 121
deleting 159 customizing the HTML Report/Graph Assistant in
deleting items 160, 161 Dashboard 117
editing 160, 161
hiding 162
hiding the toolbar 166 D
layout 167, 168
saving 150 Dashboard 17, 26, 28, 69, 96, 99, 105, 111,
types 147 112, 115, 148, 167
custom templates 111
Content List 153
customizing 28, 99, 105, 112, 115, 148
content pages 150, 151, 167 domain profiles 167
creating multiple 150 logging on 26
rearranging 150 managing 69
selecting layout 167 opening 26
Content window 148, 150 templates 111
exiting 150
Dashboard change management 207, 208, 209
control bars 119
Dashboard logoff window 136
copying domains between environments 196
Dashboard Properties 87, 88
copying domains using Developer Studio 196 displaying optional properties 87, 88
copying files between environments 194 debugging Java applets 213

copying files using Developer Studio 194 default repository 228

creating objects 192 deferred listener options 250

creating Role Trees 141 Deferred Report Status interface 148, 150, 151
Deferred Report Status Interface 222, 226, 250
Custom Colors window 115
expiration setting 250
custom public views 69, 70 invoking directly 222
managing 70 deferred reports 211, 248, 250, 251
Custom Reports 68 managing 248
promoting to Standard Reports 68 purging 251
custom templates 111 Deferred Status option 68

278 WebFOCUS
Index

Deferred Ticket Cleanup Utility 252, 253, 254, Domain Builder 23, 42, 51, 63, 68
255, 256, 259, 260, 261, 262, 263, accessing MR Administration interface 42
267, 269, 270, 271, 272, 273 components 23
creating backup HTML file 253, 256, 259, 260 domain builder applets 214
creating log file 253, 256 tracing 214
Managed Reporting Repository 253, 262, 263 domain content information 172
MR repositories 269
multiple repositories in silent mode 269 domain information 172
processing Managed Reporting Repository 252, domain profiles 167
253 in Dashboard 167
running in help mode 261, 262, 267 Domain property flags 185, 187
running in interactive mode 254, 259, 261, 263
domain search 153, 157
running in silent mode 254, 259, 260, 261,
adding items to content blocks 157
262
Domain Trees 83, 84, 123, 124
specifying server credentials 254
displaying 123, 124
troubleshooting CONFPATH Error 270, 271
hiding 123, 124
troubleshooting server connection failure 270,
hiding reports 83
272
positioning 123, 124
troubleshooting silent mode error 273
showing only Standard Reports 83, 84
troubleshooting silent mode failure 270
domains 41, 43, 48, 51, 115, 120, 191, 196
Trusted connection restriction 255
adding in a group 48
UNIX 259, 261, 263
assigning to a developer 51
using with Realm Driver 260
changing color of 115
validating server credentials 255, 263
colors 115
WebFOCUS Administration Console 254, 255
copying 196
Windows 259, 263
creating 43
deferred tickets 248, 253, 260
custom color areas 120
deleting 253, 260
deleting 43
deleting items from Role Trees 144, 145 modifying properties 43
deleting My Reports 66 removing in a group 48
Domains output files 175
deployment process 21
DYNAM ALLOC command 182
descriptions for navigating Managed Reporting 192
Developer role 51
Developer Studio 42, 192, 194, 196 E
accessing MR Administration interface 42
Edit window 160
copying domains 196
copying files 194 editing My Reports 66
directories bar 226, 227 editing Role Trees 144
Domain Admin 191 empty blocks 148

WebFOCUS Managed Reporting Administrator's Manual 279


Index

environments 16, 35, 38 group views 69, 71, 91, 92, 93, 95, 96, 97, 98,
Managed Reporting/ReportCaster properties 38 102, 103
Web server properties 35 adding 93
error messages in Dashboard 83 copying 102, 103
creating 93, 95
Event Log for Two-Way Email 240
deleting 98
purging 240
directing users to upon login 96, 97
EXL2K PIVOT format 157
editing 98
in Dashboard 157
exiting 103
extract files 182 managing 71
extracting information from MR Repository 172, window 93, 103
groups 41, 46, 47, 48, 50
174, 175 adding domains to 48
adding users to 47
creating 46, 47
F removing domains from 48
removing users from 47
file allocations 182
FILEDEF command 182
H
finished My Reports 86, 87, 88
hiding the share option 86, 87, 88 hiding content blocks 162
folder blocks 99, 147, 153, 160
changing contents 160 hiding the toolbar in a content block 166
reloading content 99 HTML Graph Assistant 117
folders 23, 24 customizing in Dashboard 117
deleting 24 HTML Report Assistant 117
frame separators 123 customizing in Dashboard 117
HTML User Environment 226
FTP output files 182
http errors in Dashboard 83

G
I
general public views 69, 70
managing 70 IBIExtractRepos utility 171, 172, 173, 174
Graph Assistant 117, 211 output files 174
customizing in Dashboard 117 IBIMRDMC.MAS Master File 176, 184
Group Administrator 46, 48, 50, 51, 53, 96
assigning privilege 50, 51 IBIMRDOM.MAS Master File 176, 185, 187
group information 172 IBIMRGRP.MAS Master File 176
Group output files 174 IBIMRROL.MAS Master File 176
IBIMRUSR.MAS Master File 176, 185

280 WebFOCUS
Index

idle limit 81, 82 logos 125, 126, 127


for authenticated users 81, 82 inserting 125, 127
for public users 82 maximum size 125, 126
internal references 192 Look templates 112
invoking the Deferred Report Status Interface 222 Look window 109

J M
JavaScript options 223, 224, 225, 226 Manage Users 75
Job Log for Two-Way Email 237, 239 Managed Reporting 18, 23, 24, 192, 212
purging 239 configuring tool types 212
Data Servers 23
domains 23
L internal references 192
launch blocks 147, 152, 153, 160, 162 navigating 192
changing contents 160, 162 tool types 212
launch pages 227, 228 toolbars 24
coding a FOCEXEC 227 Managed Reporting Administration interface 23,
settings in Administration Console 227 41, 42, 47, 48, 50, 51, 53, 61, 62
customizing 62
layout of content blocks 167
Managed Reporting Administrator 18, 41, 43, 45,
Library content in Dashboard 159
46, 48, 50, 53, 252, 253, 260, 262, 263, 272
Library Only User role 71
Managed Reporting deployment process 21
Library page 152
Managed Reporting Extract utility 171, 172
link colors 115
Managed Reporting logon page 223
links 127, 129
adding 129 Managed Reporting Repository 38, 171, 172, 192,
deleting 129 228
list blocks 147, 152, 153, 160, 161 extracting information 172
adding items 160 Managed Reporting/ReportCaster properties 38
deleting items 160, 161
managing group views 71
list of users 68
managing private views 72
location bars 226, 227
managing public views 70
locked content block 158
managing users in Dashboard 75
logging on to the Dashboard 26
Master Files 176
Logo & Links window 125, 127 IBIMRDMC.MAS 176
IBIMRDOM.MAS 176
IBIMRGRP.MAS 176

WebFOCUS Managed Reporting Administrator's Manual 281


Index

Master Files (continued) output files (continued)


IBIMRROL.MAS 176 relationships 184
IBIMRUSR.MAS 176
menu bars 226, 227 P
Message of the Day 121, 135
custom color areas 121 page tabs 99, 120
editing outside of Dashboard 135 pages 99
messages in Dashboard 83 reloading 99
metadata 18 passwords 77, 79, 80
OLAP-enabled 18 for the public user 77, 79, 80
migrating existing customizations 105 positioning columns 168
private views 26, 69, 72
moving components between environments 190
logging on 26
MR Deferred Ticket Cleanup Utility 270 managing 72
trace files 270
promoting Custom Reports to Standard Reports 68
MR_BASE_DIR variable 228
properties
MRSAMP01.FEX sample procedure 176 displaying Created By 99
displaying Last Modified By 99
multiple content pages 150
share option 99
My Reports 53, 63, 66, 83, 84, 99
property flags 185
deleting 66
editing 66 public groups 106
hiding 83 public user 71, 106
hiding from user roles 99 Library privileges 71
hiding from users 84 rights 106
public user ID 77
O changing 77
public view links 127, 128, 129
OCP (OLAP Control Panel) 223 adding 129
deleting 128, 129
OLAP Control Panel (OCP) 223 editing 128
OLAP-enabled reports 18 public views 26, 71, 79, 80, 91, 92, 93, 95, 98,
manipulating 18 102, 103, 127, 148, 150, 151
running 18 adding 93
organizing Dashboard content 150 copying 102, 103
creating 93, 95
Other Files 99
customizing 127
hiding from user roles 99
deleting 98
output blocks 147, 152, 153 editing 98
output files 174, 182, 183, 184 exiting 103
allocating 183 Report Library access 71
FTP 182 setting user ID and password 79, 80

282 WebFOCUS
Index

public views (continued) resizing browser windows 226, 227


window 93, 103
role information 172
Public Views button 150
role inheritance 58
PUBLIC_MAX_INACTIVE parameter 82
role property flags 185

R Role Tree window 142


Role Trees 123, 124, 141, 142, 143, 144, 145
read-only content block 158 adding items 144
cancelling 145
refresh options 68
creating 142, 143
Reload Domain option 68 deleting items 144, 145
displaying 123, 124
Reload User Management option 68
editing 144
Reload User option 68 hiding 123, 124
positioning 123, 124
removing banners 127, 129
roles 41, 50, 53, 54, 58, 61
Report Assistant 117, 211 Analytical User 54
customizing in Dashboard 117 assigning 50
Report Library 71, 148, 150, 151, 152, 159 base roles 53, 58
window 148 Content Manager 54
ReportCaster 17, 18, 23, 59, 99, 148, 150, 151, creating 53
212 creating new 61
Scheduler 99 customizing existing 61
ReportCaster Alerts 18 defined 54
Developer 54
ReportCaster single page Scheduler Tool 138, 139
inheritance 58
Reporting Objects 18, 83, 84, 99 Library Only User 54
creating 18 Run Only User 54
hiding 83 user 54
hiding from user roles 99
hiding from users 84
organizing by domains 18 S
reports 18, 64, 68
creating 18 Save Entered Values privilege 53
deleting 64 saving content blocks 150
editing 64
publishing 18 saving customizations 139
running 64 screen alignment 226, 227
running deferred 68
scroll bars 166, 226, 227
REPOSITORY_CACHE setting 251
scroll buttons 166
resetting the View Builder 107, 109

WebFOCUS Managed Reporting Administrator's Manual 283


Index

scrolling options 125, 160, 165 time out period (continued)


for public users 82
Section 508 186
tool types 212
user flag 186
associating users with tools 212
server properties 45
toolbar 166
Server window 79 toolbars 23, 24, 115, 121, 132, 134, 226, 227
Share Report option 86, 87, 88 changing colors for 115
hiding 86, 87, 88 custom color areas 121
Shared Reports 83, 84, 99 toolboxes 132, 133
hiding 83
hiding from user roles 99 trace file names 217
hiding from users 84 trace files 218
sidebar list position 123, 124
TRACE_LEVEL parameter 215, 216
site customization 223, 224, 225, 226, 227
traces 270
restrictions 227
MR Deferred Ticket Cleanup Utility 270
Standard Reports 18, 68, 84, 88, 99
tracing 215
creating 18
dynamically in Dashboard 215
creating from a Custom Report 68
creating in Dashboard 88, 99 tracing domain builder applets 214
hiding from user roles 99 tracing in Dashboard 217
limiting display in the Domain Tree 84
organizing by domains 18 tracing Java applets 213, 214
synchronizing 18 tracing options in Dashboard 215, 216
status lines 226, 227 for OS/390 215, 216
for UNIX 215, 216
storing credentials on a WebFOCUS Server 39 for Windows 215, 216
subscribers 232 Two-Way Email 18, 232, 233, 237, 238, 240
adding subscribers 233
deleting subscribers 233
T Event Log 240
Job Log 237
templates 109, 110, 111, 112, 115, 117, 125, viewing current subscribers 232
126 viewing job status 237, 238
color schemes 115 Two-Way Email Administrator console 232, 233,
custom 111 234, 235, 236, 237, 240, 242, 243,
custom colors 115, 117 244, 245, 246
in Dashboard 111 accessing 232
logos 125, 126 adding addresses 235
selecting 109, 110 adding subscribers 233, 234
text colors 115 canceling reports 245, 246
time out period 81, 82 deleting addresses 235, 236
for authenticated users 81, 82 deleting subscribers 233, 235
monitoring e-mail traffic 242, 243

284 WebFOCUS
Index

Two-Way Email Administrator console (continued) View Builder (continued)


purging the Event Log 244 exiting 140
purging the Job Log 240 migrating 105
refreshing templates 236 opening 94, 107, 108
using the Event Log 240 resetting 109, 139
using the Job Log 237 templates 111
viewing current subscribers 232 viewing My Reports 63
viewing job status 245
views 26
custom public 26
U multiple public 26
private 26
updating a user's Dashboard view 75 public 26
upload data file 99
user environments 18 W
customizing 18
wallpaper in banners 115, 122
user information 172
watch list 153
User Management tree 63, 64, 66 blocks 147, 152, 153
User output files 174 interface 148, 150, 151
user privileges 59 Web server properties 35
General 59 WebFOCUS Administration Console 45, 251
My Reports 59 REPOSITORY_CACHE setting 251
user property flags 185 servers 45
WebFOCUS Business Intelligence Dashboard 69,
user roles 53, 54 105
USER_MAX_INACTIVE parameter 81, 82 managing 69
WebFOCUS Client 36, 252, 253, 254, 256, 259,
users 41, 48, 50, 53, 59
260, 262, 263, 267, 271, 272, 273
creating 48
properties 36
privileges 59
saving parameter values 53 WebFOCUS Client Path parameter 36
searching for 50 WebFOCUS Client traces 270
setting up 53 MR Deferred Ticket Cleanup Utility 270
utilities 212 WebFOCUS Environment Properties 33
WebFOCUS Environment Properties dialog box 32,
V 192
View Builder 28, 87, 88, 94, 96, 99, 105, 107, WebFOCUS environments 16, 29
108, 109, 111, 131, 139, 140, 152 adding 29
customizing 108 WebFOCUS Reporting Server 45, 252, 253, 254,
Edit Setting 99
255, 262, 263, 272, 273

WebFOCUS Managed Reporting Administrator's Manual 285


Index

WebFOCUS Server Connection window 79 window height 226, 227


WebFOCUS Server properties 39 window resizing 226, 227
welcome message 99, 131 window width 226, 227
displaying 99

286 WebFOCUS
WebFOCUS

Reader Comments

In an ongoing effort to produce effective documentation, the Documentation Services staff


at Information Builders welcomes any opinion you can offer regarding this manual.
Please use this form to relay suggestions for improving this publication or to alert us to
corrections. Identify specific pages where applicable. You can contact us through the following
methods:

Mail: Documentation Services - Customer Support


Information Builders, Inc.
Two Penn Plaza
New York, NY 10121-2898
Fax: (212) 967-0460
E-mail: books_info@ibi.com
Web form: http://www.informationbuilders.com/bookstore/derf.html

Name:
Company:
Address:
Telephone: Date:
Email:
Comments:

Information Builders, Two Penn Plaza, New York, NY 10121-2898 (212) 736-4433
WebFOCUS Managed Reporting Administrator's Manual DN4500809.1208
Version 7 Release 6.1 and Higher
Reader Comments

Information Builders, Two Penn Plaza, New York, NY 10121-2898 (212) 736-4433
WebFOCUS Managed Reporting Administrator's Manual DN4500809.1208
Version 7 Release 6.1 and Higher