WF 761 Mradmin
WF 761 Mradmin
WF 761 Mradmin
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
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
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
6 WebFOCUS
Contents
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.
Chapter/Appendix Contents
2 Creating Domains, Groups, Describes how to create domains, groups, roles, and
Roles, and Users users with the Managed Reporting Administration
interface.
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.
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 WebFOCUS
Preface
Chapter/Appendix Contents
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.
{ } Indicates two or three choices; type one of them, not the braces.
... Indicates that you can enter a parameter multiple times. Type
only the parameter, not the ellipsis points (...).
Convention Description
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
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.
14 WebFOCUS
WebFOCUS
WebFOCUS Products
In this section:
Managed Reporting
Business Intelligence Dashboard
ReportCaster
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.
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.
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 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.
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.
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 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
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.
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.
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.
Edit Source Displays the code for the selected object (report, procedure, or launch
page) in the text editor window.
24 WebFOCUS
1. Introducing WebFOCUS Managed Reporting
Button Description
Run Executes the selected report or displays the selected launch page.
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.
ReportCaster Enables you to access ReportCaster. For more information, see the
ReportCaster Development and Administration manual.
Report Library Enables you to access the content in the Report Library.
Properties Displays the name and data source of the selected object.
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
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.
mpv Opens the public views index page. This page lists all
existing public views.
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.
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
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.
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.
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.
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.
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
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.
The following image shows the Managed Reporting Repository section of the WebFOCUS
Environment Properties dialog box.
38 WebFOCUS
1. Introducing WebFOCUS Managed Reporting
40 WebFOCUS
WebFOCUS
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.
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.
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.
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.
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.
5. When you have selected all of your users, click the Add icon.
6. Click Save.
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.
48 WebFOCUS
2. Creating Domains, Groups, Roles, and Users
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.
6. Click Save.
Note: To modify or delete a user, select user from the Users tab and click the appropriate
icon.
How to:
Assign the Group Administrator Privilege
50 WebFOCUS
2. Creating Domains, Groups, Roles, and 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.
6. Click Save.
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
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.
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.
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.
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.
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
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.
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.
56 WebFOCUS
2. Creating Domains, Groups, Roles, and Users
User Roles LO US RO AU PU DV CM MA
Advanced O D O D F
Data Server O D D
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.
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 *
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.
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.
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.
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.
60 WebFOCUS
2. Creating Domains, Groups, Roles, and Users
Privilege Description
ReportCaster
5. Select the Privileges. For details on privileges, see User Privileges Defined on page 59.
6. Click Save.
62 WebFOCUS
WebFOCUS
3 User Management
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.
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.
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.
68 WebFOCUS
WebFOCUS
4 Managing Dashboard
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
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
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.
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.
6. Click Submit.
76 WebFOCUS
4. Managing Dashboard
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.
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.
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
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.
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
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.
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.
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
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.
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.
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
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"/>
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.
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.
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.
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.
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.
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.
90 WebFOCUS
WebFOCUS
92 WebFOCUS
5. Creating Public and Group Views
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.
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.
94 WebFOCUS
5. Creating Public and Group Views
4. Click Logon. The Public Views window opens. To create a group view, click 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.
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
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.
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.
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.
98 WebFOCUS
5. Creating Public and Group Views
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.
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.
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.
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
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
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.
106 WebFOCUS
6. Customizing Dashboard
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.
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.
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
2. Enter your user ID and password, then click Logon and the following message displays:
WebFOCUS BI Dashboard ViewBuilder customization session ended.
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.
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.
110 WebFOCUS
6. Customizing Dashboard
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.
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.
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.
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.
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
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.
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
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.
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.
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
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.
Background The color of the toolbar at the top of the Domain Tree, Role Tree,
and content blocks.
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.
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.
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
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.
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.
Background The background color for the Message of the Day block.
Background 3 The tool bar background (area behind the items in the tool bar).
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.
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.
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
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.
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.
124 WebFOCUS
6. Customizing Dashboard
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.
1 48 413
2 53 207
3 74 354
4 80 200
126 WebFOCUS
6. Customizing Dashboard
5 91 160
6 64 188
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.
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.
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
4. Click Preview.
5. Click Save to save changes.
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.
130 WebFOCUS
6. Customizing Dashboard
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.
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.
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.
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.
132 WebFOCUS
6. Customizing Dashboard
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.
2. Highlight a toolbox from the Select Toolbox list and click Save As.
The Explorer User Prompt dialog box opens.
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.
134 WebFOCUS
6. Customizing Dashboard
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.
2. Type the desired text in the Message field. The message can contain up to 100
characters.
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.
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.
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.
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.
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
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.
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.
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.
2. Click Done.
The Dashboard index page opens and displays links to the Dashboard views and the
View Builder.
140 WebFOCUS
WebFOCUS
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.
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.
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.
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.
146 WebFOCUS
WebFOCUS
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.
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.
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.
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.
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.
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.
From the Add Block window, you can create content blocks that the public or group users
see when opening Dashboard.
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)
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.
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 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
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.
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
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.
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
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.
7. Click Save.
162 WebFOCUS
8. Creating Dashboard Content
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.
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.
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.
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.
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.
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.
Note: The Lock Block and Automatic Block Refresh check boxes are available to
administrators only.
166 WebFOCUS
8. Creating Dashboard Content
2. Click Save.
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.
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.
168 WebFOCUS
8. Creating Dashboard Content
170 WebFOCUS
WebFOCUS
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.
172 WebFOCUS
9. Managed Reporting Extract Utility
outputfile
The name of the output file.
You can tailor the extract utility for your own purposes.
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"
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.
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",""
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
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, $
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.',$
180 WebFOCUS
9. Managed Reporting Extract Utility
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.
182 WebFOCUS
9. Managed Reporting Extract Utility
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.
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.
Flag Description
Flag Description
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
Flag Description
Flag Description
Flag Description
188 WebFOCUS
WebFOCUS
10 Change Management
190 WebFOCUS
10. Change Management
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.
The following sections describe features or methodologies that can help organizations
achieve their change management objectives with Managed Reporting.
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.
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
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
All Dashboard Change Management export and import files are stored in the
WebFOCUS\worp\management directory.
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
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.
210 WebFOCUS
WebFOCUS
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.
Note: The ReportCaster User Interface cannot be configured for Managed Reporting
Analytical Users, who must use the HTML-based Scheduling Wizard and User Interface.
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.
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.
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.
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
214 WebFOCUS
11. Additional Administration Topics
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.
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>
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
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.
220 WebFOCUS
WebFOCUS
222 WebFOCUS
12. Application Integration Topics
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.
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.
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
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");
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.
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”.
226 WebFOCUS
12. Application Integration Topics
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.
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.
230 WebFOCUS
WebFOCUS
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.
232 WebFOCUS
13. Two-Way Email Administration
The Two-Way Email Administrator console opens in a scrollable window as shown in the
following image.
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.
234 WebFOCUS
13. Two-Way Email Administration
3. Click Delete to remove the subscriber from the Two-Way Email database.
You can re-send a user's templates to a single e-mail address or to multiple addresses for
that user.
236 WebFOCUS
13. Two-Way Email Administration
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.
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.
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.
238 WebFOCUS
13. Two-Way Email Administration
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.
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.
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
How to:
Monitor E-mail Traffic
The following image shows sample entries from an Event Log that displays only errors.
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.
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.
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
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.
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.
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.
246 WebFOCUS
WebFOCUS
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.
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.
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.
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
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.
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
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.
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.
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:
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.
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.
258 WebFOCUS
14. Managing Deferred Tickets
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
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.
260 WebFOCUS
14. Managing Deferred Tickets
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.
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.
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)
264 WebFOCUS
14. Managing Deferred Tickets
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)...
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...
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
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.
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[+...]]]
-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
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
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.
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.
272 WebFOCUS
14. Managing Deferred Tickets
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:=================================================================
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
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
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
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
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
282 WebFOCUS
Index
284 WebFOCUS
Index
286 WebFOCUS
WebFOCUS
Reader Comments
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