Tivoli Integrated Portal Online help

Tivoli Integrated Portal Online help
Tivoli Integrated Portal
Online help
Version 1.0 Tivoli Integrated Portal 2.2
Tivoli Integrated Portal
Online help
Version 1.0 Tivoli Integrated Portal 2.2
Note
Before using this information and the product it supports, read the information in “Notices” on page 95.
This edition applies to version 2, release 1 of Tivoli Integrated Portal and to all subsequent releases and
modifications until otherwise indicated in new editions.
© Copyright IBM Corporation 2012.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Chapter 1. IBM Tivoli Integrated Portal
help . . . . . . . . . . . . . . . . 1
What is new? . . . . . . . . .
Logging into the portal . . . . . .
Portal accessibility . . . . . . .
Supported web browsers . . . . .
Welcome. . . . . . . . . . .
Accessing support information . . .
About page - Support information .
About portlet - Support information
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
1
2
3
4
5
5
5
6
Chapter 2. Portal layout . . . . . . . . 9
Portal banner .
Page bar . .
Navigating the
Portal pages .
. .
. .
portal
. .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
10
11
11
13
Chapter 3. Customizing the portal . . . 15
My tasks . . . . . . . . . . . . .
My Startup Pages . . . . . . . . . .
Editing page content and layout . . . . .
Arranging portlets using the drag-and-drop
feature . . . . . . . . . . . . .
Customizing a portlet . . . . . . . . .
Setting text and component direction . . . .
Personalizing a web portlet . . . . . . .
Working with image portlets . . . . . .
Manage Open Pages . . . . . . . . .
Configure Portlet Refresh . . . . . . . .
.
.
.
. 15
. 15
. 17
.
.
.
.
.
.
.
.
.
.
.
.
.
.
19
20
21
22
22
24
24
View properties . . . . . . .
Working with catalogs . . . . . .
Creating catalogs . . . . . .
Editing catalogs . . . . . . .
Deleting catalogs . . . . . .
Working with roles . . . . . . .
Creating roles . . . . . . .
Editing roles . . . . . . . .
Deleting custom roles . . . . .
Managing roles for users . . . .
Managing roles for groups . . .
Role properties . . . . . . .
Working with portlets . . . . . .
Custom portlets . . . . . . .
Portlet events and wires . . . .
Portlet properties . . . . . .
Working with preference profiles . .
Creating preference profiles . . .
Editing console preference profiles.
Deleting console preference profiles
Preference profile properties . . .
Resource types . . . . . . . .
Manage Global Refresh . . . . .
Credential Store . . . . . . . .
Exporting portal settings . . . . .
Common settings . . . . . . .
Add Roles . . . . . . . . .
Add views . . . . . . . .
Add Pages. . . . . . . . .
String translation properties . . .
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
.
46
48
48
49
50
50
51
52
53
54
55
56
57
58
65
68
69
70
71
72
72
73
74
75
76
77
78
78
78
79
Chapter 4. Administrative settings . . . 27
Chapter 5. Charting . . . . . . . . . 81
Setting up the portal . . . . . . . . .
Process for planning and setting up the portal .
Logging out active users . . . . . . . .
Working with pages . . . . . . . . .
Creating classic pages . . . . . . . .
Creating freeform pages . . . . . . .
Creating folders . . . . . . . . . .
Editing the properties of a page, folder, or
external URL . . . . . . . . . . .
Deleting custom pages and folders . . .
Restoring system pages, folders, and external
URLs . . . . . . . . . . . . .
Page field descriptions. . . . . . . .
Working with views . . . . . . . . .
Creating views . . . . . . . . . .
Editing views. . . . . . . . . . .
Deleting custom views . . . . . . .
IBM charts. . . . . . . . . . . . . .
Configuring a chart portlet in the Portlet Wizard
Opening a chart from an IBM application . .
Defining a Web service connection. . . . .
Custom charts . . . . . . . . . . . .
Opening a chart created in the BIRT Designer .
Uploading a BIRT chart . . . . . . . .
Chart or table creation with the BIRT Designer
BIRT Designer and Tivoli Common Reporting .
Chart tools . . . . . . . . . . . . .
© Copyright IBM Corp. 2012
.
.
.
.
.
.
.
.
.
.
.
.
.
.
27
29
30
30
31
32
33
.
.
. 33
. 34
.
.
.
.
.
.
.
.
.
.
.
.
34
35
43
44
45
46
. 81
81
. 83
. 85
. 87
. 87
. 88
89
. 90
. 91
Notices . . . . . . . . . . . . . . 95
Trademarks .
.
.
.
.
.
.
.
.
.
.
.
.
. 96
Index . . . . . . . . . . . . . . . 97
iii
iv
Tivoli Integrated Portal Online help
Chapter 1. IBM Tivoli Integrated Portal help
Welcome to the online help for IBM® Tivoli® Integrated Portal Version 2.2.0.5.
Tivoli Integrated Portal provides a single portal for administering IBM products
and related applications. Use this help to find general information about the portal
and its features.
Getting started
v
v
v
v
“What is new?”
“Logging into the portal” on page 2
“Portal accessibility” on page 3
“Supported web browsers” on page 4
v “Welcome” on page 5
v Chapter 2, “Portal layout,” on page 9
Customizing the console
v “My tasks” on page 15
v “My Startup Pages” on page 15
v “Manage Open Pages” on page 24
v “Configure Portlet Refresh” on page 24
Settings
v “Working with pages” on page 30
v “Working with views” on page 43
v
v
v
v
v
“Working with roles” on page 50
“Working with preference profiles” on page 69
“Working with portlets” on page 57
“Manage Global Refresh” on page 74
“Credential Store” on page 75
Related resources
v IBM
v IBM Support
v Integrated Solutions Console support forum
What is new?
This topic describes functions that are available in IBM Tivoli Integrated Portal
Version 2.2.0.5. Features described here supersede any functionality described
elsewhere in the help that might state otherwise. The following updates are
included in this portal installation.
Freeform page creation
Users with appropriate permissions can now create pages in the portal
using a self-service dashboard whereby they can select available portlets in
from a portlet palette and drag them to the page content area. Multiple
© Copyright IBM Corp. 2012
1
portlets can be arranged on the page in a very flexible and freeform
manner. Such users can still create new pages using the classic grid-based
method of creating pages.
For more information, see “Creating freeform pages” on page 32.
Customize portlet wizard
IBM Tivoli Integrated Portal includes a customize portlet wizard that
allows a portal administrator to select an existing base portlet and
configure custom settings for a copy of the base portlet. Once configured,
the newly customized portlet is made available in the portlet palette and
can be added to freeform pages or classic pages.
For more information, see “Exporting portal settings” on page 76.
Log out active users
Administrators can search for and log out active users.
For more information, see “Logging out active users” on page 30.
Access support information for pages and portlets
Administrators can access support information for pages and their portlets,
or for an individual portlet on a particular page.
For more information, see “Accessing support information” on page 5.
Logging into the portal
Follow these steps to access the portal.
1. Point your web browser to the URL of the server where the portal is installed
and running, appending the context root for the portal, to the address. The
default context root is /ibm/console, but it may be configured differently for
your portal, so if you are in doubt, check with your administrator. For example,
if the portal is installed to a server on www.example.com using a secure port of
444 and with the default context root, enter this address in the browser:
https://www.example.com:444/ibm/console
The login page for the portal is displayed.
2. Enter your User ID and Password and click Log in.
When you are finished, the welcome page is displayed.
To prevent unauthorized access, be sure to use the Logout link in the portal
toolbar when you are finished using the portal. If there is no activity during this
login session for an extended period of time, the session expires and you must log
in again to access the portal. To update the session expiration, see Changing the
console session expiration.
Note: If your portal session expires, you may have to log in twice to start a new
session.
Depending on the operating system on which Tivoli Integrated Portal is installed,
there are certain restrictions on which characters can be used for user IDs and
passwords.
Multiple users can concurrently log in to the portal using the same user account
details providing the users log in to the console in discrete browser sessions. This
behavior is not enabled by default and must be enabled by an administrator.
2
Tivoli Integrated Portal Online help
Note: When two users concurrently log in with the same user ID and they both
launch the IBM WebSphere® Application Server administrative console, the last
user to launch the administrative console gains control. All other WAS
administrative console gains sessions for that user ID are automatically invalidated.
Tivoli Integrated Portal sessions for other users with the same user ID remain
unaffected.
Portal accessibility
v Accessibility features
v Navigating the portal interface by using the keyboard
Accessibility features
The portal has the following accessibility features:
v The following features are for vision-impaired users:
– Supports interfaces commonly used by screen readers and screen magnifiers
(Microsoft Windows systems only)
– Can be operated by using only the keyboard
– Communicates all information independent of color
– Supports the attachment of alternate output devices
– Provides help information in an accessible format
v The following features are for users who have mobility impairments or limited
use of their hands:
– Allows the user to request more time to complete timed responses
– Can be operated by using only the keyboard
– Supports the attachment of alternative input and output devices
v The following features are for the deaf and hard of hearing users:
– Supports alternatives to audio information
– Supports adjustable volume control
v The console does not flash the screen at rates that could induce epileptic
seizures.
The help system for Integrated Solutions Console has the following accessibility
features:
v Uses the accessibility support enabled by the browser that is used to display the
help
v Enables navigation by using the keyboard
Note: Hover text for certain elements, such as page tabs, cannot be read by the
screen reader, Windows Eyes.
Navigating the portal interface by using the keyboard
To move through the controls on a particular page, press the Tab key.
To click a link or control on a page using the keyboard, navigate to the link or
control and press ENTER.
To select a checkbox, use the Tab key to bring the checkbox into focus and press
the Space bar.
Chapter 1. IBM Tivoli Integrated Portal help
3
To view the contents of a selection list (drop-down menu), tab to the field and use
Alt + the down arrow.
Related information:
Accessibility and keyboard shortcuts in the help system
Supported web browsers
The following web browsers are supported for use with the portal:
v Microsoft Internet Explorer, V9.0
v Microsoft Internet Explorer, V8.0
v Microsoft Internet Explorer, V7.0
v Mozilla Firefox, V3.6
JavaScript must be enabled in the browser. A minimum screen resolution of 1024 x
768 pixels is recommended.
Note: The browser back button is not reliable for navigating the portal and is not
supported. Use the navigation controls and links in the portal as an alternative.
Supported languages
The portal text has been translated into the following languages.
v Arabic (ar)
v
v
v
v
v
Brazilian Portuguese (pt-br)
Czech (cs)
Croatian (hr)
Dutch (nl)
English (en)
v
v
v
v
v
v
v
v
French (fr)
German (de)
Hebrew (he)
Hungarian (hu)
Italian (it)
Japanese (ja)
Korean (ko)
Polish (pl)
v Russian (ru)
v Slovenian (sl)
v
v
v
v
Swedish (sv)
Simplified Chinese (zh-cn)
Spanish (es)
Traditional Chinese (zh-tw)
The language that is displayed when you access the portal is always the first
language in your browser's language settings that matches one of these portal
translations. If none of your language preferences match one of the portal
translations, then the default is displayed, which is English (en). Individual
components, such as portlets or pages, might provide additional translations that
4
Tivoli Integrated Portal Online help
are displayed according to your browser's language settings. In this case, you
could see a combination of languages displayed in the portal.
The portal also supports bidirectional languages, such as Arabic or Hebrew, which
are displayed and read from right to left. If your browser's first language
preference is set to a bidirectional language, elements in the portal are arranged in
right-to-left orientation and the text is right-aligned, even though the displayed
text might not be bidirectional.
Welcome
Welcome displays the products that are installed that use the portal for
administrative tasks.
When two or more products are deployed to the portal, this welcome page appears
by default when you log in to the portal. You can also access this page by clicking
its link in the navigation pane.
When a single product is deployed to the portal, that product's About page
automatically becomes the default "Welcome" page that is displayed after logging
in. It also appears when a user clicks the "Welcome" link in the navigation pane.
A table on the page lists the suite name and version number. The About portlet
displays the portal license information.
Accessing support information
You can access support information for a page and its portlets, or for a specific
portlet within a page.
About page - Support information
The About item from the Select Action drop-down list provides support
information for the portal, browser, current page and its associated portlets.
To display support information, from the Select Action drop-down list, click
About.
A new page is displayed with details of the portal, browser, and Dojo versions. In
addition, general information is provided for the page itself, as well as details for
each portlet on the page and any wiring that is configured between the portlets.
You can use the links at the top of the page to print or save an HTML version of
the support information.
The following support information is provided in relation to the portal:
Table 1. Portal, browser, and Dojo information
Section
Description
Tivoli Integrated Portal The Tivoli Integrated Portal version.
Browser Information
Details of the browser.
Dojo Version
The Dojo Library version.
Chapter 1. IBM Tivoli Integrated Portal help
5
Table 2. General page information
Section
Description
Page ID
The unique page ID.
Note: The page ID is used as the default file name if you choose
to save a copy of the support information.
Layout
Page layout type, for example, Classic or Freeform.
Location
The location of the page. Its location reflects where the page is
displayed in the navigation pane.
Module
Module type.
Allows Multiple
Instances
This setting indicates whether or not multiple instances of a page
is allowed.
Roles [type - access
Roles associated with the page including the access level
provided to each role.
Author
Product or component associated with the page.
For each portlet on a page, a section is included with the following detail:
Table 3. Portlet information
Section
Description
Portlet type
The base portlet type name is shown in bold font for each portlet.
Portlet ID
The portlet unique ID.
Portlet Definition ID
The portlet definition ID.
Dimensions [height,
width]
The portlet size in pixels.
Location [x, y, z]
Coordinates for the portlet location on the page.
Type
The portlet type, that is, the type of underlying technology
associated with the portlet, for example, iWidget.
Module
The .war file associated with the portlet.
Render Mode
How the portlet is rendered, for example, inline.
Role [type - access]
Roles associated with the portlet including the access level
provided to each role.
Author
Product or component associated with the portlet.
Table 4. Wires information
Section
Description
Wires
For each wire that exists between portlets, details are provided in
relation to its type, source, target, event, transformation, and
whether the wire is enabled or not.
Note: An entry of None in this section indicates that they are no
wires configured.
About portlet - Support information
The About portlet is used to display support information as it relates to an
individual portlet.
To display the portlet support information, the page that contains the portlet must
be in edit mode. From the portlet title bar, click the Edit options icon and select
About.
6
Tivoli Integrated Portal Online help
The following portlet support information is provided:
Table 5. Portlet information
Section
Description
Portlet type
The base portlet type name is shown in bold font at the top of
the page.
Portlet ID
The portlet unique ID.
Portlet Definition ID
The portlet definition unique ID.
Dimensions [height,
width]
The portlet size in pixels.
Location [x, y, z]
Coordinates for the portlet location on the page.
Type
The portlet type, that is, the type of underlying technology
associated with the portlet, for example, iWidget.
Module
The .war file associated with the portlet.
Render Mode
How the portlet is rendered, for example, inline.
Role [type - access]
Roles associated with the portlet including the access level
provided to each role.
Author
Product or component associated with the portlet.
Chapter 1. IBM Tivoli Integrated Portal help
7
8
Tivoli Integrated Portal Online help
Chapter 2. Portal layout
The layout of the portal user interface has these major elements.
Figure 1. Portal layout
1 Banner
Displays a common image across all portal installations. The banner
includes a greeting to the user as well as links to log out of the portal and
to open online help. The View selection list in the banner controls which
nodes are displayed in the navigation as well as pages that are opened
when the view is selected.
2 Page bar
Displays tabs to select between open pages. The page bar allows you to
work on different pages without closing the page or losing unsaved data.
For example, if you are working on an application on Page A, you can
open an application on another page to gather information about a
resource that you need to finish the form on Page A without losing any
© Copyright IBM Corp. 2012
9
unsaved data you have already entered. Multiple pages can be opened at
one time, but only one of the open pages is in focus (current page). The
page bar also contains a Select Action drop-down list for performing
actions on the current page.
3 Navigation pane
Displays a set of navigation nodes used for accessing content. The nodes
shown in the navigation pane are only those to which you have access.
4 Work area
Displays the current page that you are working on. The page contains one
or more Web applications or portlets, each in its own portlet window with
a title bar.
Portal banner
The portal banner displays a common image across all portal installations. The
banner includes a greeting to the user, links to log out of the portal and to open
online help, and a selection list for different views.
Selecting views
Use the View selection list in the banner to select a list of tasks in the navigation
according to your preferences. Views can also be associated with pages that are
launched automatically when the view is selected. The following types of views
can be selected.
All tasks
This shows all tasks in the portal to which you have access.
My tasks
This shows only the tasks that you have added to this view. This list is
initially empty, but provides a link to My Tasks, which you can use to add
and remove from your personal task list in the navigation.
Product selection
Selecting a product name shows only the tasks for that particular product,
for example, WebSphere Application Server.
Custom views
These are views that have been created by the portal user or an
administrator from within the portal interface. Only users with access to
the Views portlet can create or edit custom views.
If you have access to create custom views, you can determine what pages and
folders are included using Views.
Accessing help
Help is available for the entire portal or for a specific portlet in the portal.
v To access online help, click the Help link in the banner. Help for all topics in the
portal is displayed.
v To access help for a portlet on a page, click Help (?) in the portlet title bar. Help
for the individual topic is displayed.
10
Tivoli Integrated Portal Online help
Page bar
Use the tabs in the page bar to navigate between open pages or to close a specific
page. While many pages can be open at a time, only one page can be in focus, or
current.
The page bar can display multiple tabs. If you open more tabs than can be
displayed at once in the page bar, horizontal scroll arrows provide access to the
other page tabs.
Note: Page tabs provide hover text to display the full page name when the name
is concatenated by limited display space. However, for users of the Windows Eyes
screen reader, the page name is not read.
The page bar also includes a page action selection list. Depending on the
capabilities of the page, the following actions are provided.
v Close Page
Closes the current page.
v Add to My Startup Pages
Adds the current page to the list of pages that are automatically launched when
you log into the portal.
v Manage Open Pages
Opens a module that you can use to access or close pages that are open. This
application is intended for situations in which you have a very large number of
pages open that are too difficult to manage using the tabs in the page bar.
v Configure Portlet Refresh
Used to customize your personal refresh settings for portlets on the page that
support portlet refresh.
v Open Page in New Tab
For pages that support multiple instances (known as multitask nodes), this action
opens another copy of the current page.
v Edit Page
Used to change the layout and content in the page. This option is available only
if your role has Editor access to the page.
v Save As
Used to save a copy of the current page using another name. This option is
available only if your role has Editor access to the page.
Navigating the portal
The navigation pane displays a set of nodes used to launch pages in the portal
work area. Nodes are grouped into folders, for example, Users and Groups or
Settings, which can be nested in multiple levels.
Be sure you understand the terms for each of the user interface elements (banner,
page bar, navigation pane, and work area) that constitute the portal layout before
reading this section .
Chapter 2. Portal layout
11
The border between the navigation pane and work area can be clicked to hide and
show the navigation. This is helpful if you need more space in the work area.
Note: The browser back button is not reliable for navigating the portal and is not
supported. Use the navigation controls and links in the portal as an alternative.
Navigation node types
The portal navigation is composed of a hierarchical structure of nodes. The
following types of nodes are supported.
Folder Does not display any content but contains other nodes. Use folders to
organize nodes in the navigation. A folder can be expanded, to reveal its
child nodes, or collapsed to hide them using the following icons.
v Expand folder contents: the Expand node icon
v Collapse folder contents: the Collapse node icon
URL
Launches any URL-addressable resource, including external Web sites, into
a new browser window.
Page
Launches a page in the work area. This is the most common node type.
Page nodes are further distinguished by their task. A task is an instance of
a page that is rendered in the work area of the portal. Tasks are associated
with the navigation node that launches the page and determine the
characteristics of that page. The following types of tasks are supported.
Single task node
A navigation node in which only one instance of the page can be
opened in the work area per session. Clicking on a single task
node in the navigation pane opens the task in the work area and
adds a page tab. If the page is already open, that page becomes the
current page.
Multitask node
A navigation node in which multiple instances can be opened in
the work area per session. Each new instance can be launched
either from a portlet or by selecting Open Page in New Tab from the
page action selection list in the page bar.
For multitask nodes, the label for the page tab indicates multiple
open instances of the page. For example, if the page name for a
multitask node is Expense Records and three instances of the page
are opened, the tabs are labelled in the order they are opened as
follows:
v Expense Records (1)
v Expense Records (2)
v Expense Records (3)
If one or more instances of a multitask node is already open in the
work area, clicking the node from the navigation pane does not
open a new instance of the node, but rather makes the last
accessed page instance the current page.
Hidden task node
A navigation node that launches a page that does not have a tab in
the page bar. While a hidden node is open, the page bar is
disabled. Pages launched by a hidden task node do not have page
bar actions, cannot be added to the list of startup pages, and
cannot be closed or accessed using Manage Open Pages
12
Tivoli Integrated Portal Online help
Each page, folder, and URL is further distinguished by its resource type. Use Pages
to create, edit, and delete portal pages.
Portal pages
The work area displays the current page that you are working on with one or
more web applications, portlets (sometimes informally called widgets).
Note: This help system uses the term portlet to generically refer to both portlets and
widgets, unless it is necessary to distinguish between the two underlying
technologies.
Portal pages contain one or more portlets , which are used to complete a task.
Portlets can contain information, such as news articles or stock quotes, or provide
a service, such as a department calendar, reports, or database query. Portlets are
displayed in windows that are arranged on the page within rows and columns in
pages that are created using the classic method of page creation. Pages created
using the freeform method, can displayed portlets anywhere on the page. Along
the top of each window is a title bar that includes controls that allow you to
manipulate the portlet, such as maximizing the portlet on the page or editing the
portlet settings.
v Users whose roles have Privileged User or Editor access to a page can resize
portlet windows on the page. To resize the portlet windows, use your mouse to
drag the border between the windows.
The window sizes are preserved as long as the page is open. To save these
changes after the page is closed or after you logoff, click Save at the top of the
page. After changing and saving the initial window sizes on a page, the Restore
button is rendered at the top of the page to allow you to return to the default
window sizes of the page.
v Users whose roles have Editor access to a page can add, remove, and rearrange
portlets on the page.
v Administrators with access to Pages navigation node can create custom pages.
Portlets and widgets
Each portlet, or widget, on a page is displayed within a discrete panel. The panel
includes a title bar displaying the portlet name. Portlets vary in their purpose and
use, but they all share similar controls that are accessed from the title bar. Panels,
including their title bar, can be hidden, but will be displayed when a user rolls
over the title bar area. Depending on the functions supported by the portlet, the
following icons can be available.
v The Edit options icon is displayed so that you or an administrator customize
display and other options for a portlet. Clicking this icon reveals some or more
of the following options:
– Personalize - Click this option to set your personal settings for the portlet.
These changes only affect your interaction with the portlet.
– Edit Shared Settings - Click this option to set shared settings for a portlet
that all users of the portlet can see. Users in roles that have Privileged User
access can change the defaults to their own personal preferences.
– Minimize - Click this option to minimize the portlet view. When you click
this option, only the title bar is visible on the page.
– Maximize - Click this option to maximize a portlet view. The portlet
occupies the full width and height of the page, replacing all other content
until it is restored.
Chapter 2. Portal layout
13
–
Restore - Click this option to return a portlet window to its original state
after it has been minimized or maximized.
v Use the Back icon to return to the previous panel.
v The Help (?) icon is displayed if help is available for the portlet. When you click
the icon, the help is displayed in a separate browser window.
v The Minimize icon allows you to minimize the portlet view. When you click the
icon, only the title bar is visible on the page.
v The Maximize icon allows you to maximize a portlet view. When you click the
icon, the portlet occupies the full width and height of the page, replacing all
other content until it is restored.
v The Close portlet icon is provided so that you can close a portlet that has been
dynamically added to the page.
v The Restore icon is provided so that you can return a portlet window to its
original state after it has been minimized or maximized.
Some portlets can refresh their content without causing the entire portal page to be
refreshed. This is known as portlet refresh and is provided to make your experience
with the portal more responsive. Portlets that support portlet refresh provide icons
in the title bar reflecting this feature, as follows:
The Portlet refresh icon
Indicates that this portlet can be refreshed without reloading the portal
page (portlet refresh). Clicking this icon displays the following options:
v Pause Refresh - Select this option to pause the refresh timer.
v Resume Refresh - Select this option to restart the refresh timer from the
pause state.
v Manual Refresh - Select this option to initiate a portlet refresh.
Displays the time remaining until a portlet's next scheduled refresh.
Refreshing
Indicates that a portlet is currently refreshing its content.
Depending on your access permissions for the portal, you can configure these
refresh settings using Configure Portlet Refresh.
Aside from the controls on the title bar, a portlet can include controls for other
actions, such as a button to submit input. Some portlets have controls that launch
other portlets. If a portlet launches another portlet, the newly launched portlet is
displayed on the same page in an area near the bottom of the page.
14
Tivoli Integrated Portal Online help
Chapter 3. Customizing the portal
Use these applications to make changes to the portal settings for your own use.
Access to these applications depend upon permissions defined for your role in the
portal.
My tasks
Use My tasks to create and edit a list of tasks to view in the portal navigation. A
task includes a page that contains one or more web applications, or portlets, that
are used to complete that task.
When you first access the portal, all tasks to which you have access are displayed
in the navigation. My tasks is especially useful to customize the navigation to
show only the tasks you use most often. After you customize your tasks, My Tasks
is initially displayed each time you log in to the portal.
Follow these general steps to customize your task list in the navigation.
1. Select My tasks from the View selection list in the navigation. If you have
never used My tasks before, you must click Add tasks to open it.
2. Use the checkboxes to select and deselect tasks from the My tasks navigation.
3. To save your changes, click Apply.
4. To cancel your changes, click Reset.
After applying your selections, your customized task list is displayed in the
navigation.
Use the following buttons to customize your task selections.
Apply Saves the current selections.
Reset
Backtracks all changes to the selections that were set since the last time My
tasks was applied. This is useful if you need to cancel your changes.
Select All
Checks every task.
Deselect All
Unchecks every task.
Expand All
Expands each node in the display and reveals all subtasks in the
navigation.
Collapse All
Collapses each node in the display so that only the top level nodes are
displayed.
My Startup Pages
Use My Startup Pages to configure your default views and pages to load when
you login to the portal.
© Copyright IBM Corp. 2012
15
Using My Startup Pages
Use My Startup Pages to add or remove pages from the list of pages that are
launched every time you log into the portal. Only single task and multiple task
pages can be added to the startup list. You can set which page is opened as the
current page (in focus). To open one of your startup pages, click the link for that
page in the Page name column.
My Startup Pages also allows you to define the default view for the portal
navigation. You can select All tasks, My tasks, or a product from the list. After
you apply your selection, the view that you selected is rendered in the navigation
every time you log in.
Field descriptions
Console default view
Select the view that you want to display in the navigation pane after you
log in. You can select from the following choices:
v All tasks
All navigation categories and nodes are displayed.
v My tasks
Only navigation nodes that you saved in My Tasks are displayed. This
option is intended for users who have a specific set of tasks that they
need to perform and do not want to see all navigation nodes.
v Custom, system, and product views
Other views defined to the portal can be included in the selection list. If
a view is defined by the system administrator as the default, that is
indicated in the selection list.
Select all icon
Selects all items displayed in the table for deletion. If you are displaying
only a filtered set of items, only those items are selected. You can deselect
specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
Remove
Removes the selected pages from the startup list.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Default
Selects the page to be rendered as the current page (in focus) after you log
in. All other pages are loaded in the background and are accessible from
the page bar or from Manage Open Pages.
Page name
Displays the name of each page in the startup list. This is rendered as a
link so that you can access the page directly by clicking on the name.
16
Tivoli Integrated Portal Online help
Editing page content and layout
Pages are an arrangement of one or more portlets in the work area and contain the
portlets needed to complete tasks. Users whose roles have “Editor” or “Manager”
access to a page can edit a page's layout and content using the Edit Page option in
the page action list. After saving changes to the layout and content, you can
change a page's properties, including it's name and location in the navigation.
About this task
Note: User's with “Privileged User” access can change the size of portlet windows
on the page.
Procedure
1. Locate the page you want to edit in the navigation pane and open it.
2. In the page bar, select Edit Page from the page actions selection list. The page
is changed to show buttons at the top. Each portlet title bar displays new
icons for creating horizontal and vertical layouts and an edit options icon.
3. Optional: To change the skin associated with a portlet, in the title bar click the
Edit options icon and select Skin to display a menu of the skins that you can
apply to the portlet. Skins can be used to change the background of a portlet,
for example, to set it to transparent. Skins may also be used to hide the portlet
title bar. In this mode, a user can hover their mouse pointer in the title bar
area in order to display the title bar.
4. Optional: To add more portlets to the page that was created in freeform mode,
follow these steps.
a. Once a freeform page is in edit mode, the portlet palette is displayed at
the top of the page. To add new portlets to the page, click and drag a
portlet from the palette.
b. Optional: If required and if it is supported by the portlet that you added,
you can use the Edit options icon to configure settings for the new portlet.
c. If you have completed editing the freeform page, click Done to exit the
page from the edit mode.
5. Optional: To add more portlets to the page that was created in classic mode,
follow these steps.
a. Create a window for the new portlet by splitting one of the windows
displayed.
v Use the Horizontal split icon to create a window below an existing
window.
v Use the Vertical split icon to create a window to the right of an existing
window.
The Portlet Picker is displayed within the new portlet window for
selecting the portlet content.
b. Scroll through the list or use the Filter field to find the portlet you want to
add.
c. Click OK. The portlet is added to the window.
6. Optional: To replace a portlet in a window, follow these steps.
a. Click Edit options in the title bar where you want to replace the portlet
content and select Replace content. The Portlet Picker is displayed within
the new window.
Chapter 3. Customizing the portal
17
b. Scroll through the list or use the Filter field to find the portlet you want to
add.
c. Click Add Portlet. The portlet is added to the window.
7. Optional: To remove a portlet and its window, click Edit options in the title
bar and select Delete space. The content is removed immediately without a
warning prompt.
8. Optional: To create wires between portlets so they can share information and
updates, click Show Wires. Before working with wires, make sure that you
have enough information about the events that a portlet supports.
9. Click Page settings. The page settings are displayed.
10. Optional: Make changes to the page's settings as required.
a. Click the General tab.
b. In the Page name field, provide a descriptive name for the page and in the
Page location field indicate where you want the page to be displayed in
the navigation pane. Consider the content on the page and how users will
find that content by looking for the page name in the navigation pane.
c. Use the Navigation visibility list to indicate whether or not you want the
page to be listed in the navigation pane.
d. From the Page persistence list, make one of the following selections:
v Client side (default setting) - This setting preserves any changes that the
user makes on the page when the user navigates away from the page.
Changes include not only form data, but any state changes to portlets,
for example, opening edit mode, switching to another panel in the
portlet, or minimizing a portlet. Page data and page state are
maintained on the client side until the user closes the page or logs out
of the portal.
v None
v Server side - This setting maintains unsubmitted or unsaved form data
from a page when the user navigates away from the page. The data is
saved on the server and fetched when the user returns to the page.
Unsaved data is saved until the user closes the page or logs out of the
portal.
Note: The Server side setting only applies to forms on a page. Any user
interaction outside of a form is not maintained.
e. Use the Page tasking radio buttons to indicate whether multiple instances
of the page can be launched.
f. In the Component direction drop-down list, you can accept the Default
setting to allow the component direction to be governed at portal level or
select one of the other settings to indicate whether you want to display
page components from left-to-right or from right-to-left. If you select a
setting other than Default, it will override any component direction setting
that may be set at portal or browser level.
g. In the Text direction drop-down list, you can accept the Default setting to
allow the text direction to be governed at portal level or select
Left-to-Right or from Right-to-Left to indicate the direction that you want
the page text to display. You can also select Contextual Input so that for
pages that include text entry fields, the direction of text is dependent on
the language used to enter data. If you select a setting other than Default,
it will override any text direction setting that may be set at portal or
browser level.
18
Tivoli Integrated Portal Online help
11. Optional: Click the Roles tab to update the list of roles with permissions to
the page and their access level. A list of all roles with access to the page is
displayed.
Option
Description
To remove access for a role
Select a role and click Remove. The role is
removed immediately from the access list
without a warning prompt.
To add access for a role
Click Add. Select one or more of the roles
displayed and click OK. The roles you
added are included to the list.
To change the access level for a role
Select one of the options under Access Level
for the role.
Attention: Make sure that the roles with access to a page also have access to
the portlets that are on the page.
12. Optional: Click the View Membership tab to update the list of views that
include this page.
Option
Description
To add this page to a view
Click Add and select one or more views.
To remove this page from a view
Select one or more views in the list and click
Remove.
13. If you accessed the Page settings window and made changes, click Save to
commit your changes and return to the main edit page window.
14. When you are satisfied with your updates, click Save to commit your changes.
Results
You are returned to the page with your changes displayed.
Arranging portlets using the drag-and-drop feature
When editing a page, you can drag portlets to any window on the page. The
portlet must already be placed in a window on the page, and the target window
must already exist.
About this task
The target window can be an empty window or it can already contain a portlet.
v If you drag a portlet into an empty window, the original window becomes
empty after the portlet has been moved.
v If you drag a portlet into a window that already contains another portlet, the
two portlets exchange windows.
Procedure
1. Locate the mouse over the portlet title in the title bar. You cannot drop a portlet
into another window by dragging from any other location in the portlet
window or title bar. The portlet must be dragged using the title.
2. Drop the portlet in the target window when the target window displays a blue,
dotted outline around the frame. The outline is the only indication that the
portlet can be dropped into this location.
Chapter 3. Customizing the portal
19
Customizing a portlet
Depending on how a portlet was configured when it was created and any shared
settings applied by your administrator, you can customize a portlet's setting using
the Edit options icon in the portlet's taskbar.
About this task
Individual portlets have different customization settings. This topic outlines
settings that are common to most portlets. Depending on your access permissions
to a portlet, you may be able to customize its appearance and location in relation
to other portlets (for example, in front or behind other portlets).
Note: Portlets can be customized at various levels. Initially when a portlet is
created, the portlet Manager configures and customizes the portlet using a base
portlet as a template. Subsequently, an administrator can edit a portlet's shared
settings overriding its initial configuration. This topic describes how a user can
further customize a portlet's settings, again overriding its shared settings.
To personalize a portlet:
Procedure
1. In the title bar, depending on your access privileges, click the Edit options icon.
A menu is displayed that provides a number of customization options.
2. Select a menu item and customize the appearance and z-axis location of the
portlet as required. The following table describes the common functions
available in many portlets:
Table 6. Edit options menu
20
Menu item
Description
Edit Shared Settings
Some portlets support editing shared settings.
Settings available through this item are specific to
each portlet type. This menu item may or may not be
available, depending on your access level in the
portlet. Select it to configure shared settings for the
portlet overriding settings set when the portlet was
created. Shared settings affect all users of the portlet.
Personalize
Some portlets support personalized settings. Settings
available through this item are specific to each portlet
type. You can configure personal settings for the
portlet overriding any shared settings that may have
been configured for it. Personal settings affect only
your use of the portlet.
Skin > Default
Select this setting to display the portlet's taskbar and
frame at all times.
Skin > Default no title
Select this setting to display the portlet's frame and
but not the taskbar. To subsequently access taskbar
functions, roll over the taskbar area and click the
Show Menu button that is displayed.
Skin > Transparent
Select this setting to display the portlet's taskbar and
but not the portlet's frame. To subsequently access
taskbar functions, roll over the taskbar area and click
the Show Menu button that is displayed.
Tivoli Integrated Portal Online help
Table 6. Edit options menu (continued)
Menu item
Description
Skin > Transparent no title
Select this setting to hide the portlet's taskbar and
frame. To subsequently access taskbar functions, roll
over the taskbar area and click the Show Menu
button that is displayed.
Fill Work Page
Select this settings to maximize the portlet on the
page. Use this setting with the Send to Back setting
to set the portlet as a background to the portal page.
Bring to Front
Select this setting to ensure that the portlet overlays
all other content on the page.
Send to Back
Select this setting to ensure that the portlet underlays
all other content on the page.
Bring Forward
Select this setting to display the portlet one layer up
relative to other content on the page.
Send Backward
Select this setting to display the portlet one layer
down relative to other content on the page.
Events
Select this setting to view event settings for the
portlet.
Delete space
Select this setting to remove the portlet from the
page.
Results
Any changes you make affects content only in relation to your user ID.
Setting text and component direction
Some portlets, or widgets, allow you to customize whether a its components and
text are displayed left-to-right, or right-to-left.
About this task
Any changes you make affects the portlet content only in relation to your user ID.
Procedure
1. Open the page that contains the portlet or widget that you want to personalize.
2. In the title bar, click the Personalize icon to display a panel that allows you to
customize its settings.
3. Edit the settings as required.
For example, for both content and text, the Default option lets the display
direction be determined at page level. You can choose to set the text and
content direction to either left-to-right or right-to-left. In the Text direction list,
you can also select Contextual Input so that for portlets that include text entry
fields, the direction of text is dependent on the language used to enter data.
Note: Display direction settings that you set at this level (user level), override
any other settings that may have been set at portlet, page, portal, or browser
levels.
4. Submit your changes and in the title bar of the personalize settings portlet,
click Back to return to the page that hosts the portlet and review your changes.
Chapter 3. Customizing the portal
21
Your changes are applied and only affect your interaction with this particular
portlet.
Personalizing a web portlet
Depending on the settings applied by your administrator, you can personalize a
web portlet's title, home page, help page, and layout. Administrators can set
shared settings to provide a common experience for users of a web portlet.
About this task
If your administrator has not configured shared settings for the web portlet, you
can enter a complete web address in the field provided and browse the web. To set
a default web page for the portlet and to further personalize your experience of a
web portlet, complete the following steps:
Procedure
1. In the title bar, depending on your access privileges, click the Edit options icon
and select Personalize.
2.
3.
4.
5.
6.
A settings page is displayed, where depending on shared settings applied by
your administrator, you can personalize the web portlet's title, home page, help
page, and layout.
Optional: In the Widget title field provide a brief descriptive name. When
selecting a title, consider the purpose of the web portlet, its home page, and
that the title is used in the navigation pane to access the portlet.
Optional: In the Home page field provide a valid web address. This the web
address of the page that displays by default when a user accesses the portlet
from the navigation pane.
Optional: In the Help page field, provide a relative or absolute URL to a
custom help page HTML topic to replace the default help topic that is
associated with the web portlet.
Optional: Check the Show a browser control toolbar to include a web
navigation toolbar, that is, standard web navigation buttons and web address
entry field.
Click Save to commit your changes, or Restore Default Settings to reset the
form.
Results
Any changes you make affects content only in relation to your user ID.
Working with image portlets
You can set up an image portlet as a background image in a portal page or overlay
multiple image portlets on another image portlet, for example, a background map
image could be overlaid with additional images to highlights features on the map.
The image portlet allows you to add images to a portal page and set their position
in relation to other portlets or images, for example, you can decide if you want an
image to form a background to a page or have it overlay another image or portlet
on the page.
22
Tivoli Integrated Portal Online help
To set up an image portlet you must put the portal page in edit mode, that is,
open the page in the portal and from the Select Action drop-down list, select Edit
Page.
Working with the Edit options
To set up display settings for an image portlet, click the Edit options icon in its
taskbar and the following options are available:
Table 7. Edit options menu
Menu item
Description
Edit Shared Settings
Select this item to configure which image to display
in the image portlet.
Skin > Default
Select this setting to display the portlet's taskbar and
frame at all times.
Skin > Default no title
Select this setting to display the portlet's frame and
but not the taskbar. To subsequently access taskbar
functions, roll over the taskbar area and click the
Show Menu button that is displayed.
Skin > Transparent
Select this setting to display the portlet's taskbar and
but not the portlet's frame. To subsequently access
taskbar functions, roll over the taskbar area and click
the Show Menu button that is displayed.
Skin > Transparent no title
Select this setting to hide the portlet's taskbar and
frame. To subsequently access taskbar functions, roll
over the taskbar area and click the Show Menu
button that is displayed.
Fill Work Page
Select this settings to maximize the image portlet on
the page. Use this setting with the Send to Back
setting to create a background image for the portal
page.
Bring to Front
Select this setting to ensure that the image portlet
overlays all other content on the page.
Send to Back
Select this setting to ensure that the image portlet
underlays all other content on the page.
Bring Forward
Select this setting to display the portlet one layer up
relative to other content on the page.
Send Backward
Select this setting to display the portlet one layer
down relative to other content on the page.
Events
Select this setting to view event settings for the
portlet.
Delete space
Select this setting to remove the portlet from the
page.
Moving and resizing an image portlet in a free form page
Once a free form page is in edit mode, you can click and drag at the taskbar to
move a portlet to the required position on the page.
You can also resize a portlet by clicking and dragging the bottom right hand
corner of the portlet.
Chapter 3. Customizing the portal
23
Manage Open Pages
Use Manage Open Pages to close or navigate to open pages.
Using Manage Open Pages
This module supports the same tasks that can be performed in the portal page bar.
v Close one or more pages.
v Navigate to a page.
The purpose of this module is to help manage a large number of open pages. For
example, if you have 25 pages open, you could use this module to select 20 of
them to close so that you can work on the remaining five.
Field descriptions
Select all icon
Selects all items displayed in the table for deletion. If you are displaying
only a filtered set of items, only those items are selected. You can deselect
specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
Close
Closes the selected pages.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Page Name
Displays the name of each page in the startup list. This is rendered as a
link so that you can access the page directly by clicking on the name.
Configure Portlet Refresh
Use this module to customize the refresh settings for portal modules that support
this feature. Portlet refresh is used to refresh the content of a single module
without reloading the entire page. As a result, your experience with the portal
interface is quicker and more interactive. Use these settings to fine tune how each
portlet refreshes its content individually on the page.
Using Configure Portlet Refresh
This module is launched when you select Configure Portlet Refresh from the
action list in the portal page bar. Your changes apply only to your use of the portal
and do not affect other users. You can perform the following tasks:
v Set the refresh mode.
v Set the refresh interval.
v Show or hide the timer from the portlet title bar.
v Restore all of these settings to the default.
Portlet refresh settings
Restore Default Configuration
Changes all of the field values to the default settings as determined by the
portal administrator. At least one portlet must be selected to enable this
24
Tivoli Integrated Portal Online help
button. To save the changes displayed by this button, select the portlets
that you want to restore to the default settings and click Apply or OK.
Select all Select all icon
Selects all of the portlets displayed. A maximum of 10 refreshable portlets
can be displayed and selected at a time.
Deselect all Deselect all icon
Deselects all of the portlets displayed.
Select Use the checkbox to select individual portlets that you want to restore to
the default settings.
Portlet
Indicates the name of the portlet or portal module which can be refreshed.
Refresh Mode
Select one of the following options:
v No Refresh
Indicates that the portlet content will not be refreshed automatically. The
refresh timer is not displayed in the portlet title bar, but the portlet can
still be refreshed manually.
v Timed Refresh
Indicates that the portlet content is refreshed automatically based on the
value of the refresh interval.
v Smart Refresh
Indicates that after the refresh interval has timed out, the client should
query the portlet on the server to determine if it should refresh the
content. If the portlet has updates to provide, then the content is
updated on the client. Otherwise, no change is made and the timer is
started again.
Refresh Interval
Indicate a value in seconds after which the portlet's content can be
refreshed from the server without reloaded the entire page. This value
must be greater than or equal to the minimum refresh interval.
Minimum Refresh Interval
Indicates the minimum value for the refresh interval. This value is
determined by the administrator.
Show Timer
Indicates whether to display a timer in the portlet title bar showing the
number of seconds remaining until the next refresh can take place.
Chapter 3. Customizing the portal
25
26
Tivoli Integrated Portal Online help
Chapter 4. Administrative settings
Use these applications to make changes to the portal that generally affect all portal
users. Access to these applications depend upon permissions defined for your
portal role.
Setting up the portal
For a new portal installation, the portal administrator needs to create the
experience for users when they log into the portal. This task involves working
through the portal content from the basic building blocks to the high level
organization and presentation of these resources so that users can quickly find
what their way around and perform their tasks efficiently.
To get started setting up the portal, you should already be familiar with the
concepts and characteristics of the layout. You should take time navigating through
the portal to become familiar with the portlets, pages, views, roles, and preference
profiles that are provided. As you work with the portal, you will create some of
these resources to suit your organization's needs.
Understanding the structure of the portal
Access to each level in the portal organization is assigned based on the users' roles.
Keep each role in mind when planning how to structure the portal content.
Content in the portal is composed of portlets. The following figure shows how
portlets are arranged on a page using a row and column layout. Access to each
page, and to each portlet on each page, is assigned to users based on their defined
role.
© Copyright IBM Corp. 2012
27
Each page is accessed from the navigation pane, either from the portal root or they
can be grouped into folders. The hierarchical structure of the navigation affects
how quickly users can find a page and work with the portlets on that page.
Folders and pages can be assembled into views that the user can select from the
View drop down list in the banner. Each view can include pages that are initially
launched when the view is selected.
28
Tivoli Integrated Portal Online help
Finally, you can define a set of preferences, called a preference profile, that
determines what views are available to each role, and whether the navigation pane
should be displayed.
Process for planning and setting up the portal
Setting up the portal is an iterative process. While you should initially start with
organizing pages, roles, and portlets and work your way up to setting up views
and preference profiles, over time you will need to come back to any of these steps
to make changes.
Procedure
1. Define your portal users and what tasks they perform. Portal users are assigned
to roles, which are used to determine what tasks they can perform. As you
assess the users' tasks, think about how these roles will be defined. Consider
how the community of users will be assigned to different roles and whether
there are any existing roles that you can use, or if you need to create new roles.
Roles can be created without assigning access to any resources. This step can be
performed later.
2. Review the content. Users' tasks are performed using portlets on portal pages.
You need to understand what portlets are available and how they will be used
to perform these tasks. For each portlet, determine which roles should have
access and which roles should be restricted.
3. Create a navigation structure of pages and folders. Determine which pages are
currently used to access the portlets. Are these pages sufficient for the roles that
you have defined, or do you need to create new pages? For existing pages, do
you need to add or remove any portlets or change the way they are arranged
on the page? Consider that multiple roles can access a page with different
access to the portlets on that page.
Review the folders in the navigation and the pages that are contained in these
folders. Do these folders help the users find their content? Do you need to edit
existing folders or create new folders? Should you move any pages between
folders? What folders or pages should be hidden for each role?
4. Organize the content and navigation into views. Determine which navigation
folders and pages have a related purpose for each role. You can define one or
more views for each role, and even make a single view appear differently
between roles based on access control. Each view can also include one or more
pages that are launched when the view is selected. Each of these options is
provided to help remove other content and pages that can distract users.
5. Define the presentation for each role Determine which views should be
available to users in a role. For some roles, you can remove the navigation pane
and just provide a set of startup pages. You can assign exactly one preference
profile per role.
6. Test the portal for each role. Create a test user for each role. Log into the portal
as each user and verify the use cases.
v The navigation is shown or not, depending on the setting in the preference
profile.
v The view selection list shows only the views to which the role has access and
as defined by the preference profile.
v Each view shows only the navigation nodes and startup pages allowed for
that role.
v Each folder shows only the pages allowed for that role.
Chapter 4. Administrative settings
29
v Each page launched in the navigation pane shows only the portlets allowed
for that role.
v If the role has Editor access to a page, the Edit Page option is available in the
Page Actions selection list. This option is not showing if the user's role does
not have Editor access.
v Each page shows only the portlets allowed for that role.
v The portlet title bar provides an Edit options icon that provides access to
two options, a Personalize option, and an Edit Shared Settings option. The
Personalize option is available, if the user's role has Privileged User access.
The Edit Shared Settings option is available if the user's role has Editor
access. Otherwise, neither of these options are available.
Go back and make corrections as indicated by the results of your testing.
7. Move the portal to production use. Assign roles to actual users and notify the
user community that the portal server is ready for use.
Logging out active users
Administrators can search for active users and log them out in the User Roles
page.
About this task
To search for active users and if required log them out:
Procedure
1. In the navigation pane, click Users and Groups > User Roles. The User Roles
page is displayed.
2. Leave all search fields empty and select the Active Users Only check box.
3. To log out a user that is listed as being active, select the checkbox associated
with their list entry and click Logout.
Tip: To log out all active users, click the Select all icon icon to select all the
entries and click Logout.
Working with pages
Portal content is composed of pages, folders, and external URLs. Each of these
resources is represented in the navigation pane as a node. Click Settings > Pages
to create, edit, and delete pages and folders for the portal navigation. You can also
edit external URLs that are launched from the navigation pane. You cannot create
URLs in the portal. Instead, URLs are created when an application is deployed to
the portal that includes the URL node in its descriptors.
Field descriptions
This section describes the fields and controls in the main panel of Pages.
Select all icon
Selects all items displayed in the table for deletion. If you are displaying
only a filtered set of items, only those items are selected. You can deselect
specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
30
Tivoli Integrated Portal Online help
New Page
Opens a panel for creating a new page.
New Folder
Opens a panel for creating a new folder.
Delete Immediately deletes all selected items in the list. Only Custom resource
types can be deleted.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Name Displays the title of the page as it is shown in the navigation.
Type
Displays the type of page.
Unique Name
Displays the string used by the system to uniquely identify the page or
folder.
Creating classic pages
To create a page in classic mode, you must first set the properties of the page,
including the page name and its location in the navigation pane. You must then
select content for the page and specify the layout of the portlet window. All pages
that are created in the portal have a resource type of “Custom”.
About this task
Important: Manager access to the Pages portlet is required in order to be able to
create and delete pages or folders.
To create a page for testing purposes:
Procedure
1. To display the Create New Work Page portlet:
v In the taskbar, click the Create new work page tab.
v In the navigation pane, click Settings > Pages and in the Pages portlet, click
New Page.
A Page Settings page is displayed.
2. In the Page name field, provide a descriptive name for the page and in the
Page location field indicate where you want the page to be displayed in the
navigation pane. Consider the content on the page and how users will find that
content by looking for the page name in the navigation pane.
3. Select the Classic option for the page layout.
4. Optional: Click the Optional Setting label and associate one or more roles with
the new page and set the level of access for each role.
5. Click OK. The taskbar tab is updated with the name of the new page and a
Choose a Portlet window is displayed.
6. To add a portlet, scroll through the list and select a portlet or use the Filter
field to find the portlet you want to add.
7. Optional: Use the the Horizontal split icon or the the Vertical split icon to add
more portlet containers to the page and select a portlet for each section.
8. Click OK in the Choose a Portlet window. The selected portlet is displayed.
9. Click Save to commit your changes.
Chapter 4. Administrative settings
31
Results
The new page is displayed. Users with “editor” access to the page can add more
content, arrange the content using horizontal and vertical layouts, and replace and
remove content.
What to do next
Make sure that the roles with access to this page also have access to the portlets
that are on the page. You can also edit the new page to customize its settings, for
example, its page persistence settings or text direction settings.
Creating freeform pages
To create a freeform page in the self service dashboard, you must first set the
properties of the page, including the page name and its location in the navigation
pane and then select content for the page. All pages that are created in the portal
have a resource type of “Custom”.
About this task
Important: Manager access to the Pages portlet is required in order to be able to
create and delete pages or folders.
To create a freeform page for testing purposes:
Procedure
1. To display the Create New Work Page portlet:
v In the taskbar, click the Create new work page tab.
v In the navigation pane, click Settings > Pages and in the Page Management
portlet, click New Page.
2.
3.
4.
5.
A Page Settings page is displayed.
In the Page name field, provide a descriptive name for the page and in the
Page location field indicate where you want the page to be displayed in the
navigation pane. Consider the content on the page and how users will find that
content by looking for the page name in the navigation pane.
Select the Freeform option for the page layout.
Optional: Click the Optional Setting label and associate one or more roles with
the new page and set the level of access for each role.
Click OK. The taskbar tab is updated with the name of the new page and a
window is displayed that includes a portlet palette from which you can select
portlets for your new page.
6. The portlet palette can contain portlets or portlet catalogs. Portlet catalogs are
used to organize portlets into logical groups in environments where many
portlets are available to be added to a page. You can use the search field to
filter the number of items displayed, or you can use the navigation arrows to
scroll through the items. To remove a search filter, clear the search field and
click Search. You can hover over a portlet to view more information about it.
7. To add content to your page, drag items from the content palette to the content
area below the palette.
Tip: As you add items you can configure display settings through the Edit
options icon, for example, you can change skin and a portlet's position on the
32
Tivoli Integrated Portal Online help
page, that is, whether it is displayed in front of or behind other content on the
page. You can also resize a portlet by clicking and dragging the bottom right
hand corner of the portlet.
8. Click Done to commit your changes.
Results
The new freeform page is displayed. Users with “editor” access to the page can
add more content, arrange the content using horizontal and vertical layouts, and
replace and remove content.
What to do next
Make sure that the roles with access to this page also have access to the items on
the page. You can also edit the new page to customize it settings, for example, its
page persistence settings or text direction settings.
Creating folders
Folders are used to group nodes in the navigation pane. All folders that are created
in the portal have a resource type of “Custom”.
Procedure
1. Click Settings > Pages in the navigation pane. A Page Settings page is
displayed.
2. Click New Folder. The properties panel for the new folder is displayed.
3. Complete the fields in the properties panel.
4. Click Save to save your changes and return to Pages.
Results
The new folder is displayed in the summary table. The folder is also displayed in
the navigation pane once you have added page content to it. Add other nodes to
the folder by editing their location properties.
Editing the properties of a page, folder, or external URL
You can edit the properties of custom and system navigation nodes, which include
pages, folders, and external URLs. Properties of a node include its display name
and its location in the navigation. You can also indicate whether multiple or only
single instances of a page node can be launched in the portal.
About this task
When changes are made to a system node, the updated system node is saved as
System - Customized. You cannot delete a system node. Instead, you can restore
the system node, which deletes the custom copy of it.
You can perform the following tasks when you edit a node's properties.
v Define who can access a page or external URL and the level of access
v Determine which view should include the node. When the view is selected, the
page, folder, or URL is included in the navigation pane for that view.
v Change the name that is displayed in the navigation pane for a node.
v Change the location of a node in the navigation pane. For example, you can
group pages into folders.
Chapter 4. Administrative settings
33
Attention: You cannot create URLs in the portal. Instead, URLs are created when
an application is deployed to the portal that includes the URL node in its
descriptors.
Procedure
1. Click Settings > Pages in the navigation pane. Pages is opened displaying
navigation nodes in a summary table.
2. Locate the node that you want to edit in the table provided. Use the filter in
the table to type in the node name and quickly display it.
3. Click the link for the node provided in the Name column. The properties panel
for the node is displayed.
4. Make your changes to the node's Page, Folder, and External URL properties.
5. Click Save when you have finished.
Results
The changes you made are reflected in the navigation pane.
Deleting custom pages and folders
You can delete only pages with the resource type of Custom. These are nodes
created using the portal.
About this task
System nodes that have been customized can be restored.
Attention: Before deleting a page or folder, consider whether any users are
actively using the resource and any impacts this might have on services. If
necessary, notify users in advance of any plans for changes that could affect their
work.
Important: Manager access to the Pages portlet is required in order to be able to
create and delete pages or folders.
Procedure
1. Click Settings > Pages in the navigation pane. Pages is opened displaying
portal navigation nodes in a summary table.
2. Locate the node that you want to delete in the table provided. Use the filter in
the table to type in the node name and quickly display it.
3. Check the box in the Select column for the node. You can select more than one
custom page or folder for deletion.
4. Click Delete. A message is displayed at the top prompting you to confirm the
deletion.
5. Click OK.
Results
The page or folder is deleted and removed from the navigation pane.
Restoring system pages, folders, and external URLs
System nodes are always preserved with their original settings. After making
changes to a system node, the changes are saved in a customized copy of the page,
34
Tivoli Integrated Portal Online help
folder, or URL. When you restore a system node, the customized copy is deleted
and the original system node is restored in its place.
About this task
To delete the customized copy and restore the system node, follow these steps.
Procedure
1. Click Settings > Pages in the navigation pane. Pages is opened displaying
portal navigation nodes in a summary table.
2. Locate the node that you want to edit in the table provided. Use the filter in
the table to type in the node name and quickly display it.
3. Click the link for the node provided in the Name column. The properties panel
for the node is displayed.
4. Scroll to the bottom of the panel and click Restore.
5. Click OK to save your changes.
Results
You are returned to the main panel of Pages. The resource type of the node is
displayed as System.
Page field descriptions
Page properties
This panel is used to edit the general properties of a page.
This properties panel is displayed when you click a page in Pages to edit it. This
panel is also displayed when you create a new page.
Note: If you are creating a new page, add your own role to the page access list so
that you can view and access the page.
The following fields are available.
Page name
Indicates the name that is displayed for the node in the navigation, page
tab, and page title area. When entering a page name in this field, consider
the content on the page and how users will find that content by looking
for the page name in the navigation. The page name does not have to be
unique.
This field is disabled if string translation is enabled. Click String
Translation to change the support for translation of the name.
Page location
Indicates the location of the page in the navigation. Click Location to
change the location. This location is always relative to the console root
folder. For example, if you want your page to be located in a navigation
folder called Status, the location would be console/Status.
Navigation visibility
Specifies whether to display the node in the navigation. Under most
circumstances, choose Visible. Choose Hidden if the page is to be launched
from outside of the navigation, for example, launched by a portlet on
another page.
Chapter 4. Administrative settings
35
Type of page
Indicates whether this is a Custom, System, System Customized, or Core
node.
Page unique name
Displays the string that uniquely identifies this page in the portal. For
example, you could have two pages with the name Status, but they cannot
share the same unique name. This field cannot be changed.
Initialization parameters
Enter parameters to be available to portlets on the page. This field is
available only for page nodes and is useful only when you know the
parameters that the portlets on the page can process.
Page persistence
This field is particularly useful for pages that contain forms and data
entered by users. If persistence is not enabled, form data is lost when the
user navigates away from the page without closing it. To preserve data
entered by the user for the duration of the portal session, specify whether
you want the data maintained on the client or server. This field is available
only for page nodes.
Page tasking
Indicate whether multiple instances of the page can be launched. If you
select multiple instances, then the Open Page in New Tab selection is
available for the page in the page action list.
Component direction
Indicate whether page components should be displayed from left-to-right
or right-to-left. If you select the default setting, the display direction is
governed at portal level.
Text direction
Indicate whether text on the page should be displayed from left-to-right or
right-to-left. If you select the default setting, the text direction is governed
at portal level. You can also set the text direction to Contextual Input,
which for portlets that include text entry fields, displays entered text in the
appropriate direction.
Roles with Access to This Page
This section provides a table displaying roles that have been assigned to
access this page and their level of access. Access control to a page can also
be assigned using Roles. The following options are unique for the roles
table.
Role Name
Displays the name of a role that has been given access to the page.
Access Level
Displays the level of access that the role has to the page.
View Membership
This section provides a table displaying views that the page is a member
of. The following options are unique to the view table.
View Name
Provides the name of the view as it is displayed in the View
selection list in the banner.
Launch
Check this option to launch the page when the user selects the
view.
36
Tivoli Integrated Portal Online help
The following fields and controls are available in both the roles and views tables.
Select all icon
Selects all items displayed in the table for deletion. If you are displaying
only a filtered set of items, only those items are selected. You can deselect
specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
Add
Adds an item to the table.
Remove
Removes all selected items from the table. There is no warning prompt
when you click Remove.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Folder properties
This panel is used to edit the general properties of a folder.
This properties panel is displayed when you click a folder in Pages to edit it. This
panel is also displayed when you create a new folder.
Note: If you are creating a new folder, add your own role to the folder access list
so that you can view and access the folder.
The following fields are available.
Folder name
Enter the name you want to display in the navigation for the node. This
field is disabled if string translation is enabled. Click String Translation to
change the support for translation of the name. The folder name does not
have to be unique.
Folder location
Specify where in the navigation pane you want to place the node. This
location is always relative to the console root folder. For example, if you
want your page to be located in a navigation folder called Status, the
location would be console/Status. Click Location to specify the location.
Navigation visibility
Specify whether to display the node in the navigation. Under most
circumstances, specify Visible.
Type of folder
Indicates whether this is a Custom, System, System Customized, or Core
node.
Folder unique name
Displays the string that uniquely identifies this folder in the portal. For
example, you could have two folders with the name Status, but they
cannot share the same unique name.
External URL properties
This panel is used to edit the general properties of an external URL.
This properties panel is displayed when you click an external URL in Pages to edit
it. The following fields are available.
Chapter 4. Administrative settings
37
URL name
Enter the name you want to display in the navigation for the URL. This
field is disabled if string translation is enabled. Click String Translation to
change the support for translation of the name. The URL name does not
have to be unique.
URL address
Indicates the URL for the link, which you can change. When the portal
user clicks the node in the navigation pane, a new browser window is
launched to the address specified in this field.
URL console location
Specify where in the navigation pane you want to place the external URL.
This location is always relative to the /console root folder. For example, if
you want your URL to be located in a navigation folder called External
resources, the location would be console/External Resources. Click
Location to specify the location.
URL visibility
Specify whether to display the node in the navigation.
Type of URL
Indicates whether this is a System or System - Customized URL.
URL unique name
Displays the string that uniquely identifies this URL in the portal. For
example, you could have two URLs in the navigation with the name
Status, but they cannot share the same unique name. This field is for
information only and cannot be changed.
Roles with Access to This URL
This section provides a table displaying roles that have been assigned to
access this URL and their level of access. Access control to a URL can also
be assigned using Roles. The following options are provided.
Select all icon
Selects all items displayed in the table for deletion. If you are
displaying only a filtered set of items, only those items are
selected. You can deselect specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
Add
Adds an item to the table.
Remove
Removes all selected items from the table. There is no warning
prompt when you click Remove.
Filter
Type in this field to quickly find an item in the table. This field is
useful when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Role Name
Displays the name of a role that has been given access to the URL.
Access Level
Displays the level of access that the role has to the URL.
Location properties
Use this panel to specify the location in the navigation of a page, folder, or URL
node. It is accessed from the properties panel of the node.
38
Tivoli Integrated Portal Online help
You can use the buttons provided or drag the node to change its location. You can
move only the node that is being edited. Select the node text to move it. The
following buttons are used to specify the location.
Up
Moves the selected node up within a folder.
Down Moves the selected node down within a folder.
Move Click this button to change the node's parent folder. This button changes
the original panel by making only folder nodes visible in the navigation
and removing the Up and Down buttons. After changing the folder
location, you can use Up and Down to change the order within that folder.
Add
Moves the node to the selected folder in the navigation and returns
to the original panel.
Back
Returns to the original panel without changing the location.
Portlet Palette properties
Use Portlet Palette to select a portlet to add to a page, change the page layout, or
connect portlets using wires.
The Portlet Palette is displayed only when you are creating a free form page or
editing a free form page, for example, adding a new portlet. All portlets that you
drag to a page are displayed below the Portlet Palette.
v When you are creating a new page, the Portlet Palette is displayed above the
content area to allow you to select portlet content for that page. Use the controls
on each portlet to remove it from the page.
v Hover over portlet icons to view a descriptive image and text for each portlet.
v Use the navigation arrows at the bottom of the palette to view additional
portlets.
v Use the breadcrumb controls at the top left of the palette to navigate catalog
levels.
When creating or editing a page, additional controls are provided on the page and
icons displayed in each portlet window title bar.
Field descriptions
The following controls are available in the Portlet Picker.
Search
Search for a particular portlet using a text string to reduce the number of
portlets listed in the palette. The search function searches portlet names
and their descriptions.
Page Settings
Click the
page.
Page Settings icon to view the general settings for the
Show Wires
Displays a list of wires for the page. See “Summary of wires” on page 40
for a complete description of these fields.
Done
Click Done to save your page once you have added and configured your
portlets on the page.
Chapter 4. Administrative settings
39
Cancel
Click Cancel to exit from the page without saving your changes.
Summary of wires
Displays existing connections, or wires, between source portlets on the page and
their targets. Wires are used to share information between portlets. For example,
when portlets are wired on a page, they can provide updates depending on a
selection in the source portlet of the wire.
Before working with wires, make sure you have sufficient information about the
type of events each portlet supports.
This section is displayed when you click Show Wires in a page that is being
edited.
New Wire
Displays a dialog that allows you to select an event for the wire. The
description for each event should provide sufficient information to help
select an event.
The following field names are available as the headings for each column in the
wire summary table.
Type
Indicates how the wire is created. System wires are created by products
and applications in the console. Custom wires have been created by editing
this page. You can delete custom wires and change custom wire
definitions, including the target, transformation, and event. You can only
enable and disable system wires.
Source
Indicates the name of the portlet on the page that is the source of the
event.
Event Provides the name of an event that can be shared between source portlets
and their targets. The event includes information that the target portlets
can respond to.
Target Specifies the target of the event. The target can be a page, a portlet on the
same page, or a portlet on another page. Click the Browse icon to select
from a list of available targets.
Transformation
Optional field that specifies how an event should be handled before it is
delivered to the target. A transformation can change event parameter
names, parameter values, or event types to enable the target to process the
event.
Use the Browse icon to select from a list of available transforms. The
description should provide sufficient information to help select a
transformation.
Enable
If checked, the wire is enabled and delivers the event when it is launched.
This is the only option you can change for system wires.
Delete Removes the wire.
Portlet Picker properties
In classic mode, use Portlet Picker to select a portlet to add to a page, change the
page layout, or connect portlets using wires.
40
Tivoli Integrated Portal Online help
This portlet is displayed only when you are creating a page or adding a portlet
window to a page in classic mode. For free form pages, a portlet palette is
displayed. All portlets on a page are displayed within a window.
v When you are creating a new page in classic mode, Portlet Picker is displayed
within a single window to allow you to select the portlet content for that
window. Portlet Picker is also displayed within any new windows that you add
to the new page. Use the controls on each window to add or remove windows
on the page.
v When you are editing a page, Portlet Picker is displayed only when you are
creating a new portlet window (using the Horizontal split icon or the Vertical
split icon) or replacing a portlet in an existing window (using the Replace
content icon).
When creating or editing a page, additional controls are provided on the page and
icons displayed in each portlet window title bar.
Field descriptions
The following controls are available in the Portlet Picker.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects a single portlet to be added to the page.
Portlet Entity Title
Displays the name of each portlet entity that can be placed on a page. In
some cases, multiple portlet entities can indicate the same portlet using
different names. For example, after deployment, an application can add a
portlet that provides news updates from an RSS feed. But there could be
two entities of the portlet, one with the name Company headlines and one
with the name Product updates. Each entity can be configured to obtain
the RSS feed from separate sources.
Leave portlet window blank
Check this box to save the window without portlet content. You must click
Add Portlet before you can save the page with this option checked.
Changes are not saved until you use the Save button on the page. This button is
enabled when you click OK in Portlet Picker.
Page editing controls in classic mode
Use these controls to change page content and layout in classic mode or to change
wires between portlets on the page. These controls are displayed only when
creating or editing a page.
v “Portlet title bar icons for layout and content”
v “Page level field descriptions” on page 42
v “Summary of wires” on page 42
Portlet title bar icons for layout and content
The following icons are available on every portlet window's title bar when creating
or editing a page. Changes are not committed until you click the page Save button.
See “Page level field descriptions” on page 42.
Chapter 4. Administrative settings
41
the Horizontal split icon
Creates a window beneath the current portlet window. A new instance of
the Portlet Picker is included in the new window for selecting the window
content.
the Vertical split icon
Creates a window to the right of the current portlet window. A new
instance of the Portlet Picker is included in the new window for selecting
the window content.
the Events icon
Displays events to which the portlet already subscribes or publishes.
the Replace content icon
Replaces the current portlet with the Portlet Picker to allow you to select
another portlet for the window.
the Delete icon
Deletes the current window and its content.
Page level field descriptions
The following controls are available on the page that you are creating or editing.
Save
Saves all changes you have made to the page and opens the page
properties.
Cancel
Cancels your changes and returns to the most recently opened page.
Show Wires
Displays a list of wires on the page. See “Summary of wires” for a
complete description of these fields.
Summary of wires
Displays existing connections, or wires, between source portlets on the page and
their targets. Wires are used to share information between portlets. For example,
when portlets are wired on a page, they can provide updates depending on a
selection in the source portlet of the wire.
Before working with wires, make sure you have sufficient information about the
type of events each portlet supports.
This section is displayed when you click Show Wires in a page that is being
edited.
New Wire
Displays a dialog that allows you to select an event for the wire. The
description for each event should provide sufficient information to help
select an event.
The following field names are available as the headings for each column in the
wire summary table.
Type
42
Indicates how the wire is created. System wires are created by products
and applications in the console. Custom wires have been created by editing
this page. You can delete custom wires and change custom wire
definitions, including the target, transformation, and event. You can only
enable and disable system wires.
Tivoli Integrated Portal Online help
Source
Indicates the name of the portlet on the page that is the source of the
event.
Event Provides the name of an event that can be shared between source portlets
and their targets. The event includes information that the target portlets
can respond to.
Target Specifies the target of the event. The target can be a page, a portlet on the
same page, or a portlet on another page. Click the Browse icon to select
from a list of available targets.
Transformation
Optional field that specifies how an event should be handled before it is
delivered to the target. A transformation can change event parameter
names, parameter values, or event types to enable the target to process the
event.
Use the Browse icon to select from a list of available transforms. The
description should provide sufficient information to help select a
transformation.
Enable
If checked, the wire is enabled and delivers the event when it is launched.
This is the only option you can change for system wires.
Delete Removes the wire.
Working with views
Views are a defined set of tasks that are displayed in the navigation pane. Views
also can include one or more pages that are launched when the view is selected.
For example, if you find a set of tasks related to obtaining sales and cost reports
from retail stores throughout a region, you could create a view called “Reports”
that includes all of the pages associated with those tasks in the navigation. Each
page, along with the folders that include them, would be added to the view. You
could then set some of the most important pages to launch when the view is
selected. In this way, views can make your experience with the portal more
productive than sorting through all of the navigation tasks that are displayed by
default.
If you have sufficient access, you can create your own custom views. You can only
edit system views.
To access Views in the portal, click Settings > Views in the navigation.
Field descriptions
This section describes the fields and controls in the main panel of Views.
Select all icon
Selects all items displayed in the table for deletion. If you are displaying
only a filtered set of items, only those items are selected. You can deselect
specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
New
Opens a panel for creating a new view.
Chapter 4. Administrative settings
43
Delete Immediately deletes all selected items in the list. Only Custom resource
types can be deleted.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
View Name
Displays the name of the view as it is shown in the View selection list in
the banner. Click the name to edit the view.
Type
Displays the type of view. The actions you can perform on a view depend
upon its type.
Role Count
Displays the number of roles that have access to this view..
Page Count
Displays the number of pages that are available in the portal when the
view is selected.
Creating views
Views determine what pages are listed in the navigation pane as well as which
pages are launched when the view is selected. All views that are created in the
portal have a resource type of Custom. This procedure walks you through the task
of creating a view for testing purposes. After completing these steps, you can
remove or edit this view for production use.
Before you begin
You should understand the portal layout before starting this task.
Procedure
1. Click Settings > Views in the navigation pane. The Views page is displayed
with the list of system and custom views in the portal.
2. Click New. The properties panel for the new view is displayed.
3. Enter a descriptive name for the view. This name is displayed in the View
selection list in the banner.
4. Expand the Roles with Access to This View section and click Add. The Add
Roles panel is displayed with a list of available roles. For this task, add a role
that can be used to test the view before adding access for other roles.
Attention: Granting access to the view does not grant access to the pages
within the view.
5. Select your role in the table. You can use the filter to quickly find your role if
the list of roles is very large.
6. Click Add after making your selection. You are returned to the view
properties. The next step is to determine the pages that make up the view.
7. Expand the Pages in This View section and click Add. The Add Pages panel
is displayed with a list of available pages.
8. Select several folders or pages in the list. Selecting a folder also selects all of
the pages contained in that folder. You can individually deselect pages in a
folder if necessary.
9. Click Add after making your selections. You are returned to the view
properties.
44
Tivoli Integrated Portal Online help
10. Select the Launch option for two or three of the pages and select one of the
launch pages as the default.
11. Click Save to save the new view and return to the Views page.
Results
Select the new view from the View drop down list located above the navigation
pane. Verify that all pages and folder that you selected are displayed in the
navigation, that the pages selected to launch are available is the page bar, and that
the default selection has focus in the work area.
Editing views
Views provide a limited set of nodes in the navigation pane and optional set of
startup pages to help users focus on their tasks. If you have sufficient
authorization in the portal, you can change the view name, navigation content, and
access permissions for system and custom views. You can delete only custom
views. Changes you make to a system view are saved as System Customized.
About this task
Procedure
1. In the navigation pane, click Settings > Views. The Views page is displayed
with the list of system and custom views in the portal.
2. Click the view name in the list displayed in Views. This displays the view's
properties.
3. Optional: Expand Roles with Access to This View to update the list of roles
with permissions to the view and their access level. A list of all roles with
access to the view is displayed.
Option
Description
To remove access for a role
Select a role and click Remove. The role is
removed immediately from the access list
without a warning prompt.
To add access for a role
Click Add. Select one or more of the roles
displayed and click OK. The roles you
added are included to the list.
To change the access level for a role
Select one of the options under Access Level
for the role.
Note: Granting access to the view does not grant access to the pages within the
view.
4. Optional: Expand Pages in This View to change which pages are displayed in
the navigation when the view is selected.
Option
Description
Add a page to the view
Click Add to add a page to the view.
Remove a page from the view
Select the page in the Select column and
click Remove. You can select multiple pages
to remove.
Chapter 4. Administrative settings
45
Option
Description
Change the launch options for a page
Select Launch for each page that should be
opened when the view is selected. Only one
page can be in focus (current) when the
view is selected. When multiple pages are
set to launch, set the current page in the
Default column.
5. Click Save to save your changes and return to the main view panel.
Results
For customized versions of a system view, you can retrieve the system view
settings by editing the system customized view and clicking Restore. The “system
customized” version of the view is removed and replace by the original system
view.
Deleting custom views
You can delete only views with the resource type of Custom. These are views
created using the portal.
About this task
Customized versions of system views can be restored. Restoring a System
Customized view deletes the custom copy and replaces it with the original system
view.
Attention: Before deleting a view, consider whether any users are actively using
the view and any impacts this might have on services. If necessary, notify users in
advance of any plans for changes that could affect their work.
Follow these steps to delete a custom view.
Procedure
1. Click Settings > Views in the navigation pane. The Views page is displayed
with the list of system and custom views in the portal.
2. Select the custom view that you want to delete. You can select more than one
custom view.
3. Click Delete. A message is displayed at the top prompting you to confirm the
deletion.
4. Click OK.
Results
The custom view is removed from the view list.
View properties
This panel is used to edit the general properties of a view.
This properties panel is displayed when you click a view in Views to edit it. This
panel is also displayed when you create a new view.
Note: If you are creating a new view, add your own role to the view access list so
that you can select the view.
46
Tivoli Integrated Portal Online help
The following fields are available.
View name
Enter the name you want to display for the view, which is displayed in the
View selection list. This field is disabled if string translation is enabled.
Click String Translation to change the support for translation of the name.
The view name must be unique within the portal.
Hide any open pages in the work area that are not part of this view
Selecting this option forces open pages that are not part of the view from
being displayed in the page bar when the view is selected. The pages are
available again when the user returns to the previous view in which the
page was originally opened.
Type of view
Displays either Custom, System, or System Customized. This field cannot be
changed.
View unique name
Displays the identifer used by the portal to uniquely identify this view
from other views. This field cannot be changed.
Roles with Access to This View
This section provides a table displaying roles that have been assigned to
access this view and their level of access. Access control to a view can also
be assigned using Roles. The following options are unique for the roles
table.
Role Name
Displays the name of a role that has been given access to the view.
Access Level
Displays the level of access that the role has to the view. For views,
all access levels are equivalent, giving the role access to launch, but
not edit, the view.
Pages in This View
This section provides a table displaying pages, folders, and external URLs
that are displayed in the navigation when this view is selected. The
following options are unique for the pages table.
Set all pages in this view to launch
Selects the launch option for all pages in the table.
Page Name
Displays the name of the page or node as it appears in the
navigation.
Unique Name
Displays the identifier that uniquely identified the page in the
portal.
Launch
When selected, launches the page in the work area when the view
is selected.
Default
Defines the page that is launched in focus when multiple pages are
set to launch when the view is selected.
The following fields and controls are available in both the roles and pages tables:
Chapter 4. Administrative settings
47
Select all icon
Selects all items displayed in the table for deletion. If you are displaying
only a filtered set of items, only those items are selected. You can deselect
specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
Add
Adds an item to the table.
Remove
Removes all selected items from the table. There is no warning prompt
when you click Remove.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Working with catalogs
Catalogs are used to logically group portlets in the portlet palette. Access to portlet
catalogs, and therefore any portlets contained within, is controlled by roles.
If you have sufficient access, you can create and edit your own custom portlet
catalogs.
To access Catalogs in the portal, click Settings > Catalogs in the navigation pane.
Field descriptions
This section describes the fields and controls in the main panel of Catalogs.
New icon
Opens a panel for creating a new catalog.
Edit icon
Opens a panel for editing a selected catalog.
Delete icon
Deletes the selected catalog from the list.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Name Displays the name of the catalog. Click the name to edit the catalog.
Type
Displays the type of catalog. The actions you can perform on for a catalog
depend upon its type.
Contains
Displays the number of portlets that the catalog contains.
Description
Displays a description of the catalog.
Creating catalogs
Catalogs determine how portlets are organized in the portlet palette when a new
freeform page is being created. All catalogs that are created in the portal have a
resource type of Custom.
48
Tivoli Integrated Portal Online help
Before you begin
You should understand the portal layout before starting this task.
Important: Manager access to the Catalog portlet is required in order to be able to
create and edit catalogs.
Procedure
1. Click Settings > Catalogs in the navigation pane. The Catalogs page is
displayed listing any catalogs that exist in the portal.
2. Click the New icon. The Create Catalog panel is displayed.
3. Enter a name and a description for the catalog.
4. In the Access Controls area, to associate one or more roles with the catalog,
select roles in the Available Roles list and click Add to move them to the
Roles which can see the catalog list.
5. In the Portlets area, to add one or more portlets to the catalog, select portlets in
the Available Portlets list and click Add to move them to the Selected Portlets
list.
6. Click OK to save the new catalog and return to the Catalogs page.
Results
The new catalog is listed in theCatalogs page and those portlets that you added to
the catalog are made available in portlet palette contained within the new catalog.
Editing catalogs
If you have sufficient authorization in the portal, you can change the edit details
for existing portlet catalogs.
About this task
Important: Manager access to the Catalog portlet is required in order to be able to
create and edit catalogs.
Procedure
1. In the navigation pane, click Settings > Catalogs. The Catalogs page is
displayed with a list of a available catalogs in the portal.
2. Click a catalog's name in the list to display its properties panel.
3. Optional: Update the portlet catalog's name and description.
4. Optional: In the Access Controls area, to associate one or more roles with the
catalog, select roles in the Available Roles list and click Add to move them to
the Roles which can see the catalog list.
5. Optional: To disassociate one or more roles with the catalog, select the roles in
the Roles which can see the catalog list and click Remove.
6. Optional: In the Portlets area, to add one or more portlets to the catalog, select
portlets in the Available Portlets list and click Add to move them to the
Selected Portlets list.
7. Optional: To remove one or more portlets from the catalog, select portlets in the
Selected Portlets list and click Remove.
8. Click OK to save the updates to the portlet catalog and return to the Catalogs
page.
Chapter 4. Administrative settings
49
Results
The updated catalog is listed in the Catalogs page. Any updates that you made to
the catalog name, description, and contents are also reflected in the portlet palette.
Deleting catalogs
If you have sufficient authorization in the portal, you can delete existing portlet
catalogs. Deleting a catalog does not delete the portlets contained in that catalog.
About this task
Important: Manager access to the Catalog portlet is required in order to be able to
delete catalogs.
If you delete a catalog and a portlet from that catalog is not associated with any
other catalog, it becomes uncategorized and is listed in the portlet palette at the
same level as any other catalogs that may exist in the portal.
Follow these steps to delete a portlet catalog.
Procedure
1. In the navigation pane, click Settings > Catalogs. The Catalogs page is
displayed with a list of a available catalogs in the portal.
2. Select the radio button for the catalog that you want to delete. and click the
Delete icon.
3. In the message area at the top of the page, click OK to confirm that you want
to delete the selected catalog.
Results
The selected catalog is removed from the catalog list and is no longer available in
the portlet palette.
Working with roles
Portal users are granted access to resources based on the role to which they have
been assigned. In the navigation pane, click Users and Groups > Roles to add and
remove roles and to assign access to portlets, pages, and views.
After the portal is installed, there are some roles already defined to the server.
Access levels
The access level that a role has to a resource determines the actions that users
within that role can perform on the resource.
Table 8. Access rights to portal resources based on access level
Access Level
Resource
50
Tivoli Integrated Portal Online help
“User”
“Privileged
User”
“Editor”
“Manager”
Table 8. Access rights to portal resources based on access level (continued)
Access Level
Portlet
View and
interact with the
portlet and
access portlet
help.
View and
interact with the
portlet, edit
personal
settings, and
access portlet
help.
View and
interact with the
portlet, edit
personal
settings, edit
global settings,
and access
portlet help.
View and
interact with the
portlet, edit
personal
settings, edit
global settings,
and access
portlet help.
Create and edit
customized
portlets in the
portlet wizard
Page
Launch the node from the
navigation.
Launch the node from the
navigation and edit the content and
layout.
Folder
Note: Folders are always available in the navigation if the user has
access to at least one of its pages.
External URL
Launch the node from the navigation.
View
Select the view.
For a given resource, if a role does not have one of these access level settings, then
the role has no access to the resource.
Only users with “adminsecuritymanager” and “Administrator” role can create,
delete or change the properties of a role. If you assign access for any other role to
the Roles portlet, users in that role will only be able to view roles and change
access to views and pages.
Note: The access control settings are not observed when using the administrative
portlets under the Settings node. Users with access to these pages and portlets will
be able to create, edit, and delete all custom pages, portlets, and views. For
example, if a user has no access to “Page Two”, but has access to Pages, that user
can edit all of the properties of “Page Two” and change access control settings.
Keep this in mind when granting access to the Settings portlets for a role.
If a user is assigned to multiple roles, the user acquires the highest access level
between these roles for a resource. For example, if a user belongs to the manager
role with “Privileged User” access to a portlet and also belongs to the
communications role with no access to the portlet, then the user has “Privileged
User” access to the portlet.
Tasks
You can grant access for multiple roles while creating or editing a resource, such as
a page or a portlet. You can also grant access to multiple pages or views while
creating or editing a role.
Creating roles
Portal users are granted access to resources based on the role to which they have
been assigned. All roles that are created in the portal have a resource type of
Chapter 4. Administrative settings
51
Custom. This procedure describes creating a role for testing purposes. After
completing these steps, you can remove or edit this role for production use.
Procedure
1. Click Users and Groups > Roles in the navigation. A list of all roles in the
portal is displayed.
2. Click New. The properties panel for the new role is displayed.
3. Enter a descriptive name for the role.
4. Optional: Expand the Users and Groups section. Use this section to associate a
role with one or more users and groups. The method to add users and groups
is similar, so this topic describes adding users only. To associate a user with a
role, follow these steps:
a. In the Users panel, click Add. A new page is displayed that allows you to
search for and select users to be added to the role.
b. Provide search filters in the relevant fields, select the maximum number of
results that you want returned and click Search to return a list of users that
match your criteria.
Tip: If you leave the search filter fields blank, the system returns all users
(up to a limit of 1000).
c. From the returned results, select the users that you want to associate with
the role and click Add. The previous page is displayed listing the selected
users in the Users panel.
5. Expand the Access to Views section. Use this section to grant access to one or
more custom views for users who are assigned to the new role. If you have
already created a custom view, follow these steps.
a. Click Add. A list of available views is displayed.
b. Select one or more views and click OK.
c. To make sure the role has access to all of the pages within the view, click
Grant to All.
6. Expand the Access to Pages section. A list of pages that the role can access is
displayed. However, this list is empty if you did not add a view and grant
access to all of the pages within the view.
7. Optional: Click Add to grant access to additional pages.
8. For each page that is listed, verify that the Access Level is set correctly.
9. Click Save to save your changes and return to Roles.
Results
The new role is created with access to the views, users and groups, and pages that
you indicated. To grant access to the portlets on those pages you must edit the
portlets.
Editing roles
Portal users are granted access to resources based on the role to which they have
been assigned. If you have sufficient authorization in the portal, you can change
the name of custom roles. For all roles, you can change access to views and pages
and set the access level to pages.
52
Tivoli Integrated Portal Online help
About this task
Procedure
1. In the navigation pane, click Users and Groups > Roles. A list of all roles in
the portal is displayed.
2. Click the name of the role that you want to edit. The properties panel for the
role is displayed. If this is a custom role, the only field you can edit is Role
Name. For all other resource types, you cannot edit any of the role properties.
3. Optional: Expand the Users and Groups section. Use this section to associate a
role with one or more users and groups. The method to add users and groups
is similar, so this topic describes adding users only. To associate a user with a
role, follow these steps:
a. In the Users panel, click Add. A new page is displayed that allows you to
search for and select users to be added to the role.
b. Provide search filters in the relevant fields, select the maximum number of
results that you want returned and click Search to return a list of users that
match your criteria.
Tip: If you leave the search filter fields blank, the system returns all users
(up to a limit of 1000).
c. From the returned results, select the users that you want to associate with
the role and click Add. The previous page is displayed listing the selected
users in the Users panel.
4. Expand the Access to Views section. Use this section to grant access to one or
more custom views for users who are assigned to the new role. If you have
already created a custom view, follow these steps.
a. Click Add. A list of available views is displayed.
b. Select one or more views and click OK.
c. To make sure the role has access to all of the pages within the view, click
Grant to All.
5. Expand the Access to Pages section. A list of pages that the role can access is
displayed. However, this list is empty if you did not add a view and grant
access to all of the pages within the view.
6. Optional: Click Add to grant access to additional pages.
7. For each page that is listed, verify that the Access Level is set correctly.
8. Click OK.
Results
Your changes are saved and you are returned to the Roles page.
What to do next
For any pages that you added for the role, you should ensure that the role also has
access to the portlets on the page..
Deleting custom roles
You can delete only roles with the resource type of Custom. These are roles created
using the portal.
Chapter 4. Administrative settings
53
About this task
Attention: Before deleting a role, consider whether any users are actively using
the role and any impacts this might have on services. If necessary, notify users in
advance of any plans for changes that could affect their work.
Follow these steps to delete a custom role.
Procedure
1. Click Users and Groups > Roles in the navigation pane. The Roles page is
displayed with the list of roles in the portal.
2. Select the custom role that you want to delete. You can select more than one
custom role.
3. Click Delete. A message is displayed at the top prompting you to confirm the
deletion.
4. Click OK.
Results
The custom role is removed from the list.
Managing roles for users
Administrators can search for users and manage their roles in the User Roles page.
About this task
To search for users and manage their roles:
Procedure
1. In the navigation pane, click Users and Groups > User Roles. The User Roles
page is displayed.
2. In the search fields provided, you can enter search criteria by given name,
surname, user ID, and e-mail address. If you do not have exact details for a
particular item, all of the search fields support using an asterisk (*) as a
wildcard character. For example, to return all user records with a given name
that starts with “Mich”, enter mich* in the First name field.
Tip: You can leave the search fields blank to return all user records.
Tip: To return only users that are currently logged in, leave the search fields
blank and select the Active Users Only check box.
3. From the Number of results to display list, select the number of records that
you want returned and click Search.
Restriction: Returned records are displayed one page only. If more records are
available than the setting you chose from the list, only a partial list is returned.
To display all records you need to search again after selecting a larger number
from the Number of results to display list.
A list of records that match your search criteria are listed in the grid.
4. Select a user from the User ID column. A list of available roles for the selected
user is displayed on a new page. Those roles that are currently associated with
the selected user are checked.
54
Tivoli Integrated Portal Online help
5. Modify the roles associated with the user as required, that is, check the roles
that you want associated with the user and clear those that you do not.
6. Click Save to commit your changes, or Reset to reset the form to its initial
state. Once you click Save, the User Roles page is displayed. The entry for the
user in the Roles column is updated to reflect your changes.
What to do next
You can select another user from the search results and update their role settings,
enter new search criteria to manage other user records, or close the User Roles
page.
Managing roles for groups
Administrators can search for groups and manage their roles in the Group Roles
page.
About this task
To search for user groups and manage their roles:
Procedure
1. In the navigation pane, click Users and Groups > Group Roles. The Group
Roles page is displayed.
2. In the search fields provided, you can enter search criteria by group ID and
description. If you do not have exact details for a particular item, both search
fields support using an asterisk (*) as a wildcard character. For example, to
return all group records with a group ID that starts with “tes”, enter tes* in
the Group ID field.
Tip: You can leave the search fields blank to return all records.
3. From the Number of results to display list, select the number of records that
you want returned and click Search.
Restriction: Returned records are displayed one page only. If more records are
available than the setting you chose from the list, only a partial list is returned.
To display all records you need to search again after selecting a larger number
from the Number of results to display list.
A list of records that match your search criteria are listed in the grid.
4. Select a group from the Group Name column. A list of available roles for the
selected group is displayed on a new page. Those roles that are currently
associated with the selected group are checked.
5. Modify the roles associated with the group as required, that is, check the roles
that you want associated with the group and clear those that you do not.
6. Click Save to commit your changes, or Reset to reset the form to its initial
state. Once you click Save, the Group Roles page is displayed. The entry for
the group in the Roles column is updated to reflect your changes.
What to do next
You can select another group from the search results and update its role settings,
enter new search criteria to manage other group records, or close the Group Roles
page.
Chapter 4. Administrative settings
55
Role properties
This panel is used to edit the general properties of a role. The properties panel is
displayed when you click one of the roles to edit it. This panel is also displayed
when you create a new role.
To access this panel, click Users and Groups > Roles in the navigation pane. Then
click the name of one of the roles that are listed, or click New to create a new role.
Role name
Enter a descriptive name for the role. This name should be informative
enough to indicate the actions and resources that are available to the users
in this role. The role name must be unique within the portal. The
characters in a role name are restricted to letters, digits, blank spaces, and
underscores. The role name cannot start with a digit.
Type of role
Displays either Custom, System, or Core. This field cannot be changed.
Users and Groups
This section shows two table displaying the users and groups that have
been assigned to this role. The following options are unique for these
tables.
Users
This table lists the users with access to the role. The following
column headings are unique to this table:
User ID
Displays the unique system ID associated with the user.
First Name
Displays the first name associated with the user ID.
Last Name
Displays the last name associated with the user ID.
Groups
This table lists the user groups with access to the role. The
following column headings are unique to this table:
Group Name
Displays the name associated with this group.
Unique Name
Displays the unique system ID associated with the group.
Access to Views
This section provides a table displaying views that have been assigned to
this role. The following options are unique for the views table.
View Name
Indicates the name of the view. You can sort the list of names by
clicking the column heading.
Access Level
Indicates the level of access for role members in relation to the
view.
Access to Child Resources
Grants access to all pages that are part of this view. After clicking
this option, the Access to Pages table is updated with the new
pages. If necessary, you can individually select pages from that
table to remove access.
56
Tivoli Integrated Portal Online help
Access to Pages
This section provides a table displaying pages that have been assigned to
this role. The following options are unique for the pages table.
Name Displays the name of the page or node as it appears in the
navigation.
Unique Name
Displays the identifier that uniquely identified the page in the
portal.
The following fields and controls are available in all sections.
Select all icon
Selects all items displayed in the table for deletion. If you are displaying
only a filtered set of items, only those items are selected. You can deselect
specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
Add
Adds an item to the table.
Remove
Removes all selected items from the table. There is no warning prompt
when you click Remove.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Access Level
Indicates the actions that users in the role can perform on the view or
page.
Working with portlets
Portlets are web applications that display information or provide a service in a
portal page. You can only work with portlets that have been deployed to the
portal. Use Portlets to create, edit, and delete a portlet from a page.
To access Portlets in the portal, click Settings > Portlets in the navigation pane.
The main panel displays a list of all of the portlets in the portal.
In relation to the portlet palette that is displayed when creating freeform page,
portlets can be associated with one or more portlet catalogs. Portlets that are not
organized into catalogs, are said to be uncategorized, but depending on your
authorization, may still be listed in the portlet palette.
Field descriptions
This section describes the fields and controls in the main panel of the Portlets
management page.
New icon
Launches the Create Portlet Wizard that allows you to create a customized
copy of an existing portlet.
Edit
Launches the Edit Portlet Wizard that allows you to edit settings for a
non-core portlet.
Chapter 4. Administrative settings
57
Delete Deletes a selected custom portlet.
Restore icon
Reloads the portlets list.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Name Displays the title of the portlet as it is shown on the page. To edit details
for a portlet, click its name entry in the table to launch the Edit Portlet
Wizard.
Type
Indicates whether a portlet is a core, system, or custom portlet.
Catalog
Displays the catalog that contains the portlet.
Description
Provides a description of a portlet and its intended function.
Custom portlets
You can create and edit custom portlets in the Portlet Wizard.
Creating portlets
You can configure settings using an existing portlet to create a custom portlet. You
can create many different custom portlets and configure them in the Create Portlet
Wizard, each portlet with a different name and configuration settings. The portlet
must already be installed in the portal for you to create a custom version of it.
About this task
Follow these steps to create and configure a custom portlet:
Important: Manager access to the Portlets portlet is required in order to be able to
create and edit portlets in the Portlet Wizard.
Procedure
1. In the navigation pane, click Settings > Portlets. A list of all of the portlets is
displayed in a scrollable table.
2. In the task bar, click the New icon to start the Create Portlet Wizard. The
Welcome page is displayed.
3. Click Next to display the Select Base Portlet page. In this page, you can
directly select an portlet on which to base your custom portlet or filter the
number of portlets displayed by searching for portlets with a particular name.
4. Optional: To search for a portlet, enter a text string in the search field and
click Search. To clear a search and again list all portlets, clear the search field
and click Search.
5. Select a base portlet from list of portlets and click Next. The General portlet
information page is displayed.
6. Required: Enter a new, descriptive name, which in most circumstances,
becomes the portlet's display name.
7. Enter a description for the portlet, indicating its function.
8. Select a thumbnail icon that you want associated with the portlet. The selected
thumbnail icon is used in the portlet palette when a user is creating a freeform
page in the self-service dashboard.
58
Tivoli Integrated Portal Online help
9. Select a description image that you want associated with the portlet. The
selected image is displayed when a user points to a thumbnail icon in the
portlet palette when they are creating a freeform page in the self-service
dashboard.
10. Optional: In the Component direction and Text direction fields, accept the
default whereby portal components and text are displayed according to your
browser settings. Alternatively, you can choose to impose either left-to-right or
right-to-left display settings.
11. Optional: To associate the portlet with one or more portlet catalogs, select
catalogs in the Available Catalogs list and move them to the Selected
Catalogs list. Catalogs are used to logically group portlets when they are
displayed in the portlet palette of the self-service dashboard.
12. Click Next to display the portlet Security page is displayed. In the Security
page, you can provide some or all portal roles with varying levels of access to
the portlet. The following access levels are available:
User
Roles with User access, have view access to the configured portlet,
when it is subsequently added to a page.
Privileged User
Roles with privileged user access, have view access and such users
can personalize their own experience of a portlet through the Edit
options icon in the portlet taskbar. Personalizing a portlet does not
affect the experience of other users of the portlet.
Editor
Roles with Editor access can subsequently edit shared settings for a
portlet through the Edit options icon in the taskbar. When an editor
modifies shared settings, it affects other portlet user settings for that
portlet.
Also, roles with Editor access can subsequently edit the portlet's
general settings in the Portlet Wizard. Editor access (unlike manager
access) does not provide access to portlet-specific customization pages
or to the security settings page in the Portlet Wizard.
Manager
Roles with Manager access can subsequently modify any aspect of the
portlet in the Edit Portlet Wizard.
Note: As the creator of the custom portlet you are given Manager
access by default.
13. Optional: To associate a role with a particular access level for the portlet:
a. Select the role in the Available Roles panel.
b. In the right hand panel, click the access level that you want the role to be
associated with and click Add to move the selected role to that access
level's panel.
For example, to provide the chartAdministrator role with Editor access,
select chartAdministrator in the left panel and then click the Editor bar in
the right hand panel to display its content panel. Click Add to move the
chartAdministrator role to the Editor content panel.
14. Click Next to display portlet specific customization pages.
Chapter 4. Administrative settings
59
What to do next
Customize your portlet further in the portlet specific wizard pages. Portlet specific
settings vary for each portlet type and you can use the portlet level help (available
through Help (?) in the wizard page taskbar) to assist you. Once you have
customized the portlet, and click Next, a Summary page is displayed where you
can review your settings.
Note: Some portlets do not have customization pages associated with them. In
those cases, when you click Next in the portlet Security page, the Summary page is
displayed.
Editing portlets
Portlets provide content on a portal page, for example, viewing system information
or submitting reports. If you have sufficient authorization, you can change access
permissions to a portlet. You can also change the display name of the portlet and
its configuration settings.
About this task
Note: You cannot edit portlets of the portlet type core.
Important: Manager access to the Portlets portlet is required in order to be able to
create and edit portlets in the Portlet Wizard.
To edit details for a custom portlet:
Procedure
1. Click Settings > Portlets in the navigation pane. A list of all of the portlets is
displayed in a scrollable table.
2. You can select the portlet that you want to edit in two ways:
v Click the name of the portlet that you want to edit to start the Edit Portlet
Wizard.
v Select the radio button associated with the portlet that you want to edit and
click the Edit icon to start the Edit Portlet Wizard.
3.
4.
5.
6.
7.
8.
60
The Welcome page is displayed.
Click Next to display the General portlet information page.
Optional: Edit the portlet's name and description.
Optional: Select a thumbnail icon that you want associated with the portlet. The
selected thumbnail icon is used in the portlet palette when a user is creating a
freeform page in the self-service dashboard.
Optional: Select a description image that you want associated with the portlet.
The selected image is displayed when a user points to a thumbnail icon in the
portlet palette when they are creating a freeform page in the self-service
dashboard.
Optional: To associate the portlet with one or more portlet catalogs, select
catalogs in the Available Catalogs list and move them to the Selected Catalogs
list. Catalogs are used to logically group portlets when they are displayed in
the portlet palette of the self-service dashboard.
Click Next to display the portlet Security page is displayed. In the Security
page, you can provide some or all portal roles with varying levels of access to
the portlet. The following access levels are available:
Tivoli Integrated Portal Online help
User
Roles with User access, have view access to the configured portlet,
when it is subsequently added to a page.
Privileged User
Roles with privileged user access, have view access and such users can
personalize their own experience of a portlet through the Edit options
icon in the portlet taskbar. Personalizing a portlet does not affect the
experience of other users of the portlet.
Editor
Roles with Editor access can subsequently edit shared settings for a
portlet through the Edit options icon in the taskbar. When an editor
modifies shared settings, it affects other portlet user settings for that
portlet.
Also, roles with Editor access can subsequently edit the portlet's
general settings in the Portlet Wizard. Editor access (unlike manager
access) does not provide access to portlet-specific customization pages
or to the security settings page in the Portlet Wizard.
Manager
Roles with Manager access can subsequently modify any aspect of the
portlet in the Edit Portlet Wizard.
Note: As the creator of the custom portlet you are given Manager
access by default.
9. Optional: To associate a role with a particular access level for the portlet:
a. Select the role in the Available Roles panel.
b. In the right hand panel, click the access level that you want the role to be
associated with and click Add to move the selected role to that access
level's panel.
For example, to provide the chartAdministrator role with Editor access, select
chartAdministrator in the left panel and then click the Editor bar in the
right hand panel to display its content panel. Click Add to move the
chartAdministrator role to the Editor content panel.
What to do next
Customize your portlet further in the portlet specific wizard pages. Portlet specific
settings vary for each portlet type and you can use the portlet level help (available
through Help (?) in the wizard page taskbar) to assist you. Once you have
customized the portlet, and click Next, a Summary page is displayed where you
can review your settings.
Note: Some portlets do not have customization pages associated with them. In
those cases, when you click Next in the portlet Security page, the Summary page is
displayed.
Editing portlet shared settings
Some portlets include an Edit Shared Settings mode that allows users with “Editor”
access level to configure common settings for other users of the portlet. Once
shared settings are configured, users with “Privileged User” level of access can
change these values for their own personal use of the portlet. Default settings
cannot be changed by users with “User” level of access. Follow these steps to set
the shared settings for a portlet.
Chapter 4. Administrative settings
61
Before you begin
You must have “Editor” access to the portlet to perform this task.
Procedure
1. Navigate to the page where the portlet is located.
2. Click Edit options in the portlet title bar. Two options are displayed:
Personalize and Edit Shared Settings.
Attention: If Edit Shared Settings option is not available, then either the
portlet does not support Edit Shared Settings mode, or you do not have “Editor”
access for the portlet.
3. Select Edit Shared Settings. The portlet displays shared settings that can be
changed.
4. Make any changes to the settings and submit them when you are finished. The
portlet might provide a Save, OK, or Submit button. Once you have submitted
your changes, you should be returned to the main panel for the portlet. If not,
click Back in the title bar.
Results
The shared settings for using this portlet are saved. If the portlet is located on
more than one page, the updated settings will be observed on the other pages as
well.
What to do next
The updated settings configuration only affect settings that have not been
personalized by users. To verify that the a user's preferences have been preserved,
log in with a test user name and verify that the shared settings are set as intended.
Deleting portlets
You can only delete a custom portlet that was created in the Portlet Wizard. To
remove the original portlet that was used as a base template for a custom portlet,
the portal administrator must undeploy the portal module application to which the
portlet belongs.
About this task
Important: Manager access to the Portlets portlet is required in order to be able to
delete custom portlets.
Procedure
1. Click Settings > Portlets in the navigation pane. A list of all of the portlets is
displayed in a scrollable table.
2. Browse through the list or use the Filter field to locate the portlet you want to
remove. To use the filter field, start typing the portlet name. The list is reduced
to portlets whose names match the characters you entered.
3. Select the radio button associated with the portlet that you want to delete.
4. Click the Delete icon.
5. In the Messages area at the top of the page, click OK to confirm that you want
to delete this portlet.
62
Tivoli Integrated Portal Online help
Configuring a web portlet in the Portlet Wizard
You can configure a web portlet and subsequently customize its settings in the
portlet-specific configuration pages of the Portlet Wizard.
About this task
Once you configure access levels for the web portlet in the Portlet Wizard, a portlet
specific configuration page is displayed:
Procedure
1. Required: In the Widget title field provide a brief descriptive name. When
selecting a title, consider the purpose of the web portlet, its home page, and
that the title is used in the navigation pane to access the portlet.
2. Required: In the Home page field provide a valid web address. This the web
address of the page that displays by default when a user accesses the portlet
from the navigation pane.
3. Optional: In the Help page field, provide a relative or absolute URL to a
custom help page HTML topic to replace the default help topic that ships with
the web portlet.
4. Required: In the HTML iFrame name field, provide a unique HTML iFrame
name. The entry in this field serves to uniquely identify the web widget to
allow its content to be dynamically updated.
Attention: It is important to provide a unique iFrame name. If you do not,
web portlets sharing iFrame names may not display correctly until you
configure its HTML iFrame name value.
5. Optional: Check the Show a browser control toolbar to provide users with a
web navigation toolbar, that is, standard web navigation buttons and a web
address entry field.
6. Optional: To allow users to personalize their portlet settings , check the relevant
check box. By default, the following check boxes are cleared:
v Widget title
v Home page
v Help page
v Browser control bar
7. Click Save to commit your changes, or Restore Default Settings to reset the
form.
8. Click Next to display a Summary page is displayed where you can review your
settings.
9. Click Finish to complete the wizard steps. The configured portlet is available to
be included on portal pages.
Editing shared settings for a web portlet:
Administrators can set shared settings to provide a common experience for users
of a web portlet.
About this task
If you have not configured any shared settings for a web portlet, users can by
default enter a complete web address in the field provided and browse web pages.
To edit shared settings:
Chapter 4. Administrative settings
63
Procedure
1. In the title bar of the web portlet, click the Edit options icon and select Edit
Shared Settings.
2. Required: In the Widget title field provide a brief descriptive name. When
selecting a title, consider the purpose of the web portlet, its home page, and
that the title is used in the navigation pane to access the portlet.
3. Required: In the Home page field provide a valid web address. This the web
address of the page that displays by default when a user accesses the portlet
from the navigation pane.
4. Optional: In the Help page field, provide a relative or absolute URL to a
custom help page HTML topic to replace the default help topic that is
associated with the web portlet.
5. Required: In the HTML iFrame name field, provide a unique HTML iFrame
name. The entry in this field serves to uniquely identify the web widget to
allow its content to be dynamically updated.
Attention: It is important to provide a unique iFrame name. If you do not,
web portlets sharing iFrame names may not display correctly until you
configure its HTML iFrame name value.
6. Optional: Check the Show a browser control toolbar to provide users with a
web navigation toolbar, that is, standard web navigation buttons and a web
address entry field.
7. Optional: To allow users to personalize their portlet settings , check the relevant
check box. By default, the following check boxes are cleared:
v Widget title
v Home page
v Help page
v Browser control bar
8. Click Save to commit your changes, or Restore Default Settings to reset the
form.
Configuring an image portlet in the Portlet Wizard
You can configure an image portlet and subsequently customize its settings in the
portlet-specific configuration pages of the Portlet Wizard.
About this task
Once you configure access levels for the image portlet in the Portlet Wizard, a
portlet specific configuration page is displayed:
Procedure
1. In the Title field provide a brief descriptive name. When selecting a title,
consider the purpose of the image portlet.
2. Required: In the Image URL field provide a valid URL for the image to be
displayed. This the Web address of the image that displays when a user
accesses the page that contains the image portlet.
3. Optional: In the Image Scale area, you choose to have set the image to scale to
the size of its containing portlet or to set the image to display at its actual size.
If you select the Do not scale option, you can further apply image alignments
settings and decide whether or not you want the image to be repeated in the
portlet window.
4. Click Save to commit your changes.
64
Tivoli Integrated Portal Online help
5. Click Finish to complete the wizard steps. The configured portlet is available to
be included on portal pages.
Editing shared settings for an image portlet:
Administrators can configure shared settings for an image portlet to display an
image in a number of ways. For example, image portlets can be used on free form
pages to provide a background image whereby it can be maximized and set to
display behind other portlets on a page.
About this task
To set an image to be displayed in the portlet and to further configure its display
settings, complete the following steps:
Procedure
1. In the title bar, click the Edit options icon and select Edit shared settings.
A settings page is displayed, where you can configure the image portlet's title,
URL, and display options.
2. Required: In the Title field provide a brief descriptive name. When selecting a
title, consider the purpose of the image portlet.
3. Required: In the Image URL field provide a valid URL for the image to be
displayed. This the Web address of the image that displays when a user
accesses the page that contains the image portlet.
4. Optional: In the Image Scale area, you choose to have set the image to scale to
the size of its containing portlet or to set the image to display at its actual size.
If you select the Do not scale option, you can further apply image alignments
settings and decide whether or not you want the image to be repeated in the
portlet window.
5. Click Save to commit your changes and the configured image portlet is
displayed.
Portlet events and wires
You can create connections, or wires, between portlets so that they can exchange
messages with each other. When an action occurs in a source portlet, it creates an
event, which contains information that can be sent to other portlets.
Before you begin
Before working with wires on a page, you must first open the page for editing.
Not all portlets support wires and events. Portlets must use specific code to
process events that are sent or received through a wire. Each portlet is designed to
process certain events. You should have thorough knowledge of the portlets and
the events that they support before creating or editing wires. To determine if a
portlet supports an event, click the Events icon to view a list of all events that the
portlets subscribes to or publishes.
Some target portlets are capable of processing events after they have been
transformed to match certain criteria. For example, an event that sends the cost of
a transaction in one currency might need to be transformed to a different currency
before the target portlet can receive it. When you create a wire, you have the
option of selecting a transformation for the event, if the target portlet requires it.
The portal provides the Simple String Transformation to transform from one event
Chapter 4. Administrative settings
65
to another. Other transformations might be available from other applications in the
portal.
About this task
The target portlet can be on the same or on a different page from the portlet that is
the source of the event. A page can also be the target of a wire. In this case, all
portlets on the target page can receive the event. In response to the event, the
target portlet can update its content.
You can work with wires using the wire summary panel or the drag-and-drop
feature.
Using the wire summary panel
About this task
These steps describe how to create a new wire. You can also edit and delete wires
using this panel.
Procedure
1. Click Show Wires. The Summary of wires panel is displayed. The Wire Type
column indicates whether the existing wires are system or custom.
v System wires are created by applications in the portal. You cannot create,
edit, or delete system wires.
v Custom wires are created by portal users with “Editor” access to a page. You
can also edit and delete these wires as necessary.
2. Click New Wire. A dialog is displayed that allows you to select an event
provided by a source portlet on the page. If no events are listed, then you
cannot create a wire from this page. You can select from the events listed to
read a description of each event.
3. Select one of the available source events for the new wire and click OK. A
dialog is opened that allows you to select the target for the new wire. You can
browse through the pages and folders listed to select a target portlet or page, or
use the search field to find the target.
4. Select a target for the new wire.
5. Optional: If the target is on another page, select from the following options.
v Load the selected target page
This option opens the target page if it is not already opened when the event
is launched.
v Switch to the selected target page
This option makes the target page the current page when the event is
launched.
6. After you have finished making your selections, click OK. A dialog is opened
that allows you to select from a list of transformations. Transformations are
used to change event names or parameters so that the target can process them.
You should be familiar with the transformation and target before defining a
transformation for the wire. You can select from the list of transformations to
read a description.
7. Select the transformation for the new wire, or select None if no transformation is
needed, and click OK. If you selected “Simple String Transformation”, select a
target event from the list and select the source parameter names for each target
parameter in the list. When the original event is sent, it is transformed into this
target event before it is received by the target portlet.
66
Tivoli Integrated Portal Online help
Results
The new wire is created and added to the wire summary for the page.
What to do next
When you are finished making changes to the page, click Save.
Using the drag-and-drop feature
About this task
Portlets register the events that they support to the portal. If it is a subscribed
event, the portlet can be a target of the event and receive the event message. If it is
a published event, the portlet is the source of the event and sends the event
message. When editing a page, some portlets might display the Events icon in the
title bar. Click this icon to view the events that the portlet has registered with the
portal.
You can create wires by dragging the events from the source portlet to another
portlet on the page. Wires to other pages must be created using the Summary of
wires table.
Procedure
1. In the portlet title bar, click the Events icon. The portlet window replaces the
portlet with a list of events supported by the portlet.
Note: There is an Enable checkbox next to each event in the list. Unchecking
this box disables all custom and system wires associated with the event and
source portlet. Your selection to enable or disable the event overrides preceding
selections for the same event that could have been made for other custom wires
with other portlets.
2. To create a wire from a source portlet, drag an event listed under Published
Events to another portlet on the page. The target portlet must be capable of
processing the selected event. A dialog is opened that allows you to select from
a list of transformations. Transformations are used to change event names or
parameters so that the target can process them. You should be familiar with the
transformation and target before defining a transformation for the wire. You
can select from the list of transformations to read a description.
3. To create a new custom wire from a source portlet to a target on another page,
drag the event to the target listed in the Summary of wires panel.
4. Select the transformation for the new wire, or select None if no transformation
is needed, and click OK. If you selected “Simple String Transformation”, select
a target event from the list and select the source parameter names for each
target parameter in the list. When the original event is sent, it is transformed
into this target event before it is received by the target portlet.
Results
The new wire is created and added to the wire summary for the page.
What to do next
When you are finished making changes to the page, click Save.
Chapter 4. Administrative settings
67
Portlet properties
This panel is used to edit the general properties of a portlet.
The properties panel is displayed when you click a portlet in Portlets to edit it.
Portlet entity title
Indicates the title of the portlet. This field can be edited only for copies of
a portlet. The title should be brief, but descriptive enough to inform users
when making portlet selections for a page.
Portlet display title
Indicates the name that is displayed in the portlet title bar on the page.
This name is also displayed in the selection list when adding portlets to a
page. In most cases, the display title is the same as the entity title. There
are settings in the portlet code that can override the value of the entity
title.
Component direction
Indicate whether portlet components should be displayed from left-to-right
or right-to-left. If you select the default setting, the display direction is
governed at page level.
Text direction
Indicate whether portlet text should be displayed from left-to-right or
right-to-left. If you select the default setting, the text direction is governed
at page level. You can also set the text direction to Contextual Input,
which for portlets that include text entry fields, displays entered text in the
appropriate direction.
Portlet unique name
Uniquely identifies this portlet to the portal. For example, you could have
two portlets with the name Reports, but they cannot share the same
unique name. This field cannot be changed.
Page membership
Lists the pages that the portlet has been added to. Users with “Editor”
access to a page can update the portlet content by navigating to the page
and selecting Edit Page from the selection list in the page bar.
Roles with Access to This Portlet
This section provides a table displaying roles that have been assigned to
access this portlet and their level of access. Access control to a portlet can
also be assigned using Role Management. The following options are
provided by the roles table.
Select all icon
Selects all items displayed in the table for deletion. If you are
displaying only a filtered set of items, only those items are
selected. You can deselect specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
Add
Adds an item to the table.
Remove
Removes all selected items from the table. There is no warning
prompt when you click Remove.
Filter
68
Tivoli Integrated Portal Online help
Type in this field to quickly find an item in the table. This field is
useful when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Role Name
Displays the name of a role that has been given access to the
portlet.
Access Level
Displays the level of access that the role has to the portlet.
Title bar - Personalize icon - the Personalize icon
Provides access to a panel where you can personalize the
appearance of a portlet, in this case the Portlet Management
portlet, where you can set the display direction for both portlet
content and text at user level. If you set text and component
direction preferences at this level (user level), it overrides any other
settings that may have been set at portlet, page, portal, or browser
levels.
Working with preference profiles
Preference profiles are a collection of portal behavior preferences for using the
portal that are created by the portal administrator. These preferences include the
visibility of the navigation tree, contents of the view selection list, and the default
view. Assign preference profiles to roles to manage how the navigation area and
view selections are displayed to the users in the role.
Attention:
Each role is limited to one preference profile.
Field descriptions
This section describes the fields and controls in the main panel of Console
Preference Profiles.
Select all icon
Selects all items displayed in the table for deletion. If you are displaying
only a filtered set of items, only those items are selected. You can deselect
specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
New
Opens a panel for creating a new preference profile.
Delete Immediately deletes all selected items in the list. Only Custom resource
types can be deleted.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Profile Name
Indicates the name of the profile. You can sort the list of names by clicking
the column heading.
Role Count
Indicates the number of roles assigned to a preference profile. Each role is
limited to one preference profile. However, multiple roles can be assigned
to any single preference profile.
Chapter 4. Administrative settings
69
Creating preference profiles
Preference profiles are a collection of console behavior preferences for using the
console that are created by the console administrator. Follow these steps to create a
preference profile and assign it to a role.
About this task
Procedure
1. Click Settings > Console Preference Profiles in the console navigation. The
Console Preference Profiles page is displayed with the list of preference
profiles that have already been created in the console.
2. Click New. The properties panel for the new preference profile is displayed.
3. Required: Enter a descriptive name for the preference profile. Consider how
the name reflects the roles that have been assigned to it or the console settings
that are defined.
4. Optional: Edit the system-provided unique name for the preference profile.
Accept the default value or provide a custom value.
5. Optional: Select a theme for the preference profile. A theme dictates how
elements of the console are displayed, for example, background colors and
contrast. You can select a theme, click Preview, and navigate to areas of the
console to assess the impact of your selection. The theme that you select is
committed only when you save the preference profile, so that you can preview
other themes before deciding which one is appropriate.
6. Indicate whether the navigation tree should be hidden. This might be
preferable when the user has few pages to access and display space in the
console is better reserved for page content.
7. Optional: Use the Console Bidirection Options to set the direction to display
console content and text. The default option lets the browser dictate the text
and content direction, for example, for Arabic and Hebrew, the text is
displayed right-to-left, whereas for other languages it is displayed left-to-right.
Alternatively, you can decide to set the text and content direction to either
left-to-right or right-to-left. In the Text direction list, you can also select
Contextual Input so that for portlets that include text entry fields, the
direction of text is dependent on the language used to enter data.
8. Select which view options should be available for users in the role.
9. Expand the section Roles Using this Preference Profile.
10. Click Add and select one or more roles to use this preference profile. When
assigning roles, you might notice some roles missing from the list. This means
they are assigned to another preference profile. The role must be removed
from the other profile before it can be assigned to this one.
11. Select the default console view for this preference profile. The default view is
the one that is selected when users in this role log in to the console. This field
is enabled when at least one role has been added for this preference profile.
12. Click Save to save your changes and return to Console Preference Profiles.
Results
The new preference profile is created and listed on the main panel for Console
Preference Profiles.
70
Tivoli Integrated Portal Online help
Editing console preference profiles
Preference profiles are a collection of console behavior preferences for using the
console that are created by the console administrator. Follow these steps to change
the properties or roles assigned to a preference profile.
About this task
Procedure
1. In the navigation pane, click Settings > Console Preference Profiles. The
Console Preference Profiles page is displayed with the list of preference
profiles that have already been created in the console.
2. Click the name of the preference profile that you want to edit. The properties
panel for the preference profile is displayed.
3. Enter a descriptive name for the preference profile. Consider how the name
reflects the roles that have been assigned to it or the console settings that are
defined.
4. Optional: Edit the system-provided unique name for the preference profile.
Accept the default value or provide a custom value.
5. Optional: Select a theme for the preference profile. A theme dictates how
elements of the console are displayed, for example, background colors and
contrast. You can select a theme, click Preview, and navigate to areas of the
console to assess the impact of your selection. The theme that you select is
committed only when you save the preference profile, so that you can preview
other themes before deciding which one is appropriate.
6. Optional: Indicate whether the navigation tree should be hidden. This might
be preferable when the user has few pages to access and display space in the
console is better reserved for page content.
7. Optional: Use the Console Bidirection Options to set the direction to display
console content and text. The default option lets the browser dictate the text
and content direction, for example, for Arabic and Hebrew, the text is
displayed right-to-left, whereas for other languages it is displayed left-to-right.
Alternatively, you can decide to set the text and content direction to either
left-to-right or right-to-left. In the Text direction list, you can also select
Contextual Input so that for portlets that include text entry fields, the
direction of text is dependent on the language used to enter data.
8. Optional: Select which view options should be available for users in the role.
9. Expand the section Roles Using this Preference Profile.
Option
Description
To add roles
Click Add and select one or more roles to
add to the list. Click OK when you have
made all of your selections.
Note: If a role is not listed, it likely means
that it has been assigned to another
preference profile.
To remove roles
Select one of more roles in the list and click
Remove. Be certain of your selections. When
you delete, there is no warning prompt and
the action cannot be undone.
To assign a default view
Select from the Default console view section
to the side of the role list.
10. Click Save to save your changes.
Chapter 4. Administrative settings
71
Results
The preference profile is updated and you are returned to the main panel for
Console Preference Profiles.
Deleting console preference profiles
Preference profiles are a collection of console behavior preferences for using the
console that are created by the console administrator. Follow these steps to delete a
preference profile.
About this task
Procedure
1. Click Settings > Console Preference Profiles in the navigation pane. The
Console Preference Profiles page is displayed with the list of preference profiles
that have already been created in the console.
2. Locate the preference profile that you want to delete in the table provided. You
can use the filter in the table to type in the preference profile name and quickly
display it.
3. In the Select column select one or more preference profiles.
4. Click Delete. A message is displayed at the top prompting you to confirm the
deletion.
5. Click OK.
Results
The preference profile is removed.
Preference profile properties
This panel is used to edit the general properties of a preference profile.
This properties panel is displayed when you click a preference in Console
Preference Profiles to edit it. The following fields and options are available.
Preference profile name
Enter a descriptive name for this preference profile.
Preference profile unique name
Optionally, edit the system-provided unique name for this preference
profile. This name must be unique within the console.
Theme
Select a theme to be associated with the preference profile and therefore
those roles that are assigned to the preference profile. You can preview one
or more selected themes before committing to one particular theme.
Navigation tree options
Select whether the navigation should be displayed for the roles that use
this preference profile. Hiding the navigation can be helpful when the
default view for the role includes some startup pages. If there are few tasks
available in the navigation, hiding the navigation makes better use of the
window space.
Console Bidirection options
Select whether console components and text should always be displayed
from left-to-right or right-to-left. If you select the default setting, text and
72
Tivoli Integrated Portal Online help
console components direction is dictated by your browser locale settings.
You can also set the text direction to Contextual Input, which for portlets
that include text entry fields, displays entered text in the appropriate
direction.
Required view
You must select at least one option. All tasks displays all of the tasks in
the console to which the user has access. System and custom views shows
only the views that have been created in the console or by deployed
applications.
Core views
This option displays views for products that have been installed that use
the console.
My tasks
This option allows users to customize their own task list.
Roles Using this Preference Profile
Use this section to add or remove roles for the preference profile and to
select the default view.
Select all icon
Selects all items displayed in the table for deletion. If you are
displaying only a filtered set of items, only those items are
selected. You can deselect specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
Add
Adds an item to the table.
Remove
Removes all selected items from the table. There is no warning
prompt when you click Remove.
Filter
Type in this field to quickly find an item in the table. This field is
useful when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Role Name
Displays the name of a role that has been assigned to the
preference profile.
Default view
Select one of the views listed to be the default view for these roles.
Only views that are common to all of the roles listed in the access
list are available for selection as the default.
Resource types
You can use the portal to create pages, roles, and views. All of these resources that
you create using the portal are assigned a resource type of Custom. With other
resource types, a more limited set of actions are available.
The type of resource is determine by how it was created.
Core
This resource type is central to the operation of the portal. Core resources
cannot be created or deleted in the portal, and you cannot edit its
Chapter 4. Administrative settings
73
properties. However, you can make other changes that do not alter the
nature of the resource, for example, including a core page in a custom
view.
System
This resource type is created by products and applications that deploy the
resource to the portal. For example, when an application is installed to the
portal environment, it can define certain pages, roles, and views needed to
administer the application through the portal. All of these have a resource
type of System. Like core resources, system resources cannot be created or
deleted. However, for views, pages, and folders, you can create copies of
system resources, which are explained under System Customized. And like
core resources, you can perform actions on a system resource, like
changing access to the resource, without modifying its properties.
System Customized
This is a copy of a system resource with properties, such as the name of
the resource, that have been changed in the portal. The original system
resource is always maintained, but the system customized version of the
resource is used until the original is restored. When the system resource is
restored, the system customized copy is deleted.
You can create system customized pages, folders, and views, but not roles,
wires, or external URLs.
Custom
These are resources that you create using the portal. Custom resources can
be created, edited, and deleted by any user whose role has access to the
Pages, Views, Portlets, and Roles portlets under the Settings folder in the
navigation.
Manage Global Refresh
Portal administrators use Manage Global Refresh to configure portlet refresh
settings for all users of the portal. Portlet refresh is used to refresh the content of a
single module without reloading the entire page. As a result, your experience with
the portal interface is quicker and more interactive. Use these settings to fine tune
how each portlet refreshes its content individually on the page.
Using Manage Global Refresh
Use this module for the following tasks:
v Giving permission to portal users to edit their own portlet refresh options.
v Configuring default refresh settings for portal modules. Administrators can set
values for refresh mode, refresh interval, and show timer settings. These settings
become the default values for Configure Portlet Refresh.
v Setting the minimum refresh interval for each portal module. Use this setting to
prevent the performance impacts of too many calls to the server to refresh
content.
Portlet refresh settings
Restore Default Configuration
Changes all of the displayed field values to the values that were last saved.
At least one portlet must be selected to enable this button. To save the
changes displayed by this button, select the portlets that you want to
restore to the default settings and click Apply or OK.
74
Tivoli Integrated Portal Online help
Select all Select all icon
Selects all of the portlets displayed. A maximum of 10 refreshable portlets
can be displayed and selected at a time.
Deselect all Deselect all icon
Deselects all of the portlets displayed.
Select Use the checkbox to select individual portlets that you want to restore to
the default settings.
Portlet
Indicates the name of the portlet or portal module which can be refreshed.
Refresh Mode
Select one of the following options:
v No Refresh
Indicates that the portlet content will not be refreshed automatically. The
refresh timer is not displayed in the portlet title bar, but the portlet can
still be refreshed manually.
v Timed Refresh
Indicates that the portlet content is refreshed automatically based on the
value of the refresh interval.
v Smart Refresh
Indicates that after the refresh interval has timed out, the client should
query the portlet on the server to determine if it should refresh the
content. If the portlet has updates to provide, then the content is
updated on the client. Otherwise, no change is made and the timer is
started again.
v Unregister
Disables portlet refresh capabilities for this portlet. The portlet still
displays in Manage Global Refresh. Portlet refresh can be subsequently
restored by setting this value to one of the other settings.
Refresh Interval
Indicate a value in seconds after which the portlet's content can be
refreshed from the server without reloaded the entire page. This value
must be greater than or equal to the minimum refresh interval.
Minimum Refresh Interval
Indicates the minimum value for the refresh interval. This value is
determined by the administrator.
User Configurable
Indicates whether users can change refresh setting in Configure Portlet
Refresh.
Show Timer
Indicates whether to display a timer in the portlet title bar showing the
number of seconds remaining until the next refresh can take place.
Credential Store
Use Credential Store to save sensitive information in encrypted form.
Using Credential Store
Credential Store is ideal for saving login information (such as usernames and
passwords) so that portal modules that need to authenticate portal users to
Chapter 4. Administrative settings
75
backend systems can retrieve those credentials without prompting the user. Each
key containing sensitive information can be identified by an application using the
credential key name. Before using this module, consult the application
documentation or service representative to determine the semantics required for
the key.
Field descriptions
New
Opens a new panel which displays fields used to create the new credential
information. The information provided depends on the application or
system that will be using this information.
For example, to authenticate to a remote machine named ServerA, you
could set the key name to ServerA, set the credential name to the login
username, and set the credential value to the login password. Then a
portal module can retrieve the username and password using the String
ServerA and log the user in without presenting a login prompt.
Key Name
Required. Enter the name of the key used to represent the
credentials to be stored. Typically this name is used by a portlet to
retrieve credentials for the user.
Credential Name
Required. Enter a name for the credential.
Credential Value
Required. Enter a value that is stored in encrypted form.
Description
Optional. You can use this field to provide further information of
this key.
When you click OK, you are returned to the main panel of Credential
Store.
Delete Deletes any keys that are selected.
Select all Select all icon
Selects all of the keys displayed for removal. A maximum of 10 keys can
be displayed and selected at a time.
Deselect all Deselect all icon
Deselects all of the keys displayed.
Select Selects keys to be deleted.
Key name
Displays the name of each key that you have stored. This is rendered as a
link so that you can edit a key directly by clicking on the name.
Description
Displays the description of each key.
Exporting portal settings
Administrators can use the Export wizard to export settings and customizations for
a portal instance, that can be can subsequently imported and installed as a
separate instance. For example, using the Export wizard, you could export portal
settings from a test environment.
76
Tivoli Integrated Portal Online help
About this task
To export settings for a particular portal instance:
Procedure
1. Click Settings > Export Wizard in the navigation pane.
2. In the Export Wizard page, click Next to display the Export options page. Use
the Export options page to indicate that you want to export all settings or that
you want to define specific settings for export.
v To export all portal settings and customizations, select the All TIP settings
and customizations option.
v In order to choose specific settings to export, select the Choose which
console settings and customizations to export option.
3. In the Export package name field, accept the default export package name or
provide a custom name. Check the Download package to my desktop on
completion checkbox if you want specify a custom location to save your
export package.
4. Click Next. If you chose to export all settings, go to step 9.
5. In the Detail Options page, select the settings and customizations that you
want to export and click Next.
Note: You must select at least one item to export.
6. Optional: If you indicated in the Detail Options page that you wanted to
export preference profiles, the Profiles to Export page is displayed. Select the
profiles that you want to export and click Next.
Note: Views and pages associated with the selected preference profiles are
automatically exported.
7. Optional: If you indicated in the Detail Options page that you wanted to
export custom views, the Views to Export page is displayed. Select the views
that you want to export and click Next.
8. Optional: If you indicated in the Detail Options page that you wanted to
export custom pages, the Pages to Export page is displayed. Select the pages
that you want to export and click Next.
9. In the Summary page, review the settings that are selected for export. If, in
the Export option page, you did not specify a custom location to save the
export package, take note of the system generated path provided in the
summary.
Restriction: If you select the Download package to my desktop on
completion option, your settings are actually exported at the time of clicking
the last Next button, just prior to viewing the Summary page. Once you click
finish in the Summary page, you can specify a download directory for the
export package.
10. Click Finish to complete the export process.
Common settings
These panels are used in several portlets under the Settings folder in the
navigation pane.
Chapter 4. Administrative settings
77
Add Roles
Use this panel to provide access for a role to a resource, such as a portlet, a page,
or a view. It is also provided to associate a role with a preference profile.
This panel is displayed when you click Add from the properties panel of the
resource. Use the following fields.
Select all icon
Selects all items displayed in the table for deletion. If you are displaying
only a filtered set of items, only those items are selected. You can deselect
specific items before actually deleting.
Deselect all icon
Deselects all items displayed in the table.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Role Name
Displays the name of the role.
Type
Displays the type of role.
Click OK when you are finished to save your changes.
Add views
Use this panel to add a view to a page or role. For a page, adding this view makes
the page a member of the view so that the page can be accessed from the
navigation when the view is selected. For a role, adding this view grants users in
that role access to the view. The access level can be selected after the view has
been added to the list.
Select all Select all icon
Selects all views in the table. You can deselect specific views before adding.
Deselect all Deselect all icon
Deselects all selected views in the table.
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
View Name
Displays the name of the view.
Type
Displays the type of view.
Add Pages
Use this panel to add a page to a view or role. For a view, the added page
becomes a member of the view and is accessible from the navigation pane when
the view is selected. For a role, adding this page grants users in that role access to
the page. The access level can be selected after the page has been added to the list.
Select all Select all icon
Selects all pages in the table. You can deselect specific pages before adding.
Deselect all Deselect all icon
Deselects all selected pages in the table.
78
Tivoli Integrated Portal Online help
Filter
Type in this field to quickly find an item in the table. This field is useful
when there are a large number of items to look through.
Select Selects or deselects a single item in the table.
Page Name
Displays the name of the page.
Type
Displays the resource type of page.
Unique Name
Displays the name used to uniquely identify this page in the portal.
String translation properties
This panel is used to specify a resource bundle to support translated names for
view, page, folder, or URL resources. It is accessed from the properties panel of the
resource. To use these settings, you must know the location of a resource bundle of
a deployed portal module and the key name containing the translated strings that
you want to use.
Use the following fields to enable translated strings for the resource.
String translation
Select Enabled to use resource bundles to provide localized (translated)
strings for the resource. When this field is enabled, the name field for the
resource is disabled, preventing you to directly enter the name for the view
or node.
Module
Select from the list of deployed portal modules.
Location
Specifies the location of the resource bundle within the portal module
WAR file. This is relative to the /WEB-INF directory within the portal
module package. For example, if the resource bundle is located in
/WEB-INF/classes/nls/mySample.properties, then specify
classes/nls/mySamples for this field.
Key
Specifies the key used to provide the localized page name.
Chapter 4. Administrative settings
79
80
Tivoli Integrated Portal Online help
Chapter 5. Charting
The Charting feature enables you to retrieve data from IBM applications such as
Tivoli Monitoring and Tivoli Business Service Manager and from custom charts
that were designed with the Eclipse Business Intelligence and Reporting Tools
Designer.
Use the charting features to build portal pages with charts from IBM applications
and customized charts created using the Business Intelligence and Reporting Tools
Designer.
Related concepts:
“Custom charts” on page 87
The charts portlet enables you to display charts created with the Eclipse Business
Intelligence and Reporting Tools Designer.
“IBM charts”
You can display charts with data from IBM Tivoli Monitoring and other IBM
products.
IBM charts
You can display charts with data from IBM Tivoli Monitoring and other IBM
products.
When you create a page with the Charting portlet, it opens with choices for chart
sources and chart customization. Use the IBM Charts source to display a chart of
data selected from supported IBM applications such as Tivoli Monitoring and
Tivoli Business Service Manager.
Configuring a chart portlet in the Portlet Wizard
You can configure a chart portlet in the Create Portlet Wizard so that the
configured portlet can be added to a page using the portlet palette.
Before you begin
In Portlet Wizard, create a new portlet using the Charting base portlet, or edit an
existing Charting portlet.
About this task
Once you have selected a Charting portlet in the Portlet Wizard, configured its
general properties, and set access levels for it, you can set charting specific settings
in the Customization section of the wizard. You can select the type of chart to
configure, that is, an IBM chart or a Business Intelligence and Reporting Tools
(BIRT) custom chart. In addition to the create portlet task, described in this topic,
you can also import an existing chart from an IBM application, use an existing
BIRT based chart, or upload a new BIRT based chart. In these additional tasks, you
cannot customize chart settings as you can when you create or edit a new IBM
chart as described here.
© Copyright IBM Corp. 2012
81
Procedure
To create a new IBM chart:
1. In the General page of the Customize section of the Create Portlet Wizard,
select Create a chart and click Next. The Select a Data Set page is displayed
with a list of connections, where you can select a data set for your chart. Data
sets are organized hierarchically under connections and data sources.
2. In the Select a Data Set page, you can browse through the connections listed.
You can use the Filter field to reduce the amount of connections listed.
Alternatively, you can use the Search field to access a data set directly,
without having to browse the list of connections and data sources. In the latter
case, enter a text string and click Search to return a list of matching data sets
and go to step 5 to continue.
3. To browse for a data set, select a connection from the list and click Next to
display a page that lists data sources associated with your selection.
4. Select a data source from the list and click Next to display a page that lists
data sets associated with your selection.
Note: If you do not find the data set that you require, an administrator can
use the Connection Manager under SettingsConnections to define and
configure connections to applications that provide data sets.
5. Select a data set from the list (its attributes are shown on the right hand side
of page) and click Next. The Parameters page is displayed if there are
parameters associated with a data set, otherwise this page is skipped and the
Filters page is displayed, see 7.
6. Optional: To allow the chart to accept parameters from other portlets on a
page, accept the default setting on this page. Otherwise clear the check box so
that the portlet only uses the default parameters associated with it. Click Next
to display the Filters page. Filtering the parameters to be displayed on your
chart allows you customize the type of data to be displayed from the selected
data set.
Define filter button to
7. Optional: In the Filters page, click the
display the filter dialog. To set one or more filters:
a. If you intend to apply more than one filter, in the Match field, select all
rules to ensure that all filters that you create are applied and only those
parameters matching all filters are returned. Alternatively, select any rules
to return parameters that match any of the applied filters.
b. In the Column drop down list, accept the default to apply the filter across
all columns, or select a column from the drop down list.
c. In the Condition drop down list, select the type of condition that you
want to apply in relation to the string that you enter in the Value field.
d. In the Value field, type a text or number string for the filter you want to
icon and provide
apply. To apply additional filters, click the
additional values, conditions, and so on.
e. When you have applied your filters, click Filter to save your settings.
Whether or not you chose to apply filters to the data set, you must click Next,
to display the Visualization page where you can select a chart type for your
data set.
8. In the Visualization page, select a chart type and define the chart layout and
labelling that your require.
82
Tivoli Integrated Portal Online help
As you define the layout and labelling, which is dependent on the chart type
that you select, the right hand side of the page updates to show a preview of
the chart as you apply each setting.
icon to start
To add columns, lines, or pie slices to a chart, click the
building up your chart.
To add columns in a table chart, move items from the Available Columns
panel to the Selected panels column.
9. Once you are satisfied with your chart setup, click Next to display the
Thresholds page. Use the thresholds page to ensure that once a defined
attribute value is exceeded that is highlighted on the chart. You can set
multiple thresholds for each attribute highlighting different value ranges. In
the drop down list in the Color column, you can also create custom styles for
threshold.
10. Optional: In the Thresholds page, to set a threshold for an attribute, enter a
value in the relevant field in the Value column and select a threshold color
and label from the drop down list in the Color column. To add additional
icon. Whether or not you chose to
thresholds for an attribute, click the
apply thresholds to the chart attributes, you must click Next, to display the
Visualization Options page where you can further customize display settings
for the chart.
11. Optional: In the Visualization Options page, you can further define how you
want to display your data. For example, you can customize colors, themes,
legend positions, and X and Y axis settings. Whether or not you chose custom
display settings, you must click Next, to display the Summary page where
you can review details for your charting portlet.
12. In the Summary page, review the detail of your charting portlet, and click
Finish to complete the wizard steps.
Results
The new IBM chart is available in the portlet palette to be included on portal
pages.
Related tasks:
“Opening a chart from an IBM application”
You can retrieve real-time data from IBM applications to render in a chart portlet.
“Uploading a BIRT chart” on page 88
You can retrieve charts that were created with the Business Intelligence and
Reporting Tools (BIRT) Designer.
“Opening a chart created in the BIRT Designer” on page 87
You can retrieve charts that were created with the Business Intelligence and
Reporting Tools.
Opening a chart from an IBM application
You can retrieve real-time data from IBM applications to render in a chart portlet.
About this task
A Charting portlet gives you a choice of displaying a chart with data retrieved
from an IBM product or one that was created with the BIRT Designer. These
instructions are for data sources accessed through a Tivoli application's Web service
Chapter 5. Charting
83
(J2EE application for using the chart and table queries from Tivoli monitoring and
analytics products).
Procedure
1. Create a new page (Settings > Pages > New Page), select the Charting portlet
entity. The Charting title bar has several tools for editing the portlet, getting
help, and minimizing or maximizing the display.
2. In the Charting portlet, click IBM Charts to open a table of defined connections
to chart sources. If the chart services for IBM Tivoli Monitoring were enabled
during installation, details are displayed with the name ITM.
3. Select an application row from the list and click Next.
list. The Web service
4. Select an information group from the Groups
identifies the available chart types for that group and displays them in the list.
If the list is empty, ask your administrator for help or review the
troubleshooting topic for charts.
5. Select the chart type to open and click Finish. The query is passed through the
Tivoli servers to the monitoring agent (or agents) and data samplings are
returned based on the chart that was requested.
6. If you would like to save the page, click Save and complete the fields. Select
Client Side page persistence to ensure the best performance and behavior of
charting portlets.
Results
The chart is rendered as specified by the view query. To share the chart with others
who view the same page, click Share Preferences. You must have the
chartAdministrator or chartCreator role to be able to share preferences.
What to do next
Hover the mouse over a chart point to see the value it represents or switch to the
table view to see all the values. If the chart toolbar is hidden, click
it. You can
Refresh the data, manipulate and refine the chart, publish the
chart for sharing with other users, or click
a different chart.
84
Tivoli Integrated Portal Online help
to open
Return to chart selector and select
Related concepts:
“IBM charts” on page 81
You can display charts with data from IBM Tivoli Monitoring and other IBM
products.
Related tasks:
“Defining a Web service connection”
The Charting portlet enables you to retrieve data from IBM data sources that have
been defined there. The definition includes the application server address and the
Web service name.
“Configuring a chart portlet in the Portlet Wizard” on page 81
You can configure a chart portlet in the Create Portlet Wizard so that the
configured portlet can be added to a page using the portlet palette.
Related reference:
“Chart tools” on page 91
After creating or opening a page from one of the chart sources, you can adjust it.
Console pages
The work area displays the current console page, which contains one or more
portlets.
Defining a Web service connection
The Charting portlet enables you to retrieve data from IBM data sources that have
been defined there. The definition includes the application server address and the
Web service name.
Before you begin
Before a connection can be established for a Web service, that service and its data
sources must be configured. Web service connections are usually created during
the product installation, so it is rare that an administrator needs to create a new
connection. The chartAdministrator role is required to create or delete connections.
In particular for IBM Tivoli Monitoring Web Service connections, the optional
BIRTExtension component must be installed and single sign-on (SSO) must be
configured between the Tivoli Integrated Portal Server and the Tivoli Monitoring
instance.
About this task
Create a connection definition for the IBM applications from which you want to
retrieve chart data.
Procedure
1. Create a new page (Settings > Pages > New Page), select the Charting portlet
entity. The Charting title bar has several tools for editing the portlet, getting
help, and minimizing or maximizing the display.
2. In the Charting portlet, click IBM Charts to open a table of defined connections
to chart sources. If the chart services for IBM Tivoli Monitoring were enabled
during installation, details are displayed with the name ITM.
New. If you do not see this tool, click
to display the chart
3. Click
toolbar.
4. In the window that opens, complete the fields to identify the Charting Web
service:
Chapter 5. Charting
85
a. Enter a Name of up to 32 characters for the connection.
b. From the Type list select a service type, for example, Web Service.
c. From the Protocol list, select the non-secure HTTP or secure HTTPS. For
example, for an Tivoli Monitoring Web Service connection, select HTTP.
d. Enter the fully qualified Hostname of the application server.
e. Enter a Port number for the application server. The default port is 16310 for
HTTP and 16311 for HTTPS. However, the port number used depends on
the product you are connecting to, for example, an Tivoli Monitoring Web
Service connection normally uses port 15200. Consult your administrator or
the product documentation for the port to use.
f. In the Service Name field, provide a service name for the connection. The
service name depends on the application you are connecting to (such as
TIPWebServiceHttpRouter for Tivoli Monitoring). Refer to your product
documentation for the correct Web Service Name to use.
g. Select a render format for the connection, that is, either BIRT or Dojo. For
example, for an Tivoli Monitoring Web Service connection select BIRT.
h. Select the authentication method to be used and if you do not select the
single sign-on (SSO) option, provide log in credentials. For a IBM Tivoli
Monitoring Web Service connection, select the SSO option.
5. Click Create to add the Web service definition to the list.
6. To configure the connection in relation to the relevantTivoli Enterprise Portal
Server, carry out the following steps at the command line:
a. Change directory to install_dir/profiles/TIPProfile/bin.
b. To configure the connection, depending on the platform enter:
./tipcli.sh ITMLogin --hostname host_name --port
port_num --servicename service_name
./tipcli.sh ITMLogin --hostname host_name
--port port_num --servicename service_name
Where:
hostname is the name that you provided in the Connection Properties
dialog.
service_name is the exact service name that you provided in the Connection
Properties dialog.
port_num is the port number that is to be used for the Tivoli Enterprise
Portal Server connection (normally 1920).
What to do next
If you need to modify a definition, delete it and then create a new connection.
Repeat these steps on any other application servers that you intend to import IBM
charts from.
86
Tivoli Integrated Portal Online help
Related concepts:
“IBM charts” on page 81
You can display charts with data from IBM Tivoli Monitoring and other IBM
products.
Related tasks:
“Opening a chart from an IBM application” on page 83
You can retrieve real-time data from IBM applications to render in a chart portlet.
Related reference:
“Chart tools” on page 91
After creating or opening a page from one of the chart sources, you can adjust it.
Custom charts
The charts portlet enables you to display charts created with the Eclipse Business
Intelligence and Reporting Tools Designer.
A page created with the Charting portlet opens with choices for chart source and
chart customization. You can open charts that were created with the BIRT Designer.
BIRT is an Eclipse-based open source reporting system that is available for
downloading and using with your product.
Your product contains a special version of the BIRT Designer with plug-ins to
connect to IBM applications hosting a custom Web service interface.
Opening a chart created in the BIRT Designer
You can retrieve charts that were created with the Business Intelligence and
Reporting Tools.
About this task
A Charting portlet gives you a choice of displaying a chart with data retrieved
from an IBM product or one that was created with the BIRT Designer. These steps
are for opening a BIRT chart.
Procedure
1. Create a new page (Settings > Pages > New Page), select the Charting portlet
entity. The Charting title bar has several tools for editing the portlet, getting
help, and minimizing or maximizing the display.
2. In the Charting portlet, click Custom Charts to open a list of BIRT charts. If no
charts are listed, you need to upload them.
3. Select the chart to display and click Finish.
Results
The chart and the data it specifies are displayed.
Chapter 5. Charting
87
Related concepts:
“Custom charts” on page 87
The charts portlet enables you to display charts created with the Eclipse Business
Intelligence and Reporting Tools Designer.
“Chart or table creation with the BIRT Designer” on page 89
Use the Business Intelligence and Reporting Tools Designer to create custom charts
and tables that can be saved and uploaded to a charting portlet.
Related tasks:
“Uploading a BIRT chart”
You can retrieve charts that were created with the Business Intelligence and
Reporting Tools (BIRT) Designer.
“Configuring a chart portlet in the Portlet Wizard” on page 81
You can configure a chart portlet in the Create Portlet Wizard so that the
configured portlet can be added to a page using the portlet palette.
Related reference:
“Chart tools” on page 91
After creating or opening a page from one of the chart sources, you can adjust it.
Uploading a BIRT chart
You can retrieve charts that were created with the Business Intelligence and
Reporting Tools (BIRT) Designer.
About this task
You need to identify the BIRT report file to the Charting portlet to make it
accessible for display.
Procedure
1. Create a new page (Settings > Page Management > New Page), select
Charting portlet entity, then click Add Portlet.
2. In the Charting portlet, click Custom Charts to open a list of BIRT charts.
3. Click
Upload.
Upload
4. Click Browse to locate and open the report design file, then click
to add it to the list of BIRT charts. Charts are created in the BIRT Designer
workspace directory with a .rptdesign extension.
Results
After uploading the report design, you can open the uploaded BIRT chart in a
chart portlet.
88
Tivoli Integrated Portal Online help
Related concepts:
“Custom charts” on page 87
The charts portlet enables you to display charts created with the Eclipse Business
Intelligence and Reporting Tools Designer.
“Chart or table creation with the BIRT Designer”
Use the Business Intelligence and Reporting Tools Designer to create custom charts
and tables that can be saved and uploaded to a charting portlet.
Related tasks:
“Opening a chart created in the BIRT Designer” on page 87
You can retrieve charts that were created with the Business Intelligence and
Reporting Tools.
“Configuring a chart portlet in the Portlet Wizard” on page 81
You can configure a chart portlet in the Create Portlet Wizard so that the
configured portlet can be added to a page using the portlet palette.
Related reference:
“Chart tools” on page 91
After creating or opening a page from one of the chart sources, you can adjust it.
Chart or table creation with the BIRT Designer
Use the Business Intelligence and Reporting Tools Designer to create custom charts
and tables that can be saved and uploaded to a charting portlet.
Here is a brief overview of the basic steps to create a chart or table.
After downloading the BIRT Designer, you need to download and extract it. The
BIRT Designer that comes with Tivoli Integrated Portal runs only on Windows.
1. Select Custom Charts from the page that was created with the Charting portlet.
BIRT Designer link.
2. Select the
3. When prompted, save the birt-designer compressed file, then decompress it.
4. In the birt-designer directory, start birt.exe.
After installing and starting the BIRT Designer, create your first chart.
1. Create a new report in the BIRT Designer with File > New > New Report.
2. Click the Data Explorer tab to open the Data Explorer view.
3. Right-click Data Sources and click New Data Source, with either IBM Tivoli
Data Query Web Service or JDBC Data Source as the type, depending on what
kind of data sources are available. (Do not select the sample data database
because the number of data rows returned might exceed the charting 10,000
row limit.) Follow the screens and enter the information as necessary.
v When IBM Tivoli Data Query Web Service is the type of Data Source, a
connection is made to the Web Service. You can securely connect to a Web
service by choosing HTTPS as the protocol. For the port, increment the port
number you chose at install time by 1 (such as 16311). You must also enter a
username and password for the administrative portal. You will receive
another prompt to accept the SSL certificate from the server. Accept the
certificate to connect.
v When JDBC Data Source is the data source, you might need to add the driver
to the BIRT Designer and the application server. The DB2® JDBC driver is
included with both the stand-alone BIRT Designer and the one that is
included with your product. Copy the JDBC drivers to the these directories
and then restart the BIRT Designer and the application server: <BIRT
Chapter 5. Charting
89
4.
5.
6.
7.
Designer>\plugins\
org.eclipse.birt.report.data.oda.jdbc_2.2.1.r22x_v20070919\drivers;
<install_dir>\systemApps\isclite.ear\TIPChartPortlet.war\WEB-INF\
platform\plugins\
org.eclipse.birt.report.data.oda.jdbc_2.2.1.r22x_v20070919\drivers.
Create a new Data Set and select the data source you just created. A data set
provides data to a chart or table. Follow the screens and enter information as
necessary.
Drop a Chart from the Palette view of BIRT onto your report, then configure
the chart with the Chart Wizard using the Data Set created in the previous step.
To create a table, drag the Data Set onto the report. A table containing the data
set is created for you. The report design you create in the BIRT Designer should
contain a single data set and a single chart or table only.
After you finish creating the chart, save your changes, and click the Preview
tab to render the chart. Each report design file can contain one chart or table.
Use the Reporting module if you want to multiple charts or tables in the same
report.
Return to the administrative portal, create a new page with the Charting
portlet, save it, click Custom Charts, then choose Upload, and navigate to the
mychartname.rptdesign location. The chart was saved in the workspace
directory of the BIRT Designer.
Note: The sample database charts that are provided with the BIRT Designer can
consume a large amount of hard disk space. Use the sample data base only for
testing and practice.
Related concepts:
“BIRT Designer and Tivoli Common Reporting”
The standalone version of the BIRT Designer is available through theTivoli
Integrated Portal Charting module. The full Eclipse version is available through
Tivoli Common Reporting.
Related tasks:
“Opening a chart created in the BIRT Designer” on page 87
You can retrieve charts that were created with the Business Intelligence and
Reporting Tools.
“Uploading a BIRT chart” on page 88
You can retrieve charts that were created with the Business Intelligence and
Reporting Tools (BIRT) Designer.
Related reference:
“Chart tools” on page 91
After creating or opening a page from one of the chart sources, you can adjust it.
BIRT Designer and Tivoli Common Reporting
The standalone version of the BIRT Designer is available through theTivoli
Integrated Portal Charting module. The full Eclipse version is available through
Tivoli Common Reporting.
Common Reporting uses an import feature that is available only in the full Eclipse
version of the BIRT Designer. If you need the functionality required by Common
Reporting, you can download the full version through the link in the Tivoli
Common Reporting portlet.
90
Tivoli Integrated Portal Online help
The Charting portlet has a link for the standalone BIRT Designer used by Charting.
Report design files created in the full Eclipse version are compatible with the
standalone client.
Related concepts:
“Chart or table creation with the BIRT Designer” on page 89
Use the Business Intelligence and Reporting Tools Designer to create custom charts
and tables that can be saved and uploaded to a charting portlet.
Tivoli Common Reporting
Use the Reporting console module to work with and manage reports.
Chart tools
After creating or opening a page from one of the chart sources, you can adjust it.
While a chart is displayed, click any of these tools to manipulate it. If the charting
to expand. You can also right-click a chart data
toolbar is collapsed, click
point to see and select a chart tool from the pop-up menu.
Tool
Refresh
Preferences
Toggle Table
Toggle Chart
Return to chart selector
Print Preview
Save to File
Purpose
Refresh the current chart with new data. You
can also refresh the design, which reads the
chart definition from the source application
and is useful if the definition has been
edited. However, it slows down the chart
rendering, so use it only when you know or
think that the chart definition has changed.
Change the appearance and behavior of the
chart.
Note: When you use the Preferences button
to update the paging size for a chart, your
changes do not take effect until you
subsequently log back into the portal.
Switch the chart to a table format. You can
drag the column borders to adjust the
widths.
Switch the table to a chart format. If this tool
is unavailable, the table cannot be rendered
as a chart.
Go back to the previous view and select
another chart type or design.
Open a printable view of the chart or table.
You can then use the browser's print function
to print the page.
Save the chart or table in the PNG (Portable
Network Graphics) image format.
Chapter 5. Charting
91
Tool
Publish
Purpose
Publish this portlet to make it available to
other chart users. Select one of the following:
Share Preferences to save the current chart
selection and customization for this portlet to
share with others.
Clear Shared Preferences to reset the
preference settings to their defaults for this
portlet. Users will see the chart selector
instead of a specific chart. Specify will not
remove specific user preferences; other users
will still see their selections if they have
changed them.
Clear User Preferences to reset only the
preferences that the current user might have
set in this portlet. If default preferences exist,
the user will see the chart and customization
for the defaults. Otherwise, the chart selector
is displayed.
Related concepts:
“IBM charts” on page 81
You can display charts with data from IBM Tivoli Monitoring and other IBM
products.
“Custom charts” on page 87
The charts portlet enables you to display charts created with the Eclipse Business
Intelligence and Reporting Tools Designer.
“Chart or table creation with the BIRT Designer” on page 89
Use the Business Intelligence and Reporting Tools Designer to create custom charts
and tables that can be saved and uploaded to a charting portlet.
Related tasks:
“Opening a chart from an IBM application” on page 83
You can retrieve real-time data from IBM applications to render in a chart portlet.
“Defining a Web service connection” on page 85
The Charting portlet enables you to retrieve data from IBM data sources that have
been defined there. The definition includes the application server address and the
Web service name.
“Opening a chart created in the BIRT Designer” on page 87
You can retrieve charts that were created with the Business Intelligence and
Reporting Tools.
“Uploading a BIRT chart” on page 88
You can retrieve charts that were created with the Business Intelligence and
Reporting Tools (BIRT) Designer.
Charting
You can retrieve charts with data from IBM Tivoli Monitoring and other Tivoli
products, and from custom charts that were designed with the Eclipse Business
Intelligence and Reporting Tools Designer.
A page created with the Charting portlet opens with choices for the chart source
and chart customization:
92
Tivoli Integrated Portal Online help
Custom charts
Display a chart that was created with theBusiness Intelligence and
Reporting Tools Designer. BIRT is an Eclipse-based open source reporting
system for Web applications that is available with your Tivoli Integrated
Portal.
Tivoli charts
Display a chart of data selected from supported Tivoli applications such as
Tivoli Monitoring and Tivoli Business Service Manager. The hostname and
port number of the application server are referenced, along with the Web
Service name.
Chapter 5. Charting
93
94
Tivoli Integrated Portal Online help
Notices
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in
other countries. Consult your local IBM representative for information on the
products and services currently available in your area. Any reference to an IBM
product, program, or service is not intended to state or imply that only that IBM
product, program, or service may be used. Any functionally equivalent product,
program, or service that does not infringe any IBM intellectual property right may
be used instead. However, it is the user's responsibility to evaluate and verify the
operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter
described in this document. The furnishing of this document does not grant you
any license to these patents. You can send license inquiries, in writing, to:
IBM Director of Licensing
IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.
For license inquiries regarding double-byte (DBCS) information, contact the IBM
Intellectual Property Department in your country or send inquiries, in writing, to:
IBM World Trade Asia Corporation
Licensing
2-31 Roppongi 3-chome, Minato-ku
Tokyo 106-0032, Japan
The following paragraph does not apply to the United Kingdom or any other
country where such provisions are inconsistent with local law: INTERNATIONAL
BUSINESS MACHINES CORPORATION PROVIDES THIS PUBLICATION "AS IS"
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
PURPOSE. Some states do not allow disclaimer of express or implied warranties in
certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors.
Changes are periodically made to the information herein; these changes will be
incorporated in new editions of the publication. IBM may make improvements
and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for
convenience only and do not in any manner serve as an endorsement of those Web
sites. The materials at those Web sites are not part of the materials for this IBM
product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it
believes appropriate without incurring any obligation to you.
© Copyright IBM Corp. 2012
95
All statements regarding IBM's future direction or intent are subject to change or
withdrawal without notice, and represent goals and objectives only.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which
illustrate programming techniques on various operating platforms. You may copy,
modify, and distribute these sample programs in any form without payment to
IBM, for the purposes of developing, using, marketing or distributing application
programs conforming to the application programming interface for the operating
platform for which the sample programs are written. These examples have not
been thoroughly tested under all conditions. IBM, therefore, cannot guarantee or
imply reliability, serviceability, or function of these programs.
Trademarks
IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of
International Business Machines Corp., registered in many jurisdictions worldwide.
Other product and service names might be trademarks of IBM or other companies.
A current list of IBM trademarks is available on the Web at “Copyright and
trademark information” at www.ibm.com/legal/copytrade.shtml.
Internet Explorer is a trademark of Microsoft Corporation in the United States,
other countries, or both
96
Tivoli Integrated Portal Online help
Index
B
BIRT charts 87
BIRT Designer
and Tivoli Common Reporting
steps to create a chart 89
90
C
chart
connection to a Tivoli Web service
IBM application 81
opening a BIRT 87
Tivoli application 83
tools 91
uploading a BIRT 88
charts
BIRT overview 87
85
I
image portlet
22
P
portlet
custom
58
T
Tivoli charts
81
© Copyright IBM Corp. 2012
97
98
Tivoli Integrated Portal Online help
Printed in USA
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement