Getting Started With Webmethods Portal
Getting Started With Webmethods Portal
VERSION 6.5.1
webMethods, Inc. South Tower 3877 Fairfax Ridge Road Fairfax, VA 22030 USA 703.460.2500 http://www.webmethods.com
webMethods Access, webMethods Administrator, webMethods Broker, webMethods Dashboard, webMethods Developer, webMethods Fabric, webMethods Glue, webMethods Installer, webMethods Integration Server, webMethods Mainframe, webMethods Manager, webMethods Modeler, webMethods Monitor, webMethods Optimize, webMethods Portal, webMethods Servicenet, webMethods Trading Networks, and webMethods Workflow are trademarks of webMethods, Inc. webMethods and the webMethods logo are registered trademarks of webMethods, Inc. Acrobat and Adobe are registered trademarks, and Reader is a trademark of Adobe Systems Incorporated. Amdocs is a registered trademark, and ClarifyCRM is a trademark 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. ChemeStandards and CIDX are trademarks of Chemical Industry Data Exchange. Unicenter is a registered trademark of Computer Associates International, Inc. PopChart is a registered trademark of CORDA Technologies, Inc. Kenan and Arbor are registered trademarks of CSG Systems, Inc. Data Connection and SNAP-IX are registered trademarks of Data Connection Corporation. DataDirect, DataDirect Connect, and SequeLink are registered trademarks of DataDirect Technologies. D&B and D-U-N-S are registered trademarks of Dun & Bradstreet Corporation. 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, DB2, Domino, IBM, Informix, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390, OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, z/OS, and WebSphere 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. JBoss is a registered trademark, and JBoss Group is a trademark of Jboss, Inc. 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, Windows, and Windows NT are registered trademarks; and Windows Server is a trademark of Microsoft Corporation. Six Sigma is a registered trademark of Motorola, Inc. Firefox is a registered trademark, and Mozilla is a trademark of the Mozilla Foundation. MySQL is a registered trademark of MySQL AB. nCipher is a trademark of nCipher Corporation Ltd. Teradata is a registered trademark of NCR International, Inc. Netscape is a registered trademark of Netscape Communications Corporation. SUSE is a registered trademark of Novell, Inc. ServletExec is a registered trademark, and New Atlanta is a trademark of New Atlanta Communications, LLC. CORBA is a registered trademark of Object Management Group, Inc. JD Edwards, OneWorld, Oracle, PeopleSoft, Siebel, and Vantive are registered trademarks, and PeopleSoft Pure Internet Architecture and WorldSoftware are trademarks of Oracle Corporation. Infranet and Portal are trademarks of Portal Software, Inc. Red Hat is a registered trademark 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. SWIFT and SWIFTNet are registered trademarks of Society for Worldwide Interbank Financial Telecommunication SCRL. SPARC and SPARCStation are registered trademarks of SPARC International, Inc. SSA is a registered trademark, and Baan and SSA Global are trademarks 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, SOAP with Attachments API for Java, JavaServer Pages, 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. All other marks are the property of their respective owners. Copyright 20032005 by webMethods, Inc. All rights reserved, including the right of reproduction in whole or in part in any form.
Contents
Contents
About This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Challenges Facing Businesses Today . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The Portal as a Business Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Introducing webMethods Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 2. Understanding webMethods Portal Concepts . . . . . . . . . . . . . . . . . . . . . . . . . Portlets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Portal Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Skins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Shells . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Renderers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Publishing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Portal Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Subscriptions and Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Version Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 3. Understanding webMethods Portal Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . Getting Started with the Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging Into the Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging Out of the Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Your Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Navigating the Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Content to the Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Publishing a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Publishing a Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Publishing a Portal Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Publishing a Portlet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Your Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing the Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 7 7 9 10 10 11 13 14 14 15 15 16 16 17 18 18 19 21 22 22 23 23 23 26 26 27 27 28 28 29
Contents
Changing the Full Page View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Changing the Portlet View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Changing the Number of Items Displayed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Chapter 4. Managing Information Using webMethods Portal . . . . . . . . . . . . . . . . . . . . . . . Displaying Information on Portal Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a New Portal Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Designating a Portal Page as Your Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Information You Own . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Content Within a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Portlet Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Moving an Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Moving an Item Using Cut, Copy, and Paste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting an Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using Version Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding a File or Folder to Version Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Checking Out a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Undo File Check Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Checking In a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using File History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing a Files History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reverting a File to a Previous Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Publishing a Previous Version of a File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Chapter 5. Accessing Information Using webMethods Portal . . . . . . . . . . . . . . . . . . . . . . Looking for Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Finding an Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Searching for an Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Finding Information about Other Portal Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Navigating to Information about Other Portal Users . . . . . . . . . . . . . . . . . . . . . . . . Finding Information Outside the Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Delivering Information Automatically . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting up Notification Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting up a Subscription to a Portal Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Accessing, Showing/Hiding, and Deleting Portal Notification Messages . . . . . . . . . . . . 33 34 34 34 35 35 36 37 37 38 38 39 39 40 40 41 41 41 42 43 44 44 44 48 48 49 49 51 52 52
Contents
53 54
Contents
Document Conventions
Convention Bold Italic Description Identifies elements on a screen. 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. Identifies storage locations for services on the webMethods Integration Server using the convention folder.subfolder:service. Identifies characters and values that you must type exactly or messages that the system displays on the console. 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.
Narrow font
Typewriter font
UPPERCASE \ []
Additional Information
The webMethods Advantage Web site at http://advantage.webmethods.com provides you with important sources of information about webMethods components: Troubleshooting Information. webMethods provides troubleshooting information for many webMethods components in the webMethods Knowledge Base. Documentation Feedback. To provide documentation feedback to webMethods, go to the Documentation Feedback Form on the webMethods Bookshelf. Additional Documentation. All webMethods documentation is available on the webMethods Bookshelf.
CHAPTER
Introduction
Challenges Facing Businesses Today . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 The Portal as a Business Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Introducing webMethods Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11
CHAPTER 1 Introduction
10
Increasing productivity - Interactive and timely access to critical information is the root of productivity. Increasing collaboration - Redundant efforts among employees drain corporate resources. Portal tools help workers comply with existing business processes, share expertise, and collaboratively build the corporate knowledge base. Securing resources - A portal can help businesses strictly manage how employees, customers, and partners access and interact with critical information. Leveraging existing resources - Investments in legacy databases and middleware systems do not have to be discarded. A portal can rapidly integrate and leverage existing information and applications, and make them widely available from a secure, Web-based point of access.
11
CHAPTER 1 Introduction
Track changes on collaborative projects and ensure that participants adhere to existing business processes using version control. Develop and deploy composite applications rapidly with advanced tools.
12
CHAPTER
13
Portlets
Portlets are the fundamental building blocks of the webMethods Portal. Each portlet is a self-contained, interactive component used to access information resources, including enterprise applications, structured and unstructured data, collaboration tools, and Internet content. Portlets are miniature, task-oriented applications that are easily plugged into portal pages. They make it possible to build a portal that securely and dynamically accesses and interacts with diverse information resources. Portlets are the primary mechanism for extending portal functionality. Using a simple, standard plug-in development tools, portlet developers can quickly build and deploy new, customized portlets that meet specific business needs. Portlets are also used to access and manage system resources. System administrators are able to configure, support, and delegate administrative responsibilities by using intuitive Portal Administration Dashboards. webMethods Portal is preinstalled with a number of pre-built portlets. Custom portlets can also be built with the Portlet Developer. This tool makes it easy to develop and deploy new portal features and functionality quickly. Access to each portlet is based on permissions, which define the level of access that portal users and groups must have in order to access the portlet and its associated resources. For instance, a user might be able to view a portlet, but not create new instances of it. Portlets can be displayed with other portlets on a portal page. Typically users will interact with portlets on portal pages that are dedicated to specific users or business goals. Portlets are not required to have user interface elements. That is, a portlet can be put on a page or deployed simply as a listener or mini-application with no input or output.
Portal Pages
Portal pages are containers for portal resources. Portal pages provide a convenient access point to portlets, items, and links. That is, portal pages are personalized Web pages dedicated to organizing and presenting portlets. Each portal page resembles a composite application, and is generally dedicated to accomplishing specific business processes and related tasks. For example, the Human Resources department might create an "HR" portal page containing a discussion board portlet for employee benefits, including links to tax forms, and a form to apply for current job openings. Portal pages, like other information resources, can be customized to meet the needs of various users and groups. They are essential components for customizing and aggregating portal resources, and providing dedicated forums for task-based, user-focused, or group-based activities.
14
Skins
To create new portal pages or edit existing ones, you use the Portal Page Designer. The Portal Page Designer is a Web-based visual editing tool that enables you to drag-and-drop, organize, and configure portlets on portal pages, similar to arranging icons on a desktop. All portal users have a default portal page that displays when you first log on to the system. With proper permissions, you can set their default portal page (your Home page) to any existing portal page, or one you have created. Also, when a you create a portal page, you become the owner of that portal page. As a portal page owner, you can choose to share the portal page with other portal users and groups. For instance, the VP of Sales might give all portal users permission to view a sales-related portal page, but only give users in the Sales group permission to customize the portal page.
Skins
A skin is an installable webMethods Portal component that defines the look-and-feel of the portal user interface. It modifies the images, fonts, colors, and other subtle stylable aspects of HTML content; but it does not modify the HTML content in any functional way. A developer would create a custom skin to: Brand the portal with the deployed site's corporate or divisional logos. Align the portal color scheme with the deployed site's corporate or divisional colors. Align the portal look-and-feel with the deployed site's corporate or divisional look-and-feel. A portal system administrator can assign a particular skin to a specific user. A portal system administrator can also set up rules that dynamically assign a skin to a user based on the user's directory information, his or her group membership, or the request headers sent by the user's browser and intermediaries. In addition, if granted the rights, an individual user can also set his or her skin. Arbitrary rules can also be set up to assign skins based on a variety of other variables.
Shells
A shell is a special kind of installable component that generates the webMethods Portal header, footer, and portlet title bars. While regular portlets produce the primary content of a portal page, a shell provides the structure that frames the primary content. Common Web page design elements such as corporate banners, global navigation links, and search boxes, appear in a shell. A developer can create a custom shell to: Add a row of links to other corporate Web sites below the page banner. Change the look and feel of the default portal header.
15
Add a custom footer to portal pages. As with skins, a portal system administrator can assign a particular shell to a specific user. A portal system administrator can also set up rules that dynamically assign a Shell to a user based the user's directory information, his or her group membership, or the request headers sent by the user's browser and intermediaries. Arbitrary rules can also be set up to assign skins based on a variety of other variables.
Renderers
Renderers control a webMethods Portal users view of portal objects. These objects can be folders, links, content, portal pages, and so forth. A renderer is the engine that lays out a view of the portal object as an HTML page. This includes rendering (or not rendering) the page's hidden content, the page's shell sections (that is, the header, footer, left navigation panel, and so forth) and the portlets that compose the page's primary content. For example, different renderers can display the same portal container as: A portal page with the contents of the container displayed in rows and columns, and portlets. A portal page with contents container viewed as thumbnails. A folder listing with the contents of the container listed like the details view of a folder on your desktop in Windows Explorer. A properties page that lists metadata of the container. An XML document that describes the container in machine-readable format. Portal developers or portal system administrator can create new renderers and associate those renderers with a wide variety of variables. This allows for increased user interface flexibility in webMethods Portal. A portal system administrator can control which renderers are used by administering the rendering rules of the portal; this can be accessed using the Administration Dashboard.
Folders
Folders make up the hierarchical framework for organizing and browsing portal content. While still controlling access based on user permissions, folders help ensure that portal resources are easily accessed and browsed using a familiar, explorer-like interface. Public Folders are the portals public organizational structure and contain references (shortcuts) to actual resources that have been published to the portal. A single portal resource can be referenced in multiple folders using portal shortcuts. For instance, both a Human Resources folder and a Sales folder might contain shortcuts to a corporate travel
16
Publishing
policy document, while the original document would reside in the authors Private Folder. Note: Original documents always reside in folders. The original documents can be referenced in other folders using shortcuts. Deleting a shortcut does not delete the original file, only the reference to it. The default webMethods Portal taxonomy (that is, the folder structure) contains only required system folders. Users with the appropriate permission can create a customized folder structure that meets specific organizational requirements. All folders can contain any depth of subfolders. By default, each user has Private Folders used to store portal content only they can access. Users also have access to shared Public Folders where they and other users store portal content that should not reside only in an individual users Private Folders. All resources published to the Public Folders will be indexed and made searchable from the portal search engine. Resources published only to a users Private Folders will not be indexed.
Publishing
webMethods Portal enables authorized users to populate the portal with a variety of resources, including documents, folders, portal pages, portlets, and other structured and unstructured content. When publishing an item to the portal, the process is similar to using the Save As function in many of todays software programs; you are essentially saving a resource such as a document or link to the portal. As with the Save As function, you must specify a folder location and a name for the item. When you publish an item to the portal, you automatically become the owner of that resource. Resource owners have the ability to set explicit access permissions on every resource they publish; however, Portal Administrators can override the owner status on any resource. Initially, newly published resources automatically assume the permissions associated with the folder to which they are published. For example, if everyone has read privileges in the "Company Activities" folder, any resource published to this folder will be accessible to everyone, unless the resource owner specifically denies access. The webMethods Portal supports WebDAV, which makes it possible to simultaneously publish multiple items directly from your computer desktop by creating a Web folder (Network Place) that points to the corresponding portal folder. Using a WebDAV folder to publish content in bulk is an effective way to quickly populate the portal with large amounts of existing information.
17
In a similar way, webMethods Portal supports FTP. You can publish multiple items from an FTP server to an FTP folder on the portal. You can have multiple FTP folders, each one listening to a different port.
Portal Search
webMethods Portal automatically indexes all of the content users publish to the portal, specifically files, shortcuts, portal pages, folders, and forms. Using the Portal Search feature will return all relevant results to a search query within the bounds of the user's access permissions. Two levels of Portal Search exist: Basic and Advanced. A basic search provides basic keyword searching from a single text field. A basic Portal Search can be confined to resource metadata, or limited to return results from Web search engines. Advanced Portal Search enables more granular control on specific resource metadata. For instance, you could use Advanced Portal Search to search for a document with tax in the title, tax shelters in the body, and published by Mary Smith on or before January 26, 2001. Advanced Portal Search can also restrict searches to specific Dynamic Business Objects. For instance, you could search the portal for all published Job Application Forms containing sales in the Position Applied For field. The Portal Search feature enables you to search the entire portal repository, or specific subsets of information, based on specific keywords and criteria. Search results are filtered based on permissions so that a portal user will only see results they are authorized to access. This means that no sensitive portal content, such as summary information, URL, or link information, is visible to unauthorized users. All searches can be saved and re-submitted on a recurring basis. By default, each user has a personal Saved Searches folder where frequently executed searches can be saved. This folder provides a convenient way to quickly resubmit any saved search and obtain the most current results.
18
Version Control
Since all portal resources are messaging-enabled, webMethods Portal makes it possible to build a portal that continually communicates important status information between resources and users. To receive notifications, users can subscribe to any portal item they are authorized to view. Portal resources have unique events associated with them. For example, a folder can generate a notification when it is deleted, when a sub-folder is added, and when an item is added to the folder, whereas portlets can only generate notifications when they are deleted. By default, notifications are delivered to the subscriber by email or notification inside the portal in the users personal Subscription Inbox page. From their Subscriptions Inbox page, users can manage, edit, and delete all of their subscriptions and associated notifications. The Inbox is implemented as a portlet and can therefore be added to any page. Notification messages, whether delivered by email or to a users subscription page in the portal, provide a brief description of the update and a direct link to the portal resource. Note: Receiving a notification requires the proper viewing rights. If a user has subscribed to a resource and their viewing rights are later revoked, the user will not receive notifications even though they still see that they are subscribed to a particular item.
Version Control
Collaborative projects demand effective ways of tracking user participation, especially for teams that work from remote locations. The webMethods Portal version control system provides versioning support for published documents, maintaining each unique version of a document as it changes throughout its life cycle. Both files and entire folders can use the webMethods Portal version control system. Once a resource is versioned, it is possible to view any previous versions, or revert to a previous version, making it the active document. Also, once a file is versioned, a user must check out the file before making changes. A file can only be checked out by one user at a time and must be checked in before it can be checked out by another user. If necessary, webMethods Portal administrators can override any file that is currently checked out, or force a file to be checked in. For example, if someone goes on vacation and has left a file checked out, the administrator can force a check-in so that other authorized users can access the file.
19
20
CHAPTER
21
where:
host is the host name of the machine on which the Portal server is installed. port is the port on which the Portal server listens for incoming requests. The default port is 8080, but your system may have a different port number assigned.
For example, if the host name is rubicon.company.com and it uses the default port (8080), type the following URL:
http://rubicon.company.com:8080
22
In the User Name field, type your user name. Note: When logging in, the value you specify in the user name is case insensitive. However, after logging in, webMethods Portal 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 webMethods Portal needs to use the user name, for example, for HTTP authentication, it uses the version defined in the user account, which is Administrator.
3 4
23
means that you can include or exclude components, or customize the default components as needed. Desktop Component Browser header Description All of the components of the browser's user interface, that is the menu bar, tool bar, and address bar, right-click menu, remain functional. They are part of the browser application but they do not affect the portal application. The portal header consists of a banner, global navigational links, portal search engine controls, the Locator path, and Quick Links. Each of these components is described separately below. The banner is a static element that displays information or artwork on all consoles. The following Global links provide quick access to the main portal page: Home - the user's default Start page My Profile - the user's portal identity My Folders - the user's private content Inbox - notifications from the user's subscriptions Public Folders - globally available content Directory - portal users and groups Logout - ends the user's portal session Search bar The search bar allows you to search for content within the portal or on the Internet. The search bar also allows you to use the Advanced Search feature so you can enter more specific search criteria. The locator path shows you where you are in the portal taxonomy from the top-level directoryeither My Folders or Public Folders, to the folder currently displayed in the content pane. You can click on any step in the locator path and the corresponding folder will appear in the content pane. This is sometimes referred to as breadcrumbs.
Portal header
Locator Path
24
Description The content pane displays portal pages that contain portlets, folders, items, and lists. The content pane has a title bar that contains Quick Links and three control buttons. These elements are described below.
Footer
By default, the footer is located at the bottom of the page. It is an element of the shell and usually contains useful links or copyright information.
Occupying the bulk of the console, the content pane displays in a portal console. When items are displayed, whether it is a link, file, portlet, and so forth, they are displayed in the content pane. For example, if the user clicks on a portal page, the content pane will populate with that portal page. If the user clicks on a folder, the content pane will display a list of the items in that folder. In either case, the content pane has its own header, which denotes the item being displayed. The following components can be accessed: Quick Links: The Quick Links give portal users immediate access to folders, files, or links that are exposed to users as they browse the portal user interface. Quick Links provide a familiar tabs-based approach to navigating within a folder and offer another level of navigational flexibility to portal users. Item: An item is a file, form, folder, link, portal page, or standalone portlet, on which you can perform various actions, such as set permissions, subscribe, view, and modify properties. Folder: Folders are located under Public Folders and My Folders. Folders contain the original versions of items published to the portal. Buttons: There are three buttons that appear in the title bars of the items displayed in the portal's content pane. This title bar is easily customizable and can be turned on or off per item. By default, each item has a title bar with the following buttons. Contract/Expand: contracts the portlet to display only its title bar, or expands it to its original size. Maximize/Restore: maximizes the portlet to occupy the entire content pane, or restores it to its original size. Tools: opens a menu of tools that allows you to work with portal content. Each item will have its own Tools button, and only commands that are relevant to that item will be available in the menu.
25
Publishing a File
You can add a file to the portal by publishing it to a folder, which saves the file to that folder. You can also create shortcuts to the file in as many folders as needed. Note: To publish a shortcut to a file in a folder, you must first publish the file to a folder.
To publish a file 1 2 3 4 5 6 Browse to the folder to which you want to publish the file, and then click Tools. On the Tools menu, click New and File. On the New content screen, enter a name for the file you are publishing. In the Description field, enter a brief description of the file. In the File field, enter the path to the file you are publishing, or click Browse to browse to it. From the Encoding list, select the correct encoding for the file. The default encoding is Non text (binary).
26
Click Create.
Publishing a Link
You can add a link to a Web page by publishing the link to a folder. You can also publish shortcuts to the link in as many folders as needed. Note: To publish a shortcut of a link to a folder, you must first publish the link to a folder.
To publish a link 1 2 3 4 5 6 Browse to the folder to which you want to publish the file, and click Tools. On the Tools menu, click New and Link. On the New link screen, enter a name for the link you are publishing. In the Description field, enter a brief description of the link. In the URL field, type the URL of the Web page you are publishing. Click Create.
To publish a portal page 1 2 3 4 5 Browse to the folder where you want to create a new portal page. On the Tools menu, click New and Portal Page. On the New Portal Page screen, enter a name for the page you are publishing. Click Create. Browse to the Page you just created.
27
6 7 8
From the Tools menu select Edit Portal Page if you would like to start adding content to the page. From the portlet menu, drag and drop portlets onto the portal page, placing them in the rows and columns as desired. When you have finished adding portlets to the portal page, click Save.
Publishing a Portlet
You can add a portlet by publishing the portlet to a portal page. To publish a portlet 1 2 3 4 Browse to the folder to which you want to publish the portlet, and click Tools. On the Tools menu, click Edit portal page. In the Root list of the Available Portlets panel, click Portlets. In the Portlets list of the Available Portlets panel, click the category that contains the portlet you want to add to the portal page. For example, the Drawing list contains portlets you can use for the placement of images and text. 5 Drag and drop portlets onto the portal page, placing them in the rows and columns as desired. For example, to add an area to contain HTML text, in the Drawing list, drag the HTML Text portlet and drop it into one of the columns on your portal page. 6 When you have finished adding portlets to the portal page, click Save.
28
These tasks are described in the following sections. This task... Change the skin for a portal page Change how a page is rendered Change how an object is rendered Change the number of items displayed in tables Is described here... Changing the Skin on page 29 Changing the Full Page View on page 29 Changing the Portlet View on page 30 Changing the Number of Items Displayed on page 31
To change the skin 1 2 3 On the desktop menu bar, click My Profile. Under Portal User Attributes, select a new skin from the list. Click Apply.
29
To change the full page view 1 2 3 On any folder or portal page, click (Popup Menu) and then click Properties.
From the Properties page, select an option from the full page view list in the Display Property Group. Click Apply. Note: Specifying the default setting means that the system-wide settings for that type of portal object will be used for the view property.
From the Properties page, select an option from the Portlet View list in the Display Property Group. Click Apply. Note: Specifying the default setting means that only the system-wide settings for that type of portal object will be used for the view property.
30
31
32
CHAPTER
33
On the New Portal Page screen, enter a name and a description for the new portal page, and click Create. On the title bar of the portal page you just created, click click Edit portal page. (Popup Menu) and then
Locate the portlets or other portal objects you want to add to the page, and drag and drop them from the portlet selector on to the portal page. When the portal page is complete, click Save.
34
To set a portal page as your Home page Navigate to the portal page you want as your Home page, click and then click Set as Home. (Popup Menu)
To update a file 1 Navigate to the item so that its name is displayed on the portal page. Click the item name to open the file in a new browser window. Note: If you open the document and it does not open in a new browser window, but instead opens in the browser content pane of the existing portal window, click Save As from the browser menu. 2 From the Browser menu bar, click File and Save As.
35
3 4 5 6 7 8 9
Choose the location on your local or network drive to which you want to save the document, and then click Save. Open the document from your local or network drive, make the desired changes and then click Save. Using the webMethods Portal, navigate to the original version of the file so that its name is displayed in the content pane. To the right of the file name and click (Popup Menu) and then click Update.
Click Browse, select the file you just saved to your local or network drive, and then click Open. Click Update to replace the old file with the newly modified version. Change the items properties. Item properties include the name, description, and owner name of an item. By changing the name and description, you will change the information displayed for that item in the content pane. Note: By giving ownership of an item to another user, you will be relinquishing your rights to change and delete an item to the new owner.
To change an items name and/or description 1 2 3 4 5 Navigate to the item so that its name is displayed in the content pane. To the right of the item name, click (Popup Menu) and then click Properties.
In the Name field, type a name for the item. Optionally, use the Description field to type a description for the item. Click Apply.
36
To change portlet properties 1 2 3 Navigate to the portlet so that its name is displayed in the content pane. To the right of the portlet name, click (Popup Menu) and then click Properties.
Moving an Item
You can move an item to a different folder location in portal by using cut, copy, and paste. You can also modify the items location information.
Navigate to the folder where you will add a copy of the item so that its name is displayed in the portal page. To the right of the folder name, click Paste. (Popup Menu) and then click Clipboard and
To cut and paste an item 1 2 3 4 Navigate to the item so that its name is displayed in the content pane. To the right of the item name, click (Popup Menu) and then click Clipboard and Cut.
Navigate to the folder where you want to add the item to so that its name is displayed in the content pane. To the right of the folder name, click Paste. (Popup Menu) and then click Clipboard and
37
Deleting an Item
You can remove an item from the portal by deleting it. When you delete a shortcut to an item from a folder you remove only the shortcut to the item unless otherwise specified. When you delete an item from a folder you remove the item from portal unless otherwise specified, including any shortcuts to that item. To delete an item 1 2 Navigate to the item so that its name is displayed in the portal page. To the right of the item name, click (Popup Menu) and then click Delete.
38
This task... Make your changes to a file available to others View the history of a file and revert it if necessary
To add a file or folder to Version Control 1 2 Navigate to the file or folder so that its name is displayed in the content pane. To the right of the file or folder name, click Control and Add to Version Control. (Popup Menu) and then click Version
To check out a file 1 Navigate to the versioned file so that its name is displayed in the content pane. Note: A versioned file has a Version Control button to the right of the file name. If this button is not present next to the file you want to check out, see Adding a File or Folder to Version Control on page 39.
39
To the right of the file or folder name, click (Popup Menu) and then click Version Control and Check Out. The file you want to check out will open in a new browser window. From the browser menu bar, click File, and then click Save As. Choose the location where you want to save the document, and then click Save.
3 4
To undo file check out 1 2 Navigate to the checked out file so that its name is displayed in the portal page. To the right of the file name, click Undo Check Out. (Popup Menu) and then click Version Control and
Checking In a File
When you are finished updating a file that you have checked out, you can check it back in to make your changes available to others. Checking in a file saves a new version of the file into its file history. It also removes the red check mark that was placed over the Version Control button when you checked the file out. When you check in a file, you can also enter a comment about what you have changed to the file when you check it in. Adding a comment allows viewers to track the specific changes made to the file for each version. To check in a file 1 2 3 4 Navigate to the checked-out file so that its name is displayed in the portal page. To the right of the file name, click (Popup Menu) and then click Version Control and Check In. Click Browse to select the file you would like to check in. Optionally, in the Comments field, add a short description of the changes you made to the file. Click Check It In.
40
Navigate to the previous version of the file to which you want to revert. To the right of the file name, click (Popup Menu) and then click Set Current.
41
To make a previous version of a file available to others 1 Navigate to the versioned file so that its name is displayed in the content pane. Note: A versioned file has a Version Control button to the right of the file. If this button is not present next to the file for which you want to view the history,Adding a File or Folder to Version Control on page 39. 2 3 4 5 To the right of the file name, click View History. (Popup Menu) and then click Version Control and
Navigate to the previous version of the file. To the right of the file name, click (Popup Menu) and then click Publish Version.
Navigate to the folder in which you want to publish this version. Click OK.
42
CHAPTER
43
Finding an Item
If you can recall certain information about the content or properties of an item, you can find the item using the search feature. Or, if you know the general location of the item, you can navigate to the item. For example, My Folders Private.
44
Searching by Description If you know a portion of the description of an item, you can search for the item by typing descriptive keywords into the search bar. To search for an item by description 1 2 3 On the Search bar in the Search list, click Item Properties. In the Search field, type the word or phrase within the description of the item you want to find. Click Search.
Searching by Content Within a File If you know words or phrases contained within the body of a file, you can search for the file by typing this information into the search bar. To search for a file by file content 1 2 3 On the Search bar in the Search list, click Content. In the Search field, type the word or phrase located within the body of the file you want to find. Click Search.
Conducting a Portal Search When searching for items in the portal, you can combine the content and item properties searches using the Portal Search feature. A Portal Search will return resources that contain the query details in the content of the item, as well as the item properties. To conduct a portal Search 1 2 3 On the Search bar in the Search list, click Portal Search. In the Search field, type a descriptor relating to the resource you want to find. Click Search.
Advanced Portal Searching There are many ways you can refine your search using the Advanced Portal Search feature. Use Advanced Portal Search when you want to be more specific in your search, such as searching with multiple criteria, or limiting the search results. These types of searches are described in the following pages.
45
Note: Since webMethods Portal is very customizable, you may have more or different advanced search options than described in the following table. For more information about different advanced search functionality, see your system administrator. For this type of search... Search for an item by the content it contains. Search for an item by name. Search for an item by description. Do this... In the Search field, type a word or words contained in the item content. In the Name field, type a word or phrase within the name of the item you want to find. In the Description field, type a word or phrase contained in the description of the item you want to find. In the Created On list, specify the time period for your search. In the Modified On lists, specify the time period for your search. In the Content Type drop-down, select the appropriate option. In the Extended Types list, select the type of item that you want to find. In the Extended Property list, click Select. From the Selected Property list, select a property, and then click Next. Follow the wizard, selecting or filling in options as they are presented, and then click Select to finish. Note: You must first choose an extended type before you can select an extended property. Search for an item based on its owner name. Limit the total number of search results. In the Owner field, type the name of the owner, or click Select, choose the owner name from the list, and then click Select. In the Maximum Results list, click the number of results you want returned.
Search for an item within the time frame that the item was created or published to the portal. Search for an item within the time frame that the item was modified or updated. Specify a content type: all types, content, link, form, folder. Search for an item based on its type. Extend your search on extended type to include searching by a specific property in the type.
46
For this type of search... Search for items that match all of the search criteria that you have entered, but not necessarily in the order you entered them, OR Search for items that match any but not necessarily all of the search criteria that you have entered. Search for items using basic words you enter into the Search field (concept), OR Search for items by including and/or excluding certain words or phrases you enter into the Search field using AND, BUT, and NOT (boolean operators), OR Search for items by accounting for spelling differences in words or phrases you enter into the Search field (pattern).
Do this... In the Match Criteria list, click how you want the search to use your search criteria. Note: When you select a boolean search method, setting the Match Criteria to All only matches text in the Search text field.
In the Search Method list, click the search method you want to use.
To search using the Advanced Portal Search feature 1 2 3 4 On the Search bar, click Advanced. Choose one or more libraries you would like to search and click Next. Enter the search criteria for the item you want to find. Click Submit.
Saving a Search Once you have executed a search in the portal, you can save this search criteria. This is especially useful when you use the same search criteria on a regular basis. Saving a search will recall the criteria you used for you query, but not the actual results. Note: By default, your search will be saved under My Folders in your Saved Searches folder.
47
To save a search 1 Use either the Portal Search options in the search bar or the Advanced Portal Search screen. Note: You cannot save a search using any of the Web Search options in the search bar. 2 3 4 On the top right of the Search Results screen, click Save Search. Type a name and a short description. Click Create.
After you have saved a search in the portal, you can use it to perform the same search again. To search by using a saved search 1 2 Under My Folders, click Saved Searches to display your searches. Click the search name to start the search.
48
To search for information using Portal Web Search 1 2 3 On the search bar in the Search field, select an Internet search engine under Web Search. In the search field type the word or phrase you want to search. Click Search.
49
For example, an Internet-News/Weather portlet is similar to a news feed that presents live information such as stock quotes or weather forecasts. The Internet-News/Weather portlet lets you view the live information directly from the portal page, or from the folder where you added the Internet-News/Weather portlet. Once configured, the Internet-News/ Weather portlet does not require maintenance in order to present new information. The information it presents is current each time you view it. Alternatively, you can set it up to be cached at regular intervals by your system administrator. For information about adding a portlet to a portal page, see Publishing a Portal Page on page 27. The first step when using notification messages is subscribing to information. When there are changes to information to which you have subscribed, you will be notified through portal, e-mail, or Instant Messenger notification. You can also choose the type of changes you want to be notified about by selecting notification options, such as additions, deletions, and other modifications to information. You can subscribe to portal pages, folders, files, forms, links, and portlets. For this portal resource... Portal page or folder You receive notifications when the resource is... Has its properties or content modified Is added to a folder Is deleted Is moved File Has its properties or content modified. Is deleted Is moved Link Has its properties modified Is added to a folder Is deleted Is moved Portlet Is deleted Is moved Note: You can only subscribe to standalone portlets, which are portlets that have been published to a folder. You cannot subscribe to portlets that have been added to portal pages.
50
This task... Specify how you are to be notified of an event Subscribe to a portal resource Manage your notification messages Modify your subscription options for a portal resource Delete a subscription to a portal resource
Is described here... Setting up Notification Methods on page 51 Setting up a Subscription to a Portal Resource on page 52 Accessing, Showing/Hiding, and Deleting Portal Notification Messages on page 52 Changing a Subscription on page 53 Deleting a Subscription on page 54
To modify settings in the Notification Attribute Provider 1 2 3 4 On the desktop menu bar, click My Profile. On the Profile Page, click the Notification Attributes tab to bring it to the front. To receive notifications by e-mail, in the E-Mail Address field, type the e-mail address to which notifications should be sent. To receive notifications by Instant Messenger, do the following: In the Instant Messenger Service list, select the Instant Messenger service to which notifications should be sent. Valid services are MSN, Yahoo!, AOL, and ICQ. In the field that follows the list, type the user name to which the notification should be sent. 5 Click Apply.
51
In the Subscriptions screen under Notify me when, select one or more of the options listed. Under Delivery Methods, select Email, Portal Notification, Instant Messenger, or any combination of these methods. Click Apply.
To access a notification message 1 Do one or both of the following tasks, depending on the type of notification: For email notifications: open your email Inbox and select the notification message. For Portal Notifications: on the desktop menu bar, click Inbox. Any notifications you have received will be displayed in the content pane. Click the Event name to view the notification message. Note: To return to the Inbox screen from within a notification message, click your browsers Back button. 2 To open the item contained within the subscription, click the item name.
52
To show or hide a portal notification message Click the arrow to the left of the subscription name. To delete a portal notification message 1 2 On the desktop menu bar, click Inbox. Located the unwanted notification from the presented list and click the delete checkbox at the right of the item. Note: You can select multiple items for deletion. 3 At the bottom of the window, click Delete Selected Notifications. Note: You can also delete a notification by opening it individually and clicking Delete Notification.
Changing a Subscription
You can change subscription options for the information to which you have subscribed on the Inbox screen. You can also disable a subscription, which prevents you from receiving messages about the subscription until you choose to enable the subscription again. To change a subscription 1 2 3 4 From the desktop menu bar, click Inbox. To the right of the subscription name, click subscription. (Popup Menu) and then click Edit
Under Notify me when, make your changes by selecting and clearing the appropriate options. Click Apply.
53
Deleting a Subscription
If you no longer want to receive notification messages on information you have subscribed to, you can delete a subscription. To delete a subscription 1 2 On the desktop menu bar, click Inbox. To the right of the subscription name, click subscription. (Popup Menu) and then click Delete
54