Managing Portlets

Portlets are the components that make up Netcool Reporter. You can use the Portlet tab to add new add-on applications to Netcool Reporter.

These operations are managed from the User Administrator window Portlet tab. This section covers:

•   Using the Portlet Tab

•   Creating and Editing Portlets

•   Deleting Portlets

Using the Portlet Tab

The User Administrator window Portlet tab lets you create, modify, and delete portlets. The Portlet tab appears at the bottom of the User Administrator window, as shown below.

 

   Figure 360: Portlet Tab

The Portlets tab lists all of the installed portlets. By default, Netcool Reporter is shipped with the following portlets:

•   Advanced Search

•   Easy Reporter

•   Freeform Report Designer

•   Group Options

•   HTML Customizer

•   Information Designer

•   Lightweight Chart Property Designer

•   Manage Channel Content

•   Manage Channels

•   Manage Folder Content

•   Manage Folders

•   My Channels

•   My Folders

•   Publish Channel Content

•   Publish Channels

•   Publish Folder Content

•   Publish Portlets

•   Report Designer

•   Report Options

•   Reporter Page Builder

•   Reporter Page Publisher

•   Reporter Template Builder

•   Reporter User Profile

•   Server Admin

•   Simple Search

•   Upload Content

•   Upload JSP

•   User Admin

•   User Profile

Depending upon your installation configuration, some or all of these default portlets appear in the list in the Portlet tab.

Creating and Editing Portlets

To create a new portlet, select PortletÆNew Portlet. The New Portlet window is displayed with the Portlet Info tab in the foreground, as shown below.

 

   Figure 361: Portlet Info Tab

Enter the name for the new portlet in the Portlet Name field. You can also enter a description in the Description field.

To edit an existing portlet, highlight a name, select PortletÆEdit Portlet. The Edit Portlet window is displayed. This window is identical to the New Portlet window. The only difference is the inability to change the portlet name.

Assigning an Action to a Portlet

You can assign actions to the portlet using the Actions tab, as shown below.

 

   Figure 362: Actions Tab

This tab lets you select the action performed when a user starts the portlet. Every portlet can be started in the following ways:

•   By starting the portlet itself by clicking its link in a Netcool Reporter page.

•   By running a file associated with the portlet.

•   By editing a file associated with the portlet.

You can define special actions for each of these situations. The default action (for when the portlet is started directly) is also used if a user runs or edits a file associated with that portlet, and there is no action defined specifically for running or editing files.

To specify a start method, enter the following:

•   Type - This specifies the type of portlet being used. The various portlet types are described in Types of Portlets on page 560.

•   Value - Enter the actual address or program to be used. (For example, if the portlet’s Type is URL, this is a web address.) Appropriate values for each type are described in Dynamic URLs on page 561.

•   Window Parameters - (Optional) Use this field to specify any HTML parameters for the browser window used for the new portlet. Valid window parameters are a collection of the attributes listed below separated by commas, without any space after the comma.

The available Window Parameters are listed in the following table.

Table 112: Window Parameters Field Descriptions

Value

Description

left

Specifies the X-position, in pixels, of the window with respect to the desktop.

top

Specifies the Y-position, in pixels, of the window with respect to the desktop.

height

Specifies the height of the window in pixels.

width

Specifies the width of the window in pixels.

resizable

Controls whether or not the user can resize the window (yes or no).

scrollbars

Controls whether or not scrollbars is displayed when the window contents exceed the window size (yes or no).

menubar

Controls whether or not a menu bar is displayed at the top of the window (yes or no).

toolbar

Controls whether or not the standard browser toolbar (with Next and Back buttons, and so on) is displayed at the top of the window (yes or no).

status

Controls whether or not a status bar is displayed at the bottom of the window (yes or no).

An example Window Parameters field value is shown below:

left=100,top=100,height=300,width=500,resizable=no,scrollbars=yes,menubar=no,toolbar=no,status=yes

Associating File Types with a Portlet

You can associate a file type to a portlet using the File Type tab, as shown below.

 

   Figure 363: File Type Tab

This tab lets you associate one or more file types with this portlet. If a file is associated with a portlet, the user can select the file and click the Run or Edit button, and the portlet starts, using the defined run or edit functions (if defined).

To associate a file type with the portlet, select its filename extension in the left panel and click Select>. To disassociate a file type from the portlet, select its extension in the right panel and click <Unselect.

The file types in the following table are reserved and cannot be used for portlets you create:

Table 113: Reserved File Extensions

Extension

Description

car

Report Designer parameterized charts

cctb

Report Designer child crosstabs

