7-1 Getting Started With My WebMethods
7-1 Getting Started With My WebMethods
Cerebra, Glue, Infravio X‐Broker, Infravio X‐Registry, Infravio, My webMethods Server, My webMethods, webMethods Access, webMethods Administrator,
webMethods Broker, webMethods Central Configuration, webMethods Dashboard, webMethods Designer, webMethods Developer, webMethods Fabric,
webMethods Glue, webMethods Infrastructure Data Collector, webMethods Infravio X‐Broker, webMethods Infravio X‐Registry, webMethods Installer,
webMethods Integration Server, webMethods logo, webMethods Mainframe, webMethods Manager, webMethods Modeler, webMethods Monitor,
webMethods Optimize for Infrastructure, webMethods Optimize for Process, webMethods Optimize, webMethods Portal, webMethods Process Engine,
webMethods Servicenet, webMethods Task Engine, webMethods Trading Networks, webMethods Workflow, and webMethods are either registered
trademarks or trademarks of webMethods, Inc.
Acrobat, Acrobat, and Reader are registered trademarks of Adobe Systems Incorporated. Amdocs and ClarifyCRM are registered trademarks of Amdocs.
Ariba is a registered trademark of Ariba, Inc. BEA, BEA WebLogic Server, Jolt, and Tuxedo are registered trademarks, and BEA WebLogic Platform is a
trademark of BEA Systems, Inc. Action Request System, BMC Software, PATROL, and Remedy are registered trademarks of BMC Software, Inc. BroadVision
is a registered trademark of BroadVision, Inc. Chem eStandards and CIDX are trademarks of CIDX, The Chemical Industry Data Exchange. SiteMinder and
Unicenter are registered trademarks of CA, Inc. PopChart is a registered trademark of CORDA Technologies, Inc. Kenan and Arbor are registered trademarks
of Alcatel‐Lucent. Data Connection and SNAP‐IX are registered trademarks of Data Connection Corporation. D&B and D‐U‐N‐S are registered trademarks of
Dun & Bradstreet Corporation. Eclipse is a trademark of Eclipse Foundation, Inc. Entrust is a registered trademark of Entrust, Inc. papiNet is a registered
trademark of the European Union and the United States. Financial Information eXchange, F.I.X, and F.I.X Protocol are trademarks of FIX Protocol Ltd.
UCCnet and eBusinessReady are registered trademarks, and 1SYNC and Transora are trademarks of GS1 US. Hewlett‐Packard, HP, HP‐UX, OpenView, PA‐
RISC, and SNAplus2 are trademarks of Hewlett‐Packard Company. i2 is a registered trademark of i2 Technologies, Inc. AIX, AS/400, CICS, ClearCase, DB2,
Domino, IBM, Informix, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390, OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, and WebSphere, and
z/OS are registered trademarks; and Communications System for Windows NT, DB2 Universal Database, IMS, MVS, and SQL/DS are trademarks of IBM
Corporation. InnoDB is a trademark of Innobase Oy. Itanium is a registered trademark of Intel Corporation. Linux is a registered trademark of Linus
Torvalds. W3C is a registered trademark, and X Window System is a trademark of the Massachusetts Institute of Technology. MetaSolv is a registered
trademark of Metasolv Software, Inc. ActiveX, Microsoft, Outlook, Visual Basic, Visual SourceSafe, Windows, Windows NT, and Windows Server are
registered trademarks of Microsoft Corporation. Six Sigma is a registered trademark of Motorola, Inc. Firefox and Mozilla are registered trademarks of the
Mozilla Foundation. MySQL is a registered trademark of MySQL AB. nCipher is a trademark of nCipher Corporation Ltd. Eclipse is a trademark of Eclipse
Foundation, Inc. Entrust is a registered trademark of Entrust, Inc. papiNet is a registered trademark of the European Union and the United States. Financial
Information eXchange, F.I.X, and F.I.X Protocol are trademarks of FIX Protocol Ltd. UCCnet and eBusinessReady are registered trademarks, and 1SYNC and
Transora are trademarks of GS1 US. Hewlett‐Packard, HP, HP‐UX, OpenView, PA‐RISC, and SNAplus2 are trademarks of Hewlett‐Packard Company. i2 is a
registered trademark of i2 Technologies, Inc. AIX, AS/400, CICS, ClearCase, DB2, Domino, IBM, Informix, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390,
OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, and WebSphere, and z/OS are registered trademarks; and Communications System for Windows
NT, DB2 Universal Database, IMS, MVS, and SQL/DS are trademarks of IBM Corporation. InnoDB is a trademark of Innobase Oy. Itanium is a registered
trademark of Intel Corporation. Teradata is a registered trademark of NCR Corporation. Netscape is a registered trademark of Netscape Communications
Corporation. ServletExec is a registered trademark, and New Atlanta is a trademark of New Atlanta Communications, LLC. SUSE is a registered trademark
of Novell, Inc. Appia is a registered trademark and Javelin Technologies is a trademark of NYFIX, Inc. CORBA is a registered trademark of Object
Management Group, Inc. JD Edwards, OneWorld, Oracle, PeopleSoft, Siebel, and Vantive are registered trademarks; and Infranet, PeopleSoft Pure Internet
Architecture, Portal, and WorldSoftware are trademarks of Oracle Corporation. Perforce is a trademark of Perforce Software. JBoss and Red Hat are
registered trademarks of Red Hat, Inc. PIP and RosettaNet are trademarks of RosettaNet, a non‐profit organization. SAP and R/3 are registered trademarks
of SAP AG. PVCS is a registered trademark of Serena Software, Inc. SWIFT and SWIFTNet are registered trademarks of Society for Worldwide Interbank
Financial Telecommunication SCRL. SPARC and SPARCStation are registered trademarks of SPARC International, Inc. BAAN and SSA are registered
trademarks; and SSA Global is a trademark of SSA Global Technologies, Inc. EJB, Enterprise JavaBeans, Java, JavaServer, JDBC, JSP, J2EE, Solaris, Sun, and
Sun Microsystems are registered trademarks; and Java Naming and Directory Interface, JavaServer Pages, SOAP with Attachments API for Java, and SunSoft
are trademarks of Sun Microsystems, Inc. Sybase is a registered trademark of Sybase, Inc. VERITAS is a registered trademark, and VERITAS Cluster Server is
a trademark of Symantec Corporation. UNIX is a registered trademark of The Open Group. Unicode is a trademark of Unicode, Inc. VeriSign is a registered
trademark of Verisign, Inc.
Software AG and all Software AG product names are either trademarks or registered trademarks of Software AG.
Other product and company names mentioned herein may be the trademarks of their respective owners.
Copyright © 2007 webMethods, Inc. All rights reserved.
Copyright © 2007 Software AG and/or its suppliers, Uhlandstrasse 12, 64297 Darmstadt, Germany. All rights reserved.
Contents
Chapter 5. Managing the Content on Your Home Page and Custom Pages . . . . . . . . . . 61
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Adding Content to Your Home Page and Custom Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Removing Content from Your Home Page and Custom Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Managing the Display of Information on Your Home Page and Custom Pages . . . . . . . . . . . . . . . . . 64
Defining the Layout of Your Home Page and Custom Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Re-arranging the Portlets Displayed on Your Home Page and Custom Pages . . . . . . . . . . . . . 66
Minimizing and Maximizing Portlets on Your Home Page and Custom Pages . . . . . . . . . . . . . . 66
Adding Custom Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Displaying Custom Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Deleting Custom Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Document Conventions
Convention Description
Bold Identifies elements on a screen.
Italic Identifies variable information that you must supply or change
based on your specific situation or environment. Identifies terms the
first time they are defined in text. Also identifies service input and
output variables.
Convention Description
Narrow font Identifies storage locations for services on the webMethods
Integration Server using the convention folder.subfolder:service.
Typewriter Identifies characters and values that you must type exactly or
font messages that the system displays on the console.
UPPERCASE Identifies keyboard keys. Keys that you must press simultaneously
are joined with the “+” symbol.
\ Directory paths use the “\” directory delimiter unless the subject is
UNIX‐specific.
[] Optional keywords or values are enclosed in [ ]. Do not type the [ ]
symbols in your own code.
Additional Information
The webMethods Advantage Web site at http://advantage.webmethods.com provides you
with important sources of information about webMethods products:
Troubleshooting Information. The webMethods Knowledge Base provides
troubleshooting information for many webMethods products.
Documentation Feedback. To provide feedback on webMethods documentation, go to
the Documentation Feedback Form on the webMethods Bookshelf.
Additional Documentation. Starting with 7.0, you have the option of downloading the
documentation during product installation to a single directory called
“_documentation,” located by default under webMethods installation directory. In
addition, you can find documentation for all webMethods products on the
webMethods Bookshelf.
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Overview
My webMethods is a Web‐based, monitoring and administration user interface for
managing your webMethods components. When you log into My webMethods, you are
logging into all webMethods components that are incorporated into My webMethods.
Your user name and password will be the same for all underlying webMethods
components.
For example, if you have webMethods Monitor and webMethods Optimize for Process
installed, when you log into My webMethods, the system automatically logs you into both
webMethods Monitor and webMethods Optimize for Process with a single login. When
you log out of My webMethods, My webMethods logs you out of all underlying
webMethods components.
Important! Because My webMethods uses JavaScript and cookies, you must ensure that
your Web browser is set up to allow cookies and allow JavaScript to execute. For more
information about how to verify that your Web browser settings, see the help for your
Web browser.
where:
host is the host name of the machine on which My webMethods Server is
installed.
port is the port on which My webMethods Server listens for incoming requests.
The default port for My webMethods is 8585.
For example, if the host name is rubicon.company.com and it uses the default port
(i.e., 8585), enter the following URL:
http://rubicon.company.com:8585/mywebmethods
2 On the Login page, type your My webMethods user name and password. The user
name is case insensitive.
Note: When logging in, the value you specify in the user name is case insensitive.
However, after logging in, My webMethods uses the case of the user name that is
defined in your user account. For example, if the user account is defined as
“Administrator”, you can log in using “administrator”. When My webMethods needs
to use the user name, for example, for HTTP authentication, it will use the version
defined in the user account, which is “Administrator”.
Note: For instructions about how to change your My webMethods password, see
“Changing Your Password” on page 9.
3 Click Login.
After you log in, My webMethods displays your home page. Your home page is your
start page; that is it is the first page displayed when you log in to My webMethods.
Your home page is always the My webMethods Home page. For more information
about the My webMethods Home page and how you can customize it, see “My
webMethods Home Page” on page 30 and Chapter 5, “Managing the Content on Your
Home Page and Custom Pages”.
Click the Logout link, which is located at the top of all My webMethods pages.
1 Click the My Profile link, which is located at the top of all My webMethods pages.
2 On the User Information tab, type your new password in the Password field.
3 In the Confirm Password field, type your new password again for confirmation.
4 Click Apply.
Standard Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
Search Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Custom Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
In addition to the My webMethods Home page, you can also create one or more custom
pages that contain content that you select. Similar to the home page, you add content to a
custom page by adding portlets to a custom page. You might create custom pages to
group information for similar tasks on a single page. The custom pages that you create are
specific to your user account and not shared with other users.
For more information about your home page and custom pages, see “My webMethods
Home Page” on page 30, “Custom Pages” on page 31 and Chapter 5, “Managing the
Content on Your Home Page and Custom Pages”.
The following shows the format of the My webMethods Home page and custom pages.
logged in user
standard links
navigation bar
page name
View list
Create New
Page button
portlet
controls
page content
The following table describes the features of the home page and all custom pages:
access. If you have been granted access to only one navigation path, My webMethods
displays that navigation path option along with Home; for example, if you have access
only to the Monitoring navigation path, My webMethods displays only Home and Monitoring.
If you have no access to the Administration navigation path nor the Monitoring navigation
path, My webMethods displays only Home.
After selecting a navigation path (either Monitoring or Administration, My webMethods
updates the navigation bar to include additional selections that are specific to the selected
navigation path. Each navigation path has a separate set of functions. In other words, if
you select Administration, My webMethods displays the administration functions that are
available to you; you will not see the monitoring functions available in the Monitoring
navigation path. For more information, see “Navigation within the Monitoring or
Administration Navigation Paths” on page 18.
For a list of all possible selections in each navigation path and the webMethods
components required for each, see “Selections Available in the Navigation Paths” on
page 20. For information about granting access to tasks, see the My webMethods Server
Administrator’s Guide.
The selections available in the navigation bar are dynamic based on the webMethods
components that you have installed and the functionality to which you have been granted
access.
When you make a selection from the navigation bar, My webMethods displays a page for
the selected function. The following shows the typical format of most Monitoring and
Administration pages.
standard links
logged in
user
navigation
bar
page
content, page name
which
often
includes...
...a search
panel
and...
...search
results
The following describes the features of a typical page within the Monitoring and
Administration navigation paths.
The next to the name of a selection indicates that there is another level of navigation.
When you rest your mouse pointer over the selection, My webMethods displays
additional options, as shown below:
Standard Links
The following table describes the standard links that appear at the top of every page of
My webMethods.
Note: For a list of the webMethods components you have installed, click the About link,
which is one of the standard links at the top of all My webMethods pages.
This Monitoring
function... Has these navigation selections... Required webMethods components
System-Wide Problems to locate problems with process Optimize for Infrastructure
instances and to view information related Optimize for Process
to the KPI rules that a process instance has
For more information, see the webMethods
violated. Additionally, use Problems to
Optimize for Infrastructure User’s Guide and
view problems where system components
the webMethods Optimize for Process User’s
are out of compliance and to view
Guide.
information about the event rules and
threshold rules that were violated.
This Monitoring
function... Has these navigation selections... Required webMethods components
System-Wide System Overview to view a summary of all Optimize for Infrastructure
(continued) system components. Use this task to view Optimize for Process
the performance of the entire system at a
For more information, see the webMethods
high level.
Optimize for Infrastructure User’s Guide and
the webMethods Optimize for Process User’s
Guide.
Six Sigma Summary to view six sigma Optimize for Process
information for process instances.
For more information, see the webMethods
Optimize for Process User’s Guide.
Rules to manage KPI, event, and threshold Optimize for Infrastructure
rules. Within this selection, you can Optimize for Process
navigate to:
For more information, see the webMethods
Rule List to create rules to notify you Optimize for Infrastructure User’s Guide and
when a process or resource becomes the webMethods Optimize for Process User’s
problematic and requires user Guide.
attention.
Rule Filters to edit data collection
filters.
This Monitoring
function... Has these navigation selections... Required webMethods components
Business Tasks to view tasks that have been Task Engine
(continued) assigned to you. Within this selection, you My webMethods Server
can navigate to:
For more information, see the webMethods
My Inbox to view your task inbox. Task Engine User’s Guide.
This Monitoring
function... Has these navigation selections... Required webMethods components
Integration Services to view log data that an Monitor
(continued) Integration Server has logged for a service
and to resubmit services. For more information, see the webMethods
Monitor User’s Guide.
Documents to view and resubmit
documents that have been logged to the
logging database.
Reports Process Instances to generate aggregate Monitor
reports on process instances.
For more information, see the webMethods
Monitor User’s Guide.
Process Models to generate aggregate Monitor
reports on process models.
For more information, see the webMethods
Monitor User’s Guide.
Task Users to generate aggregate reports on Monitor
users that participate in tasks. Task Engine
For more information, see the webMethods
Monitor User’s Guide and webMethods Task
Engine User’s Guide.
Task Roles to generate aggregate reports on Monitor
roles that are involved in tasks. Task Engine
For more information, see the webMethods
Monitor User’s Guide and webMethods Task
Engine User’s Guide.
This
Administration
function... Has these navigation selections... Required webMethods components
System-Wide B2B Permissions to manage permissions that Trading Networks
control access to Trading Networks data and
actions. Within this selection, you can navigate For more information, see the
to: webMethods Trading Networks
Administrator’s Guide.
Data Permissions to identify data sets and
indicate the actions roles can take against
Trading Networks data in the data sets.
General Functional Permissions to indicate the
Trading Networks actions that roles can
perform. These permissions govern Trading
Networks data not covered by data
permissions.
User Management to manage users, groups, and My webMethods Server
roles. Within this selection, you can navigate to:
For more information, see the My
Roles to add, edit, and delete roles. webMethods Server Administrator’s
Guide.
Groups to add, edit, and delete groups.
This
Administration
function... Has these navigation selections... Required webMethods components
System-Wide Environments to configure environments for Broker
(continued) Optimize for Process and Optimize for Optimize for Infrastructure
Infrastructure. Within this selection, you can Optimize for Process
navigate to: My webMethods Server
Database Pool Configuration to maintain a For more information, see the
common list of database pools for webMethods Central Configuration
webMethods servers in an environment. and Deployment Guide.
This
Administration
function... Has these navigation selections... Required webMethods components
Analytics Rules to manage KPI, event, and threshold rules. Optimize for Infrastructure
Within this selection, you can navigate to: Optimize for Process
Rule List to create rules to notify you when a For more information, see the
process or resource becomes problematic webMethods Optimize for
and requires user attention. Infrastructure User’s Guide and the
webMethods Optimize for Process
Rule Filters to edit data collection filters. User’s Guide.
This
Administration
function... Has these navigation selections... Required webMethods components
Business Business Processes to configure process models Monitor
and to identify the process models that you want Optimize for Process
to monitor using Monitor and Optimize for
For more information, see the
Process.
webMethods Monitor User’s Guide or
the webMethods Optimize for Process
Administrator’s Guide.
business Overview to configure the display of Optimize for Process
processes in the tree that My webMethods
For more information, see the
displays on the Monitoring > Business > Business
webMethods Optimize for Process
Overview page.
Administrator’s Guide and the
webMethods Optimize for Process
User’s Guide.
Data Management to archive and delete logging Monitor
data from the Process Audit database.
For more information, see the
webMethods Monitor User’s Guide.
Tasks to administer generic tasks that have been Task Engine
published to My webMethods Server. From here
For more information, see the
you can enable, disable, delete, and start tasks, as
webMethods Task Engine User’s
well as modify task rules.
Guide.
Integration B2B to manage Trading Networks partner Trading Networks
management and configure Business Activity
For more information, see the
Monitoring for Trading Networks data.
webMethods Trading Networks
Partner Profiles to add, edit, and delete Administrator’s Guide.
Trading Networks profiles and extended
profile fields
Profile Groups to add, edit, and delete Trading
Networks profile groups.
Partner Certificates to query for partner
certificates that are expired or expiring soon
Public Queues to add, edit, and delete Trading
Networks public queues.
Business Monitoring to configure TN
document types for BAM (Business Activity
Monitoring) and globally enable all the TN
document types for monitoring.
This
Administration
function... Has these navigation selections... Required webMethods components
Integration B2B Settings to set configuration settings for Trading Networks
(continued) Trading Networks
For more information, see the
Administrative Preferences to set administrative webMethods Trading Networks
settings, including identifying the Trading Administrator’s Guide.
Networks server that My webMethods
Server is to interact with.
Server Settings to set Trading Networks Server
configuration properties.
My webMethods System Settings to change the host names and port Monitor
numbers that My webMethods uses to Optimize for Infrastructure
communicate with the Integration Server, the Optimize for Process
Analytic Engine, and the webMethods Task Task Engine
Engine.
For more information, see the
webMethods Monitor User’s Guide,
the webMethods Optimize for
Infrastructure Administrator’s Guide,
the webMethods Optimize for Process
Administrator’s Guide, and the
webMethods Task Engine User’s
Guide.
Directory Services to configure external directory My webMethods Server
services you want to use with My webMethods.
For more information, see the My
webMethods Server Administrator’s
Guide.
Email Servers to configure the mail server settings My webMethods Server
used by My webMethods Server when
processing e‐mail messages. For more information, see the My
webMethods Server Administrator’s
Guide.
Cluster Settings to define the URL to use to access My webMethods Server
My webMethods in a clustered environment and
For more information, see the My
to configure different roles of My webMethods
Server clustered nodes. webMethods Server Administrator’s
Guide.
Data Sources to connect to external data sources, My webMethods Server
such as databases, and make them available to
For more information, see the My
My webMethods Server.
webMethods Server Administrator’s
Guide.
Search Panel
To search for data you use a search panel. My webMethods search panels typically use the
format described in this section. The two main areas of the search panel are the search bar
and the search results.
search bar
search results
For more information about using the search panel, see Chapter 4, “Using Search Panels
to Search for Data to Display”.
Custom Pages
In addition to the My webMethods Home page, you can create other custom pages; that is
additional pages where you manage the content that appears on the page. You might want
to create custom pages to group information for similar tasks on a single custom page. For
example, if you are responsible for tracking new employees, you might create a “New
Employee” custom page and add information related to new employees, such as,
information about the running instance of a new employee process. The custom pages
that you create are only for your own use.
To navigate to one of your custom pages, you first navigate to your home page. From your
home page, you select the name you assigned to your custom page from the View list.
For more information about custom pages, see Chapter 5, “Managing the Content on Your
Home Page and Custom Pages”.
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Overview
The system maintains a profile for each user of My webMethods. You access your profile
via the My Profile standard link. The following table lists the settings you can update from
your profile:
User Profile tab. Several fields that provide optional information that you can supply
about your identity.
1 Click the My Profile link, which is located at the top of all My webMethods pages.
2 On the User Information tab, use the First Name and Last Name fields to specify your
name.
3 Click the User Profile tab.
Default Number Format The format that My webMethods uses when displaying
numbers. For more information about number formats, see
the Javadoc for DecimalDateFormat.
Default Currency The format that My webMethods uses when displaying
Format currency. For more information about currency formats, see
the Javadoc for DecimalDateFormat.
Note: Not all portlets make use of the defaults that you specify in Default Date Format,
Default Time Format, Default Time Zone, Default Number Format, and Default Currency Format.
5 Click Apply.
1 Click the My Profile link, which is located at the top of all My webMethods pages.
2 On the User Information tab in the E-mail Address field, type your e‐mail address.
3 Click the Notifications tab.
4 Specify the following optional information for where you want to receive
notifications:
Instant Messenger User The user name to use with the instant messenger service.
Name
Text Encoding The type of text encoding My webMethods is to use with
the corresponding notification method.
5 Click Apply.
Items Per Page The default number of rows that My webMethods displays
in portlets that list items in rows, for example in search
results. You can select one of the following:
Default to allow the system to determine the number of
items to display per page.
A number to indicate the number of items you want the
system to display per page.
Show All to have the system display all items on a single
page.
Home Page Template The template you want My webMethods to use for the
layout of your home page and all of your custom pages. For
more information about how to select a template, see
“Defining the Layout of Your Home Page and Custom
Pages” on page 64.
4 Click Apply.
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Overview
My webMethods uses a standard search panel for all searches in the user interface. The
following table describes the types of searches you can perform, the tab of the search
panel that you use to perform the search, and when the type of search is available for your
use.
Search
Type of Search Description Panel Tab Availability
keyword Search for data that contains the Keyword Whether keyword
keywords and/or exact phrases searching is available
that you specify. depends on the data
being searched.
For instructions on how to
perform a keyword search, see
“Performing Keyword
Searches” on page 42.
basic Search using basic search Basic Whether basic
criteria when a keyword search searching is available
is not available. depends on the data
being searched.
advanced Search using keywords and Advanced Advanced searching is
exact phrases along with only present when the
additional search criteria to data being searched
produce a detailed search for warrants detailed
specific information. search criteria for
specific information.
For more information, see
“Performing Basic and
Advanced Searches” on
page 43.
Search
Type of Search Description Panel Tab Availability
saved You can re‐execute searches by Saved Re‐executing saved
saving the criteria for a search. searches is always
When you save a search, you available from a search
provide a name for the search panel.
criteria. Then when you want to
re‐execute the search, you select
the criteria by the name you
assigned it. You can save and
re‐execute keyword and
advanced searches.
For instructions on how to save
search criteria and re‐execute
searches, see “Saving Your
Search” on page 47
You can set default search options for each My webMethods page that has a search panel.
For example, you can set the tab of the search panel that you want My webMethods to
display when it displays the My webMethods page and whether you want My
webMethods to automatically execute a search when it displays the My webMethods
page. For more information, see “Setting Search Options for a My webMethods Page” on
page 49.
My webMethods displays the results of your search in either a standard‐format table or a
tree format. You can customize the display of the search results, for example, you can
select the columns you want included in the display. For more information about display
options and a description of standard‐format table and tree format, see “Defining How
My webMethods Displays Search Results” on page 51.
You can take actions against the items in the search result. For example, if your search was
for logged services data, from the search results, you might resubmit a service. For more
information, see “Working with Search Results” on page 57.
Click or rest your mouse pointer on the Keyword Search Help icon. My webMethods
displays text that lists the fields that it will search against.
Note: My webMethods searches across a variety of data sources and databases. Some of
the data sources and databases do not allow searches that contain certain
non‐alphanumeric characters. If you specify non‐alphanumeric characters in a keyword
and the data source or database does not support searching with those characters, rather
than issuing an error and requesting you retype your keywords, My webMethods
continues with the search. However, My webMethods will replace the non‐supported
character with a wildcard character that matches a single character. As a result, your
search results might include additional entries that do not exactly match the search
criteria you specified.
Tip! If you will need to perform this search again in the future, you can save and name
the search criteria. Then to re‐execute the search, you simply need to select the search
criteria that you want to execute. For more information, see “Saving Your Search” on
page 47.
Although the search criteria on an Advanced tab is specific to the page you are viewing,
one field that is often included on the Advanced tab is a field to specify a time period, for
example, a date and time range to restrict the search. Typically, this criterion is called the
Range search criterion. The table below provides information about how the Range search
criterion typically functions.
Criteria Description
Range If the data that My webMethods is to search has a time aspect associated
with it, the Range list is available to restrict the search within a specified time
period.
The Range list contains:
Several options that allow you to select a relative time period (e.g.,
Today, Last 7 days, Last Month)
Custom option that allows you to specify an exact time period. When
you select Custom, you must also fill in the Start Date, End Date, and Times
fields to specify the exact time period.
Important! If you use the Custom option to specify an exact time period, My
webMethods returns data within the exact time period that you specify. If
you add the search results to your home page or a custom page, the data
added will be static; that is the data displayed will always be for the exact
time period that you specified. If you want the data to be dynamic, use one
of the relative time period options (e.g., Last 7 days). For more information,
see “Adding Search Results to Your Home Page or Custom Pages” on
page 59.
The procedure for performing a basic or advanced search varies based on the page you
are viewing. See the appropriate guide that contains information about the task you are
using. For a list of guides, see the “Finding More Information About How to Perform a
Search” on page 45.
My webMethods returns all entries in the search results up to the defined maximum
results allowed. The defined maximum number of search results for a search is set by My
webMethods and is typically 2000 results. If you want to define the maximum number of
results, use the Max Results or No Maximum fields on the Options tab. For more information,
see “Setting Search Options for a My webMethods Page” on page 49.
My webMethods displays the search results in a table format. For more information, see
“Defining How My webMethods Displays Search Results” on page 51 and “Working with
Search Results” on page 57.
Tip! If you will need to perform this search again in the future, you can save and name the
search criteria. Then to re‐execute the search, you simply need to select the search criteria
that you want to execute. For more information, see “Saving Your Search” on page 47.
Monitoring
Functions For more information
System-Wide For Problems, see the webMethods Optimize for Infrastructure
User’s Guide and the webMethods Optimize for Process User’s
Guide.
For System Overview, see the webMethods Optimize for
Infrastructure User’s Guide and the webMethods Optimize for
Process User’s Guide.
For Rules > Rule Lists, see the webMethods Optimize for
Infrastructure User’s Guide and the webMethods Optimize for
Process User’s Guide.
Business For Process Instances, see the webMethods Monitor User’s Guide.
Monitoring
Functions For more information
Integration For Services and Documents, see the webMethods Monitor User’s
Guide.
For B2B > Transactions, see the webMethods Trading Networks
User’s Guide.
For B2B > Tasks, see the webMethods Trading Networks User’s
Guide.
For B2B > Activity Log, see the webMethods Trading Networks
User’s Guide.
Reports For all selections, see the webMethods Monitor User’s Guide.
Administration
Functions For more information
Messaging For all functions, see the webMethods Broker Administrator’s
Guide.
Analytics For Rules > Rule Lists, see the webMethods Optimize for
Infrastructure User’s Guide and the webMethods Optimize for
Process User’s Guide.
For KPIs > Business Data, see the webMethods Optimize for
Infrastructure Administrator’s Guide and the webMethods
Optimize for Process Administrator’s Guide.
For KPIs > System Data, see the webMethods Optimize for
Infrastructure Administrator’s Guide and the webMethods
Optimize for Process Administrator’s Guide.
For KPIs > Dimensions, see the webMethods Optimize for
Infrastructure Administrator’s Guide and the webMethods
Optimize for Process Administrator’s Guide.
For Monitored Components, see the webMethods Optimize for
Infrastructure Administrator’s Guide and the webMethods
Optimize for Process Administrator’s Guide.
Administration
Functions For more information
Business For the Business Processes task, see the webMethods Monitor
User’s Guide.
Integration For B2B > Partner Profiles, see the webMethods Trading Networks
Administrator’s Guide.
For B2B > Partner Certificates, see the webMethods Trading
Networks Administrator’s Guide.
1 Perform the search that you want to save. For more information about performing a
search, see one of the following:
“Performing Keyword Searches” on page 42
“Performing Basic and Advanced Searches” on page 43
2 Click Save. My webMethods displays the Save Search dialog box.
3 In the Search Name field, type the name you want to assign to the search.
4 Click OK.
Tip! If you are unsure of the search criteria for the selected search, click Details. My
webMethods displays the saved search criteria.
Tip! If you are unsure of the search criteria for the selected search, click Details. My
webMethods displays the saved search criteria.
1 Access the My webMethods page for which you want to set search options.
2 Click the Options tab.
3 To define the search panel tab you want My webMethods to display when you
initially access the My webMethods page, use the Search Tab field. Select one of the
following:
Selection... Description
4 To select a saved search to load, and optionally execute, use the Selected Saved Search
field and the Run selected saved search when window is displayed check box:
a Use the Selected Saved Search field to identify a saved search you want loaded when
you initially access the My webMethods page.
If you do not select the Run selected saved search when window is displayed check box
(which is described in the step below), My webMethods does not automatically
execute the search when you access the My webMethods page; it will execute the
search when you click Go. If you set the Search Tab field to Saved or Saved - Details,
when you initially access this My webMethods page, My webMethods displays
the saved search that you select on this tab.
If you do not select a saved search in the Selected Saved Search field, My
webMethods will not load nor execute a search when you initially access the
page.
b If you want My webMethods to execute the saved search that you selected in the
Selected Saved Search field, select the Run selected saved search when window is
displayed check box. When you select this check box, My webMethods
automatically executes the selected saved search when you access the My
webMethods page and displays its results, regardless of your setting in the Search
Tab field.
5 To define the maximum number of search results that you want My webMethods to
retrieve before it stops execution of a search, use the Max Results field or No Maximum
check box.
To define a maximum number of search results, type a number in the Max Results field.
Use Max Results if you are only interested in the most recent information. By
setting a limit, your searches will run more quickly and you will receive your
search results faster.
If you want to always view all search results, select the No Maximum check box. When
you select the No Maximum check box, your searches can potentially be long
running, and you might have to wait before My webMethods displays your
search results.
6 Click Save to save your search options.
Tree format. My webMethods can use a tree format if the search results are hierarchical.
When data is presented in a tree format, My webMethods sometimes provides you
with the option to display hierarchical search results either in the standard‐format
table or tree format. When you use a tree format, My webMethods automatically
expands the search results tree to the nodes where the matches are found. After My
webMethods displays search results, you can click a button to reformat the results
into either format. Additionally, My webMethods also sometimes allows you to set a
display option to define the format to use by default when displaying hierarchical
search results.
The following table lists the possible display options that might be available for you to use
for search results and the sections in this chapter where you can find more information
about the display option. Whether display options are available at all and which options
you can use depend on the page that My webMethods is displaying.
To set the default table format for a My webMethods page where search results are hierarchical
1 Access the My webMethods page for which you want to set display options.
2 Click Display Options, which is located at the top right of the search results panel.
My webMethods replaces the search results with fields to allow you set your display
options.
3 Select the default you want to use for the search results (Table or Tree) from the View
Results As list. My webMethods only displays the View Results As field if the search
results for the page are hierarchical.
4 Click Save.
To view the search results in the alternate table format, click a button that is located in the
top right of the search results:
If the search results are currently displayed as a tree and you want to view them in a
standard‐format table, click View As Table.
When My webMethods is displaying hierarchical results in standard‐format table, the
table includes only entries that match your search criteria. You will not see the parent
information for the matching entries.
If the search results are currently displayed in a standard‐format table and you want
to view them in a tree format, click View As Tree.
Parent entries that might not specifically match your search criteria are included
when their children match the search criteria.
To set the default sort order for search results on a specific a My webMethods page
1 Access the My webMethods page for which you want to set display options.
2 Click Display Options which is located at the top right of the search results panel.
My webMethods replaces the search results with fields to allow you set your display
options.
3 In the Sort By field, select the column name that you want to use to sort the search
results.
4 For Sort Order select either Ascending or Descending to specify the sort order.
5 Click Save.
To re‐sort the search results, click the column heading of the column that you want to use
to sort the search results. My webMethods indicates the current sort order by displaying a
icon or icon next to the column header of the column that is currently being used for
sorting:
A indicates the results are sorted in ascending order
Tip! If you want to take the same action against all results from a search, set the number of
rows to show all. Then, you can use Select All to select all items in the search results,
allowing you to act on all items at one time. For example, you might want to do this if you
need to perform a bulk delete of several items. For more information about acting on
search results, see “Taking Action Against Items in the Search Results” on page 57.
To define the number of rows that My webMethods displays on all My webMethods pages by default
1 Click the My Profile link, which is located at the top of all My webMethods pages.
2 Click the User Preferences tab.
3 In the Items Per Page field, select one of the following:
Default to allow the system to determine the number of search results to display
per page.
A number to indicate the number of search results you want the system to display
per page.
Show All to have the system display all search results on a single page.
4 Click Apply.
To override the default number of rows you set in your user preferences
1 Access the My webMethods page for which you want to set display options.
2 Click Display Options, which is located at the top right of the search results panel.
My webMethods replaces the search results with fields to allow you set your display
options.
3 In the Number of Rows to Display field, select the number of rows you want My
webMethods to use when displaying search results on this My webMethods page.
4 Click Save.
1 Access the My webMethods page for which you want to set display options.
2 Click Display Options, which is located at the top right of the search results panel.
My webMethods replaces the search results with fields to allow you set your display
options.
3 To specify the columns that you want included, in the COLUMN DISPLAY section of the
screen, move the columns to the Selected box.
4 To specify the order in which My webMethods displays the columns in the search
results, move the column names up and/or down in the list.
5 Click Save to save your column display changes.
Actions against a single item in the search result (e.g., editing an item or displaying
details about an item)
For information about the actions available in a specific search panel and more details
about how to perform the actions, see the appropriate guide that is associated with the
task. For a list of guides, see “Finding More Information About How to Perform a Search”
on page 45.
Tip! If you want to take the same action against all results from a search, first update the
number of rows to display in the search results to show all search results on a single page.
Then, you can use Select All to select all items in the search results, allowing you to act
on all items at one time. For information about setting your preference, see “Defining the
Number of Search Results Rows to Display Per Page” on page 55.
Adding Items
If you can add an item, My webMethods displays a button you can use to add items in the
function bar. For example, on the Monitoring > System‐Wide > Rules > Rule List page,
there is a Create Rule button. To add a new rule, click Create Rule.
To add an item
Click the add button, which is typically labeled “Add” or “Create”. If My webMethods
displays additional screens, supply the requested information to describe the new item
you are adding.
Two common action icons are the Edit icon that you use to edit information for an item
in the search results and the Detail icon that you use to display detail information for
an item in the search results.
Click on the appropriate icon for the item you want to act on.
Note: For more information about customizing the content of your My webMethods Home
page, see Chapter 5, “Managing the Content on Your Home Page and Custom Pages”.
1 Click Add to Custom Page, which is located at the top right of the search results.
Important! If your search includes a criterion that specifies an exact time period, for
example using the Custom selection of the Range search criterion, when you add the search
results to your home or custom page, the data is static; that is the data displayed will
always be for the exact time period that you specified. For more information about the
Range search criteria, see “Performing Basic and Advanced Searches” on page 43.
2 From the Add to Page list, select the page to which you want to add the search results.
3 In the Target Name field, specify the name you want to appear in the title bar of the
portlet when it appears on your home or custom page.
4 Click Add to Custom Page.
1 Click Export Table, which is located in the top right of the search results.
2 From the Character Encoding list, select the character encoding to use.
3 Click Export.
4 In the File Download dialog box, click Save to indicate you want to save the search
results to a file.
5 In the Save As dialog box, browse to the location where you want to save the .csv file.
6 Click Save.
Note: To open a .csv file saved with UTF‐16 LE encoding in Excel 2000 or earlier, you will
need to import the file using Data > Get External Data > Import Text File and follow the
instructions in the Import Wizard.
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Managing the Display of Information on Your Home Page and Custom Pages . . . . . . . . . . . . . 64
Overview
When you log into My webMethods, the system displays your My webMethods Home
page. If you navigate to other pages, you can return to your My webMethods Home page
by selecting Home from the navigation bar. You navigate to your custom pages by first
accessing the My webMethods Home page.
The My webMethods Home page and custom pages are similar in that you add the
content you want on these pages. The procedures for managing the content on the My
webMethods Home page and custom pages are the same. The following table lists tasks
this chapter provides for working with the My webMethods Home page and your custom
pages:
cycle time to your home page. When you view your home page, the portlet will display
the monitor specifically for order cycle.
Additionally, the content on the home or custom page displays information for the current
time period, not the information that My webMethods was displaying when you added
the portlet. My webMethods refreshes the information on the home or custom page every
two minutes.
Note: If you are adding search results to your home or custom page and your search
criteria included a criterion that specifies an exact time period (for example, by using the
Custom selection of the Range search criteria), the portlet on your home or custom will
contain static data; that is the data displayed will always be for the exact time period that
you specified. For more information about the Range search criteria, see “Performing Basic
and Advanced Searches” on page 43.
1 Click Add to Custom Page, which My webMethods displays at the top right of
portlets in the user interface.
2 From the Add to Page list, select the page to which you want to add the search results.
3 In the Target Name field, specify the name you want to appear in the title bar of the
portlet when it appears on your home or custom page.
4 Click Add to Custom Page.
Note: For information about where My webMethods adds the portlet to your home or
custom page, see “Defining the Layout of Your Home Page and Custom Pages” on
page 64.
Click Delete, which My webMethods displays at the top right of portlets that are on
your home or custom page.
Re‐arranging the portlets to move them to the location where you want them
Minimizing portlets that you do not need to view, but that you still want to keep on
your home or custom page
Maximizing portlets that you previously minimized when you need to view them
again
Each template defines the order in which you want the one‐column and two‐column areas
to appear; that is, whether you want the one‐column area to appear before the
two‐column area or vice versa. The following table describes the templates you can use:
Template Description
Template 1:2 Use the Template 1:2 template to have My webMethods display
the one‐column area first followed by the two‐column area.
Template 2:1 Use the Template 2:1 template to have My webMethods display
the two‐column area first followed by the one‐column area.
You can select one layout that My webMethods uses for your home page and all your
custom pages.
When you add a portlet to your home or custom page, My webMethods adds the portlet
to the next available space within the appropriate area (i.e., one‐column area or
two‐column area). For example, if you add a portlet that uses one‐column formatting, My
webMethods will place the portlet last in the designated one‐column area. If you would
like the portlet to display higher within the designated area, you can move it; for more
information, see “Re‐arranging the Portlets Displayed on Your Home Page and Custom
Pages” on page 66.
Note: You cannot change the color scheme, graphic images, or any other aspect of the skin
and shell of the My webMethods Home page.
To define the template to use for the layout of your home page and all your custom pages
1 Click the My Profile link, which is located at the top of all My webMethods pages.
2 Click the User Preferences tab if it is not already selected.
3 For Home Page Template, select the template that you want to use.
4 Click Apply.
1 Click Move, which My webMethods displays at the top right of portlets that are on
your home or custom page, and drag the portlet to the new location.
2 Confirm your changes by clicking Save in the confirmation box.
Click Minimize, which My webMethods displays at the top right of portlets that are on
your home or custom page.
Click Maximize, which My webMethods displays on the title bar of a minimized portlet.
1 If you are not currently viewing your home page, select Home from the navigation bar
to view the home page.
2 Click Create New Page. My webMethods displays the Create New Custom Page page.
3 On the Create New Custom Page page, fill in the following fields:
New Custom A name for your custom page. My webMethods uses this name in
Page Title the View list on your home page. It is the name you will select to
navigate to this page.
Description A description for the custom page.
4 Click OK.
Your new custom page will contain default content, which is a single instruction
portlet that provides information about how to add content and customize your new
custom page. You can remove this instruction portlet; for more information, see
“Removing Content from Your Home Page and Custom Pages” on page 63.
1 If you are not currently viewing your home page, select Home from the navigation bar
to view the home page.
2 Select the page you want to view from the View list.
1 If you are not currently viewing your home page, select Home from the navigation bar
to view the home page.
2 Select the page you want to delete from the View list.
3 With the page that you want to delete being displayed, click Delete This Page.
Index
m Notifications tab 36
Notifications tab 36 tasks you can perform 34
updating 36 template for layout of custom pages 65
User Information tab 36 template for layout of home page 65
updating 9, 34, 36, 55, 65
O user identification information 34
Options tab, search panel 49 User Information tab 9, 34, 36
User Preferences tab 55, 65
User Profile tab 34
P
page layout
Q
Administration pages 16
custom pages 12, 14 quotations (" ")
Monitoring pages 16 using in keyword searches 42
My webMethods Home page 12, 14
pages in My webMethods S
page content 18 saved searches
search panel automatically executing 50
overview 29 definition 41
tab displayed by default 49 deleting 48
search results modifying search criteria 48
column order 56 re-executing 48
columns displayed 56 viewing saved criteria 48
how displayed 51 saving searches
number of rows in results 55 how to 47
standard-format table 51 reasons to 47
tree format 51 search options, setting 49
password, changing 9 search panel
portlets Advanced tab 40
adding to custom pages 63 Basic tab 40
adding to home page 63 default tab to display 49
maximizing display on custom pages 66 Keyword tab 40
maximizing display on home page 66 Options tab 49
minimizing display on custom pages 66 page layout 29
minimizing display on home page 66 Saved tab 41
re-arranging on custom pages 66 search bar 30
re-arranging on home page 66 search options 49
removing from custom pages 63 where search results displayed 30
removing from home page 63 search results
where added to custom pages 65 setting default format, standard-format table vs. tree format 53
where added to home page 65 sorting 54
profile searching
defining number of search results to display per page 55 advanced search
notification settings 36 definition 40
V
viewing
custom pages 67
My webMethods Home page 62
saved search criteria 48
W
wildcard characters used in searches 42