You can configure the Event Dashboard to
run a script that launches another product. The script is run when
a user clicks a monitor box. For integrations with products that are
in Jazz for Service Management,
you can use the Dashboard Application
Services Hub action
framework to define events that can be launched by the script, or
specify a URL that is opened in the browser. For products that are
not in Jazz for Service Management,
you can only use a URL.
Before you begin
If you want the script to launch a URL, obtain the URL that
you want to launch from the Event Dashboard. For more information
about how to build the URL, see the product documentation for the
launched product. For the documentation of Tivoli products, see the IBM® Documentation at http://www-01.ibm.com/support/knowledgecenter.
Procedure
To use the Dashboard Application
Services Hub action
framework, complete steps 1 and 2. Otherwise, skip
these steps.
- On the Web GUI server,
define the broadcasting event in the JazzSM_WAS_Profile/installedApps/JazzSMNode01Cell/isc.ear/OMNIbusWebGUI.war/WEB-INF/ibm-portal-event.xml file.
For example:
<!-- Event Definition -->
<events:event-definition>
<events:name xmlns:x="http://ibm.com/namespace">
x:eventname
</events:name>
</events:event-definition>
Where
eventname is
the name of the broadcasting event and
namespace is
the name space shorthand for the
Web GUI.
Important: The combination of namespace and eventname must
be unique.
- In the ibm-portal-event.xml file of the integrating
product, define a subscription to the event in the widget that you
want to be launched from the Event Dashboard:
- Locate the section that defines the widget that you
want to subscribe to the event.
- Define the subscription.
For example:
<!-- Portlet Subscriptions -->
<events:widget-definition-ref widgetDefinitionRef="widgetdefinition">
<events:supported-subscribed-event>
<events:name xmlns:x="http://ibm.com/namespace">x:eventname
</events:name>
</events:supported-subscribed-event>
</events:widget-definition-ref>
Where:
- eventname
- Is the name of the event defined in step 1
- namespace
- Is the name space shorthand for the Web GUI
- widgetdefinition
- Is the widget definition of the page to which you want to launch
from the Event Dashboard.
- Edit the widget preferences for an Event
Dashboard, or set the defaults for all users.
In
the
Edit Event Dashboard Portlet Preferences window,
from the
Single Click list select
Script.
In the text field, write the required JavaScript. See
Sample scripts for more information.
- Click OK.
Sample scripts
Use these examples to
help you write a script for the Event Dashboard in
step 3.The
following example shows how to write a script that broadcasts an event
in the Dashboard Application
Services Hub action
framework, as defined in step 1 and step 2:
{$param.widgetNamespace}sendPortletEvent
({'name':'http//ibm.com/namespace#eventname',
'parameter':{parametervalue}'});
Where namespace is
the name of the broadcasting event and eventname,
is the name space shorthand for the Web GUI.
The
following example shows how to write a script that launches a static
URL; for example to launch a Tivoli product
that is not based on Dashboard Application
Services Hub:
window.open("protocol://hostname:portnumber/contextroot/?querystring");
Where
the valid values for each variable in the URL are as follows:
- protocol
- The Web protocol to use. Valid values are http and https.
- hostname
- The host name for the Tivoli product
to which you are launching.
- port
- The port number for the Tivoli product
to which you are launching.
- path
- The location of the requested resource.
- parameters
- The parameters for the URL.
What to do next
Test the script by clicking a monitor box on the Event
Dashboard. If single sign-on is not configured, ensure
that you have login credentials for the launched product.