cht

Report Designer charts

cmp

Report Designer combo reports

cntr

N-Tier crosstabs

crpt

Report Designer child reports

ctb

Report Designer crosstabs

ctr

Report Designer parameterized crosstabs

cub

Report Designer cubes

durl

Dynamic URLs

frm

Report Designer forms

gif

GIF image files

htm

HTML files

html

HTML files

jpg

JPEG image files

jurl

JavaScript URLs

mcar

Easy Reporter parameterized metacharts

mcht

Easy Reporter metacharts

mcub

Easy Reporter metacubes

mpar

Easy Reporter parameterized metareports

mrpt

Easy Reporter metareports

ntr

N-Tier reports

par

Report Designer parameterized reports

rpt

Report Designer reports

scht

Chart snapshots

scmp

Combination snapshots

scub

Cube snapshots

srpt

Snapshot reports

url

Uniform Resource Locator. The global address of documents and other resources on the World Wide Web.

Types of Portlets

When you define a portlet, you must specify the portlet’s type. This specifies what kind of action Netcool Reporter performs when the portlet is run. There are several types:

•   Relative Path

•   Absolute Path

•   URL

•   Dynamic URL

•   Cartridge

Relative Path

The portlet is associated with a file on the server. The file is specified with a relative path, a path relative to the server’s $INFOHOME directory (the directory where Netcool Reporter is installed). When a user starts the portlet, the specified file is opened with the user’s browser.

 

   Note:


    The contents of the file are delivered by the Netcool Reporter server. The file itself is not opened in-place on the Web server. For this reason, if the file is an HTML file, relative hyperlinks do not work. To deliver a web page, you should use URL or Dynamic URL, described in the following sections.


For example, if the server is installed in a machine’s c:\htdocs\infospc directory, and the Documentation portlet is specified with the relative path packages\doc\index.html, then when the user starts the Documentation portlet, the browser attempts to open the file c:\htdocs\infospc\packages\doc\index.html.

Absolute Path

This is similar to a relative path, except the file is specified with its full directory address on the server. You can use this to specify files that are not in the server’s HTTP directory tree. As with relative path, if the file delivered is written in HTML, relative hyperlinks do not work.

URL

This may be any full URL. When the user starts the portlet, the user’s browser opens the URL.

 

   Note:


    You must use a full URL, with a protocol identifier and host name. For example, http://hostname.micromuse.com/infospc/readme.txt is a valid URL, but infospc/readme.txt is not.


Dynamic URL

This is similar to a URL, except you can include special Netcool Reporter variables which are evaluated when the URL is opened.

Cartridge

This specifies a Java object which implements the portlet API interface. It must be installed on the server’s Java path. When a user starts the portlet, an instance of that object is created and initialized on the user’s computer.

Dynamic URLs

A dynamic URL is just like a regular URL, except that it may include some special Netcool Reporter variables. These variables are expanded when the URL is opened. For example, you might specify a URL like this:

http://hostname.micromuse.com?UserID={User.NAME}

The Netcool Reporter server would replace the parameter (the bracketed portion) with an appropriate value.

You can use the parameters listed in the following table. The relevant object is inserted, in serialized form. For example, if you use the parameter {User}, the User object for that session is inserted.

Table 114: Dynamic URL Parameter Descriptions

Parameter

Description

Session

Expands to information about the current session.

User.<field_name>

Expands to information about the currently logged-in user. <field_name> can be the name of a column in the data repository’s USER table, or a field in the user’s Preferences file. Valid fields are:

•   ID: the disk ID of the user object

•   NAME: the name of the user object

•   DESCRIPTION: the description of the user

•   MODIFIED: the modified date of the user in milliseconds

•   CREATED: the created date of the user in milliseconds

•   PATH: the full name of the user

•   RPPASSWD: the encrypted password of the user

•   Any other parameter value defined in the user’s or default group’s preference file. (If the user has a default group defined, then the preference value for the group is used.)

File.<field_name>

Expands to information about the file object representing the link. If you use File and the portlet is not started on a specific file, then a null value is used. Valid fields are:

•   ID: the disk ID of the file

•   NAME: the name of the file

•   DESCRIPTION: the description of the file

•   MODIFIED: the modified date of the file in milliseconds

•   CREATED: the created date of the file in milliseconds

•   Any other parameter value defined in the properties file of the file object representing the link.

Deleting Portlets

To delete an existing portlet, highlight the portlet on the User Administrator window Portlet tab, and select PortletÆDelete Portlet. A window appears asking you if you are sure you want to delete the portlet. Click Yes to delete.