IBM Software Services for Lotus
distribution for not
SPVC; for
Installation and Administration of IBM WebSphere Portal 7.0 on Windows guide Student Guide ERC 3.0
Course Code WPL81
Accompanying Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Trademarks
IBM, the IBM logo, and ibm.com are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. These and other IBM trademarked terms are marked on their first occurrence in this information with the appropriate symbol ( or ), indicating US registered or common law trademarks owned by IBM at the time this information was published. Such trademarks may also be registered or common law trademarks in other countries. A current list of IBM trademarks is available on the Web at http://www.ibm.com/legal/copytrade.shtml
The following terms are trademarks of the International Business Machines Corporation in the United States, other countries, or both: AIX® iSeries® Redbooks® distribution DB2® Lotus® System x® DB2 Universal Database™ PartnerWorld® Tivoli® developerWorks® Passport Advantage® WebSphere® Domino® PowerPC® z/OS®for IBM® Rational® zSeries The following terms are trademarks of other companies: not Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both.
Microsoft, Windows, Windows NT, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.
Intel, Intel logo, Intel Inside, Intel Inside logo, Intel Centrino, Intel Centrino logo, Celeron, Intel Xeon, Intel SpeedStep, Itanium, and Pentium are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. SPVC; UNIX is a registered trademark of The Open Groupfor in the United States and other countries. Linux is a trademark of Linus Torvalds in the United States, other countries, or both.
Other company, product, or service names may be trademarks or service marks of others.
guide
June 2011, ERC 3.0
The information contained in this document has not been submitted to any formal IBM test and is distributed on an “as is” basis without any warranty either express or implied. The use of this information or the implementation of any of these techniques is a customer responsibility and depends on the customer’s ability to evaluate and integrate them into the customer’s operational environment. While each item may have been reviewed by IBM for accuracy in a specific situation, there is no guarantee that the same or similar results will result elsewhere. Customers attempting to adapt these techniques to their own environments do so at their own risk.
© Copyright International Business Machines Corporation 2011. All rights reserved. This document Accompanyingmay not be reproduced in whole or in part without the prior written permission of IBM. Note to U.S. Government Users — Documentation related to restricted rights — Use, duplication or disclosure is subject to restrictions set forth in GSA ADP Schedule Contract with IBM Corp. ii © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Contents
Contents
Trademarks ...... ii
Course description...... xv
Course agenda ...... xvii
Lesson 1. Introduction...... 1 Objectives...... distribution ...... 1 Topic A: WebSphere Portal software stack and architecture ...... 2 View of the stack ...... 2 Topic B: WebSphere Portal and the WebSphere Applicatioforn Server...... 8
Lesson 2. Page management ...... 11 Objectives...... not...... 11 Topic A: Navigating and managing WebSphere Portal 7.0 ...... 12 Administrative interface ...... 12 Pages and page hierarchy ...... 12 Topic B: Creating pages and page management...... 14 Designing the page hierarchy ...... 14 WebSphere Portal nodes . . . . SPVC;...... 15 Page layout ...... 22 Portlets and pages . . . . for...... 24 Page Builder...... 27
Lab 2: Exploring portal page hierarchy and portal commands ...... 29 Objectives...... 29 Task 1: Startingguide and stopping WebSphere Portal ...... 30 Checking the server status of WebSphere Portal and WebSphere Portal Application Server ...... 30 Task 2: Signing up as a new user to the portal ...... 32 Task 3: Exploring the portal Administration area as an administrator . . . . . 34 Task 4: Creating a new portal page and placing a portal on it ...... 35 Customizing the Reminder portlet ...... 38 Stopping the WebSphere_Portal instance ...... 40 Task 5: Backing up the WebSphere Portal configuration...... 41
Lesson 3. Deploying portlets ...... 43 Objectives...... 43 Topic A: Portlet deployment ...... 44 AccompanyingStand-alone environment...... 45 Clustered environment ...... 45
© Copyright IBM Corp. 2011. All rights reserved. iii Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic B: Page hierarchy and portlets ...... 51 Exporting and importing the page hierarchy ...... 51
Lab 3: Deploying a portlet ...... 55 Objectives...... 55 Task 1: Verifying that WebSphere Portal is started and logging in ...... 56 Verifying that WebSphere Portal is started ...... 56 Logging in to WebSphere Portal ...... 56 Task 2: Deploying a portlet...... 57
Lesson 4. WebSphere Portal security management ...... 63 Objectives...... distribution ...... 63 Topic A: Overview of role-based security...... 64 Privileges ...... 64 Traversal ...... for ...... 66 Topic B: Defining the portal resource security mechanism ...... 67 Defining the portal resource security mechanism ...... 67 Exploring the resources and roles ...... not...... 67 Topic C: Blocking propagation and role inheritance...... 67 Blocking propagation ...... 68 Blocking inheritance ...... 69 Topic D: Access control settings ...... 70 Initial access control settings ...... 70 Initial portlet access control settingsSPVC; ...... 71 Initial page access control settings ...... 71 Topic E: Granting privilegesfor ...... 72 Granting privileges to a portlet ...... 72 Granting different privileges on a single portlet ...... 75 Topic F: Creating anonymous pages ...... 76 Analyzing role interactions on pages and Portlets ...... 76 Topic G: Traversalguide ...... 77 The need for traversal ...... 77 Traversal scenario ...... 78 Configuring traversal ...... 78 Topic H: Securing your portal page hierarchy ...... 79 Setting resource permissions...... 79
Lab 4: Implementing security and creating a Developer Administration page...... 81 Objectives...... 81 Task 1: Verifying that WebSphere Portal is started and logging in ...... 83 Verifying that WebSphere Portal is started ...... 83 Logging in to WebSphere Portal ...... 83 AccompanyingTask 2: Importing the Human Resources page hierarchy ...... 84 Task 3: Viewing the initial security permissions ...... 85 iv © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Contents
Task 4: Setting and verifying page permissions...... 88 Task 5: Allowing customization ...... 92 Task 6: Setting and verifying portlet permissions...... 96 Task 7: Configuring traversal permissions ...... 100 Task 8: Creating an Administration page for developers ...... 102
Lesson 5. Wikis and blogs...... 109 Objectives...... 109 Topic A: Page Builder theme and a wiki or blog...... 110 Overview of the Page Builder theme ...... 110 Wikis...... 110 Blogs ...... distribution ...... 110 Topic B: Adding a wiki or blog to a page ...... 111 Adding a wiki to a page ...... for ...... 111 Adding a blog to a page ...... 112 Topic C: Deleting wiki or blog content ...... 113 The difference between deleting and purgingnot ...... 113 Deleting wiki or blog content ...... 113 Topic D: Purging wiki or blog content...... 115 Purging a wiki or blog...... 115 Topic E: Assigning access to the wiki or blog ...... 115 Wiki and blog roles...... 116 Configuring access control to wikisSPVC; or blogs ...... 117 Lab 5: Setting up a blog and a wiki...... 119 Objectives...... for...... 120 Task 1: Adding Web Content Management authoring to a base installation ...... 121 Task 2: Adding a blog...... 122 Task 3: Adding a wiki ...... 124 Task 4: Assigningguide users rights ...... 127
Lesson 6. Tagging and rating ...... 133 Objectives...... 133 Topic A: Tag clouds ...... 134 Topic B: Public, private, personal, and community tags...... 134 Topic C: Statistics...... 136 Tagging and rating statics ...... 136 Sharing tagging and rating data with portlets...... 137
Lab 6: Enabling and configuring tagging and rating ...... 139 Objectives...... 140 Task 1: Enabling or disabling tagging and rating for portal users...... 141 AccompanyingTask 2: Enabling and adding words to the blacklist ...... 144 Task 3: Working with whitelist filters...... 150
© Copyright IBM Corp. 2011. All rights reserved. v Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Lesson 7. Attribute-based administration ...... 151 Objectives...... 151 Topic A: Personalization rules ...... 152 Rules ...... 152 Exploring campaigns ...... 152 Topic B: Administering the portal using attribute-based techniques...... 152 Access control and visibility rules...... 153 Policies...... 153 Error condition behavior ...... 153 Topic C: Defining attribute-based administration ...... 153 Examining visibility rules ...... 155 Exploring interactions between security and rules ...... distribution ...... 155 Handling errors...... 156 Topic D: Creating and managing visibility rules ...... for ...... 158 Applying visibility rules to pages and portlets...... 159 Lab 7: Creating rules ...... not...... 161 Objectives...... 161 Task 1: Verifying that WebSphere Portal is started and logging in ...... 163 Verifying that WebSphere Portal is started ...... 163 Logging in to WebSphere Portal ...... 163 Task 2: Validating the ability to apply rules to a portlet ...... 163 Task 3: Working with visibility rulesSPVC; ...... 167 Creating a visibility rule ...... 168 Applying the new rule to a portlet...... 171 Creating and applying a forvisibility rule to a page...... 174
Lesson 8. Virtual portals and realms ...... 177 Objectives...... 177 Topic A: Virtual portals and multiple realms ...... 178 Defining virtualguide portals ...... 178 Defining realms ...... 180 Virtual portals with multiple realms...... 182 Topic B: VMM realm configuration files ...... 182 Topic C: Creating a realm ...... 183 Topic D: Creating a virtual portal ...... 184 Using the Virtual Portal Manager portlet ...... 184 Using the ConfigEngine create-virtual-portal task ...... 185 Topic E: Scoped and non-scoped resources ...... 186 Defining scoped resources...... 186 Defining non-scoped resources ...... 187 Topic F: Virtual portal provisioning script ...... 188
AccompanyingLab 8: Configuring realms and virtual portals...... 191 Objectives...... 191 vi © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Contents
Task 1: Creating a new user realm ...... 193 Task 2: Creating a virtual portal ...... 193
Lesson 9. IBM Syndicated Feed Portlet ...... 197 Objectives...... 197 Topic A: IBM Syndicated Feed Portlet ...... 198 Proxy for the portlet ...... 198 Configuration options for administrators ...... 199 Management implications ...... 200 Topic B: Feeds ...... 201 SSL feeds...... 201 Client-side aggregation ...... distribution ...... 202 Cookies and feeds ...... 203 Portlet proxies ...... for ...... 204 Lab 9: Working with the IBM Syndicated Feed Portlet ...... 205 Objectives...... 205 Task 1: Adding and configuring a syndicated pornottlet ...... 206
Lesson 10. Mashup integration...... 211 Objectives...... 211 Topic A: Defining mashups and iWidgets...... 212 Mashups...... 212 iWidgets ...... SPVC;...... 212 WebSphere Portal and iWidgets ...... 213 Adding an iWidget to a pagefor ...... 215 Topic B: Integrating mashups...... 216 Enabling the Mashups tab ...... 216 Adding a new widget ...... 217 Lab 10: Installingguide and configuring an iWidget...... 219 Objectives...... 219 Considerations ...... 220 Task 1: Enabling mashup integration ...... 221 Task 2: Adding an iWidget ...... 221 Task 3: Getting started with customizing iWidget attributes...... 224
Lesson 11. WebSphere Portal search...... 227 Objectives...... 227 Topic A: Comparing search options ...... 228 Search collections ...... 229 Topic B: Working with WebSphere Portal search...... 232 Search scope ...... 232 AccompanyingSearch links ...... 235 External Search Results portlet ...... 237
© Copyright IBM Corp. 2011. All rights reserved. vii Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Lab 11: Using external search engines ...... 241 Objectives...... 241 Task 1: Configuring external search scopes ...... 242 Task 2: Configuring the External Search Results portlet ...... 244 Updating the Ajax proxy ...... 244 Configuring the External Search Result portlet ...... 249
Lesson 12. Other administrative portlets...... 253 Objectives...... 253 Topic A: Portal clients...... 254 Existing client support ...... 254 Adding support for new clients ...... distribution ...... 255 Topic B: Web clippings...... 255 Defining web clippings ...... for ...... 255 Using the Web Clipping Editor to import content ...... 256 Topic C: URL mapping ...... 258 Defining URL mappings ...... not...... 258 Creating a URL mapping ...... 259 Topic D: Custom names...... 261 Defining custom names ...... 261 Creating custom names ...... 262
Lab 12: Performing miscellaneous administration tasks ...... 265 Objectives...... SPVC;...... 265 Task 1: Using web clippings to import content ...... 266 Creating a new page . . for...... 270 Task 2: Creating a URL mapping ...... 270 Task 3: Creating custom names...... 274
Lesson 13. WebSphere Portal usage analysis...... 277 Objectives. . . . guide...... 277 Topic A: Monitoring portal usage ...... 278 Data points available on the server side ...... 278 Enabling server-side logging ...... 279 Reading the log files...... 282 Topic B: Active Site Analytics for user behavior analysis...... 283 Samples and custom aggregator ...... 285 Adding an aggregator to a page...... 288 Aggregators and themes ...... 289
Lab 13: Enabling and reading the logs...... 293 Objectives...... 294 Task 1: Enabling site analysis logging ...... 295 AccompanyingTask 2: Reviewing the log ...... 299
viii © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Contents
Lesson 14. Theme architecture...... 303 Objectives...... 303 Topic A: Client-side aggregation versus server-side aggregation ...... 304 Page aggregation concepts ...... 304 Understanding aggregation options ...... 304 Topic B: Portal customization and branding...... 307 Defining and creating a brand ...... 307 Defining themes and skins ...... 308 Implementing a theme ...... 314 Adding themes ...... 315 Applying a theme ...... distribution ...... 316 Lesson 15. Installing WebSphere Portal ...... 317 Objectives...... for ...... 317 Topic A: Options, methods, and sources for installing WebSphere Portal. 318 The Base option...... 318 The Full option ...... not...... 318 Installation methods ...... 318 Profiles ...... 324 Topic B: Configuring WebSphere Portal ...... 325 Developer mode...... 325 Empty portal...... 327 SPVC; Lab 15: Installing WebSphere Portal Server 7.0 ...... 329 Objective ...... 329 for Lesson 16. Configuring WebSphere Portal ...... 339 Objectives...... 339 Topic A: Working with the ConfigEngine and the Configuration Wizard. . . 340 ConfigEngine overview ...... 340 ConfigEngineguide Wizard over view ...... 340 How the ConfigEngine works ...... 340 Topic B: Configuring the database ...... 342 Configuration tasks for the database ...... 342 Properties for the database configuration ...... 345 Topic C: Using profiles ...... 350 Profile types ...... 351 Considerations for multiple profiles ...... 352 Creating profiles ...... 354
Lab 16: Configuring the portal database ...... 361 Objectives...... 361 Task 1: Configuring the database ...... 362 AccompanyingCreating DB2 databases ...... 362 Migrating databases to DB2...... 363
© Copyright IBM Corp. 2011. All rights reserved. ix Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 2: Verifying the data transfer ...... 372
Lesson 17. Security for WebSphere Portal ...... 375 Objectives...... 375 Topic A: LDAP-based authentication ...... 376 Overview of LDAP-based authentication ...... 376 Topic B: Portal security ...... 377 Authentication ...... 377 VMM and LDAP integration ...... 380 Stand-alone LDAPs, federated repositories, and multiple LDAPs . . . . . 380 Security for immediate use...... 381 Custom LDAP integration...... distribution ...... 382 Property extension database (formerly the Look-aside database). . . . . 382 External security managers ...... for ...... 382 Lab 17: Enabling portal security using an LDAP repository ...... 383 Objectives...... 383 Task 1: Checking existing users and groups . . not...... 385 Task 2: Editing security property settings...... 385 Modifying security properties ...... 385 Restarting WebSphere_Portal ...... 387 Changing the WebSphere Portal administrator and administration group . . 387 SPVC; Restarting WebSphere_Portal ...... 388 Task 3: Testing the new seforcurity settings ...... 389 Lesson 18. Creating a cell ...... 391 Objectives...... 391 Topic A: Network deployment overview ...... 392 Concepts ...... 392 Architecture guide...... 393 Topic B: Creating a cell ...... 393 Installing network deployment ...... 393 Creating and working with the deployment manager profile ...... 394
Lab 18: Creating a portal cell ...... 401 Objectives...... 401 Task 1: Stopping WebSphere Portal Server, if needed ...... 403 Task 2: Installing the Deployment Manager ...... 404 Task 3: Starting and configuring the Deployment Manager ...... 419 Starting the Deployment Manager ...... 420 Configuring the Deployment Manager ...... 421 Increasing the HTTP connection timeout ...... 422 AccompanyingSetting the requestTimeout for the Java management extensions connector 425 x © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Contents
Changing the maximum Java heap size ...... 430 Creating a WebSphere Portal administrator group ...... 433 Changing the SOAP timeout ...... 436
Lesson 19. Federating a portal node into a cell ...... 439 Objectives...... 439 Topic A: Federating and clustering a WebSphere Portal node ...... 440 Planning ...... 440 Administrative tools ...... 442 Federating the node...... 442 Topic B: Managing a WebSphere Portal cluster ...... 447 Starting and stopping the node agent ...... distribution ...... 447
Lab 19: Federating and clustering the primary node ...... 451 Objectives...... for ...... 451 Task 1: Creating the WebSphere Portal profile template ...... 453 Task 2: Preparing the deployment manager ...... 454 Task 3: Federating and clustering the primary nodenot ...... 455 Federating the node...... 455 Creating a static cluster ...... 456 Creating the cluster definition and adding WebSphere_Portal to the cluster 457 Verifying that the cluster was createdSPVC; ...... 463 Lesson 20. Troubleshooting ...... 467 Objectives...... for...... 467 Topic A: Overview of troubleshooting...... 468 Logs ...... 468 Logging and tracking ...... 468 IBM Support Assistant-lite ...... 469 Topic B: Tools forguide troubleshoot ing ...... 472 Tracing ...... 472
Lab 20: Troubleshooting a portal ...... 477 Objectives...... 477 Task 1: Restarting all servers and checking runtime log files...... 478 Stopping the portal, node agent, and deployment manager on all nodes . . 478 Deleting the log files for the servers...... 479 Starting the deployment manager and node agent and examining the log files ...... 479 Starting the portal nodes ...... 479 Starting the portal server from the administrative console ...... 480 AccompanyingUsing the administrative console to examine the SystemOut and SystemErr logs for each server ...... 480
© Copyright IBM Corp. 2011. All rights reserved. xi Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 2: Enabling tracing for portal components ...... 481 Changing the detail level for tracing on the first cluster member ...... 481 Restarting WebSphere Portal ...... 483 Examining the startup trace information in the trace.log file ...... 483 Logging in to the portal and examining the trace log ...... 483 Task 3: Working with the IBM Support Assistant ...... 484 Task 4: Using the Tivoli Performance Viewer...... 485 Starting the performance viewer ...... 485 Monitoring the portal servlet...... 486 Examining the Tivoli Performance Viewer performance advisor ...... 488 Exiting the Tivoli Performance Viewer and disabling monitoringdistribution on the servers...... 491 Cleaning up your desktop ...... 492 for Lesson 21. XML Access...... 493 Objectives...... 493 Topic A: The XML configuration interface for WebSpherenot Portal...... 494 Overview of the XML configuration interface ...... 494 Working with the XML configuration interface tool ...... 495 Topic B: Examples of when to use XML Access ...... 497 Exporting configurations...... 497 Lab 21: Using XML Access . . . SPVC;...... 501 Objectives...... 501 Task 1: Generating a full export of the WebSphere Portal 7.0 configuration . . 502 for Task 2: Verifying that the export process ran successfully...... 504
Lesson 22. Production topologies ...... 505 Objectives...... 505 Topic A: Productionguide topologies...... 506 Distributed or stand-alone ...... 506 Vertical cluster ...... 507 Horizontal cluster ...... 507 Portal farms, cloud computing, and network deployment infrastructures507 Topic B: Building a development- and a production-ready deployment . . . 514 Planning ...... 514 Considerations ...... 515 Topic C: Reducing single points of failure ...... 517 Portal infrastructure ...... 517 Approaches for reducing single points of failure ...... 518 Topic D: Enabling redundancy for configuration data ...... 519 AccompanyingDefining configuration data ...... 519 Topic E: Evaluating data requirements ...... 520 Evaluating data requirements ...... 520 xii © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Contents
Topic F: Database split options ...... 521 Defining database split options ...... 521 Topic G: Configuring databases for failover ...... 522 Database failover support options ...... 522 Defining scalability ...... 524 Topic H: Capacity planning considerations ...... 524 Topic I: Web Services for Remote Portlets...... 526 Defining WSRP ...... 526 Benefits of WSRP ...... 526 Limitations of WSRP ...... 527
Lesson 23. Managing portlets in WebSphere Portal clustersdistribution ...... 531 Objectives...... 531 Topic A: Deploying portlets in a cluster ...... 532 Clustered portlet deployment task ...... for ...... 532 Clustered portlet deployment process ...... 533 Topic B: Installing or updating a portlet in a cluster ...... 535 Topic C: Synchronizing nodes ...... not...... 535 Topic D: Using XML Access in a cluster...... 536
Lesson 24. Staging to production...... 537 Objectives...... 537 Topic A: Moving from a staging to a production environment ...... 538 Staging versus production . . . SPVC;...... 538 Determining what is moved into production ...... 538 Topic B: Reviewing the releasefor life cycle ...... 539 Overview of the release life cycle...... 539 Topic C: Staging system and production system ...... 540 Defining the staging environment...... 541 Defining the production environment ...... 542 Topic D: Implementingguide releases...... 542 Defining releases ...... 542 Managing releases...... 543 Topic E: Using Release Builder ...... 547 Defining Release Builder ...... 547 Executing Release Builder ...... 547 Exploring release scenarios ...... 548 Topic F: Moving artifacts manually...... 550 Identifying artifacts not supported by Release Builder ...... 550 Moving artifacts manually from staging to production ...... 551
Lab 24: Deploying resources from staging to production ...... 553 Objectives...... 553 AccompanyingTask 1: Exporting the release from production...... 555 Exporting the current configuration using XML Access ...... 555 Verifying that the export process ran successfully ...... 556
© Copyright IBM Corp. 2011. All rights reserved. xiii Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 2: Moving staging resources to production ...... 556 Task 3: Running Release Builder to create a differential release...... 556 Task 4: Importing a differential release (production server) ...... 557 Importing the differential release ...... 557 Verifying that the XML Access command ran successfully ...... 558 Activating the portlet...... 558
Lesson 25. Production procedures ...... 559 Objectives...... 559 Topic A: Backup procedures for the production environment...... 560 Backup procedures ...... 560 Topic B: Applying updates in the production environment . . .distribution ...... 562 Applying WebSphere Application Server updates ...... 563 Applying WebSphere Portal updates ...... for ...... 563 Appendix A. Certification and exam competencies...... 565 IBM Software Service for Lotus training and certification...... 566 Lotus Professional Certification ...... not...... 566 Place in certification ...... 566 Preparing for a Lotus certification exam...... 567 Preparing for the IBM WebSphere Portal 7.0 System Administration exams 569 IBM WebSphere Portal 7.0 SystemSPVC; Administration Exam Competencies . . 570 IBM Lotus Certification Train and Certify promotion...... 577 for Appendix B. IBM WebSphere Portal 7.0 training paths ...... 579 System administrators new to IBM WebSphere Portal 7.0...... 580 System administrators with IBM WebSphere Portal experience ...... 581 Developers who are new to IBM WebSphere Portal 7.0 ...... 582 Developers withguide IBM WebSphere Portal experience ...... 583 Acknowledgements ...... 585
Accompanying
xiv © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Course description
Course description
This comprehensive course combines informative lectures and discussions with relevant activities and labs so that you can administer IBM WebSphere Portal 7.0. In the first half of the course, you practice common day-to-day administration tasks on IBM WebSphere Portal Server 7.0, including portlet installation, security configuration, and WebSphere Portal site management. In the second half of the course, the focus shifts to installation and configuration of WebSphere Portal V7.0. Configurationdistribution includes the database used by WebSphere Portal, federated user registries, and clustering for scalability andfor fault tolerance. Skills taught After completing this course, you shouldnot be able to use the features, functions, and procedures of IBM WebSphere Portal 7.0: Add portlets to pages using the new drag and drop of the page builder Deploy a new portlet Manage access SPVC; Set up a blog and a wiki Set up taggingfor and rating Create and apply visibility rules Work with syndication feeds Integrate mashups Configureguide search Customize or brand the portal Deploy a custom theme Transfer the ready-to-use data from the Derby database to DB2 Universal Database Configure WebSphere Portal to use an IBM Tivoli Directory Server LDAP server Create a Network Deployment cell containing a single node cluster Select the best topology for your organization’s needs Accompanying Turn on logging and tracing
© Copyright IBM Corp. 2011. All rights reserved. xv Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Use XML Access to streamline management activities Back up and restore data Implement release management practices
distribution for not
SPVC; for
guide
Accompanying
xvi © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Course agenda
Course agenda
Day 1 Lesson 1 Introduction Lesson 2 Page management Lab 2 Exploring portal page hierarchy and portal commands Lesson 3 Deploying portlets Lab 3 Deploying a portlet Lesson 4 WebSphere Portal security managementdistribution Lab 4 Implementing security and creating a Developer Administrationfor page Lesson 5 Wikis and blogs Lab 5 Setting up a blog and a wiki not Day 2 Lesson 6 Tagging and rating Lab 6 Enabling and configuring tagging and rating Lesson 7 Attribute-based administration Lab 7 Creating rules Lesson 8 Virtual portlets and realms Lab 8 ConfiguringSPVC; realms and virtual portals Lesson 9 IBM Syndicated Feed Portlet Lab 9for Working with the IBM Syndicated Feed Portlet Lesson 10 Mashup integration Lab 10 Installing and configuring an iWidget
Day 3 Lessonguide 11 WebSphere Portal search Lab 11 Using external search engines Lesson 12 Other administrative portlets Lab 12 Performing miscellaneous administration tasks Lesson 13 WebSphere Portal usage analysis Lab 13 Enabling and reading the logs Lesson 14 Theme architecture Lesson 15 Installing WebSphere Portal Lab 15 Installing WebSphere Portal Server 7.0
Day 4 Lesson 16 Configuring WebSphere Portal Lab 16 Configuring the portal database AccompanyingLesson 17 Security for WebSphere Portal
© Copyright IBM Corp. 2011. All rights reserved. xvii Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Lab 17 Enabling portal security using an LDAP repository Lesson 18 Creating a cell Lab 18 Creating a portal cell Lesson 19 Federating a portal node into a cell Lab 19 Federating and clustering the primary node Lesson 20 Troubleshooting Lab 20 Troubleshooting a portal
Day 5 Lesson 21 XML Access Lab 21 Using XML Access distribution Lesson 22 Production topologies Lesson 23 Managing portlets in WebSphere Portal clusters for Lesson 24 Staging to production Lab 24 Deploying resources from staging to productions not Lesson 25 Production procedures
SPVC; for
guide
Accompanying
xviii © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 1. Introduction
Lesson 1
distribution Lesson 1.Introduction for Welcome to IBM® WebSphere® Portal 7.0. This lesson covers WebSphere Portal architecture and notconfiguration. This lesson includes the following topics: WebSphere Portal software stack and architecture WebSphere Portal and the WebSphere Application Server SPVC; Objectives for This lesson has the following objectives: Explore the WebSphere Portal architecture. Administer WebSphere Portal by using the attribute-based technique.guide Explore default port assignments.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 1 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: WebSphere Portal software stack and architecture
This topic discusses the relationship between the two separate application server instances.
View of the stack
In this section, you examine the difference betweendistribution the two application server instances.
Examining the application server instancesfor WebSphere Portal installation creates two application server instances: not server1 runs the Integrated Solutions Console (ISC). WebSphere_Portal runs the WebSphere Portal-related applications: – WebSphere Portal – WebSphere Content Manager – Virtual Member SPVC;Management
Integrated Solutions Console: WebSphere_Portal also runs the Integrated forSolutions Console. The ConfigEngine and the ConfigWizard each use server1 as a management interface, but you can use the Integrated Solutions Console on WebSphere_Portal when convenient. guide The second server instance in Figure 1-1 on page 3, server1, runs the IBM Integrated Solutions Console and is the target of numerous ConfigEngine tasks. The ConfigEngine tasks are used to execute installation and post-installation configurations.
Accompanying
2 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 1. Introduction
Figure 1-1 Application server instances in WebSpheredistribution Portal The management of the application server can be achieved through the browser-based ISC interface orfor though a scripting interface. In either case, the underlying Java™ Management Extensions (JMX) implementation handles requests to modify settings and state of the applicationnot server and applications that are deployed to the server. Scripts, such as the ConfigEngine scripts, typically start server1 as required and run the scripts against this server instance. WebSphere administrators can also compose scripts to manage server resources such as a database.
Although most of the scripts run equally well against either server, server1 is a much lighterSPVC; weight server in terms of its overall application load. It typically starts and stops much more quickly than the WebSphere_Pfor ortal instance. Attention: Do not delete the server1 instance. Deleting this instance can result in the failure of certain scripts.
Examiningguide the server1 instance The most significant difference between the server1 instance and the WebSphere_Portal instance is the lack of the portal application, the wps.ear file, on this instance. You can use the following WebSphere Application Server administration tools on this instance: The Integrated Solutions Console (GUI) The WebSphere wsadmin scripting tool Custom Java programs
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 3 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Figure 1-2 illustrates the server1 instance.
distribution for not
SPVC; for
Figure 1-2 The server1 instance
Examining the WebSphere_Portal instance Youguide have the following WebSphere Portal administration tools in addition to the WebSphere Application Server tools: The administration portlets of WebSphere Portal XML Access, which is an XML-based scripting tool wpscript, which is a language that augments the WebSphere wsadmin tool
Accompanying
4 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 1. Introduction
Figure 1-3 illustrates the WebSphere_Portal instance.
distribution for not
SPVC;
Figure 1-3 Thefor WebSphere_Portal instance
Defining port assignments Two methods are possible to determine port assignments for each of the server instances. The first method is to start one of the serverguide instances and navigate to the Ports page by using the WebSphere Integrated Solutions Console. This method requires that you know the port number on which the application listens. The second method is to determine the port assignments for the server instances by examining the serverindex.xml file.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 5 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
In the following steps, we explain how to navigate to the Ports page for the first method. These steps apply to either the server1 or the WebSphere_Portal instance. 1. Click Servers → Application servers → (server instance) → Ports. 2. Connect to the Integrated Solutions Console by using either of the inbound admin ports (Figure 1-4).
distribution for Figure 1-4 The inbound admin ports noton server1
Accessing the ISC on the WebSphere_Portal instance: Use the default HTTP port 10042 or default HTTPS port 10032 to access the Integrated Solutions Console on the WebSphere_Portal instance.SPVC; The enterprise applications that are shown as started depend on which administeringfor console, server1 or WebSphere_Portal, you go to. The console shows only those applications that are running in its Java virtual machine (JVM) as running, which is shown in Figure 1-5 on page 7. guide
Accompanying
6 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 1. Introduction
distribution for not
Figure 1-5 EnterpriseSPVC; applications based on the instance
If the first method is not practical, you can employ the second to determine the portfor assignments for the server instances by examining the serverindex.xml document. You can find this document in the notes configuration subdirectory of the profile installation directory.
Theguide serverindex.xml file in this course is in either of the following Microsoft® Windows® directories: c:\IBM\WebSphere\wp_profile\config\cells\portal99\nodes\ portal99 c:\IBM\WebSphere\wp_profile\config\cells\portal00\nodes\ portal00
The Linux® directory for the serverindex.xml file in this course is either of the following directories: opt/IBM/WebSphere/wp_profile/config/cells/portal99/nodes/ portal99 Accompanying opt/IBM/WebSphere/wp_profile/config/cells/portal00/nodes/ portal00
© Copyright IBM Corp. 2011. All rights reserved. 7 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Remember that the root of this directory is normally represented by a variable, such as
You learn about a similar variable later in this course.
Administrators might find it convenient and therefore desirable to define a server identity by using the ICS. Defining a server identity this way brands the browser title bar of the ICS web interface and the banner of the ICS. distribution
Topic B: WebSphere Portalfor and the WebSphere Applicationnot Server The WebSphere Portal installation process creates two separate application server instances, server1 and WebSphere_Portal, which we explain in Topic A: “WebSphere Portal software stack and architecture” on page 2. These instances are more generally known as Java virtual machines. The JVM instance named WebSphere_Portal hostsSPVC; the portal that responds to requests from user devices, such as browsers, as is shown in Figure 1-6. for
guide
Figure 1-6 Application server instances
The WebSphere Application Server incorporates an internal HTTP service. This service is not normally accessed directly by users’ browsers. You might recall the discussion of ports used for WebSphere Portal and the Integrated Solutions Console in AccompanyingTopic A: “WebSphere Portal software stack and architecture” on
8 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 1. Introduction
page 2. These ports are among those to which the embedded HTTP service listens for requests.
In a conventional deployment, an HTTP server, such as the IBM HTTP Server, is installed. The IBM HTTP Server is included as part of the WebSphere Portal installation package.
One component that you install as part of the HTTP server is the WebSphere Plugin. The primary role for the plug-in is to route requests that arrive that have the context root of WebSphere Portal to an appropriate portal instance that can respond the request. The default is /wps/portal. distribution WebSphere Portal derives its configuration from two different sources. The XML files of the applications forserver’s configuration define the application server’s relationship to the portal. The principle application of which portal consists is the wps.ear application file, which is shown in Figurenot 1-7.
SPVC; for
guide
Figure 1-7 The wps preference Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 9 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
In addition, portlets that server business needs and administrative purposes are deployed as enterprise archive (EAR) files. These EAR files collectively represent the programs of which WebSphere Portal consists. WebSphere Portal also has its own configuration databases that store page definitions, page layouts, and many other features of the portal environment.
distribution for not
SPVC; for
guide
Accompanying
10 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 2. Page management
Lesson 2
distribution Lesson 2.Page management for This lesson covers common page and portlet management techniques. not This lesson includes the following topics: Navigating and managing WebSphere Portal 7.0 Creating pages and page management SPVC; Objectives for This lesson has the following objectives: Design an effective page hierarchy. Create a WebSphere Portal page hierarchy. Manage page properties and layouts. Exportguide and import page hierarchies.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 11 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: Navigating and managing WebSphere Portal 7.0
This topic explains how to navigate the administrative interface and the page hierarchy.
Administrative interface
The administration of WebSphere Portal can be donedistribution graphically and through scripting. The graphic interface is delivered through portlets. These portlets are centrally located on the administration pages of the portal. Additionally, portlets arefor available for ad hoc tasks, such as page customization in the context of when a user is facing page hierarchy. not Management of portal resources, such as pages and portlets, can also be done through scripting. Scripting is exposed through two interfaces, the Portal Scripting Interface and the XML Access configuration interface. The portal Release Builder provides an administrative tool for moving configurations from one environment, such as staging, to another environment, such as production. SPVC; The portal administrationfor pages can be accessed, in a default deployment, by using the following URL: http://
In this address, replace
Pages and page hierarchy
The following administrative tasks pertain to portal: Installing portlets Managing portal security Creating and managing pages
A portal page is the means to organize and define what information to display. As an organization element, a page can be the parent, sibling, or child of other organizational elements, Accompanyingincluding other pages and labels.
12 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 2. Page management
Page creation is an administrative task that, at a high level, focuses on the hierarchical arrangement of portal nodes, including portal pages. At a more granular level, page creation consists of the following tasks: Defining a page layout Setting the page properties Placing portlets on a page Setting page security
Page hierarchy is the arrangement of portal pages, labels, and URLs. Pages and labels are referred to as container nodes. Each can serve as a container for other portal nodes. However,distribution only a page can serve as a content container. Typically a label contains page nodes among its child nodes. When a user selects a label, the content of the first child page node is dispforlayed. If a label does not contain any child page nodes, then the “No content is available” message is displayed. not Pages are container nodes and content nodes. As a container node, pages can include, as child nodes, other pages, labels, and URLs. Labels are also container nodes, but they are not content nodes. That is, they cannot show portal content. As container nodes, they can contain other labels, pages and URLs. SPVC; URLs are not container nodes. They are displayed to the user in the page hierarchy with the same presentation as pages and labels. That is, iffor the theme uses a tab menu for example, they provide a similar navigational experience. A URL node either consists of a reference to another WebSphere Portal node, such as a page or label, or the URL refers to an external web URL.
Tableguide 2-1 compares the node types. Table 2-1 Comparison of node types Node type Contains Page Pages, Labels, URLs, portal content Label Pages, Labels, URLs URL Not a container
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 13 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic B: Creating pages and page management
This topic explains how to set up and design a page hierarchy.
Designing the page hierarchy
Designing an effective page hierarchy impacts your ability to manage your portal as it progresses. In general terms, from a user’s perspective, the hierarchy must be both logicaldistribution and predictable. From a maintainability perspective, the two most significant factors of an effective page hierarchyfor design are securability and reusability. An effective page hierarchy has the notfollowing characteristics: Securability The arrangement of pages must take advantage of role inheritance and propagation. Reusability Pages with similarSPVC; layouts use common page templates. Page templates define the initial layout of a new page. The inheritance offor design is a one-time event. Organization Users can navigate the page easily and do not lose a sense of context as it relates to other pages in the hierarchy. Flexibilityguide Pages can be moved with the hierarchy without impacting naming schemes.
Design considerations As you design your hierarchy, consider the information in the following sections.
Portal features The normal process for creating pages is to locate them within the navigable page hierarchy.
The placement of new page content nodes is dependent on the AccompanyingTheme. If you are using the Page Builder theme, you can place
14 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 2. Page management
child nodes at the content root. If you are using an existing theme, such as the WebSphere Portal theme, the child nodes of the content root are not visible. This means, in the latter case, that new pages are created as children of the “Home” label or its equivalent. When defining pages to be used as templates, define them as children of Content Root → Administration → WebSphere Portal → Portal User Interface → Page Templates.
Performance Design your pages and hierarchy with refreshes in mind. Limit the number of portlets per page, and design the portlets to use in-place refresh techniques, such as Ajax. distribution Usability Employ the ability of WebSphere Portal to fixfor column width, which makes it easier to limit the number of columns. Base content on work relevance. not An effective design likely requires the services of an experienced interface designer. Although developers understand the mechanics of creating a hierarchy and pages, they tend to overlook the features that make a hierarchy easy to navigate and a page easy to navigateSPVC; and read. WebSpherefor Portal nodes As mentioned earlier, WebSphere Portal has two primary node types: Label nodes are considered an organizing node, because they doguide not contain WebSphere Portal content. They are used to organize the child pages, labels, and URLs beneath them. They always show the content from the first child page node. Page nodes contain content in the form of portlets. These types of nodes, which are children to the label node, can also have their own children pages and labels.
Label with no page or URL: If a label does not contain a page or URL as a child, the message This page does not support content is displayed in the browser.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 15 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
You begin creating your hierarchy with the Manage Pages window (Figure 2-1).
distribution for not Figure 2-1 Manage Pages window
Creating a new label node A label node is used for organizing children page nodes and does not contain any content.SPVC; A label can contain label nodes as its children. However, if the child label is not parent to a page, the error message This page does not support content is displayed. To function correctly,for all labels must have, at some level, a page (or content node) among its children.
Clicking the New Label button on the Manage Pages window takes you to the Page Properties page (Figure 2-2 on page 17). At a minimum,guide creating a label requires a title, as noted by the Title field in the Page Properties window.
Accompanying
16 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 2. Page management
distribution for not
SPVC; for
guide
Figure 2-2 Page Properties window: Creating a new label node
the Friendly URL name field, you can create friendly URLs when you create a page. The following example shows a friendly URL name: http://
Pages and labels: Pages and labels do not require friendly URL names. Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 17 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
When sharing a friendly URL name, remember that the reference must include the node hierarchy at every level down to the page or label that you want to access. When users access the node, regardless of whether they enter the friendly URL in their browser, the full node hierarchy is displayed in the browser, such as in the example in Figure 2-3. This human readable URL is appended by the WebSphere Portal navigation state information. This means that a user can bookmark the page with a reasonable expectation that the bookmark will remain valid. For persistent bookmarks that will not be affected by changes in the WebSphere Portal node hierarchy, consider using URL Mappings discussed in Lesson 12, “Other administrative portlets” on page 253. distribution for not
SPVC; Figure 2-3 The friendly URL, humanresources, for the HR page
The new label canfor inherit the render mode of the parent or one of two specific modes: client-side aggregation or server-side aggregation. In general, these properties refer to where the effort of rendering the content of the page will occur.
Youguide can select the I want to make this page my private page check box to restrict the page or label your use only. The assumption is that you must at least be an editor.
Important: When you select the I want to make this page my private page check box, the result is a private page when a privileged user creates a page. When an administrative user wants to create a private page, this user must explicitly select this option. A privileged user is a role type that allows users to customize their portal interface. This and other role types are discussed later. Accompanying
18 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 2. Page management
Creating a new page node A page node contains content in the form of portlets and can have its own children page nodes. Creating a new page node is similar to creating a label node. You click the New Page button in the Manage Pages window to access the Page Properties window for the page node.
Creating a page node requires a title, as noted by the Title field in the Page Properties window. Another feature introduced in Version 6.1 is the unique name. The Unique Name field is available at page creation. With a custom unique name, you can assign a more user-friendly internal name to the distributionpage than WebSphere Portal generates for its own use. The custom unique name is exposed in utilities such as XML Access on the export page configurations. Figure 2-4 on page 19for shows an example of creating the page node in the Page Properties window. not
SPVC; for
guide
Accompanying Figure 2-4 Page Properties window: Page node (part 1 of 2)
© Copyright IBM Corp. 2011. All rights reserved. 19 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Figure 2-5 shows the rest of the fields and options in the Page Properties window. The new page can inherit the render mode of the parent or one of two specific modes: client-side aggregation or server-side aggregation. These modes refer to where the effort of rendering the content of the page will occur.
You need to define the type of page that you are creating. The Type of Page list has the following values: Standard Portal Layout – Portlets supply content Static Content distribution – Specify HTML files – Supports globalization for not
SPVC; for
guide
AccompanyingFigure 2-5 Page Properties window: Page node (part 2 of 2)
20 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 2. Page management
Also specify your Page Cache Options, when possible, to enhance performance.
Creating a page from a page template Clicking the Create Page From button on the Manage Pages window takes you to the Page Properties page (Figure 2-6). At a minimum, creating a page from a template requires a title, as noted by the Title field in the Page Properties window. A template should be selected, but if one is not selected, the page that is created is the WebSphere Portal default page. distribution for not
SPVC; for
guide
Figure 2-6 Selecting a template to define a new page
Shared pages Users can share the private pages that they created or customized with individual users and groups of users in the organization. They share these pages by using the Share Page link.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 21 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Changing properties after page creation You can change the page properties by clicking the Properties icon or navigating to the page and clicking Edit Page Properties from the Page menu.
You can complete the following tasks with the Advanced options window (Figure 2-7): Create a list of allowed portlets for this page. Set international titles and descriptions. Set page parameters. Create and map visibility rules. distribution for not Figure 2-7 Advanced options window
Page layout
Page layout can be asSPVC; simple or complex as you choose. In most cases, the best layout is the simplest one. In addition to the provided page layouts,for you can customize the layout to add rows and columns. You can limit the column width based on pixels or percentage. Remember that you cannot limit vertical display length of a portlet or page.
On the Change Layout tab (Figure 2-8 on page 23), you can performguide the following actions: Customize the column layout by using the Show layout tools. Change the column layout by using the Column icons. Add portlets by clicking the Add portlets button.
Accompanying
22 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 2. Page management
distribution for not
SPVC; Figure 2-8 Page Customizer - Change Layoutfor tab When you select a page layout option from Edit Layout, the Layout tools window (Figure 2-9). If Standard Portal Layout was selected for the Type of Page property, the administrator of the pageguide can change its layout.
Figure 2-9 Layout tools window Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 23 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Each page on the Manage Pages portlet has a toolbar of icons to edit a page layout (Figure 2-10).
Figure 2-10 Toolbar options for editing a page layout
Looking at Figure 2-10, from left to right, the first two icons manage the placement of the node in its relationship to other sibling nodes. The third icon, the Document icon, enables you to edit the node properties. You might see a fourth icon, a “looped arrow” icon. This icon, if shown, indicates that thedistribution page is based on a page template.
The remaining icons are Edit Layout, Markfor (meaning prepare to move the page elsewhere in the portal node hierarchy), Set Page Permissions, and Delete icons. not After you select an option to edit the page layout, you can click Show Layout Tools to view the layout tools.
Portlets and pages SPVC; Portlets are applications that adhere to a specification so that they operate within the portal container. An example of the specifications supportedfor by WebSphere Portal are JSR 186 and the newer standard, JSR 286. These small applications are deployed and managed by administrators. After the portlets are available to the portal, a portlet’s content can be rendered when the guideportlet is placed on a page. After a page is placed into Edit Layout mode, you can click the Add portlets button. Then the Edit Layout window (Figure 2-11 on page 25).
You select how you want to search for the portlets by using the Search by field. Note that the portlets are not shown in any particular order when using this option.
Select the portlet or portlets that you want to display on a page and click the OK button. Accompanying
24 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 2. Page management
distribution for not Figure 2-11 Edit Layout window
Locking containers and content The plan to provide users with customizable pages can lead to, in some cases, a need for designers and administrators to protect page elements from beingSPVC; modified or deleted. Portal provides such a mechanism. Containers and their content can be protected by using the Locks tab in the Page Customizer window (Figure 2-12 onfor page 26).
Locking a container and locking container contents have the following distinction: Lockingguide the container prevents modifications to the container. Locking the container content prevents portlets from being added, moved, or removed from the container.
Allowing some users the ability to customize pages provides them with a sense of “ownership” in the portal. You can lock containers and the container content of key areas to retain necessary control.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 25 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
Figure 2-12 Page CustomizerSPVC; - Locks tab Important remindersfor about working with portlets Remember the following points about portlets: Placing a portlet on a page creates a unique portlet instance. – Customize each portlet instance uniquely. –guide Deletion of a portlet instance causes irrecoverable loss of customizations. Lock container content to prevent users from adding portlets to pages. Locking container content might cause performance issues on pages. Restrict portlets that can be placed on a given page.
Accompanying
26 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 2. Page management
Page Builder
Page Builder was introduced in WebSphere Portal 6.1.5 and has become the default theme for WebSphere Portal 7.0. With this feature, administrators and users have a means to rapidly deliver content to target audiences. You can create a page by using mouse clicks. The interface for accessing the Page Builder features, in the default layout, is in the Actions menu of the portal banner.
From the Actions menu, you can choose such actions as New Page, which creates a sibling of the current pagedistribution or label. After the new page is added, you can customize it by using the available actions. for Adding feeds, wikis, and blogs is simple. The process for these tasks is discussed later. not Pages that are created using the Page Builder interface can be customized to employ alternative layouts, styles and content. Such pages include wikis, blogs, and mashup pages that contain widgets. SPVC; for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 27 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
28 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 2: Exploring portal page hierarchy and portal commands
Lab
Lab 2: Exploring portaldistribution page hierarchy and portalfor commands not
This lab helps you explore some of the IBM WebSphere Portal V7.0 features. The tasks include logging in to the portal as an administrator and signing on to the portal as a new user. The goal of this lab is for you to browse the site structure of the portal, focusing first on the AdministraSPVC;tion area. You also create a new page and place a portlet on the new page. for This lab includes the following tasks: Starting and stopping WebSphere Portal Signing up as a new user to the portal Exploring the portal Administration area as an administrator Creatingguide a new portal page and placing a portal on it Backing up the WebSphere Portal configuration
Objectives
This lab has the following objectives: Start and stop the portal. Log in to the portal. Create a new user ID through the sign-up process. Explore the structure of the portal Administration area. Accompanying Create a new page on the portal and place a portlet on it.
© Copyright IBM Corp. 2011. All rights reserved. 29 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 1: Starting and stopping WebSphere Portal
Substitution values: Use the following substitution values when you encounter them in the lab instructions:
Windows:
Checking the server status of WebSphere Portal and WebSphere Portal Applicationguide Server
To check the status of the servers, complete these steps: 1. Open a command prompt and check the
30 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 2: Exploring portal page hierarchy and portal commands
3. If prompted, enter the user name wpsadmin and the password wpsadmin. The WebSphere Application Server instance is server1. The WebSphere Portal Application Server instance is WebSphere_Portal. Both server1 and WebSphere_Portal should be stopped at this time, as shown in the Command Prompt window in Figure 2-13 on page 31.
distribution for
Figure 2-13 Command Prompt not
4. In the
Figure 2-14 Command prompt window
Tip: If security has been enabled, you are prompted for a user ID and password when attempting to stop a server. Starting a Accompanyingserver does not require a user ID and password.
© Copyright IBM Corp. 2011. All rights reserved. 31 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 2: Signing up as a new user to the portal
In this task, you sign up a user to the portal. A user must sign up to receive a user ID, which is required to log in to the portal. Configuring the theme might or might not provide this ability.
Currently, only one user ID exists on the portal, wpsadmin. To create a non-administrator ID, complete these steps: 1. Open a browser window, and in the Address field,distribution enter the following address: http://portal99:10039/wps/portal for Add URL as a trusted site: You must add http://portal99:10039/wps/portal as a trusted site. not 2. On the Welcome page, click the Sign Up link in the page header. 3. In the Profile Management window, enter the following information: a. In the User ID field,SPVC; enter testuser . b. In the Password field, enter testuser. c. In the First Name field, enter Joe. d. In the Lastfor Name field, enter Smith. e. In the Preferred language field, select your language. f. Click OK. All the required fields are marked with an asterisk in the windowguide shown in Figure 2-15 on page 33.
Accompanying
32 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 2: Exploring portal page hierarchy and portal commands
distribution for not
Figure 2-15 Profile ManagementSPVC; page 4. Click Log infor from the confirmation page (Figure 2-16).
guide
Figure 2-16 User creation confirmation page
5. Log in to the portal using the newly created user ID (testuser) and password (testuser). 6. Observe the appearance and functionality of the Home area. Notice that no link to Administration is displayed in the portal. The link is not there because the testuser ID does not have Accompanying administrator rights. 7. Click Log out on the toolbar in the page header.
© Copyright IBM Corp. 2011. All rights reserved. 33 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 3: Exploring the portal Administration area as an administrator
To log in as an administrator and explore the Administration area of WebSphere Portal V7.0, complete these steps: 1. Log in to the portal with a user ID and password of wpsadmin. 2. Click the Administration link. distribution Figure 2-17 shows a general site structure for WebSphere Portal V7.0 that you will use in future labs. for not
SPVC; for
guide
Figure 2-17 WebSphere Portal page
The Administration area of the default portal provides the tools that you need on a regular basis to administer the portal.
Accompanying
34 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 2: Exploring portal page hierarchy and portal commands
Task 4: Creating a new portal page and placing a portal on it
In this task, you explore the portal Home area by using the new testuser ID. To create a new portal page within the Home area Welcome page and place an existing portlet on the page, complete these steps: 1. Log out of the portal and log in using testuser for the user ID and password. The testuser ID does not have administrator authority.distribution Therefore, no Administration link should be at the top of the page. Testuser has a status of Privileged User on the Home page. A privileged user can view portal forconten t, customize pages and portlets, and create new, private pages. 2. Click Actions → New Child Page from the header (Figure 2-18). not
SPVC; for
guide
Figure 2-18 Actions menu
3. In the Create Page window (Figure 2-19), complete the following actions: a. In the Page name field, enter My Page. b. In the Friendly URL Name field, leave My-Page. c. Click the Create Page button.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 35 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution Figure 2-19 Create Page window
The new page is displayed on the headerfor as the My Page tab. 4. Click Actions → Edit Page from the menu bar to edit your new page. not
SPVC; Figure 2-20 My Page tab for 5. Click the Customize button. This will allow you to change the page layout, add portlets, and add content to the page in the next step. guide
Accompanying
36 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 2: Exploring portal page hierarchy and portal commands
6. In the Add Content portlet that is displayed (Figure 2-21), click All in the Browse Content section. In this window, you can add a portlet to a new page.
distribution for not Figure 2-21 Add Content portlet
a. In the Search field, enter Reminder and click the Search icon (magnifying glass button). b. Click the plus sign (+) next to the Reminder portlet (Figure 2-22). SPVC; c. Click Savefor to save your reminder. d. Click Done to stop personalizing the portlet.
guide
Figure 2-22 Reminder portlet Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 37 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
The resulting page (Figure 2-23) confirms that the Reminder portlet was successfully added to the new page.
distribution for not
Figure 2-23 Reminder portlet added to the new page
7. Click Save & Exit SPVC;to save the new page. 8. Verify that the My Page tab is displayed next to the Features tab. for
guide
Figure 2-24 My Page tab
Customizing the Reminder portlet
To customize the Reminder portlet, complete these steps: 1. Navigate to My Page in your portal. The Reminder portlet is already displayed on the page. Accompanying
38 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 2: Exploring portal page hierarchy and portal commands
2. On the Reminder portlet title bar, click the arrow to display the Reminder list and select Personalize (Figure 2-25).
distribution
Figure 2-25 Personalize option for
3. Click Add. 4. In the Reminder dialog box (Figurenot 2-26), in the Enter your reminder text field, enter a reminder (if text is not already entered).
SPVC; for
guide
Figure 2-26 Reminder dialog box Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 39 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
5. Click OK to reload My Page. The new reminder is now displayed in the portlet (Figure 2-27) and click Done.
Figure 2-27 Reminder shown in the portlet
6. Add additional portlets to your page. You can also click Actions → Edit Page → Customize → Changedistribution Layout to change the page layout. Another method to move portlets around the page is to drag and drop them.for 7. Click Log out after you are done.
Stopping the WebSphere_Portalnot instance
To stop the WebSphere_Portal instance, complete these steps: 1. Open a commandSPVC; prompt. 2. Change directories to
The server has stopped when you see the Stop completed message.
Accompanying
40 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 2: Exploring portal page hierarchy and portal commands
Task 5: Backing up the WebSphere Portal configuration
In this task, you back up the portal’s WebSphere configuration, including the XML configuration documents and Java artifacts.
To back up the WebSphere Portal configuration, complete these steps: 1. Open a command prompt. 2. Change directories to
SPVC; for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 41 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
42 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 3. Deploying portlets
Lesson 3
distribution Lesson 3.Deploying portlets for This lesson explains how to deploy portlets.
This lesson includes the following topics:not Portlet deployment Page hierarchy and portlets
Objectives SPVC;
This lesson hasfor the following objectives: Deploy portlet applications. Manage deployed portlets. guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 43 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: Portlet deployment
Portlets are created by developers as web applications that are grouped together in a portlet application, where the deployment unit is a web archive (WAR). These applications are written to one of several portlet APIs. The preferred API is the standard portlet specification, JSR 286. Two older specifications are JSR 186 and the proprietary IBM portlet API. The developer provides the WAR file to the portal administrator for deployment. Other portlet sources include the IBM portal catalog and third-party vendors. distribution Regardless of the source of the portlet, you can deploy portlets in one of three ways. Two methods employ the XML scripting interface, XML Access, and the third methodfor employs a graphic interface, the Manage Web Modules portlet. One approach for employing the XMLnot Access interface can be related to a portlet’s dependency on other J2EE resources, such as Enterprise JavaBeans™ (EJB). This approach is usually described as predeployment. The WebSphere Application Server administrator installs an enterprise application (EAR) to the application server in a predeployment scenario. The portlet or portlets are subsequently registered with the portal by using XML Access. This can be describedSPVC; as ISC + XML Access approach. The former is required to properly configure the enterprise Java components. Thefor latter is required to register the module’s portlets with the WebSphere Portal Server.
Another approach is similar to the first approach, but it does not include the predeployment phase. In this scenario, a web applicationguide archive (WAR file) is deployed directly to the portal where it is registered and installed, by WebSphere Portal, as an EAR file. This can be referred to as the Manage Web Modules portlet only approach.
A third approach employs the XML scripting interface, XML Access. The scripting interface is an alternative frequently used in release management for updating a production environment such that changes introduced in a staging environment are deployed. Web modules, the web archive that contains portlets must be deployed to the target system prior to execution of the XML Access script. The scripting interface is discussed in Chapter 21, “XML Access” on page 493.
AccompanyingThe initial phase of the portlet deployment is the same whether the portal environment is clustered or stand-alone. The difference
44 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 3. Deploying portlets
is in the need to accommodate distribution of the portlet binaries across the members of the cluster before starting the portlet and making it available to the user community.
Stand-alone environment
A single portal instance registers portlets, pages, and other portal resources in a portal database, such as the release database, in a stand-alone environment. This process happens when a web module (WAR file) is uploaded to the portal. In addition, the web module is “wrapped” in an enterprise archive moduledistribution (EAR file) and deployed by the portal to the underlying application server. The portlet or portlets are started immediately in the case of a stand-alone environment. for
Clustered environmentnot
Any portal instance can be selected by the administrator in a clustered environment. This portal instance registers portlets, pages, and other portal resources in a portal database, such as the release database. The registration is known to all members because each memberSPVC; of the cluster shares this (and other) portal databases.
The source binariesfor are not installed directly into the member when the portal instance wraps the web module as an EAR file. These binaries are installed to the cluster as a group. This latter deployment task is managed by the deployment manager and the node agents. guide Portal farms: The purpose of this infrastructure is to provide load balancing and fault tolerance through cluster technology. Beginning with WebSphere Portal 7.0, a load balancing feature called portal farms is provided.
Terms, such as deployment manager, node agent, managed and un-managed nodes, federation, and cell, are defined in Lessons 18 and 19. A cell is a centrally managed collection of application servers. Federation is a term used to describe the incorporation of a node into a cell. The purpose of this infrastructure is to provide load balancing and fault tolerance through cluster technology. Beginning with WebSphere Portal Accompanyingversion 7.0 is a load-balancing feature called Portal Farms. This is discussed in Lesson 22.
© Copyright IBM Corp. 2011. All rights reserved. 45 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
A deployment manager is a WebSphere Application Server that is installed as part of a network deployment cell. A cell is a term that is used to name a number of nodes and application servers that are managed by a single deployment manager. Defining a deployment manager is the first step in creating a cluster.
WebSphere Portal is said to be federated when an instance of it (a node) is added to a cell. A new application server process is created and launched during federation. This process is referred to as a node agent. Node agents contain an application, the fileTransfer.ear file, that facilitates the synchronization of configuration files and binaries with the node on whichdistribution the agent is running. You can find more information about creating clusters and WebSphere Portal later in the course. for An administrator can deploy a WAR file by using an administrative portlet named Web Modules, whether in a clustered or stand-alone environment. A web module is wrappednot in an enterprise archive module (EAR file) and deployed by the portal when it is uploaded to the portal. The deployment, in the case of a cluster, is made to the cluster as a whole, through the deployment manager, and not to the individual constituent members. Synchronization with the deployment manager, in clustered environments, must happen when a web module (WAR file) is deployed. Only after synchronization is completeSPVC; can cluster members start the portlet. A portlet or portlets are installed and started immediately because no synchronizationfor is required with a stand-alone environment. Using the Web Modules portlet The graphical administrative interface for portlet deployment is the Web Modules portlet. On the left navigation bar, expand Portlet Managementguide → Web Modules, as shown in Figure 3-1.
Figure 3-1 Menu showing the Web Modules option
Accompanying
46 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 3. Deploying portlets
The Manage Web Modules portlet is then displayed as shown in Figure 3-2.
distribution for not
Figure 3-2 Managing the Web Modules portlet
The portlet application is displayed in the list of portlets that are available to the portalSPVC; after the portal completes the deployment. The applications are often referred to as a web module (WAR file). The application status will appear in the web modules listing. The application is startedfor if the Status column is blank.
When the window for uploading the web module opens (Figure 3-3), you must provide the full path and file name of the moduleguide that you are attempting to install.
Figure 3-3 Manage Web Modules window Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 47 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Figure 3-4 illustrates the status of an installed and started web module.
distribution for not
Figure 3-4 Manage Web Modules page SPVC; Completing forclustered portlet deployment As previously described, more effort is required when portlets are deployed to a cluster. ConfigEngine provides a task that synchronizes and activates portlets across the cluster. The task, activate-portlets, is executed from the ConfigEngine directory of theguide
You can synchronize the nodes using the Integrated Solutions Console of the deployment manager. In addition, a command line task can be executed from the bin directory of the node agent. To Accompanyinghelp with troubleshooting, check the systemout.log file for both
48 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 3. Deploying portlets
the deployment manager and each node agent to determine the success or lack of success with regard to synchronization.
Configuring portlets Developers can create portlets that are configurable by the administrator. For example, the administrator points the portlet to a specific database server or web service for its content.
Use the Configure Portlet icon to access the Manage Portlets portlet. This portlet is shown in Figure 3-5. distribution for not
SPVC; Figure 3-5 The Manage Portlets portlet for Each portlet has one set of parameters, which is configurable by the administrator. Read-only preferences are set up by the developer.
Settingguide shared settings A portlet that is displayed to a user can be switched to several management modes. These modes include Edit, Edit Shared Settings, and Configure. Which, if any, of these modes are available in the portlet menu depends on whether the menu is available (defined by the skin) or by the user’s role on the portlet such as User, Privileged User, and so on. Figure 3-6 on page 50 shows an example of the menu with the Edit Shared Settings option.
Skin: A skin is a presentation component that wraps portlets on a portal page. Skins and a related term, themes are discussed Accompanyingin Lesson 14.
© Copyright IBM Corp. 2011. All rights reserved. 49 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution Figure 3-6 Edit Shared Settings option on the portlet menu for Users with Editor privileges on a portlet can set default customization values for other users. An example of this might be a line of business application in which managers of each division prefer settings that are consistent withnot their region. Although it is not a line of business application, Figure 3-7 shows how a user can set the preferences for a World Clock portlet.
SPVC; for
guide
Figure 3-7 Setting preferences for the World Clock portlet
Accompanying
50 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 3. Deploying portlets
Topic B: Page hierarchy and portlets
You can propagate your page hierarchy from one portal to another through a simple export and import process. The most common way to do this is to create a page hierarchy on your staging portal, perfecting it, and then setting it up on the production portal by using the export import.
Exporting and importing the page hierarchy distribution
The export and import process provides the ability to move pages and portlets with complete fidelity. Page hierarchiesfor are exported using XML Access. Two mechanisms are available to administrators to employ the XML Access.not Exporting a page hierarchy By exporting a page hierarchy, you can back up page layouts and transport to another system, for example, desktop development to test server, test to staging, or staging to production. SPVC; The first and simplest means of exporting is to use the Manage Pages portlet. You expand Portal User Interface on the Administrative Pages,for if it is not already expanded, and click Manage Pages. You can navigate the portal page hierarchy until you find the top-level node of the tree that you want to export.
When you click the Export icon, you are prompted to choose whetherguide to export the entire page hierarchy or just the selected node. Click Yes to export the hierarchy or No to export just the selected node (Figure 3-8).
Figure 3-8 Manage Pages window Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 51 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
In the Opening pageExport.xml window (Figure 3-9), you are prompted for a file name and storage location of the XML file that is generated by the portlet. Disable pop-up blockers, or the browser will not open the prompt.
distribution for not
Figure 3-9 The Opening pageExport.xml window
This file can be used to restore the page hierarchy or to deploy it to another portal instance,SPVC; as shown in Figure 3-10. for
guide
Figure 3-10 File used to restore the page hierarchy
Importing a page hierarchy You use the XML import portlet and XML Access command-line utility to import pages and portlets to a new system.
Accompanying
52 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 3. Deploying portlets
The process of importing a page is similar. You expand Portal Settings in the left navigation area and click Import XML. In the Import XML window (Figure 3-11), select an upload file. In our example, we choose the file that we exported previously.
distribution Figure 3-11 The Import XML window for You can use the XML Access scripting interface in addition to the graphic interface that is provided by the administration pages. The initial file can be manually written. It is much easier to export a file and then make any necessary edits.not
The XML Access scripting interface is available from the command line of any portal instance. An export command file must be composed to do an export using XML Access. This file is passed to the scripting interface, and two files are generated as a result. One file is the exportSPVC; file that contains the exported data, and the other file is a log of the export process that is executed by the XML Accessfor scripting interface. The result file of an export or a similar file can be passed to the scripting engine to import a page hierarchy using the XML Access scripting interface. In this case, a log file is created indicating the statusguide of the import.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 53 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
54 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 3: Deploying a portlet
Lab
Lab 3: Deploying a portletdistribution for This lab explains how you can deploy new portlets.
This lab includes the following tasks:not Verifying that WebSphere Portal is started and logging in Deploying a portlet
Objectives SPVC;
This lab has thefor following objectives: Verify that WebSphere Portal is started. Log in to WebSphere Portal. Deploy portlet applications. Askguide for assistance: All parts of this lab are conducted on the portal99 virtual machine. Ask your instructor for assistance if you have questions about any steps in this lab.
Substitution values: In this lab, when you see the value
© Copyright IBM Corp. 2011. All rights reserved. 55 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 1: Verifying that WebSphere Portal is started and logging in
In this task, you verify that WebSphere Portal is started and then log in.
Verifying that WebSphere Portal is started distribution To verify that WebSphere Portal is started, complete these steps: 1. Launch a command prompt and changefor directories to
Logging in to WebSphere Portal
To log in to WebSphere Portal, complete these steps: 1. Launch a browser and enter the following address: http://portal99:10039/wps/portal 2. Enter wpsadmin for the user ID and password and click Log in. Accompanying
56 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 3: Deploying a portlet
Task 2: Deploying a portlet
Installing a portlet To install a portlet, complete these steps: 1. Click Administration → Portlet Management → Web Modules and click Install. 2. In the Manage Web Modules window (Figure 3-12), click Browse and select the following: Windows: distribution C:\LabFiles\Lab3\PortalLogViewer.war, and click Open. Then click Next. Linux: for /root/LabFiles/Lab 3/PortalLogViewer.war not
SPVC; for
Figure 3-12 Installing a Web module: Selecting a WAR file guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 57 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
3. Confirm that the PortalLogViewer Application is the portlet that is being installed (as Figure 3-13 illustrates). Click Do not start application and then click Finish.
distribution for not
Figure 3-13 Installing a Web module: Viewing theSPVC; WAR file contents You receive a confirmation message that the installation was successful. for Portlets must be active to be displayed on a page properly. Clicking Start Application during the web module installation process installs and activates the portlet. In contrast, clicking Do not start application during the installation process leaves theguide portlet deactivated. An error message is displayed if a deactivated portlet is added to a page. For this lab, the application was not started to demonstrate the steps to activate a portlet.
Accompanying
58 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 3: Deploying a portlet
4. Enter Portal in the Search field. Ensure that File name starts with is selected in the Search by field, and then click Search. 5. In the list, click the Activate icon (lightening bolt) to activate the portlet. Figure 3-14 shows the PortalLogViewer.war line item.
distribution for not Figure 3-14 PortalLogViewer.war file in the Manage Web Modules window
Adding the portlet to the Features page To add the portlet to the Features page, complete these steps: 1. Click AdministrationSPVC; Page → Portal User Interface → Manage Pages. 2. Click Contentfor Root → Home. 3. In the Manage Pages window (Figure 3-15 on page 60), click the Edit Page Layout icon for the Features page.
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 59 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for
Figure 3-15 Manage Pages window not
4. Click Add Portlets. 5. Search for PortalLogViewer. 6. On the Content tab (Figure 3-16), select the PortalLogViewer portlet check box SPVC;and click OK . for
guide
Figure 3-16 Content tab
7. Click Done.
Accompanying
60 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 3: Deploying a portlet
8. Click Home → Features, and observe that the PortalLogViewer portlet is available as shown in the Features tab (Figure 3-17).
distribution for not
Figure 3-17 Features tab SPVC; for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 61 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
62 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 4. WebSphere Portal security management
Lesson 4
distribution Lesson 4.WebSphere Portal security management for not This lesson provides an introduction to portal security management.
This lesson includes the following topics: Overview of role-based security Defining the portalSPVC; resource security mechanism Blocking propagation and role inheritance Access control settings Granting privilegesfor Creating anonymous pages Traversal Securing your portal page hierarchy guide Objectives
This lesson has the following objectives: Define the portal resource security mechanism. Explain security terminology. Grant access to portal resources to users. Implement security on pages. Implement security on portlets.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 63 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: Overview of role-based security
This topic discusses privileges, propagation, inheritance, and traversal.
Privileges
Conceptually, privilege pertains to the ability, or lackdistribution thereof, for a user to interact with portal resources such as portlets and pages. More specifically, privilege can be understood through an examination of a role type and its relationshipfor with a resource.
WebSphere Portal provides a concrete list of role types, such as Editor and Owner. These role typesnot do not express the scope of a user’s privilege. For example, being an Editor of a page is different than being an Editor of a portlet. Thus, it is only when a role type is associated with a resource does the meaning become clear. WebSphere Portal distinguishes abstract role types from concrete privilege by using the term role to describe the relationship of a role type and a resource.SPVC; For example, Eric has a privilege with the Human Resources page. We mightfor say that Eric’s role is Editor@Human Resources Page. However, Eric does not have a role, but is a member of a role. Consequently, we can describe Eric as being a member of the role Editor@Human Resource Page.
When describing role inheritance and propagation, inheritance occursguide between portlet applications and portlets, and among labels, pages and child labels, and pages.
Propagation
If user privilege is managed only by explicitly setting permissions for each resource, the effort, other than being tedious, is unmanageable. For this reason, propagation is an essential means of managing user privilege. You might recall our discussion about concepts to apply during the design of a page hierarchy. Based on that discussion, you understand that, for propagation to be an effective means of managing user privilege, at least with Accompanyingregard to pages, you must understand the value and mechanisms
64 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 4. WebSphere Portal security management
of propagation. For WebSphere Portal, we are concerned with two such mechanisms, inheritance and traversal. Inheritance
Inheritance assures the propagation of privilege so that descendants derive their security settings from their parent. For example, when assigning rights to the HR page, all child nodes inherit rights by default, which is illustrated in Figure 4-1.
distribution for not
Figure 4-1 HR privileges example
This default behavior SPVC;can be altere d through inheritance blocking. A user’s privilege does not necessarily extend to each child in a given page hierarchy.for A well designed page hierarchy simplifies security role assignments: If an administrator assigns a user group to the Privileged User role on the HR label, by default, the user is implicitly granted theguide same privileges on all child nodes. If the administrator assigns explicit privileges for the same user group or any members of that group, the explicit privileges supersedes the implicit privileges. If a user is a member of two distinct roles on any resource, for example, User and Privileged User, the user gains the highest privileges available by the assignment.
In some cases, it is preferred that a user’s privilege on some resources is blocked while other resources in the same page hierarchy are permitted. Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 65 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Traversal
Traversal is the ability to navigate to a page without having privileges on intermediate pages. Figure 4-2 illustrates a typical scenario where a user has no privileges on HR, Benefits, Payroll, or 401k, but is a Privileged User on Health Care.
distribution for not
Figure 4-2 HR traversal chart
When defining a page hierarchy, circumstances might arise where a user requires access to a page far down in the hierarchy, without having any privileges SPVC;on pages in between. WebSphere Portal uses traversal to handle this scenario implicitly. for The user sees a non-active link for all pages between the top of the hierarchy and the page where they have privileges. The user does not see any content on the pages where the user does not have privileges. The page that is automatically displayed is the first guideone for which the user has explicit privileges. Consider traversal from the perspective or role assignments. When users have access on resources, such as a Page or URL Mapping, they receive implicit permission to navigate to those resources. This means a guaranteed the ability to navigate through all parent resources of those resources. The parent resources show only their title to the user, while the corresponding resource content (for example the portlets on the page) remains inaccessible.
Accompanying
66 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 4. WebSphere Portal security management
Topic B: Defining the portal resource security mechanism
This topic begins by defining the portal resource security mechanism; then it explores the resources and roles of WebSphere Portal.
Defining the portal resource security mechanism distribution
Authorization implementation on the portal is done by assigning permissions to users based on specific predefinedfor roles: Authentication is handled by IBM WebSphere security to determine who the user is. not Authorization is handled by the portal to determine what the user is allowed to do.
Users are assigned resource privileges through the Resource Permissions portlet. SPVC; Exploring the resources and roles for WebSphere Portal defines many different resources that require security role assignments. Resources are the manageable assets of the portal. The most commonly managed resources are pages, portlet applications, and portlets. guide The following items are other common resources: Application templates URL mapping contexts User groups Web modules
Topic C: Blocking propagation and role inheritance
AccompanyingThis topic discusses blocking propagation and role inheritance.
© Copyright IBM Corp. 2011. All rights reserved. 67 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Blocking propagation
The administrator can block the propagation of privileges from parent to child by disabling the roles that should not propagate. Blocking propagation effectively prunes the branch beneath it.
Figure 4-3 illustrates how blocking propagation from the HR label does not affect the propagation of privileges from the Benefits page to its children, Health Care, and 401(k). distribution for not
Figure 4-3 HR blocking propagation chart SPVC; In the Resource Permissions window, clear the Allow Propagation check boxes for all roles to block all propagated rights from HR to any child pages.for Note that Administrator and Security Administrator cannot be blocked. Also, apply explicit rights to the child pages. guide
Accompanying
68 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 4. WebSphere Portal security management
Health Care and 401k still inherit from Benefits based on the window shown in Figure 4-4.
distribution for not
Figure 4-4 Resource Permissions window SPVC; Blocking inheritance
Blocking inheritancefor allows more selective pruning of branches in the page hierarchy. Figure 4-5 shows how you can alter inheritance on the Payroll page to not allow inheritance from its specific parent, the HR label. guide
Figure 4-5 HR blocking inheritance chart
AccompanyingIn the Resource Permissions window, clear the Allow Inheritance check boxes for all roles to block all inherited rights from parent to
© Copyright IBM Corp. 2011. All rights reserved. 69 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Payroll. Again, note that Administrator and Security Administrator cannot be blocked. Payroll’s children still inherit from Payroll even after applying explicit rights to Payroll, as shown in Figure 4-6.
distribution for not
Figure 4-6 The ResourceSPVC; Permissions window for Topic D: Access control settings
This topic discusses portlet access control settings for pages and portlets.guide Initial access control settings
The portal defines the following specific virtual groups that you can use to make security role assignments: Anonymous Portal User This group consists of all portal users who have not yet logged in to the portal (unauthenticated). All Portal User Groups This super group consists of all authenticated users who have Accompanying a membership in another group in the user repository. Use this group to differentiate newly registered users from those who
70 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 4. WebSphere Portal security management
have been set up into other groups who have been assigned specific privileges within the portal. All Authenticated Portal Users This group consists of all portal users who have logged in to the portal. After a user has logged in, the user is no longer a member of the Anonymous Portal User group.
Initial portlet access control settings
The only user that has privileges on a newly deployeddistribution portlet is the user who deployed it. A user must be a member of the Manager role on the virtual resource, WebSphere Portal, to deploy a portlet. for
A user must be granted Privileged User privileges on the portlet application or portlet to customize anot portlet under Edit Portlet Preferences. Otherwise, that user cannot see the Personalize selection on the portlet menu.
Follow these guidelines when defining a user’s default rights on portlets: Deploying a new portletSPVC; applicat ion provides rights to the deployer. Portlets inheritfor role assignments from the portlet application. Average users have no rights on administrative portlets. All authenticated portal users have Privileged User role on most other portlets. guide Initial page access control settings
Consider the following guidelines when defining a user’s default rights on pages: A newly created page inherits rights from its parent. Users have Privileged User rights on the Home page. All child pages inherit these rights. Users can perform the following tasks: – Edit the page layout. – Create private pages. Accompanying – Add, move, and delete portlets. – Customize portlets.
© Copyright IBM Corp. 2011. All rights reserved. 71 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
– Create and delete portlet wires. Grant page access rights in the same way as you grant portlet rights.
Topic E: Granting privileges
This topics demonstrates the steps to grant portlet privileges.
Granting privileges to a portletdistribution
Portlets inherit privileges from their portlet forapplications, similar to how pages inherit privileges from their parent pages. You can block propagation from the application to the portlet, and you can make explicit role assignments to thenot portlet. To grant privileges to a portlet, follow these steps: 1. Click the Administration link. 2. Click Portlet Management → Portlets. 3. Search for the portlet.SPVC; 4. In the Manage Portlets window (Figure 4-7), click the Assign access to portletfor icon (key icon).
guide
Figure 4-7 Manage Portlets window
Accompanying
72 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 4. WebSphere Portal security management
5. In the Resource Permissions window (Figure 4-8), click the Edit Role icon adjacent to the required privilege level.
distribution for not Figure 4-8 Resource Permissions window (part 1 of 4)
6. Click Add to add a group or user (Figure 4-9). SPVC; for
guide
Figure 4-9 Resource Permissions window (part 2 of 4)
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 73 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
7. From the Search for Users or User Groups list (Figure 4-10), select Users or User Groups.
distribution for not
Figure 4-10 Resource Permissions window (part 3 of 4)
Note the Members SPVC;successfully added to the role message in Figure 4-11. 8. Continue addingfor users or user groups by clicking the Add button.
guide
Figure 4-11 Resource Permissions window (part 4 of 4) Accompanying
74 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 4. WebSphere Portal security management
Figure 4-12 shows the results.
distribution for not
Figure 4-12 World Clock window
Granting differentSPVC; privileges on a single portlet
Block inheritancefor from the portlet application the same way that you might block inheritance from a parent page. Privileges are assigned to portlets, not portlet placements. Placing the same portlet on multiple pages does not affect user privileges for the portlet.guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 75 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
To set different privileges on a single portlet, follow these steps: 1. Click the Copy the portlet icon (two sheets of paper). 2. In the Manage Portlets window (Figure 4-13), assign the appropriate rights to the copy.
distribution for not
Figure 4-13 Manage SPVC;Portlets window Topic F: for Creating anonymous pages
This topic discusses role interactions for pages and portlets.
Analyzingguide role interactions on pages and Portlets
Certain interactions exist between privilege settings even though privileges are not inherited between a page and a portlet. The user cannot customize the portlet if a user has Privileged User privileges on the portlet and only User privileges on the page. Customization is not permitted when defining usage scenarios if a user has Privileged User authorization on a portlet and User authorization on the page.
When the user has rights, the user sees a Personalize option on Accompanyingthe menu. However, because the user does not have the rights to
76 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 4. WebSphere Portal security management
change the page or portlet, the Personalize option is not displayed, as you can see in the menu shown in Figure 4-14.
distribution for Figure 4-14 World Clock window not Topic G: Traversal
This topic discusses traversal and presents a typical traversal scenario. SPVC; The need for traversal for Traversal is the ability to navigate to a page without having privileges on intermediate pages.
When defining a page hierarchy, circumstances might arise where a userguide requires access to a page farther down in the hierarchy, without having any privileges on pages in between. WebSphere Portal uses traversal to handles this scenario implicitly.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 77 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Traversal scenario
In a typical scenario, a user has no privileges on HR, Benefits, Payroll, or 401k, but is a Privileged User on Health Care, as illustrated in Figure 4-15.
distribution for
Figure 4-15 Traversal - HR scenarionot Configuring traversal
The user sees a non-active link for all pages between the top of the hierarchy and the page where the user has privileges. The user does not see anySPVC; content on the pages where the user does not have privileges. The page that is automatically displayed is the first one for which the user has explicit privileges. See Figure 4-2 on page 66 for afor traversal illustration.
guide
Accompanying
78 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 4. WebSphere Portal security management
Topic H: Securing your portal page hierarchy
This topic offers best practices for securing portal pages.
Setting resource permissions
Follow these best practices for creating and securing a page and portlet hierarchy: distribution Organize the hierarchy to permit security through inheritance. Assign roles no higher than Privileged User to the average portal user. for Lock container content to prevent users from adding or deleting content. not Copy portlets to assign different levels of access. Assign user the same privileges on the page as the highest privilege portlet. Assume that a user has the highest level of access granted to them by more thanSPVC; one group. for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 79 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
80 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
Lab
Lab 4: Implementing distribution security and creatingfor a Developer Administration not page
This lab describes how security roles are conferred and maintained. SPVC; This lab includes the following tasks: Verifying thatfor WebSphere Portal is started and logging in Importing the Human Resources page hierarchy Viewing the initial security permissions Setting and verifying page permissions Allowing customization Settingguide and verifying portlet permissions Configuring traversal permissions Creating an Administration page for developers
Objectives
This lab has the following objectives: Describe security roles, propagation, and inheritance. Describe initial security settings, virtual users, and groups. Assign permissions to pages and portlets. Accompanying Set resource access for each user group. Create an inheritance block.
© Copyright IBM Corp. 2011. All rights reserved. 81 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Explain traversal permissions. Configure traversal permissions. Create an Administration page.
Ask for assistance: All parts of this lab are conducted on the portal99 virtual machine. Ask your instructor for assistance if you have questions about any steps in this lab.
Substitution values: In this lab, when you see the value
SPVC; for
guide
Accompanying
82 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
Task 1: Verifying that WebSphere Portal is started and logging in
In this task, you verify that WebSphere Portal is started and then log in.
Verifying that WebSphere Portal is started distribution To verify that WebSphere Portal is started, complete these steps: 1. Launch a command prompt. for 2. Change directories to
Logging in to WebSphere Portal
To log in to WebSphere Portal, complete these steps: 1. Launch a browser and enter the following web address: http://portal99:10039/wps/portal Accompanying2. Enter wpsadmin as the User ID and Password. 3. Click Log in.
© Copyright IBM Corp. 2011. All rights reserved. 83 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 2: Importing the Human Resources page hierarchy
You import a Human Resources page hierarchy by using the Import XML Portal Setting in the administration interface. Figure 4-16 illustrates the hierarchy of the Human Resources pages.
distribution for not
Figure 4-16 Human Resources page hierarchy SPVC; To import the Human Resources page hierarchy, complete these steps: for 1. Click Administration → Portal Settings → Import XML in the portal. 2. In the Import XML window (Figure 4-17 on page 85), complete these steps: a.guide Click Browse . b. Navigate to: Windows: C:\LabFiles\lab4\HR.xml file.
Linux: root/LabFiles/PortalSecurity/HR.xml c. Click Import.
Accompanying
84 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
distribution for not
Figure 4-17 Import XML window
3. Click Home. Click the new Human Resources tab (Figure 4-18). SPVC; for
guide
Figure 4-18 New Human Resources tab
Task 3: Viewing the initial security permissions
You declare an administrator and an administrative user group during portal installation, which are assigned initial access. Three Accompanyingpredefined virtual users and groups are also created during portal installation and are used to configure initial access rights for an
© Copyright IBM Corp. 2011. All rights reserved. 85 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
abstract set of users. In this task, you view these initial default permissions. You do not change any permissions at this time, because permissions are assigned later in the lab. 1. Click Administration → Portal User Interface → Manage Pages. 2. Click Content Root → Home. 3. In the Manage Pages window (Figure 4-19), for the Human Resources page, click the Set Page Permission icon (the key icon). distribution for not
SPVC;
Figure 4-19 Managefor pages window Some permissions are preset, by default, for the roles depicted in Figure 4-20. 4. Forguide Administrator , click the Edit Role icon (the pencil icon).
AccompanyingFigure 4-20 Resource Permissions window
86 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
User wpsadmin and the group admins have full administrative rights on this page, which are inherited from the parent node of the Human Resources page. Notice that you cannot delete these members from this role. 5. Navigate back by clicking the Human Resources bread crumb, (Figure 4-21).
distribution for not
Figure 4-21 Resource Permissions window
6. Click the Edit Role icon (the pencil icon) for the Editor role to determine who hasSPVC; editor rights on this page. As shown in Figure 4-22, no members are in this role, which was also inherited from the parent node of the Human Resources page,for and none have been explicitly assigned.
guide
Figure 4-22 Resource Permissions window
7. Navigate back by clicking the Human Resources bread crumb. For Privileged User, click the Edit Role icon.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 87 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
The All Authenticated Portal Users group is listed as an inherited role as shown in Figure 4-23.
Figure 4-23 All Authenticated Portal User group listed as an inherited role distribution
Important: Users lose the Anonymous Portalfor User identity after successfully logging in and become authenticated members of the All Authenticated Portal Users virtual user group. All Authenticated Portal Users are, bynot default, assigned the Privileged User role on non-administrative pages and portlet applications. This access gives all authenticated users the right to make personal customizations.
Task 4: SettingSPVC; and verifying page permissions for In this task, you modify the permissions for Privileged User and User roles on the Human Resources page in this task. You will also block inheritance of the privileged User role to stop personal customizations of the Human Resources page. 1. Navigateguide back by clicking the Human Resources bread crumb. You do not have a choice to clear the Allow Propagation or Allow Inheritance check boxes for the Administrator and Security Administrator roles. 2. On the Human Resources page (Figure 4-24 on page 89), clear the Allow Inheritance check box for the Privileged User role.
Accompanying
88 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
distribution for
Figure 4-24 Resource Permissions window not 3. Observe the Apply button; it is used for the changes to take affect. Selecting Done without first clicking Apply will mean that your changes are not in effect. To illustrate this: a. Uncheck or verify that the Allow Inheritance for the Privileged UserSPVC; role is unchecked. b. Click Done. c. Click the Set Page Permissions icon (the key icon) for the Human Resourcesfor page. Observe that the Allow Inheritance check box is still checked. In this example, the changes were not applied. In contrast,guide any permissions set in the parent node of the Human Resources page for this role are no longer inherited after you apply this change. To illustrate this: d. Uncheck Allow Inheritance for the Privileged User role. e. Click Apply. f. When you see the message Are you sure you want to modify this resource, click OK. 4. Click the Edit Role icon (the pencil icon) for the Privileged User role. No entries should be displayed. Navigate back to the Human Resources page. 5. Click the Edit Role icon for the User role. No members should Accompanying be in this role. 6. Click the Add button to add users or groups to the User role.
© Copyright IBM Corp. 2011. All rights reserved. 89 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
7. As shown in Figure 4-25, Search for Users or User Groups, select Users to see a list of users. In the Search field, type an asterisk (*), and click Search. At this time, you do not choose an individual user. (Your list might not exactly match the screen capture shown below.)
Not all groups are the same: Be sure to select Managers and not mgrs.
distribution for not
SPVC; for
Figure 4-25 Resource Permissions window guide 8. From the Search for Users or User Groups list, click User Groups to see a list of groups. In the Search by field, select All available and click Search.
Accompanying
90 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
9. As shown in Figure 4-26, select the Employees and Managers check boxes. Click OK to add these groups to the User role. (You might need to examine more than one results page since your screen might not match Figure 4-26.)
distribution for not
SPVC;
Figure 4-26 Resource Permissions windowfor
You should see the Members successfully added to the role message and Employees and Managers listed under the “Members in the Role” column, as illustrated in Figure 4-27. guide
Figure 4-27 Resource Permissions window Accompanying 10.Navigate back to the Human Resources page and click Done.
© Copyright IBM Corp. 2011. All rights reserved. 91 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Setting page permissions Members of the Employees and Managers groups, which are now under the User role, can read the Human Resources page. They cannot make any personal changes to it. The changed permissions are propagated to all Human Resources child pages, the pages under Human Resources, which means Employees and Managers will have User role permissions on all pages under Human Resources. You change permissions to some of the pages under Human Resources later in this lab. To set the page permissions, complete these steps:distribution 1. Select the Human Resources page. 2. Click the Set Page Permissions icon for one of the child pages. for 3. Click Edit Role for User. Note that Employees and Managers are members. Navigate back by notusing the breadcrumb trail. 4. Click Edit Role for Privileged User. Note that no members are in this role. Navigate back by using the breadcrumb trail. 5. Click Done. 6. Click Log Out. Enter Employee1 as the User ID and Password and click Log in. SPVC; 7. Click the Human Resources page. Click the page menu and the portlet menu. Notice that you do not have permissions to customize thefor page. 8. Log out and log back in as wpsadmin.
Taskguide 5: Allowing customization In this task, you allow members of the Employees or Managers group the right to customize the Employee Self Service page through the Privileged User role. You also limit access to the Payroll page by creating an inheritance block.
To allow customization, follow these steps: 1. Click Administration and click Manage Pages → Human Resources. 2. For the Employee Self Service page, click Set Page Permissions. Accompanying3. Click Edit Role for the User role. Employees and Managers have User Privileges to this page. The roles are inherited from
92 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
the parent page, Human Resources, which was changed in the previous task. 4. Navigate back to Employee Self Service. 5. Click Edit Role for the Privileged User role. No entries should be displayed because roles are inherited. 6. Click Add and search User Groups, All Available.
Adding personal customization ability Employee Self Service page permissions are inherited from its parent, Human Resources. Employee Self Servicedistribution begins with one portlet, and based on the access set in the previous task, changes cannot be made. Any member of the Employees and Managers role can make personal customizationsfor to the Employee Self Service page by adding them to the Privileged User role. not To add a personal customization ability, complete these steps: 1. Select Employees and Managers and click OK. 2. Navigate back to the Employee Self Service page and click Done to complete the changes.
Creating an inheritanceSPVC; block Because of inheritance, if permissions are changed on the parent page, Human Resources,for they are also changed on the child page, Employee Self Service. Preventing role inheritance, also known as role blocking, prevents the child page from automatically inheriting the same permissions as the parent.
To createguide an inheritance block, complete these steps: 1. Click Home in the breadcrumb trail, and for the Human Resources page, click the Set Page Permissions icon. 2. Click Edit Role for Privileged User and click Add to add the All Authenticated Portal Users group. Click OK. 3. Click Human Resources and click Done. 4. Click Human Resources and click the Set Page Permissions icon for the Employee Self Service page. 5. Click the Edit Role icon for the Privileged User role. Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 93 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
In Figure 4-28, notice that the group, All Authenticated Portal Users, has been inherited from the parent, Human Resources.
distribution
Figure 4-28 Resource Permissions window for
6. Turn off Allow Inheritance for the role if this is not the intended behavior. not a. Select Employee Self Service. b. Clear the Allow Inheritance check box for Privileged User. c. Click Apply and OK to confirm. d. Click the Edit Role icon for the Privileged User role. Notice that the group isSPVC; no longer displayed (Figure 4-29). for
guide
Figure 4-29 Resource Permissions window
e. Click Employee Self Service in the breadcrumb trail and click Done. 7. Navigate to Set Page Permissions for Human Resources. Remove All Authenticated Portal Users from the Privileged Accompanying User role. Navigate back and click Done.
94 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
8. Click Log Out and log back in using Manager1 for the User ID and Password. 9. Navigate to the Employee Self Service page (Figure 4-30).
distribution for Figure 4-30 Human Resources page
10.Click Actions → Edit Page Layoutnot. 11.Click Add Portlets in the right column (Figure 4-31).
SPVC; for
guide
Figure 4-31 Edit Layout window
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 95 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
12.In the Edit Layout window (Figure 4-32), search for the Reminder portlet, select the check box next to the Reminder portlet, click OK. Then click Done.
distribution
Figure 4-32 Edit Layout window for
13.Log out and log back in by using Employee1 as the User ID and Password. Navigate to the Employeenot Self Service page under the Human Resources tab. Only one portlet is on the page. Privileged User permissions have been applied to the Employee Self Service page, which allows users to individually customize the page. SPVC; Task 6: Setting and verifying portlet permissionsfor
You applied permissions to pages in the previous tasks. In this task, you set up portlet permissions. First, you install a portlet, and thenguide you apply permissions to that portlet: 1. Click Log Out. Log back in as wpsadmin for the User ID and Password. 2. Install a portlet application: a. Click Administration → Portlet Management → Web Modules and click Install. b. Click Browse, select the
Windows: C:\LabFiles\lab4\Calculator.war file
Linux: Accompanying root/LabFiles/PortalSecurity/Calculator.war file c. Click Next.
96 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
d. Confirm that the Calculator Web Application is the portlet that is being installed (Figure 4-33). Click Do not start application and then click Finish.
distribution for not
SPVC; Figure 4-33 Manage Web Modules windowfor You receive a confirmation message indicating that the installation was successful. Portlets must be active to display properly on a page. Clicking Startguide Application during the Web Module installation installs and activates the portlet. Installing using the Do not start application parameter leaves the portlet deactivated. It returns an error message (Figure 4-34) if a deactivated portlet is added to a page. The application was not started in this task to demonstrate the steps to activate a portlet.
Figure 4-34 Deactivated portlet message
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 97 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
e. When you see the portlet.war listed, click the Activate icon (the lightening bolt icon) to activate it (Figure 4-35).
distribution for Figure 4-35 Manage Web Modules window
3. Add the portlet to the Retirementnot Benefits page: a. Click Manage Pages. b. Click Content Root → Home to navigate to the Human Resources page. c. Click the Edit Page Layout icon for the Retirement Benefits page. SPVC; d. Click Add Portlets. e. In the Editfor Layout window (Figure 4-36), search for Calculator. Then select the Calculator portlet check box and click OK. guide
Figure 4-36 Edit Layout window
f. Click Done. Accompanying4. Click Home → Human Resources → Retirement Benefits. Note that the Calculator portlet is available.
98 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
5. Log out and log back in as Employee1 or Manager1. Navigate to the Retirement Benefits page. Note that the Calculator portlet is not available for either user ID. 6. Log out and log back in as wpsadmin.
Granting permissions to a portlet Access is granted only to the ID that is used when portlet applications are initially installed, which, in this case, is wspadmin. Permissions have to be granted to the portlet for other user IDs to have access to it. distribution To grant permissions to a portlet, follow these steps: 1. Click Administration → Access → Resourcesfor Permissions. 2. Click Portlets. 3. In the Search field, type Calculator and click Search. Click the Assign Access icon (the keynot icon) for the Calculator resource.
SPVC; for
Figure 4-37 Resource Permissions window 4. Clickguide the Edit Role icon for some of the roles. Notice that Administrator is the only role for which permissions have been assigned. 5. Click the Edit Role icon for the User role. Add Managers and click OK. 6. Click Apply. 7. Log in as Manager1 to verify that you now have permission to view the Calculator portlet.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 99 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 7: Configuring traversal permissions
In this task, you configure traversal permissions. With traversal permissions, you bridge two resources across an object without giving access to that object. Users gain implicit rights to navigate all resources in a page hierarchy based on permissions that are assigned in the parent.
You want all employees to have access to the Human Resources hierarchy, with the exception that only managers distributionhave access to the Payroll page. Employees need a way to access between the Human Resources page and the Hourly page without accessing the Payroll page, which are traversal permissions.for See Figure 4-16 on page 84.
To configure traversal permission, completenot these steps: 1. Limit access to the Payroll page: a. Log in as wpsadmin and click Administration → Access → Resource Permissions. b. Click Pages → Content Root → Home → Human Resources. SPVC; c. Click the Assign Access icon (the key icon) for the Payroll page (Figurefor 4-38).
guide
Figure 4-38 Resource Permissions window
d. Clear the Allow Inheritance check box for the User role, which stops inheritance from the parent, Human Resources. Human resources allowed the Employees and Managers role to view the Payroll page. Accompanying e. Click Apply and then click OK when asked to confirm. The message Propagation/Inheritance modified
100 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
successfully displays if the confirmation was successful shown in Figure 4-39.
distribution for not
Figure 4-39 Resource Permissions window
2. Only wpsadmin has access to the Payroll page at this time. a. Click Home → HumanSPVC; Resources and expand Payroll. b. Click Log Out and log back in as Manager1. Select Human Resourcesfor. The Payroll page should not be visible. c. Log out and log back in as wpsadmin. 3. Navigate back to Payroll Resource Permissions: a. Click Administration → Access → Resource guidePermissions . b. Click Pages → Content Root → Home → Human Resources. 4. Click the Assign Access icon for the Payroll page. Add Managers to the User role. The Manager role now has access to the Payroll page. a. Log out and log back in as Manager1. b. Click the Human Resources page. Note that you have access to the Payroll page, including Salary and Hourly, the permissions for which were inherited from the parent page, Payroll. Accompanying c. Log out and log back in as Employee1.
© Copyright IBM Corp. 2011. All rights reserved. 101 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
d. Navigate to the Human Resources page. Note the you cannot access the Payroll page because the inherited permission for Employees group has no access. e. Log out and log back in as wpsadmin. 5. Configure traversal permissions: a. Click Administration → Access → Resource Permissions. b. Click Pages → Content Root → Home → Human Resources → Payroll. c. Click the Assign Access icon for the Hourlydistribution page. d. Add the Employees group to the User role. Note that the Managers group was inherited from thefor parent page, Payroll. 6. Verify traversal permissions: a. Log out and log back in as Employee1not . b. Navigate to the Human Resources page. You should see Payroll as a title. Expand Payroll and you have access to the Hourly page only. You do not have access to the Salary page. c. Log out and logSPVC; back in as wpsadmin .
Task 8: Creatingfor an Administration page for developers
In this task, you create an Administration page and assign access to aguide limited group of developers in this task. This page allows the assigned users to create pages, add portlets, and define security while restricting their access to your Administration site.
To create an administration page, complete these steps: 1. Create an Administration page for developers. a. Click Administration → Manage Pages → Content Root → Home. b. Click New Page.
Accompanying
102 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
c. Enter the values that are shown in Figure 4-40. Click OK when you are finished.
distribution for not
SPVC;
Figure 4-40 Page Properties window for
d. Click the Edit Page Layout icon for the Developers page. e. Click the Add portlets button. f.guide Search for the Manage Portlets and Manage Web Modules portlets. Select the check box for each portlet and click OK. g. Add another portlet named Resource Permissions by repeating Steps e and f.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 103 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
h. Rearrange the order of the portlets as shown in Figure 4-41. Click Done when you are finished.
distribution for not
SPVC; Figure 4-41 Edit Layouts window for i. Click Home → Developers. Note the three administration portlets. j. Log out and log back in as mgr1. Note that you can see the Developers page and it is blank. Permissions need to be guideadded to it. 2. Add Permissions to the Developers Administration page. a. Log out and log back in as wpsadmin. b. Navigate to the Developers page under Manage Pages. c. Click the Set Page Permissions icon for the Developers page. d. Click the Edit Role icon for the Manager role. Click the Add button and add the group mgrs. Search for All available User Groups. e. Click OK, click Developers in the breadcrumb trail, and Accompanying then click Done.
104 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
3. Add Permissions to the Developers Administration page portlets. a. Click Portlet Management → Portlets. b. Search for the Manage Web Modules portlet. c. Click the Assign access to portlet icon for the Manage Web Modules portlet (Figure 4-42).
distribution for not
Figure 4-42 Manage SPVC;Portlets window d. Click the Edit Role icon for the Manager role and add the group mgrsfor. Search for All Available User Groups. e. Click OK, click Manage Web Modules in the breadcrumb trail, and then click Done. f. Repeat Steps a through d for Manage Pages and Resource guidePermissions.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 105 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
4. Assign Virtual Resource permissions: a. Navigate to Access → Resource Permissions and click Virtual Resources (Figure 4-43). You might have to scroll down.
distribution for not
Figure 4-43 Resource Permissions window
b. Click the AssignSPVC; Access icon for the PORTAL resource. for
guide
Figure 4-44 Resource Permissions window
Accompanying
106 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 4: Implementing security and creating a Developer Administration page
c. Click the Edit Role icon for the Manager role and the group mgrs. Search for All available User Groups and click OK (Figure 4-45).
distribution for not
SPVC; Figure 4-45 Resource Permissions window for d. Log out and log back in as mgr1. Note that you can see the Developers page and all the portlets. You can also see the Administration link, which is not the desired result, because you assigned access to all Administrative portlets guidein the prior step. You need to restrict this access. 5. Restrict access to the Administration link: a. Log out and log back in as wpsadmin. b. Navigate to Access → Resource Permissions and click Virtual Resources. You might need to scroll through the pages. c. Click the Assign Access icon for the PORTAL resource. d. Clear the Allow Propagation check box for the Manager role and click Apply. e. When you see the Are you sure? message, click OK. f. Log out and log back in as mgr1. Note that you can still see Accompanying the Developers page and the portlets. You cannot see the Administration link.
© Copyright IBM Corp. 2011. All rights reserved. 107 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
g. Log out and log back in as Manager1. Note that you can see the Developers page (Figure 4-46). It is blank because you only want the mgrs group to see this page, which is set by the inheritance of the Privileged User role.
Figure 4-46 Developers page distribution 6. Remove permissions for Privileged User: a. Log out and log back in as wpsadmin.for b. Navigate to the Developers page under Manage Pages. c. Click the Set Page Permissionsnot icon for the Developers page. d. Clear the Allow Inheritance check box for the Privileged User role (Figure 4-47). Click Apply, click OK, and then click Done. SPVC; for
guide
Figure 4-47 Removing permissions on the Developers page
e. Log out and log back in as Manager1. Note that you no longer see the Developers page. wpsadmin Accompanying f. Log out and log back in as .
108 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 5. Wikis and blogs
Lesson 5
distribution Lesson 5.Wikis and blogs for WebSphere Portal 7.0 supports the rapid addition of blogs and wikis through the Page Builder theme and web content libraries that are created from predefined templates.not
This lesson includes the following topics: Page Builder theme and a wiki or blog Adding a wiki or blog to a page Deleting wiki or blog content Purging wiki or blogSPVC; content Assigning access to the wiki or blog for Objectives
Thisguide lesson has the following objectives: Review the Page Builder theme. Add a wiki or blog to a page. Delete a wiki or blog from a page. Purge content from a wiki or blog. Assign access to a wiki or a blog.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 109 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: Page Builder theme and a wiki or blog
Wikis and blogs provide an environment that substantively encourages users to collaborate on projects, topics, and other areas of common interest. The benefits of a wiki, for example, can include community participation in constructing a knowledge rich response to FAQs. The Page Builder theme facilitates the creation, customization, and sharing of portal pages. This topic introduces you to the Page Builder theme, wikis, distributionand blogs. Overview of the Page Builderfor theme
The Page Builder theme was introduced in IBM WebSphere Portal 6.1.5 as a way to easily create and notcustomize portal pages. The theme provides one-stop shopping versus having to use several tabs and menus to create, customize, or share a page.
The Tab menu in the Page Builder theme allows developers to work directly on the one tab. They can click the Customize button to add content, or change the style of the current page by selecting from a list ofSPVC; predefined styles and layouts. Content and pages can be moved using drag and drop. for Wikis
A wiki, which is Hawaiian for “fast,” is a website that allows the easyguide creation and editing of interlinked web pages by using a web browser using a simplified markup language or a What-You-See-Is-What-You-Get (WYSIWYG) editor. They are typically powered by wiki software. They are used to create collaborative wiki websites and to power community websites in corporate intranets or in knowledge management systems.
Blogs
A blog, which is a blend of the term web log, is a type of website or part of a website. Blogs are usually maintained by an individual with regular entries of commentary, descriptions of events, or Accompanyingother materials, such as graphics or videos. Entries are commonly displayed in reverse chronological order.
110 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 5. Wikis and blogs
Blogs are used to provide commentary or news on a particular subject. Most are text-based with images and links to other blogs and are interactive, allowing readers to leave comments on the posted information. Audio blogs are known as podcasting. Microblogging is another form of blogging that features short posts, similar to Twitter.
You can tag and rate wiki and blog content.
Topic B: Adding a wiki or blogdistribution to a page for Under the covers, a wiki or a blog is created as a content library. The interface for users to create and edit content is based on the components that are defined by web content developers. You can rapidly create a wiki or a blog withoutnot expending significant extra effort.
The Page Builder theme features a Customize link so that you can easily add a wiki or blog to a page. You can still add a wiki or a blog to a custom pageSPVC; with minor changes to your custom theme. Adding a forwiki to a page You can quickly create and edit content inline with a wiki. Use the following steps to add a wiki to a page: 1. Navigate to a target page. 2. Clickguide Customize to add a wiki to the page. Clicking Customize provides access to portal content. In the Create category, you find several choices including a wiki. Adding the wiki to a page and saving the page causes the system to copy the IBM Web Content Management template library that is used to create a blog or blog library. It also places an instance of the JSR 286 Web Content Viewer on a page. The name that you give your wiki is displayed as the portlet title, library display title, and library name when you use alphanumeric characters, spaces, and characters such as $ - _ . ! () or , Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 111 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Other characters are replaced in the actual library name with characters that are supported by a Web Content Management library. 3. Click New Page to add content to your wiki after it is added to your site. You can click Edit to modify content, and click Delete to delete a wiki from a page.
Adding a blog to a page distribution You can add a blog or blog library to a page if you have editor access to the portal or portal page. Use the following steps to add a blog or blog library to a page: for 1. Create a page to contain the blog. 2. Click Customize to add a blog ornot blog library to the page. Clicking Customize provides access to portal content. In the Create category, you find several choices including a blog. Adding a blog to a page and saving the page causes the system to copy the IBM Web Content Management template library that is used to create a blog or blog library. It also places an instance of the SPVC;JSR 286 Web Content Viewer on a page. The name that you give your blog is displayed as the portlet title, library display title, and library name when you use alphanumericfor characters, spaces, and characters such as $ - _ . ! () or , Other characters are replaced in the library name with characters that are supported by a Web Content Management library.guide 3. You can click Create Post to add content after adding a blog to the page. Click Edit to modify your content, and Delete to delete a post. 4. Click Create Blog after adding a blog library to a page, and then click Create Post to modify any content. You can click Edit to modify your content, and Delete to delete a post.
Accompanying
112 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 5. Wikis and blogs
Topic C: Deleting wiki or blog content
You can delete content from wikis or blogs over time. To maintain performance, you must purge content.
The difference between deleting and purging distribution Deleting content removes the content page from view. It is not the same as deleting a wiki or blog in its entirety, which is a topic of strategic interest to web content architects.for
A content item is no longer displayed as an item for view by consumers of the wiki or blog whennot it is deleted by a user. However, the item persists in the web content library. A second step, normally taken by administrators of the blog or wiki, purges the content from the library.
The distinction is to treat deletions as soft deletes and purges as permanent, irreversibleSPVC; elimination of content. Deleting wikifor or blog content
You must have Editor or Administrator access to delete content items from the wiki or blog interface. To delete wiki or blog content, follow these steps, which are illustrated in Figure 5-1: 1. Clickguide the Delete button that is shown on the content item. 2. When you see the Confirm delete message, click OK.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 113 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
Figure 5-1 Delete window
Restoring deleted content:SPVC; To restore deleted content, use the version management feature of Web Content Management: 1. From the Deletedfor items view, select Versions. 2. In the Versions view, select a version to restore. Click the Restore button. 3. Indicate when to restore the item.
Thisguide process is described in the Web Content Management documentation on the following web page: http://www-10.lotus.com/ldd/portalwiki.nsf/xpViewCategor ies.xsp?lookupName=IBM%20Lotus%20Web%20Content%20Managem ent%207%20Product%20Documentation
Accompanying
114 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 5. Wikis and blogs
Topic D: Purging wiki or blog content
Purging is done by administrators of the wiki or blog.
Purging a wiki or blog
To purge a wiki or blog, follow these steps: 1. Click Applications → Content → Web Contentdistribution Management. 2. Select the wiki library that contains the page or pages that you plan to purge. for Click Preferences → Configure → Library Selection to add the library to the selection list if younot cannot select it. 3. Click Item Views → Deleted Items. 4. Select the appropriate wiki page and click Purge (Figure 5-2).
SPVC; for
guide
Figure 5-2 Deleted Items window
Topic E: Assigning access to the wiki or blog
You can assign access to a wiki or a blog by using the Web Content Libraries administrative portlet in the Portal Content Accompanyingsection of the administrative pages.
© Copyright IBM Corp. 2011. All rights reserved. 115 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Wiki and blog roles
You manage access to wikis and blogs by using one of the roles shown in Figure 5-3. An administrator has Manager access and can assign Editor access, or other roles, to others who need to create and manage content in a wiki, such as deleting and purging content. Other users require Editor access to add or edit wiki content. Remember that editors can modify all content within a wiki. A contributor can view wiki content and rate or tag it.
Contributor role: A contributor is a role type thatdistribution is unique to Web Content Management resources. for not
SPVC; for
guide
Figure 5-3 Roles
Accompanying
116 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 5. Wikis and blogs
Configuring access control to wikis or blogs
Access control to wikis and blogs is managed through the Web Content Management libraries. Creating a new wiki from the Page Builder results in a new web content library of the same name. To configure access control, follow these steps: 1. Click Administration → Portal Content → Web Content Libraries. 2. Navigate to a library to assign access and clickdistribution Set Permissions. 3. Click the Edit Role icon for the Editor role and click Add to assign users or groups to the Editor role.for Search for the users or groups that belong to this role.
Web Content Management: Terms,not such as content library, relate to the Web Content Management application. A content library stores data in the JCR repository of WebSphere Portal. For more information about the Web Content Management application, see the following web page: http://www-10.lotus.com/ldd/portalwiki.nsf/dx/Building_a _web_content_system_wp7SPVC; for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 117 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
118 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 5: Setting up a blog and a wiki
Lab
Lab 5: Setting up a blogdistribution and a wiki for not You can add a user to a portal and grant this user viewer access to the pages that you create, or you can make the page public. Granting page access automatically grants view access to the web content library, which is a new function in IBM WebSphere Portal 7.0. You can also add a user to a portal and grant this user editor access to the pages that you create. Granting editor access automatically grants viewSPVC; access to the web content library (not editor access).
When you add editorfor access to the web content library, you can have view access to the page and editor access to the wiki. You do not need to have editor page access to the page for that ability. Thisguide lab includes the following tasks: Adding Web Content Management authoring to a base installation Adding a blog Adding a wiki Assigning users rights
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 119 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Objectives
This lab has the following objectives: Add Web Content Management to a base installation. Add a blog. Add a wiki. Assign users.
distribution for not
SPVC; for
guide
Accompanying
120 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 5: Setting up a blog and a wiki
Task 1: Adding Web Content Management authoring to a base installation
If you install the product using the Base option, blogs and wikis are not installed. However, you can still manually configure these features after installation.
Web Content Management: These instructions apply only if you installed an offering that includes the blog anddistribution wiki samples. An offering that does not include Web Content Management does not include the blog andfor wiki samples. 1. Open a command prompt in the wp_profile/ConfigEngine directory. not 2. Set up the authoring feature by entering the following command that corresponds to your environment: –Linux ./ConfigEngine.sh configure-wcm-authoring -DPortalAdminPwd=wpsadminSPVC; -DWasPassword=wpsadmin – Windows ConfigEngine.bat configure-wcm-authoring -DPortalAdminPwd=wpsadminfor -DWasPassword=wpsadmin After running the command, the following text is displays: [echo] updated RegistrySynchronized in file wkplc.properties with value: Return Value: 0 3. Installguide the blog and wiki content libraries by entering the following command that corresponds to your environment: –Linux ./ConfigEngine.sh configure-blog -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin – Windows ConfigEngine.bat configure-blog -DPortalAdminPwd=wpsadmin -DWasPassword=wpsadmin
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 121 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 2: Adding a blog
In this task, you add a blog to a page to collaborate with your team on a single topic. You also add a blog library to a page to collaborate with your team on multiple topics in a centralized view.
Editor access: If you have editor access to the portal page, you can add a blog or blog library to a page. See the WebSphere Portal Family Wiki for an example of how you can modify your custom theme to enable the capability of adding blogs and wikis to a page. distribution
To create a page to contain the blog and then to add a blog, complete these steps: for 1. Log in to the portal as wpsadmin. Click Actions → Edit page and click New page. not 2. In the Create Page window (Figure 5-4), enter a new page name and click Create Page.
SPVC; for
guide Figure 5-4 Create Page window for creating a blog
3. Click Actions → Edit Page. 4. Click Customize to see the content that can be added to the page.
Accompanying
122 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 5: Setting up a blog and a wiki
When you click Customize, the IBM Lotus Web Content Management template library (which creates a blog or blog library) is copied, and an instance of the JSR 286 Web Content Viewer is placed on the page (Figure 5-5).
distribution for
Figure 5-5 Creating blogs and wikis not
5. Click the plus sign (+) icon next to the blog or blog library to add it to the page. 6. In the “Add Blog to page” panel (Figure 5-6), type a blog name and click Add. SPVC; for
guide Figure 5-6 Adding a blog
Naming blogs and blog libraries: The name that you provide for the blog or blog library is shown as the portlet title, library display title, and library name when using alphanumeric characters, spaces, and the $ - _ . ! ( ) , characters. Other characters are replaced in the actual library name with characters that are supported by a Web Content Management library. Accompanying7. Click Save & Exit. 8. Click Home.
© Copyright IBM Corp. 2011. All rights reserved. 123 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
9. On the Blog tab, under My Blog (Figure 5-7), click Create Post to add content.
distribution Figure 5-7 Finished blog for Figure 5-8 shows the blog entry. To modify your content, click Edit. To delete a post, click Delete.not
SPVC; for
guide
Figure 5-8 Blog entry
Task 3: Adding a wiki
If you have editor access for the page, you can add a wiki to a page. When you add a wiki to a page, a copy of the wiki template Accompanyingis created using the name that you provided when you added the
124 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 5: Setting up a blog and a wiki
wiki to a page. This copy of the wiki template is used to store wiki page content.
Custom theme: See the WebSphere Portal Family Wiki for an example of how to add blogs or wikis to a custom theme.
To add a wiki, complete these steps: 1. Create a new page called wiki. 2. Go to the new page and click Actions → Edit Page. 3. Click Customize to view the content available.distribution 4. Click the plus sign (+) icon next to the Wiki entry to add the wiki to the page. 5. In the “Add Wiki to page” panel (Figurefor 5-9), enter a name for the wiki. a. Click Save and Exit. not
SPVC; for Figure 5-9 Creating a wiki
Naming wikis: The name that you provide for the wiki shows as the portlet title, library display title, and library guidename when using alphanumeric characters, spaces, and the $ - _ . ! ( ) , characters. Other characters are replaced in the actual library name with the characters that are supported by a Web Content Management library.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 125 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Figure 5-10 shows a finished wiki.
distribution for not Figure 5-10 Finished wiki
6. After adding a wiki to your site, click New Page to add content (Figure 5-11). To modify existing content, select the entry and click Edit. To delete a wiki page,SPVC; click Delete . for
guide
Figure 5-11 New wiki entry Accompanying
126 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 5: Setting up a blog and a wiki
Task 4: Assigning users rights
Users can be granted the following rights: The portal administrator can assign Editor access to you if you need to create and manage blogs within the site. If you are given Editor access to a blog, you can create or modify posts in that blog. If you are given Editor access to a blog library, you can create and modify blogs and you can create and modify posts in that blog library. distribution If you have Manager rights to a blog, you can create, modify, and delete posts and delete comments in that blog. If you are given Manager rights to a blogfor library, you can create, modify, and delete blogs. You can also create, modify, and delete posts and delete commentsnot within the blogs. For wikis, the access indicates whether you can read, tag, or create content. Because the purpose of a wiki is to share content, you must have Editor access to the wiki to create content. Contributors can rate and tag the content only. If the page allows anonymous users to access, they can view the wiki entries butSPVC; they cannot perform any other actions. To add users to the Editor role, as an example of assigning user rights, set the permissionsfor of the page where the wiki resides to allow all users to see it as explained in the following steps: 1. Click Administration and select Portal User Interface → Manage Pages. 2. Inguide the Manage Pages panel (Figure 5-12 on page 128), search for the wiki page that you just created and click Search.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 127 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution Figure 5-12 Manage Pages panel for 3. Select Set Page Permissions. 4. Edit the role for User and click Add. 5. Select the Users and User Groupsnot check box and click OK. All entries are selected (Figure 5-13).
SPVC; for
guide
Figure 5-13 Page resources permissions
6. Select wiki in the bread-crumb trail, and then click Apply to save the changes. Now you can set the permission to the wiki itself.
Accompanying
128 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 5: Setting up a blog and a wiki
7. Click Portal Content → Web Content Libraries (Figure 5-14).
distribution for not
SPVC; for
Figure 5-14 Web Content Libraries guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 129 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
8. Go to the wiki that you just created to assign access and click Set Permissions (Figure 5-15).
distribution for
Figure 5-15 Set permissions not 9. Click the Edit Role icon for the Editor role (Figure 5-16).
SPVC; for
guide
Figure 5-16 Resource permissions
Accompanying
130 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 5: Setting up a blog and a wiki
10.Click Add to assign users or groups to the Editor role (Figure 5-17).
Figure 5-17 Assigning users or groups to the Editordistribution role 11.Search for the available users. for 12.Select the user1 check box as an Editor so that this user can edit the content in the wiki. Then click OK (Figure 5-18). not
SPVC; for
guide
Figure 5-18 Adding role members
13.Select Resources in the bread-crumb trail and edit the role for Accompanying a contributor.
© Copyright IBM Corp. 2011. All rights reserved. 131 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
14.Add user2 as a member of the Contributor role (Figure 5-19).
distribution
Figure 5-19 Wiki contributor role for
15.Select Resources in the bread crumb. 16.Click Apply to save and apply yournot changes. 17.Click Done to return to the Web Content Libraries list. You can log in as user2 (password=user2). Now you see that you can tag and rate the content. 18.Log in as user1 (password=user1). Now you see that you can also create or edit SPVC;the content. for
guide
Accompanying
132 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 6. Tagging and rating
Lesson 6
distribution Lesson 6.Tagging and rating for This lesson provides an introduction to tagging and rating.
This lesson includes the following topics:not Tag clouds Public, private, personal, and community tags Statistics SPVC; Objectives for This lesson has the following objectives: Review tag clouds. Explain public, private, personal, community, and anonymous tagging,guide and rating. Explain tagging and rating statistics.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 133 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: Tag clouds
A tag is a non-hierarchical keyword that is assigned to content found on the web. As such, a tag cloud is a visual representation of content that is represented by these terms. Content that is most frequently tagged by a particular word is highlighted in such a way that the visual impact is more pronounced.
WebSphere Portal 7.0 users can tag or rate portal content and view the tags and ratings. Portal resources that can be tagged include Web Content Management pages, portaldistribution pages, portlets, images, and custom resources, such as items in an online store.
Essentially, all uniquely identified portal resforources can be tagged. Tag clouds are displayed by the Tag Cloud portlet.
Important: A default portal installanottion supports tagging and rating of pages for the Page Builder theme only. The Tag Center might not be displayed as expected if you select the Portal theme as the default site theme.
SPVC; Topic B: Public, private, personal, and communityfor tags
Users can choose between applying a tag or rating as private or public. Tags can also be considered as personal tags or community tags. This topic discusses public, private, personal, andguide community tagging. This topic also discusses anonymous users. This information also applies to ratings.
Private tags Private tags can be seen only by the user who applied it. They have the following usage guidelines: A user can apply the same private tag only once to one specific resource. A user can apply the same tag to multiple resources. This means that an individual user can use the same tag more than once and only once per resource. Accompanying A user can only delete private tags that the user has applied. Users with a Manager role have more rights.
134 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 6. Tagging and rating
Public tags All public tags from all users can be seen by all users who belong to the community and who have access to the resource itself, independent of who created the tag or rating. They have the following usage guidelines: A user can apply the same public tag only once to one specific resource. A user can apply the same public tag to multiple resources, meaning that an individual user can use the same tag more than once and only once per resource. The same public tag can be applied to the samedistribution specific resource by multiple users. All users can apply the same tag, or rating, to a resource once. As a result,for the resource can have the same tag applied to it multiple times. Users can only delete public tags that they have applied. Users with a Manager role have more rights. not Personal tags Personal tags are applied by a specific user. Users apply the tag to the resource as a personal tag when they tag a resource. As noted earlier, public tags can be seen by everyone who belongs to the community, and privateSPVC; tags can only be seen by the user who created the tag.
Community tagsfor Public tags become community tags when they are shown to users, which means that community tags are always public. Community tags can be seen by all users who belong to the community,guide not only by the user who created the tag. Anonymous users Anonymous users of WebSphere Portal can tag and rate portal content if an administrator adds the anonymous user to the appropriate roles. The following side effects can occur because WebSphere Portal cannot distinguish one anonymous user from another: Tagging: A user can only apply the same tag to the same resource once. An anonymous user can apply the same tag to the same resource multiple times. Rating: A user can rate a single resource only once. An Accompanying anonymous user can rate the same resource more than once.
© Copyright IBM Corp. 2011. All rights reserved. 135 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Analogy: Anonymous tagging is similar to stuffing the ballot box. Anonymous users can tag as often as they want.
Topic C: Statistics
This topic discusses deriving and sharing tagging and rating statistics. distribution Tagging and rating statics
You can obtain the tags and tag counts for fora specific portal page or all tags that a specific user has applied. You can write queries for more detailed statistics or create a user interface to visualize them. not
The portal provides a Java Model API and a RESTful API that relates to tagging and rating. You can also extend the included Dojo widget user interface. For example, you can enhance tagging and rating in the following ways: Create additional querieSPVC;s about different aspects of the tagging and rating behavior of your WebSphere Portal users. Build additionalfor user interfaces to show the statistics about the tagging and rating behavior of your WebSphere Portal users. Implement additional functionality by exploiting the tags through access to the shared render parameters. Portlets on a page can then react to what is currently happening in the tag widget.guide
Meta information about tags and ratings is already collected. Therefore, extracting and performing additional statistical analysis of existing tags and ratings involves accessing the meta information and performing your own analysis.
The Java API that the portal provides for tagging and rating follows the pattern of the portal controller SPI. For more information, see “The Java API” wiki page at the following address about the portal controller API: http://www.lotus.com/ldd/portalwiki.nsf/dx/ AccompanyingThe_Java_API_wp7
136 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 6. Tagging and rating
The REST API provides the ability to work with tagging and rating. For more information, see the following web address: http://www.lotus.com/ldd/portalwiki.nsf/dx/ The_REST_API_wp7
Sharing tagging and rating data with portlets
You can implement additional functionality by exposing tag information or properties as a shared render parameter,distribution which can be consumed by other portlets. Thus, other portlets on a page can react to what is currently happening on the page with respect to tagging and rating. for
Scenario: The page can dynamically display the most popular component that is maximized by usingnot the tag information components on a page.
SPVC; for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 137 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
138 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 6: Enabling and configuring tagging and rating
Lab
Lab 6: Enabling and distribution configuring taggingfor and rating not
In the past years, a shift has occurred in the way that content is added to web-based systems. Previously, dedicated authors were responsible for adding content. Today, entire communities contribute. As a result, these systems grow quickly and become uncoordinated. SPVC; Tagging and ratingfor have become popular collaboration techniques that introduce new ways to organize and structure content. With tagging and rating, users can better organize, categorize, and find portal content, including Web Content Management and custom content. For example, users can tag or rate books in an online bookstore. You can tag or rate portal content and view the tags andguide ratings.
With the blacklist filter, you can block selected terms from being used as tags, such as terms that might be perceived as offensive. If you enable the blacklist filter, the portal checks every term that users type as a tag before it is eventually applied and stored. If a user types a term that is listed on the blacklist, the portal blocks this tag and responds with a message. You can determine the terms that you want on the blacklist by using the XML configuration interface.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 139 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
This lab includes the following tasks: Enabling or disabling tagging and rating for portal users Enabling and adding words to the blacklist Working with whitelist filters
Objectives
This lab has the following objectives: Enable or disable tagging and rating for portaldistribution users. Enable and add words to the blacklist. for not
SPVC; for
guide
Accompanying
140 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 6: Enabling and configuring tagging and rating
Task 1: Enabling or disabling tagging and rating for portal users
Tagging and rating are enabled in the Page Builder theme, which is the default portal theme. Use the following configuration properties to disable and enable tagging and rating globally for the entire portal: To disable and enable tagging portal wide, use the com.ibm.wps.cp.tagging.isTaggingEnabled property. To disable and enable rating portal wide, use distributionthe com.ibm.wps.cp.rating.isRatingEnabled property.
To enable rating or tagging in the WebSpherefor App lication Server administrative console, complete these steps: 1. In the left navigation pane of the Integrated Solution Console (https://localhost:10032/ibm/consolenot (Figure 6-1), click Resources → Resource Environment → Resource Environment Providers.
SPVC; for
guide
Figure 6-1 Integrated Solution Console - Resources
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 141 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
2. In the “Resource environment providers” panel (Figure 6-2), select the WP CPConfigurationService.
distribution for not
SPVC; for
Figure 6-2 Resource environment providers panel guide
Accompanying
142 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 6: Enabling and configuring tagging and rating
3. In the WP CPConfigurationService panel (Figure 6-3), select Custom Properties check box.
distribution for
Figure 6-3 WP CPConfigurationService configuration panel not
SPVC; for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 143 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
4. In the Custom properties panel (Figure 6-4), verify that the first two list items, which enable tagging and rating, are set to true.
distribution for not
SPVC; for
guide
Figure 6-4 Custom properties panel
Task 2: Enabling and adding words to the blacklist
In the following steps, we continue our procedure from Task 1 “Enabling or disabling tagging and rating for portal users” on page 141, and explain how to enable and add words to the Accompanyingblacklist:
144 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 6: Enabling and configuring tagging and rating
1. Scroll through the Custom Properties list and select the com.ibm.wps.cp.filter.tagging.blacklist property to enable the blacklist filter (Figure 6-5).
Figure 6-5 Blacklist property
2. In the Configuration panel (Figure 6-6), set the value for com.ibm.wps.cp.filter.tagging.blacklist to true. Then click Apply. distribution for not
SPVC; for
Figure 6-6 Setting the blacklistguide value to true
3. In the message that is displayed at the top of the page (Figure 6-7), click Save.
AccompanyingFigure 6-7 Saving the changes
© Copyright IBM Corp. 2011. All rights reserved. 145 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
4. Use the code in Example 6-1 to create an XML file and name it blacklist.xml.
Example 6-1 The blacklist.xml file
DefaultBlacklistFilter: This XML file registers the two words whatever and badword with the blacklist filter for all locales. You must specify DefaultBlacklistFilter for the attribute ID of theSPVC; tag filter. You can optionally specify the attribute locale for the tag filter data. After you run this XML script, usersfor cannot use whatever or badword as tags. You can import the blacklist filter by using the XML Access or the Import XML on the Administration page. guide
Accompanying
146 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 6: Enabling and configuring tagging and rating
5. Log in to WebSphere Portal (http://portal99:10039/wps/portal) as wpsadmin and select Administration, in the left navigation pane (Figure 6-8). Click Portal Setting → Import XML.
distribution for not
SPVC; for
Figureguide 6-8 Selecting Portal Setting → Import XML
6. In the Import XML panel (Figure 6-9), select the blacklist.xml file that you just created and click Import.
Accompanying Figure 6-9 Importing the XML file
© Copyright IBM Corp. 2011. All rights reserved. 147 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
7. Click View Details to see the results as displayed in Figure 6-10.
distribution
Figure 6-10 Blacklist import results for 8. Restart the WebSphere Portal Servernot to update your configuration changes. 9. Go to the wiki or blog page that you created and tag it with a word in the blacklist (Figure 6-11).
SPVC; for
guide
Figure 6-11 Entering a blacklist word on a blog page
Accompanying
148 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 6: Enabling and configuring tagging and rating
Figure 6-12 shows the tag error message.
distribution for not
Figure 6-12 Tag error message
10.Export all the tags to see the list of tags that you entered (Example 6-2). a. Save the text ofSPVC; Example 6-2 into an xml document. b. Log into Portal and go to Administration → Portal Settingsfor→ Import XML. c. Import the xml document. d. Click Import. e.guide Click View Details to see the tag export. Example 6-2 Exported tags
© Copyright IBM Corp. 2011. All rights reserved. 149 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 3: Working with whitelist filters
You can use the XML configuration interface to configure both blacklist and whitelist filter lists. To work with the whitelist, adapt the examples by changing the ID of the filter from DefaultBlacklistFilter to DefaultWhitelistFilter. Sample scripts for the XML configuration interface are in Windows: C:\IBM\WebSphere\PortalServer\doc\xml-samples Linux: distribution /opt/IBM/WebSphere/PortalServer/doc/xml-samples
Whitelist definition: Blacklist filters prohibifort specific terms only. Conversely, whitelist filters allow only those terms defined in the whitelist. The portal checks every term that users type as a tag before it is eventually applied and stored.not
SPVC; for
guide
Accompanying
150 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 7. Attribute-based administration
Lesson 7
distribution Lesson 7.Attribute-based administration for not This lesson discusses attribute-based administration using personalization rules and theme policies
This lesson includes the following topics: Personalization rules Administering the SPVC;portal using attribute-based techniques Defining attribute-based administration Creating and managing visibility rules for Objectives
Thisguide lesson has the following objectives: Define attribute-based administration. Create a visibility rule. Manage visibility rules. Assign visibility rules to portlets. Assign visibility rules to pages. Define attributes. Create a theme policy.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 151 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: Personalization rules
Personalization shapes the portal experience according to rules in such a way that content is driven to the interface, or other behaviors, such as navigation, are altered. From the user perspective, the term customization has been replaced with the term personalization. From an administrative and development perspective, customization is the means by which a user alters the content, or behavior, of the portal to suit their own ad hoc interests. distribution By using personalization, sites become easier to use, content relevance increases, and user efficiency improves to the degree that personalization is understood and implemented.for
Rules not
To define how the site will interact with users, you write readable logic statements (rules) that define a condition to evaluate and an action to take based on the outcome of an evaluation. SPVC; Exploring campaigns
Campaigns organizefor sets of personalization behavior. Open enrollment on healthcare benefits might be the basis for an annual campaign on an HR intranet portal. Personalization can be used to place content according to start and stop date rules and rules to contentguide spot mappings. Topic B: Administering the portal using attribute-based techniques
Attribute-based administration is a tool to administratively define the content and behavior of portal under predetermined circumstances.
Accompanying
152 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 7. Attribute-based administration
Access control and visibility rules
Access control determines the persistent access of a user or group to portal resources. Users might experience a change in portal experience as their group memberships change. Access control is not an implementation of attribute-based administration.
Visibility rules, which are one example of attribute-based administration, provide a transient means of managing the presentation of resources. One example of visibility rules is to display a portlet if a user’s locale is within a specified region. The visibility rule is moot if a user’s access does not incldistributionude permission to view a portlet. The visibility rule filters the portlet according to the rule action if the user’s access permits access to a resource, such as a portlet. for
Policies not
Policies target resources and are applied to classes of users. By defining specific settings for a resource, such as mail, administrators can apply the policy to a class of users. A resource can have more than one policy so that effectively several classes of user can experienceSPVC; different settings through the application of a policy. for Error condition behavior
Because error conditions can occur, you want to be prepared to handle such conditions. For example, an attribute that is evaluated in a guiderule might not be available when the rule is evaluated. You can set or modify the default settings to handle these error conditions. If a problem occurs during evaluation, err on the side of caution. For example, visibility rules that encounter an error should hide the resource.
Topic C: Defining attribute-based administration
Attribute-based administration provides the administrator with Accompanyinganother tool to display or hide pages and portlets under specific circumstances. As mentioned previously, one example of
© Copyright IBM Corp. 2011. All rights reserved. 153 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
attribute-based administration is visibility rules, which allow the evaluation of user-specific data before displaying a resource. For example, if a user is from a specific region of the country, a visibility rule by might be set to show a portlet specific to that type of user. Visibility rules are different from access control. Access control is a hard rule that allows the user specific privileges on a resource.
Attribute-based administration provides a facility to customize the runtime layout of a page based on user attributes and other factors at run time. User attributes can be stored in the release, community, and customization databases. distribution Attribute-based administration also determines which pages and portlets are shown with visibility rules. The forshow or hide action is executed if the rule evaluates true. As illustrated in Figure 7-1, visibilitynot rules take advantage of the personalization engine. The portal’s personalization capabilities provide the rule creation, storage, and evaluation mechanism necessary to implement visibility rules. The personalization engine evaluates the applicable rules at run time and shows or hides the resource depending on the outcome of the evaluation. SPVC; for
guide
Figure 7-1 Visibility rules
Accompanying
154 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 7. Attribute-based administration
Examining visibility rules
Visibility rules can evaluate based on the following information: Lightweight Directory Access Protocol (LDAP) attributes Time of day, including calendar and clock attributes Properties, such as custom attributes defined by portlet developers Session information
The portal automatically triggers rule evaluation. distributionYou can assign additional rules to pages and portlets. The Automatic Programming Interface (API) invokes the rulesfor programmatically. For example, you can hide a portlet from users based on their geographical location. You must ensure that the LDAP schema includes the user location attribute, andnot then create a visibility rule to hide the portlet based on a location attribute. The visibility rule is assigned to a portlet.
Exploring interactions between security and rules SPVC;
Portal security isfor always the overriding factor in displaying a resource. If a user has no privileges on a specific page or portlet, no visibility rules are evaluated on the page or portlet, and the resource is not shown to the user. Figure 7-2 shows an example where a user has privileges, access is granted, and the resource is shownguide to the user.
Accompanying Figure 7-2 Security and visibility rules
© Copyright IBM Corp. 2011. All rights reserved. 155 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Considering that a user has privileges on the resource, all applicable rules are evaluated, and the resource is displayed or hidden based on the outcome of the rule evaluation. Figure 7-3 shows an example where the following actions occur: The user logs in to IBM WebSphere Portal. Portal checks the access control list to determine what the user is authorized to view. The content is then filtered based on the visibility rules. distribution for not
SPVC; for
guide
Figure 7-3 Security and visibility rules
Handling errors
As mentioned previously, errors can occur during rule evaluation. For example, an attribute that is evaluated in a rule might not be available when the rule is evaluated. You can set defaults to Accompanyinghandle these error conditions. If a problem occurs during evaluation, err on the side of caution and hide the resource. Errors
156 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 7. Attribute-based administration
can be caused if a rule has been deleted, if a user object is null, or it other similar missing objects are not available to the rules engine at the time that the rule is evaluated.
The following examples are ways that you might evaluate error conditions: A rule is not found, and an exception occurs during rule execution. In this case, the page or portlet is hidden, which is the system default. Change the default behavior by modifying thedistribution rulesEngine.visibilityDefault property in PersonalizationService.properties. for This file is in the wp_profile_root/PortalServer/config/ config/services/ directory. Set the value of the property to show when an error occurs. not The user is not found during rule execution. The rulesEngine.throwObjectNotFoundException property specifies the behavior if false. The error is recorded in the portal log file. The page or portlet is not displayed.
If an error occurs whenSPVC; locating or using a rule assigned to a page or portlet, by default, that page or portlet is hidden. The system continues if a user or expected application does not exist. This behavior might forbe appropriate, and therefore, you might need to change this behavior for testing purposes in a development environment. Update the PersonalizationService.properties file to override this behavior globally.
Theguide rulesEngine.visibilityDefault property specifies whether a page or portlet renders if the assigned rule has a problem. Changing the property value to show means that the page or portlet is shown even though the assigned rule cannot be found or if a problem resides with the rule.
Set the value of this property to true to throw an exception if the object is not found.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 157 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic D: Creating and managing visibility rules
You can create visibility rules while editing a page layout or page properties if you are using an existing Portal theme. Creating rules this way, while it might be the most expedient path for rule creation, does not produce a coherent and well organized list of rules.
Create rules from the Personalization Navigator, and then apply the rules when editing a page layout or page properties.distribution You can create visibility rules from the following areas for Page Builder theme-based pages: for On the page, click the Action tab and select Edit Page Properties. In Page Properties, click Advancednot Properties → Control Display through rule mapping. In the Personalization Navigator, click New → Rule.
You can create visibility rules from the following areas for existing Portal theme-based pages:SPVC; In the Edit Layout portlet, click Edit Page Layout → Show Portlet Rule Mappings → Create New Rule. In Page Properties,for select Advanced options → Show or Hide page rule → Create New Rule. In the Personalization Navigator, click New → Rule. Creatingguide rules from the Personalization Navigator offers the following advantages: Allows better management of existing rules Provides full access to personalization resources Allows editing of any existing rule in conjunction with the Personalization Editor
A page must be created for whomever is to create and manage the rules. This person needs the Personalization Navigator (Figure 7-4 on page 159) and Personalization Editor portlets.
Accompanying
158 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 7. Attribute-based administration
distribution for not
SPVC; Figure 7-4 Personalization Navigator for Applying visibility rules to pages and portlets guide Rules can be applied while editing page layouts, editing page properties, or by using XML Access. The rule must exist in order to apply it to resources. Applying rules by using XML Access applies to situations where you deploy releases from staging to production. Deploying rules from one environment to another requires additional steps, where applying a rule with XML Access is an integral part of the page and portlet deployment process.
One other factor to consider is that, when a user creates a derived page, where a Privileged User edits the layout of a shared page, the derived page automatically inherits all visibility rules. Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 159 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
160 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 7: Creating rules
Lab
Lab 7: Creating rulesdistribution for In this lab, you apply a visibility rule to a portlet. The implementation of this rule can show or hide a portlet based on the criteria that you set, which is determinednot during the evaluation of rules at run time. You apply the rule to the Human Resources page hierarchy that was imported in “Lab 4: Implementing security and creating a Developer Administration page” on page 81.
Visibility rules work in addition to permissions. They do not override access control.SPVC; Access is evaluated first and then the Personalization engine executes rules.
This lab looks atfor wher e you apply a rule to a page and a portlet. You also locate the parameter that controls the ability to add a rule to a portlet. This parameter is enabled by default, and you test the functionality of blocking the ability of adding rules by changing this parameter.guide This lab includes the following tasks: Verifying that WebSphere Portal is started and logging in Validating the ability to apply rules to a portlet Working with visibility rules
Objectives
This lab has the following objectives: Describe Edit Layout attributes that control applying rules Accompanying Create a visibility rule Apply a rule to a portlet or a page
© Copyright IBM Corp. 2011. All rights reserved. 161 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Substitution values: In this lab, use the following substitution values, depending on your environment, when you encounter them in the lab instructions:
SPVC; for
guide
Accompanying
162 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 7: Creating rules
Task 1: Verifying that WebSphere Portal is started and logging in
In this task, you verify that WebSphere Portal is started and then log in.
Verifying that WebSphere Portal is started distribution To verify that WebSphere Portal is started, complete these steps: 1. Launch a command prompt. for 2. Change directories to
To log in to WebSphere Portal, complete these steps: 1. Launchguide a browser and enter the following web address: http://portal99:10039/wps/portal 2. Enter wpsadmin as the user ID and password. 3. Click Log in.
Task 2: Validating the ability to apply rules to a portlet
The Edit Layout portlet has an attribute that controls the ability to apply rules to a portlet. This attribute is enabled by default. In this Accompanyingtask, you explore where you apply a rule to a portlet or page. You also configure the rule mapping attribute of the Edit Layout portlet.
© Copyright IBM Corp. 2011. All rights reserved. 163 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
To validate the ability to apply rules to a portlet, complete these steps: 1. Locate where to apply a rule to a page (you apply rules later in this lab): a. Click Administration → Portal User Interface → Manage Pages → Content Root → Home. b. Click the Edit Page Properties for the Human Resources page. c. Expand Advanced Options. d. Click the arrow next to No rule mapped todistribution display the Personalization Rule Picker list. e. Click Cancel. for not
SPVC; for
Figure 7-5 Page Edit Layout portlet guide
Accompanying
164 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 7: Creating rules
2. Locate where to apply a rule to a portlet. a. Click the Edit Page Layout icon for the Human Resources page. b. Click the Show Portlet Rule Mappings link (Figure 7-6).
distribution for not
Figure 7-6 Portlet Edit Layout portlet
SPVC; for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 165 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
The Show Portlet Rule Mappings link changes to Hide Portlet Rule Mappings (Figure 7-7). c. Click the arrow next to No rule mapped to display the Personalization Rule Picker list. d. Click Hide Portlet Rule Mappings to toggle back to Show Portlet Rule Mappings. e. Click Done.
distribution for not
SPVC; Figure 7-7 Portlet Edit Layout portlet for 3. Configure the rule mapping attribute of the Edit Layout portlet: a. In the left navigation pane, click Portlet Management → Portlets. b. In the Manage Portlets window, in the Search field, enter guideEdit Layout . Then for Edit Layout, click the Configure portlet icon (the wrench icon).
AccompanyingFigure 7-8 Manage Portlets window
166 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 7: Creating rules
c. In the Parameter column (Figure 7-9), locate showRuleMappingOption and click the Edit value icon (the pencil icon). The value is set to Yes by default.
distribution for not
Figure 7-9 Manage Portlets window
d. Change the Value to No and click OK. Then click OK again. e. Click Manage PagesSPVC;→ Human Resources and then click the Edit Page Layout icon. Notice that the ShowRuleMappingfor link is no longer displayed. Click Done. f. Under Portlet Management, for Edit Layout, click Portlets → Configure portlet. g. For showRuleMappingOption, click the Edit value icon. h. Change Value back to Yes and click OK. Then click OK guideagain.
Task 3: Working with visibility rules
Visibility rules determine what content is visible to a targeted audience. In this task, you create, apply, and validate time-based visibility rules for a portlet and a page in this task.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 167 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Creating a visibility rule
To create a visibility rule, complete these steps: 1. Click Applications → Content → Personalization → Business Rules. The Applications link is at the top of the page in the banner navigation.The Personalization Navigator and Editor are displayed. 2. Click New → Rule and notice that the Personalization Editor expands (Figure 7-10). distribution for not
SPVC; for
Figure 7-10 Personalization Editorguide
Accompanying
168 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 7: Creating rules
3. In the Personalization Editor panel (Figure 7-11), complete these steps: a. For the rule name, enter DateBasedVisibilityRule. b. Click the Rule Type list, select Visibility Rule.
distribution for not
SPVC; for
guide Figure 7-11 Rule Type list
The Show page or portlet when link is displayed by default. You can change the value to Hide by clicking the Show page or portlet when link. We use the default Show.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 169 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
c. As shown in (Figure 7-12), click attribute * and click Date → Date.
distribution for not
SPVC; Figure 7-12 Personalization Editor for d. Click is → is between. Two new options, value * and value *, which are where you define your date range, are displayed after the is between guideoption is selected. e. Select the first value * and enter tomorrow’s date. Then click Submit.
Accompanying
170 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 7: Creating rules
f. Select the second value * and enter Saturday’s date (Figure 7-13). Then click Submit.
distribution for not
Figure 7-13 Personalization Editor SPVC; 4. Click Save. forYou might have to scroll down to see the Save button. All changes are lost if you do not save.
The new rule has now been added to the Personalization Navigator. guide Applying the new rule to a portlet
To apply the new rule to a portlet, complete these steps: 1. Click Administration → Portal User Interface → Manage Pages. 2. Navigate to the Human Resources page. 3. Click Edit Page Layout for Human Resources. 4. Click the Show Portlet Rule Mappings link. Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 171 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
5. In the Edit Layout window (Figure 7-14), notice that No rule mapped is the default setting. Click Personalization Rule Picker → Select Rule.
distribution for not
Figure 7-14 Edit Layout window
6. In the Personalization Picker window (Figure 7-15), select the DateBasedVisibilityRule check box from the Personalization Picker portlet and SPVC;click OK. for
guide
Figure 7-15 Personalization Picker portlet Accompanying
172 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 7: Creating rules
7. Back in the Edit Layout window (Figure 7-16), notice that the visibility rule has been applied to the portlet. Click Done.
distribution for not Figure 7-16 Edit Layout window
Important: Visibility rules apply to everyone, even the administrator ID. The Reminder portlet must be hidden. Remember, by default, visibility rules are shown if the condition evaluatesSPVC; to true. In the following steps, you change the rule to show the portlet. for 8. Validate the rule: a. Click Home and navigate to the Human Resources page. b. Click Applications → Content → Personalization → Business Rules. Select DateBasedVisibilityRule, if guideneeded. c. Click Edit in the Personalization Editor. d. Change the first date value to yesterday’s date, click Submit, and then click Save. e. Click Administration → Portal User Interface → Manage Pages. f. Navigate to the Human Resources page and click Edit Page Layout. g. Re-apply the rule: i. Click Personalization Rule Picker → Select Rule. Accompanying ii. Click OK. iii. Click Done.
© Copyright IBM Corp. 2011. All rights reserved. 173 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
9. Click Home and navigate to the Human Resources page. The Reminder portlet is now visible.
Creating and applying a visibility rule to a page
To create visibility rule and apply it to a page, complete these steps: 1. Click Administration → Portal User Interface → Manage Pages. distribution 2. Click Content Root → Home → Human Resources. 3. Click Edit Page Properties icon for thefor Payroll page. 4. Expand Advanced options, click Personalization Rule Picker → Create New Rule. This opens the Personalization Picker portlet, which is automaticallynot applied to the page when you save this rule. 5. In the Personalization Picker panel, complete these steps: a. Enter the rule name PayrollVisibilityRule. b. Click Show pageSPVC; or portlet when and click Hide. c. Click attribute* and click Portal Users → Groups. A window opens displaying the groups. If you do not see this window, disablefor your popup blocker. d. Click is and select includes any of. You might need to scroll to select this parameter. e. Mouse over value * and click the greater than (>) sign. guide
AccompanyingFigure 7-17 Personalization Picker portlet
174 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 7: Creating rules
f. Scroll down to the bottom of the list and click Select Group.
Watch for popup: Watch for popup to see available groups.
g. In the Search for field, type Emp and click Search. h. Select the Employees group and click OK. i. Click Save. 6. Click OK. 7. Log out and then log back in as Employee1. 8. Click Human Resources and notice Payroll isdistribution no longer visible. 9. Click Log Out and close the browser. for not
SPVC; for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 175 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
176 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 8. Virtual portals and realms
Lesson 8
distribution Lesson 8.Virtual portals and realms for This lesson provides an introduction to virtual portlets and realms.
This lesson includes the following topics:not Virtual portals and multiple realms VMM realm configuration files Creating a realm Creating a virtual portal Scoped and non-scoped resources Virtual portal provisioningSPVC; script for Objectives
This lesson has the following objectives: Defineguide a realm. Identify Virtual Member Manager (VMM) configuration files. Differentiate between true and virtual portals. Define planning considerations for virtual portals. Identify scoped and non-scoped resources. Create a virtual portal. Customize the provisioning script for virtual portals.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 177 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: Virtual portals and multiple realms
This topic explains how to define virtual portals and realms and discusses the relationship of virtual portals with multiple realms.
Defining virtual portals
Virtual portals are administrative entities and aredistribution logical portals that share the same hardware and software installation. They have the following key benefits: Delegating the administration of a virtualfor portal. User privilege for some resources employed by a virtual portal can be managed by a team of administrators from another organization. not Associating discrete user communities with unique virtual portals.
These two benefits are understood in the terms scope and realms. Creating a virtual portal begins with realm definition. A realm is a collection of congruentSPVC; users managed by a user repository. A virtual portal forand a true portal have the following differences: Virtual portals: – Share hardware resources – Share licenses – Share software installation and updates –guide Share portal resources – Allow separate user communities True portals: – Require independent hardware and software – Require separate updates for each portal instance – Have a unique set of portal resources – Have a single user community – Provide strong isolation of applications
Define a realm that you will use for a specific virtual portal prior to creating the virtual portal. You cannot change to another realm after you create a virtual portal. You can change the membership Accompanyingcomposition of the realm at any time. You must create a new virtual portal if you determine that a different realm is required.
178 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 8. Virtual portals and realms
With the virtual portals feature, you can create multiple logical portals for different user communities. You can assign different administrative groups to each virtual portal, as illustrated in Figure 8-1.
distribution for not
Figure 8-1 Shared hardware and software installation
Creating multiple virtual portals has the following advantages: Each instance usesSPVC; shared hardware and shared software. All portals use one IBM WebSphere Portal software installation. for All portals use a shared WebSphere Application Server or cluster. Each virtual portal can have a unique user population. Eachguide virtual portal supports anonymous pages. Each virtual portal can have unique configuration properties. Each virtual portal can be administered by a unique administration team.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 179 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
A single “true” true portal can be configured to host as many as 150 virtual portals, which is illustrated in Figure 8-2.
distribution for not
Figure 8-2 Multiple virtual portals
Defining realmsSPVC;
In this section, wefor examine user- and group-distinguished names, defining a federated repository, and examining WebSphere Portal security.
User- and group-distinguished names A realmguide is a defined subset of a number of repositories defined in the federated repository configuration of the VMM. User membership in a realm is based on user- and group-distinguished names.
Creating multiple realms requires a hierarchical naming structure and a federated repository. A single LDAP can be employed by virtual portals and, if selected, access to each portal must be managed through access controls.
Creating security realms provides the ability to subdivide an all-encompassing federated repository. Distinguished naming enables LDAP administrators to generate unique names for each Accompanyinguser.
180 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 8. Virtual portals and realms
In a large organization, the naming repository can become large and unwieldy. Therefore, by dividing the repository into realms, the administrator can segment the user community based on the distinguished naming characteristics of the repository.
Defining realms becomes particularly important when implementing virtual portals. Creating realms enables the administrator to tailor the user community to the virtual portal Because each portal might have distinctly different user communities.
Defining a federated repository distribution WebSphere Portal security employs the VMM to define its repository. The VMM can support a stand-alone LDAP, or it can federate multiple different repositories as thoughfor they are a single repository.
When defining a federated repository,not keep in mind the following caveats: A group in one of the repositories cannot encompass members from another repository. Names must be unique across the entire federated repository. SPVC; Federate additional repositories into the VMM with databases and LDAPs. They do not need to be an identical type. The federated repository can actfor as a single namespace (Figure 8-3).
guide
Accompanying Figure 8-3 A federated repository definition
© Copyright IBM Corp. 2011. All rights reserved. 181 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Examining IBM WebSphere security VMM uses a database to federate and track its child repositories. The database does not contain the individual user membership. The VMM database contains the necessary information that is required to access the child repository.
VMM uses its own repository on a stand-alone server. You cannot localize authentication settings to an individual server. Access Control Lists are set by application.
VMM uses a single federated repository for the entire cell when you implement security in a cell. Users are authenticateddistribution locally by each WebSphere instance that includes authentication with the deployment manager and node agents. for Virtual portals with multiplenot realms The virtual portal to realm relationship is one-to-one. The realm membership can change, but the realm cannot be changed. When planning the virtual portal environment, take this relationship into consideration before placing virtual portals into production.
The realm to virtual portalSPVC; relationship, in contrast, is one-to-many; that is, one realm supports a number of virtual portals. for Topic B: VMM realm configuration files guide VMM stores its configuration settings in the wimconfig.xml file. Do not edit this file directly to implement your changes. If you do edit this file, distribution of the file out to the individual nodes in a cell is not triggered. Instead use the ConfigEngine utility.
Updating the wimconfig.xml file: Avoid editing the wimconfig.xml file directly. Instead, use the ConfigEngine utility to update it.
When you examine the VMM control file, you see that the VMM configuration is defined by the wimconfig.xml file. This file is in the Accompanying
182 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 8. Virtual portals and realms
The wimconfig.xml file defines the following items: The participating repositories for both databases and LDAPs The full repository’s base distinguished names (DN) The full repository’s search bases for user and group The realm configuration for all defined realms
Topic C: Creating a realm
Use the ConfigEngine configuration utility to update the wimconfig.xml file to add realm support. To createdistribution a new realm, follow these steps: 1. Modify the wkplc.properties file beforefor executing each task. 2. Run wp-create-base-entry to create base distinguished names that are used throughout the full repository. 3. Run wp-create-realm to create thenot realm definition along with the initial participating base entry. 4. Run wp-add-realm-baseentry to add additional base entries to an existing realm. 5. Run wp-add-ldap-entitytype-rdn to define new search bases. SPVC; 6. Restart all servers in the cell after completing the tasks: a. Stop the portalfor instances. b. Stop the node agents. c. Stop the deployment manager. d. Start the deployment manager. e. Start the node agents. f.guide Start the portal instances.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 183 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic D: Creating a virtual portal
This topic explains how to create a virtual portal.
Using the Virtual Portal Manager portlet
The original portal, WebSphere Portal, is defined as a virtual portal instance, and you manage virtual portals with the Virtual Portal Manager portlet. The true portal is defined as a virtual portal, which is illustrated in Figure 8-4. distribution for not
SPVC; Figure 8-4 Virtual Portal Manager window for Define a URL context that the user will enter to access the virtual portal when creating a virtual portal. This URL context is appended to the original context. You can also create a virtual portal host name, which enables the user to access the virtual portalguide using the unique host name. You cannot define a host name that is identical to the default portal host name.
The initial admins group can be the same as the default portal. The admins group specified here has a sharply curtailed set of privileges.
Accompanying
184 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 8. Virtual portals and realms
Using the ConfigEngine create-virtual-portal task
To create a new virtual portal, follow these steps: 1. Click Administration → Virtual Portals → Manage Virtual Portals → New Virtual Portal. 2. Connect to the virtual portal by entering the URL context in a browser and entering the virtual portal host name in a browser. 3. Choose a defined realm. The realm must exist before creating the virtual portal (Figure 8-5). distribution for not
SPVC; for
guide
Figure 8-5 Virtual Portal Manager
4. Define the initial admins group, which must be a smaller group than the full portal administrators group. Reinitializing the virtual portal takes it back to its original scripted state.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 185 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
5. Define the host name for the virtual portal by using the following addresses (Figure 8-6): – http://mydomain.com/wps/portal/newyork – http://nyp.newyork.ibm.com/wps/portal
distribution for Figure 8-6 Virtual Portal Manager not Topic E: Scoped and non-scoped resources
This topic discusses definingSPVC; scoped and non-scoped resources.
Defining scopedfor resources
Scoped resources are resources that are available to only a specific virtual portal.
Scopedguide resources have the following characteristics, among others: They can be assigned to a specific virtual portal. They cannot be shared between virtual portals. They can be customized for each virtual portal.
You can still use access control to restrict individual users or groups of access permissions within the context of a specific virtual portal. Scoped resources include portal pages and portlet instances.
Accompanying
186 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 8. Virtual portals and realms
Figure 8-7 illustrates how you can restrict access to these resources by virtual portal users through portal access control.
Figure 8-7 Restricting access distribution Some resources can be scoped to use within individual virtual portals. Technically, this is not the same as fora scoped resource. For practical purposes, using an ACL to scope a resource serves the same result. not Defining non-scoped resources
Non-scoped resources are shareable resources across many virtual portals. Portlets are a non-scoped resource. SPVC; Non-scoped resources have the following characteristics, among others: They are sharedfor by all virtual portals. Customization affects all virtual portals. Some resources can be scoped through the Portal access control.guide The following non-scoped resources can be scoped by using portal access control: Portlets Portlet applications Web modules URL mapping contexts Users and groups
The following non-scoped resources cannot be scoped by using portal access control: Themes and skins Accompanying Vault segments and vault slots Supported clients and markups
© Copyright IBM Corp. 2011. All rights reserved. 187 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Application templates Composite applications Policies
Topic F: Virtual portal provisioning script
You can control the appearance of new virtual portals by altering the provisioning script or creating one of your own.distribution The provisioning script defines the create time pages and their layout. To customize the initial virtual portal content,for follow these steps: 1. Locate the existing script in
guide
Figure 8-8 Managing the virtual portal asset
3. Create a new script in the same directory as the InitVirtualPortal.xml file. Accompanying
188 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 8. Virtual portals and realms
4. From the Virtual Portal Manager portlet menu, select Configure and enter the new script name (Figure 8-9).
distribution
Figure 8-9 Using the Virtual Portal Manager configuration settings to provide a script name for not
SPVC; for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 189 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
190 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 8: Configuring realms and virtual portals
Lab
Lab 8: Configuring realmsdistribution and virtual portalsfor not This lab discusses enabling multiple realm support using the IBM Tivoli Directory Server 6.2 with IBM WebSphere Portal 7.0 across an existing portal and a newly created virtual portal. In this lab, you modify Virtual Member Management (VMM) configuration files to enable realm support. You also create and test the new virtual portal. SPVC; This lab includes the following tasks: Creating a newfor user realm Creating a virtual portal
Objectivesguide This lab has the following objectives: Enable security with multiple realm support. Modify the VMM configuration files to support multiple realms. Create a virtual portal.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 191 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Substitution and location of the file for this lab: In this lab, when you see the value
The file for this lab is in the
SPVC; for
guide
Accompanying
192 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 8: Configuring realms and virtual portals
Task 1: Creating a new user realm
In this task, you modify the wkplc.properties configuration file to add a new realm.
Base entries for realms: Base entries for the realms have been previously implemented.
To create a new user realm: 1. Ensure that the portal server is running. distribution 2. Use file explorer to browse to the
The following message line is displayed: [echo] updated RegistrySynchronized in file wkplc.properties with value: Return Value: 0
Task 2: Creating a virtual portal Accompanying To create a virtual portal, complete these steps:
© Copyright IBM Corp. 2011. All rights reserved. 193 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
1. Ensure that the portal server is running. 2. Click the Administration link. 3. Click the Manage Virtual Portals portlet. 4. In the Virtual Portal Manager window (Figure 8-10), click New Virtual Portal.
distribution for
Figure 8-10 Virtual Portal Manager windownot
SPVC; for
guide
Accompanying
194 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 8: Configuring realms and virtual portals
5. In the Create New Virtual Portal panel (Figure 8-11), set the following properties and then click OK: – Virtual portal title: NewYorkPortal – URL context: newyork – Virtual portal hostname: nyp.training.ibm.com – User realm: NewYork – Initial admin user group: nyadmins
distribution for not
SPVC; for
Figure 8-11 Virtual Portal Manager window: Set properties
6. Afterguide the portal is created, click Reinitialize. 7. Add an entry to the hosts file for the IP address of the portal99 instance with a host name of nyp.training.ibm.com. 8. Open a new browser and enter the following web address: http://portal99:10039/wps/myportal/newyork 9. Log in as nyadmin1/nyadmin1. 10.Open a new browser and enter the following web address: http://nyp.training.ibm.com:10039/wps/portal 11.Log in as nyadmin1/nyadmin1. Accompanying12.Click Administration → Access → Users and Groups.
© Copyright IBM Corp. 2011. All rights reserved. 195 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
13.Set the search property to Users. In the Search text box, enter an *, and then click Search. Notice that the page structure does not show any of the pages that you previously created. Also, notice the additional nyadmins and nyusers groups. 14.Click Logout.
Adding and deleting a virtual portal: If you attempt to add a virtual portal and then delete the virtual portal, you may be unable to recreate the virtual portal. The error message you see may indicate a duplicate key. To resolve the duplicdistributionate key issue, use the xmlaccess configuration interface and execute the sample Task.xml script. for In Windows, you can run Task.xml from C:\IBM\WebSphere\PortalServer\bin using the following syntax: not xmlaccess -user uid=wpadmin, cn=users, dc=train ing,dc=ibm,dc=com -password wpsadmin -url localhost:10039/wps/config -in C:\IBM\WebSphere\PortalServer\doc\xml-samples\Task.xml -out C:\IBM\WebSphere\PortalServer\doc\xml-samples\TaskResultASPVC; .xml
In Linux, you canfor run Task.xml from /opt/IBM/WebSphere/PortalServer/bin using the following syntax:
./xmlaccess.sh -user uid=wpadmin, cn=users, dc=training,dc=ibm,dc=comguide -password wpsadmin -url localhost:10039/wps/config -in /opt/IBM/WebSphere/PortalServer/doc/xml-samples/Task.xml -out /opt/IBM/WebSphere/PortalServer/doc/xml-samples/TaskResul tA.xml
Accompanying
196 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 9. IBM Syndicated Feed Portlet
Lesson 9
distribution Lesson 9.IBM Syndicated Feed Portlet for The new IBM Syndicated Feed Portlet for IBM WebSphere Portal offers enhanced feed subscription and presentation capabilities. This lesson discusses the enhancednot features.
This lesson includes the following topics: IBM Syndicated Feed Portlet Feeds SPVC; Objectivesfor This lesson has the following objectives: Set up a proxy for a portlet. Discuss the configuration options and any management implications.guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 197 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: IBM Syndicated Feed Portlet
With the Syndicated Feed Portlet, you can integrate, view, and manage Really Simple Syndication (RSS) and Atom syndication format (ATOM) feeds from your WebSphere Portal pages. You can organize the feeds into new and existing feed categories and extensively customize the presentation style of these feeds.
User interaction is simple. Personalize a Syndicated Feed Portlet by adding categories and subscriptions (Figure 9-1).distribution for not
SPVC; for
Figure 9-1 Syndicated Feed Portlet guide Proxy for the portlet
The portlet is supported in a proxied environment and enables dynamic modification of the portlet window title. As an administrator, you can configure several administrative settings from within the portlet interface and apply selective locks on a user’s ability to customize the portlet.
The portlet complies with the Outline Processor Markup Language (OPML) standards for subscription management and supports the export of feeds to an OPML-compliant file and import Accompanyingof multiple feeds into the portlet from an OPML URL.
198 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 9. IBM Syndicated Feed Portlet
Configuration options for administrators
A user can perform the following tasks using the Syndicated Portlet Feed: Integrate, view, and manage RSS and ATOM feeds from WebSphere Portal pages. Organize the feeds into new and existing feed categories. Specify authentication options and credentials, private or shared, for password-protected feeds. Extensively customize the presentation style fordistribution feeds. Export the feeds of the Syndicated Feed Portlet to an OPML-compliant XML field and an appropriatefor OPML URL. Enable and configure servlet and dynamic caching for caching the portlet user interface and feed data respectively. not An administrator can perform all the functions that a user can with the Syndicated Feed Portlet. Additionally, you can regulate a user’s ability to customize the portlet: Apply locks on a user’s ability to perform feed subscription related functions, such as the following examples: – Adding feeds toSPVC; the portlet – Enabling or displaying the feeds in the view mode of the portlet for – Configuring cache settings Apply locks on a user’s ability to customize feed presentation related options, such as the following examples: –guide Choosing a presentation style for the feeds – Displaying or hiding the toolbar A toolbar enables a user to perform all the operations related to feeds and feed categories from within the view mode – Displaying or hiding the channel bar The channel bar shows the name of the feed category and the name of the feed subscription separated by a forward slash (/). – Customizing the portlet window title to be the same as the default portlet title, the title of the first selected feed, or a Accompanying custom title
© Copyright IBM Corp. 2011. All rights reserved. 199 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
– Displaying or hiding the author of feed items – Displaying or hiding the published date of feed items
You can perform all of these tasks from within the IBM Syndicated Feed Portlet. The steps to perform these tasks are in the WebSphere Portal Help, which you can access by clicking the Syndicated Feed portlet menu and choosing Help.
Management implications
Remember the following points when using the Syndicateddistribution Feed Portlet: The Syndicated Feed Portlet supports thefor following authentication methods: – Basic authentication not – Form-based authentication – Single sign-on (SSO) through Lightweight Third-Party Authentication (LTPA) and Netegrity SiteMinder You cannot use the XML file to which you export the feed details from one instance of the Syndicated Feed Portlet to import the exportedSPVC; feed details into another instance of the portlet. for Export file of an IBM Syndicated Feed Portlet: One purpose of OPML is to provide a means of sharing web feeds with other feed aggregators. The IBM Syndicated Feed Portlet cannot accept, as an import file, the export file of guideanother IBM Syndicated Feed Portlet. Initially, your users view the feeds in the View mode based on the settings you configured in the Configure mode of the portlet. If the user, at a later date, modifies the settings from the Personalize mode, then these settings take precedence over the subsequent settings that you configure using the Configure mode. Perform the steps in the “Viewing feeds using international character sets from the IBM Syndicated Feed Portlet for WebSphere Portal” technote at the following web page: http://www.ibm.com/support/docview.wss?rs=688&uid=swg21 Accompanying 314122
200 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 9. IBM Syndicated Feed Portlet
Topic B: Feeds
The IBM Syndicated Feed Portlet uses the Secure Sockets Layer (SSL) feed to provide security for communications over networks, both internal and external. This section discusses the SSL feed, client-side aggregation, configuration of cookies, and portlet proxies.
SSL feeds distribution Some feeds that use HTTP over SSL (HTTPS) might not function properly because of missing SSL certificates when using the Syndicated Feed Portlet over WebSphere Portal.for
You might encounter the following types of error messages among others: not Missing certificate Unknown certificate Untrusted certificate
These error messages occur because of missing root signer certificates or missingSPVC; self-signed certificates in the WebSphere Application Server certificate trust store. Regardless of the reason, you must add the appropriate certificates to the WebSphere Applicationfor Server certificate store in use for your WebSphere Portal Server installation.
To add the missing certificates, follow these steps: 1. Verify that you have administrator access to the WebSphere Applicationguide Server. 2. Obtain the missing certificates: – Missing root signer certificate Various mechanisms are available for this situation depending on the type of certificate that is missing. The quickest way is to access the feed you are trying to add directly from a web browser. All modern browsers provide the capability to view a certificate and its trust chain. The instructions for viewing and exporting certificates from a web browser are browser-vendor specific. You might need to contact your IT administrator for assistance. Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 201 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
– Missing self-signed certificate You might be prompted with several warning messages about the acceptance or trust of this certificate. Ensure that you trust the third-party server before you add the certificate to your WebSphere Application Server certificate trust store. 3. Follow the instructions in the “Adding a signer certificate to a keystore” topic in the WebSphere Application Server Information Center at: http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/i ndex.jsp?topic=/com.ibm.websphere.base.doc/info/aes/ae/ tsec_ssladdsignercert.html distribution 4. Restart the WebSphere Application Server. for Client-side aggregation not The IBM Syndicated Feed Portlet can be configured to operate in the client-side aggregation rendering mode. Client-side rendering ensures an improved user experience through faster response time. WebSphere Portal does not re-render the whole page when you enable client-side rendering in the portlet. It only re-renders the aspects of the portletSPVC; that change. The following capabilities are available when client-side rendering is enabled for thefor IBM Syndicated Feed Portlet: Feed management capabilities – Subscribe to feeds by specifying the feed URL, title, and, optionally, the credentials. –guide Edit a feed to change the feed title. – Enable or display the feeds in the view mode of the portlet. – Delete a feed subscription. Feed presentation capabilities – Customize the number of articles to be displayed per feed. – View the feed article content either expanded or collapsed. – Display or hide the author of feed items. – Display or hide the published date of feed items.
Accompanying
202 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 9. IBM Syndicated Feed Portlet
Cookies and feeds
You can configure the IBM Syndicated Feed Portlet to forward HTTP cookies with outbound requests to feed sources. Alternatively, you can restrict the portlet to forward cookies only to specific domain names.
You can also enable active content filtering for all feeds to remove active content, such as JavaScript, from the feed text: 1. Log in as administrator into WebSphere Portal. 2. Select Administration → Portlet Managementdistribution→ Portlets. 3. Locate the Syndicated Feed Portlet. 4. Click the Configure portlet icon in the forSyndicated Feed Portlet row. 5. Add the preferences and value pairs in Table 9-1 as appropriate to configure the portlet.not
Table 9-1 Preference and value pairs Preference Value cookiesToForward Specify one or more HTTP cookie names. Use a space to separate multiple cookie names.SPVC; This preference forwards the specified cookies with the outbound portlet request whenfor connecting to the feed source. You can specify cookies to forward for a given feed when you add feeds to portlet. The cookies that you specify as the value for cookiesToForward are appended to the list of cookies you specified when you added the feed. limitCookiesToForward Specify one or more domain names to which you want to forward cookies.guide This preference restricts cookie forwarding to only the domain names that you specify. You can specify a fully qualified domain name or a partially qualified domain name as in the following examples: Fully qualified domain name: www.ibm.com Partially qualified domain name: ibm.com useACF Specify the following values: true: This value enables active content filtering for all feeds and removes any active content from the feed text, such as embedded Java™ scripts. false: This value disables active content filtering for all feeds. Accompanying6. Click OK to save your changes.
© Copyright IBM Corp. 2011. All rights reserved. 203 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Portlet proxies
The IBM Syndicated Feed Portlet is supported in a proxied environment. To specify the details of a proxy server, follow these steps: 1. On the WebSphere Portal administrative console, under Portlet Management, click Portlets. 2. Search for the Syndicated Feed Portlet entry. 3. Click the Configure Portlet icon that corresponds to the Syndicated Feed Portlet. distribution 4. Add the configuration parameters in Table 9-2 to the existing list of configuration parameters for the Syndicated Feed Portlet: for a. In the New Preference field, enter the parameter name. b. In the New value field, enter the value of the parameter. c. Click Add. not
Table 9-2 Configuration parameters Parameter Value proxyHost Specify the process server host name. proxyPort SPVC;Specify the proxy server’s port number.
You do not needfor to restart the server after specifying the configuration parameters.
guide
Accompanying
204 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 9: Working with the IBM Syndicated Feed Portlet
Lab
Lab 9: Working with thedistribution IBM Syndicated Feed Portletfor not In this lab, you add and configure the IBM Syndicated Feed Portlet.
This lab includes Adding and configuring a syndicated portlet. SPVC; Objectives for This lab has the following objectives: Add a syndicated feed to a page. Configure the syndicated feed. Enable client-side rendering. guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 205 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 1: Adding and configuring a syndicated portlet
To add and configure a syndicated portlet, follow these steps: 1. Create a new page with a name of your own choosing. 2. Edit the page and choose to customize the page. Hint: Use the Action menu. 3. Click the Add Content tab, and click Collaboration to filter content type (Figure 9-2). distribution for not
SPVC; for
Figure 9-2 Collaboration portlets 4. Addguide the Syndicated Feed Portlet to your page (Figure 9-3). Save then exit.
Figure 9-3 New Syndicated Feed added to page
Accompanying
206 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 9: Working with the IBM Syndicated Feed Portlet
Figure 9-4 shows the default content.
distribution for not
SPVC; Figure 9-4 Feedfor added 5. Click the menu in the top right corner of the Syndicated Feed Portlet and click Configure (Figure 9-5). guide
Figure 9-5 Configure menu Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 207 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
6. Click Add (Figure 9-6).
distribution for not
Figure 9-6 Editing the configuration
7. In the Enter a URL for the feed to add field, enter the following sample RSSSPVC; feed and click OK. You can also select an RSS feed of your choice (Figure 9-7). http://rss.cnn.com/rss/money_latest.rssfor
guide
Figure 9-7 Adding a feed
Accompanying
208 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 9: Working with the IBM Syndicated Feed Portlet
8. Click Done (Figure 9-8).
distribution for
Figure 9-8 Forum feed added not
Figure 9-9 shows the feed.
Live feed might differ from screen shot: Because the feed is live, your screen mightSPVC; not match the screen shot. for
guide
Figure 9-9 WebSphere Forum feed
Additional information Initially, the user views the feeds in the View mode as indicated by the settings configured by the administrator from the Configure Accompanyingmode of the portlet. Thereafter, if the user modifies the settings from the Personalize mode, these settings take precedence over
© Copyright IBM Corp. 2011. All rights reserved. 209 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
the subsequent settings that the administrator configures from the Configure mode.
The administrator can lock settings, in the Appearance Permissions section of the Syndicated Feed Portlet, to prevent the user from changing them (Figure 9-10).
distribution for not
SPVC; Figure 9-10 Permissions
For example, thefor administrator can lock the caching settings (Figure 9-11).
guide
Figure 9-11 Caching
Accompanying
210 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 10. Mashup integration
Lesson 10
distribution Lesson 10.Mashup integration for This lesson provides an introduction to mashup integration.
This lesson includes the following topics:not Defining mashups and iWidgets Integrating mashups
Objectives SPVC;
This lesson hasfor the following objectives: Describe iWidgets. Add iWidgets to a page. Use the Mashups tab. guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 211 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: Defining mashups and iWidgets
This topic discusses mashups and iWidgets, including a definition, preferences, and how to add an iWidget to a page.
Mashups
Mashups are a popular way to create new, dashboard-styledistribution applications from existing, often disparate applications and data sources. IBM WebSphere Portal 7.0 incorporates a Mashup Center runtime component that supports thefor use of iWidgets to rapidly create experiences for users. Sources for iWidget data include Lotus Domino xPages, Lotus Sametime, and Lotus Connections. not
iWidgets
iWidgets are an open-source specification that allows for seamless interoperabilitySPVC; across various platforms and products. Users can perform various tasks on iWidgets. The availability of these tasks to the user depends on the access rights of the users on the iWidgets.for
Users can perform the following operations on widgets depending on the assigned mashup theme: Modify the settings for widgets. Modifyguide the skins for widgets. Rename, hide, or delete widgets. Create wires between widgets. Add a widget from the toolbox to a page. Remove a widget from a category.
Users need Editor@HRMashPage role access rights for a non-private mashup page named HRMashPage to perform these tasks. No additional rights are required for a private page.
WebSphere Portal can render both iWidgets and portlets on the same page with the Page Builder theme architecture. Managing your widgets rendered on your pages is similar to managing your Accompanyingportlets.
212 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 10. Mashup integration
WebSphere Portal only supports iWidgets that are written to comply with the iWidget Specification 2.1.
For additional information about mashups and deploying a widget, see Topic B:, “Integrating mashups” on page 216.
WebSphere Portal and iWidgets
WebSphere Portal provides a dedicated iWidget Wrapper portlet to make the handling of iWidgets easier. The unique WebSphere Portal name for this portlet is wp.p.IWidgetWrapperdistribution. iWidget definition for An iWidget definition is identified by a corresponding unique iWidget Definition URI. WebSphere Portal has at least one corresponding clone of the iWidget notWrapper portlet that provides management access to the iWidget for each individual iWidget definition. WebSphere Portal creates such an iWidget Wrapper portlet clone in the following cases: When you register a specific iWidget definition URI in WebSphere Portal by using the register-iwidget-definition configuration taskSPVC; When you deploy static page markup to WebSphere Portal that containsfor a specific iWidget definition URI The WebSphere Portal infrastructure loads the corresponding iWidget definition XML file and maps the information provided by the referenced iWidget definition into the corresponding portlet metadata when you register a new iWidget URI. This information includesguide events and modes that the iWidget supports. The title and description of the created iWidget Wrapper clone are derived from the corresponding values of the iWidgets idescriptor item set.
Preferences WebSphere Portal maps all preferences that are exposed by individual iWidgets, which are elements of the iWidget attributes item set, directly to corresponding portlet preferences. You can then configure the values for those preferences by using the corresponding WebSphere Portal administration interfaces. AccompanyingFor example, the corresponding iWidget Wrapper portlet clone defines a portlet preference named zipcode if an iWidget defines
© Copyright IBM Corp. 2011. All rights reserved. 213 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
an attribute named zipcode. You can modify this value, for example, by using the Manage Portlets portlet. You can also create additional clones, for such iWidget Wrapper portlet clones, for supporting multiple preconfiguration variants of the same iWidget definition. Users can overwrite these preferences in the Edit Shared Settings and Personalize modes the same way that they might overwrite portlet preferences.
The iWidget specification includes an attribute named sandbox. You can enable security for non-trusted widgets. This is known as sandboxing. Use this security mechanism to prevent a widget from sending malicious code to the user’s system by wrappingdistribution the widget in a secure iFrame within a different subdomain. This isolates the widget from other widgets on thefor page. You can use the sandbox attribute to determine whether you want the corresponding iWidget definition to be rendered in an iWidget sandbox. WebSphere Portal maps thisnot iWidget sandbox attribute to the com.ibm.portal.iw:iwidget:sandbox portlet preference. You can modify this preference by using the same approach as mentioned in the previous section to control whether the corresponding iWidget definition is rendered in an iWidget sandbox.
WebSphere Portal storesSPVC; the URI that points to an iWidget Definition used for a specific iWidget Wrapper clone in a portlet preference withfor the com.ibm.portal.iw:iwidget:base key. This URI allows the reload of an iWidget Definition that has changed. For example, if new events are declared in the definition, the URI allows the reload of the updated iWidget definition information from the given URI and updates the iWidget Wrapper portlet accordingly.guide You can also trigger reloads by using one of the following options: Explicitly calling the refresh-iwidget-definitions configuration task Scheduling the com.ibm.portal.services.RefreshIWidgetDefinitionsTask scheduled task
You manage access control privileges on individual iWidgets by granting users and user groups access to the corresponding iWidget Wrapper portlet clones. WebSphere Portal applies the same access control enforcement model that it uses for portlets to AccompanyingiWidgets that are wrapped by iWidget Wrapper portlets.
214 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 10. Mashup integration
Users have the following abilities: Users who have User role access rights on a specific iWidget Wrapper portlet have read-only access to the corresponding iWidget. Users who have Editor access rights on the same portlet can edit shared settings on the iWidget.
Adding an iWidget to a page
You register available iWidget definitions in WebSpheredistribution Portal by specifying the location from where it can load the iWidget definition XML. WebSphere Portal can load the iWidget definitions from the following locations: for A location that WebSphere Portal can access by using HTTP routed through the WebSphere Portalnot Ajax Proxy A server relative URL that is relative to the WebSphere Portal Server A location within the WebSphere Portal Web-based Distributed Authoring and Versioning (WebDAV) file store that is identified by a corresponding WebSphere Portal WebDAV URI SPVC; Registered iWidgets become available to WebSphere Portal administration through corresponding iWidget Wrapper portlet clones. These clonesfor are created during the iWidget registration process.
You can register iWidgets for use with the Page Builder theme by using one of the following methods: iWidgetguide registration through the register-iwidget-definition configuration task This method is the typical way to register iWidgets in WebSphere Portal. iWidget registration through static page deployment You can create a new page by uploading an archive or compressed file that contains your static page markup files with this method. This static page deployment process checks whether any of the referenced iWidget definitions in the given status page index HTML file exist in WebSphere Portal already and then registers the ones that do not exist. Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 215 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Example 10-1 shows the HTML element that the static page content contains.
Example 10-1 Static page content for the HTML element
The static page deployment process, in this case,distribution ensures that the iWidget defined by the SampleWidget.xml file in the /iwidgets/sampleWidget directory of the WforebDAV file store is registered in WebSphere Portal after the page is created. not Topic B: Integrating mashups
Mashups are a versatile means of delivering a new capability to users. By adding iWidgets to a mashup page and wiring them together, users can meet their own unique business needs for long- or short-term processes.SPVC;
Enabling forthe Mashups tab
You enable the Mashups tab user interface by using the deploy-portal-mashup-ui portal ConfigEngine task. Upon a fresh installation,guide the task takes about 3 minutes. 1. Open a command prompt and navigate to the
After the Mashups tab is enabled, users can log on and work with “My Mashups.” Accompanying
216 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 10. Mashup integration
Adding a new widget
To add new widgets to the Mashup tab, you perform the following tasks: 1. Install the widget. 2. Register the widget. 3. Make it available in the toolbox.
Installing the widget Install the widget: distribution 1. Start the WebSphere Portal Server, if it is not already started. 2. If a developer provides the widget web archive file, deploy the widget WAR file package by using the Integratedfor Solutions Console to the WebSphere Application Server. 3. Click Applications → Install Newnot Application . A web context must be provided. Do not use “widgets” because this context already exists. 4. Click WebSphere_Portal as the target server mapping in the target server mapping section. 5. After the WAR file SPVC;is installed, verify and record the application name in the Name column in the list of enterprise applications and ensure that the application is started. for Registering the widget To register the widget, navigate to the ConfigEngine directory from a command line: ConfigEngine.sh|batguide register-mashup-module -DApplicationName=application_name -DWasPassword=password -DPortalAdminPwd=password
Updating and modifying the toolbox Update and modify the toolbox: 1. Update the catalog properties by copying the catalog_default.xml file in the
© Copyright IBM Corp. 2011. All rights reserved. 217 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
3. After the edits are complete, run the following configuration task: ConfigEngine.bat/.sh import-config-file -DMMImportFile="fully_qualified_filename" -DMMImportFilePropertyName="propertyname_in_WAS"
distribution for not
SPVC; for
guide
Accompanying
218 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 10: Installing and configuring an iWidget
Lab
Lab 10: Installing anddistribution configuring an iWidgetfor not In this lab, you add and customize iWidgets.
This lab includes the following tasks: Enabling mashup integration Adding an iWidget Getting started withSPVC; customizing iWidget attributes
Objectivesfor
This lab has the following objectives: Enable mashup integration. Addguide an iWidget. Customize iWidget attributes.
Substitution values: In this lab, when you see the value
© Copyright IBM Corp. 2011. All rights reserved. 219 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Considerations
Consider the following information for working with iWidgets.
Portal model When you register an iWidget in your portal, most sections of the iWidget definition and microformat are stored in the portal model. They are stored as portlet preferences of a copy or clone of the IWidgetWrapper portlet.
Portlet identifiers distribution Each iWidget definition corresponds to a distinct copy of that portlet. The portlet preferences carry the prefixfor com.ibm.portal, which identifies them as parameters that are used internally. The values of the iWidget attributes are stored without the prefix. Instead, the item identifier is used asnot a key to the item value, which offers the following advantages: You can easily distinguish iWidget attributes from other preferences when you want to customize their values after registering an iWidget in your portal. This method is more useful for preconfiguring an iWidget definition that is inSPVC;tegrated on different portal pages by using the corresponding iWidget microformats. for Update behavior Another important aspect of iWidget attributes and their corresponding portlet preferences in the portal model is that the update behavior can be specified. The update behavior allows for use guidecases when you want to retain customization across updates of an iWidget definition.
Accompanying
220 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 10: Installing and configuring an iWidget
Task 1: Enabling mashup integration
If you want to use mashups, enable mashup integration for WebSphere Portal. To enable mashup integration for WebSphere Portal, complete these steps: 1. Open a command prompt and go to the
Task 2: AddingSPVC; an iWidget
The XML file of foran iWidget is pulled from the remote system because only one server is in the class. The iWidget was installed locally as an application on WebSphere Application Server.
To add an iWidget, complete these steps: 1. Goguide to the followi ng URL to view the XML shown in Figure 10-1 on page 222: http://portal99:10039/HelloiWidget/HelloWidget.xml
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 221 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for Figure 10-1 HelloWidget.xml not 2. To verify that you can access the iWidgets XML file, complete these steps: a. Go to the ConfigEngine folder. b. Run the following command to pass the URL of the iWidget's definitSPVC;ion XML file:
Windows: ConfigEngine.batfor register-iwidget-definition -DIWidgetDefinition=/HelloiWidget/HelloWidget.xml -DWasPassword=wpsadmin -DPortalAdminPwd=wpsadmin Linux: guide./ConfigEngine.sh register-iwidget-definition -DIWidgetDefinition=/HelloiWidget/HelloWidget.xml -DWasPassword=wpsadmin -DPortalAdminPwd=wpsadmin
3. Add the iWidget to any page.
Accompanying
222 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 10: Installing and configuring an iWidget
4. Create a new page and search for HelloWidget. Select HelloWidget and add it to your page (Figure 10-2).
distribution for Figure 10-2 Verifying that HelloWidgetnot is added The iWidget tab shows the Hello World message (Figure 10-3).
SPVC; for Figure 10-3 HelloWidget showing the Hello World message
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 223 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 3: Getting started with customizing iWidget attributes
To access the portlet to customize the iWidget attributes, complete these steps: 1. Click WebSphere Portal Administration → Portlet Management → Portlets (Figure 10-4). 2. Search for, or scroll to locate, HelloWidget. distribution for not
SPVC; for
Figure 10-4 Manage Portlets window guide
Accompanying
224 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 10: Installing and configuring an iWidget
3. Click the Configure Portlet icon ( ). In the configuration mode, you can see the properties of the iWidget. See Figure 10-5.
distribution for not
Figure 10-5 Configuring the HelloWidget
4. Click the Edit icon and change the value of the com.ibm.portal.iw.content.view.valueSPVC; property (Figure 10-6). for
guide
Figure 10-6 Changing the value of a property
5. Click OK and then click OK again.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 225 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
6. Log out and log on again; then return to the page where you placed the iWidget to view the result.
Figure 10-7 View configuration change result distribution for not
SPVC; for
guide
Accompanying
226 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 11. WebSphere Portal search
Lesson 11
distribution Lesson 11.WebSphere Portal search for Users need a single entry point to resources. A portal serves to aggregate content from many content sources across the enterprise. Search is a strategic meansnot by which users discover relevant information.
This lesson includes the following topics: Comparing search options Working with WebSphereSPVC; Portal search
Objectivesfor
This lesson has the following objectives: Determine which search option to use. Workguide with search collections.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 227 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: Comparing search options
You can choose either of the following search options depending on your needs: Portal Search Service Remote Content Server Search Service
You select the Portal Search Service to manage search collections that contain portal pages, content managed by Web Content Management, or indexed Web pages. distribution You can configure the search portlets for local operation, or you can configure them for remote search service. Remote search service might have performance benefits byfor offloading and balancing system load depending on your configuration. Also, you must use the Remote Content Server Search Service for a cluster portal environment. not
By creating additional search services, the indexing load can be distributed and offer performance advantages. To create a new search service or manage an existing one, use the Manage Search portlet (shown in Figure 11-1), which is under Administration pagesSPVC;→ Manage Search. for
guide
Figure 11-1 Manage Search portlet
In addition to WebSphere Portal Search, WebSphere Portal 7.0 offers a means to connect to external content and search providers, such as Google, Flickr, and others. This means is facilitated through a separate mechanism, which you can explore by using the External Search Results portlet.
Accompanying
228 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 11. WebSphere Portal search
Search collections
A search collection is the administrative focus for WebSphere Portal Search. Each collection contains content sources to describe where the collections will obtain their information. A collection is the index against which searches are submitted, regardless of the constituent content sources.
Select an existing search service to manage search collections. The Manage Search portlet shows a list of existing collections, as illustrated in Figure 11-2. distribution for not
SPVC; for Figure 11-2 Existing collections in the Manage Search portlet
Collections consist of content sources. A content source is a target content repository. WebSphere Portal Search supports the followingguide types of content sources, which are also shown in Figure 11-3 on page 230: Web site Seedlist provider Portal site Web Content Management site
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 229 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
Figure 11-3 Content sources supported by WebSphere Portal Search
The content source typesSPVC; are actually types of crawlers. Each crawler is software that is engineered to find hyperlinks and metadata from defined target sites. A crawler finds this information according to thefor type of site.
Website crawler A website crawler is used for remote sites regardless of whether theyguide are portal sites. Only anonymous pages are returned and indexed by the crawler if the remote site is a WebSphere Portal Server. The crawler does not index the site if the remote web site target URL contains the following line:
Seedlist provider crawler A seedlist provider crawler is a special HTTP crawler that is used to crawl external sites that publish their content using the seedlist format. This type of crawler is more effective and reduces the effort that is required of the crawler. The format is an ATOM/XML-based format that is specifically for publishing Accompanyingapplication content and all its metadata. The crawler expends less effort because only updated content between crawling sessions is
230 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 11. WebSphere Portal search
gathered. You must obtain the seedlist URL to configure a seedlist crawler.
Portal site crawler Use a portal site crawler for a local portal site. The content source is already configured in the default search provider.
Crawling a portal site consists of three security dimensions. First, crawling a remote site is restricted to anonymous pages. Second, crawling secured pages on a local site requires credentials for the crawler. Third, when users search the index of the secured site, the results are filtered according to the access settingsdistribution of the searching user.
Remember that the credentials that are usedfor by the crawler are stored on the disk in plain text unless additional steps are taken. You must encrypt the data. not Securing the crawler credentials: The XML scripting interface is discussed in Lesson 21, “XML Access” on page 493. Secure the crawler credentials by locating the searchsecret.xml file in the
The following example shows the syntax: xmlaccess.sh|bat -in copiedsearchsecret.xml -out searchsecretsresults.xml -user wpsadmin -pwd wpsadmin -url http://local_host:local_port/wps/config
Web Content Management site crawler Web Content Management site crawlers are configured by using the Web Content Management portlet. The content source can be Accompanyingadded to a collection after it is configured. The previous comments
© Copyright IBM Corp. 2011. All rights reserved. 231 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
and note concerning portal crawler search security apply to the Web Content Management site crawler as well.
Topic B: Working with WebSphere Portal search
This topic discusses search scope, search links, and the External Search Results portlet. distribution Search scope for You give users options to narrow their search by defining search scopes. A search scope’s container is a collection, which can narrow the search to a content sourcenot within the collection. Alternatively, the scope can be based on document features, such as a type of document. Figure 11-4 is an example of a search scope container within the Manage Search portlet.
SPVC; for
Figure 11-4 Search scope container
The Manage Search portlet provides a list of existing scopes, a description,guide and status. You can sort the scopes, and the Search Center reflects the order you select. If you move a particular scope to the top of the list, it becomes the default scope for user searches. A scope is not available for search if it is inactive.
You click New Scope to create a new scope. In the New Search Scope window (Figure 11-5 on page 233) of the Manage Search portlet: Enter a value for the Scope Name field. Enter a meaningful description. In the Custom Icon URL field, enter the name of an icon Accompanying image to provide a way to brand the scope with an intuitive icon for user convenience.
232 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 11. WebSphere Portal search
Leave Status set as the default value, Active, so that it is available to users. For the Visible to Anonymous Users radio button, change the default value from No to Yes if you want the scope to be seen by users who are not logged in.
distribution for not
SPVC; for
Figureguide 11-5 New Search Scope window
You can narrow the scope of the search by choosing one of two ways: Select Features Select Locations
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 233 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Figure 11-6 shows the options in the Select Features section.
distribution for
Figure 11-6 Select Features optionsnot
Figure 11-7 shows the options in the Select Locations section.
SPVC; for
guide
Figure 11-7 Select Locations options Accompanying
234 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 11. WebSphere Portal search
Figure 11-8 shows the Search Center. In the top right corner, you see the name of a search scope that has been set as the default scope. You see a selection, including the default scope, all sources, and a custom link in the Search Center portlet.
distribution for not
Figure 11-8 Search Center portlet
Search links SPVC;
By adding custom links to search locations, users can include external locationsfor such as Google or Yahoo. These links are displayed in the Search Center selection menu of search options.
Creating a search link by using the Manageguide Search portlet The interface to create custom links is on the same page as scopes as shown in Figure 11-9.
Figure 11-9 Interface to create custom links
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 235 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
When you click New Custom Link, the New Custom Link window (Figure 11-10) opens. In this window, you must provide a name for the link and a URL. You can additionally provide a branded icon for the external search site.
distribution for not
SPVC; Figure 11-10 New Custom Link window for
guide
Accompanying
236 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 11. WebSphere Portal search
External Search Results portlet
You can add several External Search Results portlets to the Search Center page, in addition to its facility for displaying search results from a user’s query. Figure 11-11 shows an example of this portlet on the Search Center page.
You can add this specialized portlet to the Search Center. The results of searches from the Search Center include those from third-party external search engines. You can add more than one copy of the External Search Results portlet to the Search Center page, and you can configure each of these copiesdistribution to show a specific number of search results. for not
SPVC; for
guide
Figure 11-11 External Search Results portlet on the Search Center page
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 237 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
You can access the configuration settings of the default External Search Results portlet by clicking the Administration pages → Portlet Management → Portlet and clicking the Configure icon (Figure 11-12).
distribution for not
SPVC; for
Figure 11-12 Configuration settings of the External Search Results portlet guide
Accompanying
238 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 11. WebSphere Portal search
You must make a copy of the portlet first if you want to place additional External Search Results portlets on the Search Center page. Browse or search for the portlet to copy from the listing of portlets. Click the Copy icon, and provide a new meaningful name for the portlet. Then configure the copy as shown in Figure 11-13.
distribution
Figure 11-13 Manage Portlets window for
You need to set the search engine URL in the portlet’s configuration, as shown in Figure 11-14.not
SPVC; for
guide
Figure 11-14 Setting the search engine URL in the portlet configuration
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 239 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
240 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 11: Using external search engines
Lab
Lab 11: Using externaldistribution search engines for not The External Search Results portlet is a specialized portlet that you can add to WebSphere Portal Search. The results of a search initiated from the Search page includes results from third-party external search engines, such as Yahoo! and Google, when you add the portlet.
You can add more thanSPVC; one copy of the External Search Results portlet to the WebSphere Portal Search page. You can also configure each forcopy to display a specific number of search results. This lab includes the following tasks: Configuring external search scopes Configuring the External Search Results portlet guide Objectives
This lab has the following objectives: Configure external search scopes. Update the Ajax proxy configuration. Configure the External Search Results portlet to pull from Yahoo! Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 241 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 1: Configuring external search scopes
Configuring the external search scope defines what the site user sees in the search list. In this task, you configure the external search scope that returns search results in a new window or tab. In Task 2 “Configuring the External Search Results portlet” on page 244, you configure the external search results portlet to show the search results in the Search Center portlet.
The user’s search term, or phrase, that is entereddistribution in the Search field is appended to the search URL string. Therefore, you must rearrange search request parameters to ensure that the user’s query string parameter is positioned last infor the string. To configure the external search scope,not complete these steps: 1. Log in to WebSphere Portal as wpsadmin. 2. Click the Administration link. 3. Click Search Administration → Manage Search → Search Scopes → New Custom Link. 4. In the New CustomSPVC; Link panel (Figure 11-15 on page 243), complete these steps: a. In the Custom link name field, specify the name that you want to showfor in the Scope list. Users will see this name when conducting a search. b. In the Link URL field, specify a search URL to use. For example, you can use one of the following URLs: guide• Google http://www.google.com/search?&q= • Yahoo!: http://search.yahoo.com/search?p= You can also include an icon for the search scope.
Accompanying
242 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 11: Using external search engines
distribution for not Figure 11-15 New Custom Link panel
5. Click OK. The Search Scopes panel (Figure 11-16) shows your changes. SPVC; for
guide
Figure 11-16 Search Scopes panel Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 243 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Figure 11-17 shows options as they are displayed on the Search Center tab. (You can access the Search Center through the link at the top of the portal page.) Google was defined as the external search scope, and no icon was used in this example.
Figure 11-17 Search Center distribution
The result is that the Google site opens in fora browser and shows your search results.
Task 2: Configuring notthe External Search Results portlet
In this task, you update the Ajax proxy configuration to allow the HTTP request for the external site to work. You configure a portlet that retrieves and showsSPVC; search re sults from third-party search engines, such as Yahoo! and Google. for Updating the Ajax proxy
You must modify the proxy configuration of the portlet if you want to addguide or modi fy an external search engine. All HTTP requests from the portlet to the external search engines are directed through the HTTP Proxy for Ajax applications, which are included in WebSphere Portal. The External Search Results portlet includes an application-specific configuration for this proxy. It allows only connections to the URL of the default external search engine in a standard portal installation: http://www.ibm.com/developerworks/views/res/*
Modify the proxy-config.xml file that is bundled with WebSphere Portal to add external search sites as explained in the following steps: Accompanying1. Navigate to Windows:
244 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 11: Using external search engines
C:\IBM\WebSphere\PortalServer\installableApps\ and click 7-Zip → open Archive (Figure 11-18).
distribution for
Figure 11-18 Opening the archive ofnot 7-Zip Linux: /opt/IBM/WebSphere/InstallableApps/ and expand the searchCenter.war file. 2. Locate the proxy-config.xml file in the \WEB-INF folder (Figure 11-19). SPVC; for
Figureguide 11-19 The WEB-INF folder 3. Open the proxy-config.xml file in an editor (Example 11-1).
Example 11-1 Default proxy-config.xml file xmlns:proxy="http://www.ibm.com/xmlns/prod/sw/ajax/proxy-con fig/1.1"> © Copyright IBM Corp. 2011. All rights reserved. 245 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
246 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 11: Using external search engines
5. Save the proxy-config.xml file to the archive. 6. Click Administration → Portal Management → Web Modules. 7. Find searchCenter.war (Figure 11-20), and click the Update Web Module icon.
distribution for not Figure 11-20 Manage Web Modules portlet
8. Click Browse and select the searchCenter.war file that you just updated (Figure 11-21). Click Next. SPVC; for
guide
Figure 11-21 Manage Web Modules portlet
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 247 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
9. In the “Updating a Web module, Step 2: View WAR file contents” panel (Figure 11-22), click Start application. Then click Finish.
distribution for not
SPVC; for Figure 11-22 Web module, Step 2: View WAR file contents panel
You now see a message indicating that the external sites were successfullyguide installed (Figure 11-23).
AccompanyingFigure 11-23 Manage Web Modules portlet
248 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 11: Using external search engines
Configuring the External Search Result portlet
You must be logged in as Administrator to add an External Search Results portlet to the Search Center. The portlet can only be added to the Search Center on the Portal Search page. It will not function anywhere else.
To configure the External Search Results portlet, complete these steps: 1. Click Administration → Portlet Managementdistribution→ Portlets from the main portal menu. 2. Locate External Search Results from forthe list of portlets, and click the Configure icon next to the portlet name (Figure 11-24). not
SPVC; for
Figure 11-24 Searching for External Search Results
3. Click the Edit icon for searchEngineURL and enter the followingguide URL: http://news.search.yahoo.com/news/rss?p=${searchTerms}& ei=UTF-8&eo=UTF-8 4. Click the Edit icon for searchEngineFullPageURL and enter the following URL: http://news.search.yahoo.com/news/rss?p=${searchTerms}& ei=UTF-8&eo=UTF-8 This parameter is optional. You can delete it or leave it empty. A More link, which links to the website of the external search engine, is added at the bottom of the portlet when you set this parameter. The value represents a parameterized form of the URL that is used to locate the search engine that is queried. Accompanying The ${searchTerms} string must be included in the parameter
© Copyright IBM Corp. 2011. All rights reserved. 249 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
value as shown in the following example. The portlet replaces the string represented by ${searchTems} in the following example, with the actual query terms submitted by the user during the search: http://news.search.yahoo.com/news/search?q=${searchTerm s} This URL returns the public HTML page of the search engine. 5. In the “Configure portlet: External Search Results” panel (Figure 11-25), change the value of the numOfEntries parameter to 5. This parameter determines the maximum number of search results to show in the Externaldistribution Search Results portlet. Then click OK. for not
SPVC; for
guide
Figure 11-25 Configure portlet: External Search Results
Accompanying6. Navigate to the Search Center and try the search, then click OK.
250 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 11: Using external search engines
You can now use the External Search Results portlet, as shown in Figure 11-26.
distribution for not
Figure 11-26 Search Center SPVC; for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 251 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
252 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 12. Other administrative portlets
Lesson 12
distribution Lesson 12.Other administrative portlets for not This lesson provides an introduction to other administrative portlets.
This lesson includes the following topics: Portal clients Web clippings SPVC; URL mapping Custom names for Objectives
Thisguide lesson has the following objectives: Support existing clients. Use web clippings. Define URL mappings. Create a custom name.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 253 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: Portal clients
You manage portal clients by using the Manage Clients portlet (Figure 12-1). The portlet is under Administration pages → Portal Setting → Supported Clients.
distribution for not Figure 12-1 Manage Clients portlet
Existing client support
To choose an existingSPVC; client and modify, in the Manage Clients window (Figure 12-1), click the Edit selected client icon.
To edit the selectedfor client, in the Manage Clients window (Figure 12-2 on page 255), change the user agent string, markup, manufacturer, model, version, capability list, such as HTML support, and position relative to other items in the list. These changes are not likely needed to the default entries. guide
Accompanying
254 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 12. Other administrative portlets
distribution for not
Figure 12-2 Manage SPVC;Clients window Adding supportfor for new clients You can create new entries for the supported clients list by using an approach similar to that described for existing clients. Be especially certain that the user agent entry is consistent with the value presented by the client during server requests or the request will guidenot be managed correctly.
Topic B: Web clippings
This topic defines web clippings and explains how to use the Web Clipping Editor to import content.
Defining web clippings
Web clippings are portlets that are created to display all or some of Accompanyingan external site’s content on a portal page. Start from the
© Copyright IBM Corp. 2011. All rights reserved. 255 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Administrative page and select Portlet Management → Web Clipping.
With the Web Clipping Editor portlet (Figure 12-3), administrators can create portlets based on a web clipping configuration.
distribution for Figure 12-3 Using the Web Clipping Editor to create portlets
The effectiveness of web clipping portlets is limited. For example, there is no assurance that the contentnot will remain appropriate if the target URL is beyond the control of an organization. Sites that employ extensive JavaScript do not render well within the web clipping portlet container. Sites that require interaction, such as form submission, are not appropriate candidates for web clipping portlets. SPVC; Using thefor Web Clipping Editor to import content
A simple web clipping portlet requires a name, a target URL, and a description,guide as shown in Figure 12-4.
AccompanyingFigure 12-4 Using the Web Clipping Editor to import content
256 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 12. Other administrative portlets
A preview window is displayed after the simple clipping is defined, as shown in Figure 12-5.
distribution for not
Figure 12-5 Web clipping preview window SPVC; The Web Clipping Editor offers the following advanced options (Figure 12-6 onfor page 258): Choose clipping types and behaviors, such as regions and HTML tags. You might not need or want to capture the entire page. Some pages have information located “below the fold,” which is an areaguide of the web page that requires users to page down to see it. By choosing an alternative clipping type, administrators can present users with the desired content in a way that reduces user effort and improves content visibility. Configure firewall settings that are required to access the target URL. By setting proxy information, the web clipping portlet can access content through a proxy. Define credentials and authentication types. Some sites require authenticating. By using this advance setting, administrators can store the logon credentials and make the content available to a target audience without Accompanying requiring them to provide secondary logons. Protecting secure
© Copyright IBM Corp. 2011. All rights reserved. 257 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
resources such as this is done through portal privilege settings. Modify URL rewriting rules to conform with site requirements. A target site, such as an internal HR site, might be in the process of migrating to a portal. Some links must point back to the portal, where other links might need to refer to resources on the target site. If all content, except the target page, has been moved to the portal, an administrator can choose standard rewriting to point links in the target URL to the portal site. Sites that contain URL links that are not serveddistribution by the portal require URL rewriting exceptions. Define rules for portal rewriting so that linksfor are managed according the nature of the URL. Some links can point to the portal window, but other links can be rewritten to point to an external window. For example, a rule matching such as *ibm\.com.* rewrites any URL thatnot contains ibm.com. Rules can be written in Perl 5 regular expressions.
SPVC; for
Figureguide 12-6 Web Clipping Editor
Topic C: URL mapping
This topic defines URL mapping and explains how to create such mappings.
Defining URL mappings
Users expect a portal to behave similar to other websites. They Accompanyingexpect to bookmark a page and use the Back and Forward buttons. Actually, they expect that, when they use those features,
258 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 12. Other administrative portlets
the portal page will be the same as it was the last time they loaded it. This matter of managing state is important, and portal URLs, the long seemingly indecipherable ones, enable users’ expectations to be met. The view that they expect is distinct from the content that they might also expect. Content is associated with a different persistence layer, such as a session, LDAP, or database facilities. Bookmarks and related user expectations relate to the navigational state.
URL mappings provide entry point navigation to portal pages. Use them in print media, and other locations where reliable URLs are needed. URL mappings are not impacted by changesdistribution in the portal typology, such as moving pages to alternative hierarchy locations.
URL mappings are different from friendly URLsfor in the following ways: URL mappings are not bound to the portal typology. Consider the following URL: not http://www.myportal.com/wps/myportal/TravelPlans This URL mapping reflects none of the portal typology. The URL syntax consists of the following format: protocol://hostname/context/vpname/ url-mapping-context-labelSPVC; A friendly URL, in contrast, might look similar to the following example: for http://www.myportal.com/wps/myportal/Home/ HumanResources/Trips URL mappings are not retained while inter-reacting with the target page. The URL replaces the familiar portal-generated URLguide for navigational state management as soon as it is rendered. Content nodes might have only one friendly URL, and they might have many URL mappings.
Creating a URL mapping
Creating a URL mapping consists of defining a label and a context. The label must never match or overlap a term that is used for a friendly URL. Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 259 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
To access the URL mapping portlet (Figure 12-7), go to the Administration pages and click Portal Settings → URL Mapping.
distribution
Figure 12-7 URL mapping portlet for
Click New Context, which prompts for a label, as shown in Figure 12-8. not
SPVC; for
Figure 12-8 URL mapping portlet
The label is displayed in the lists of contexts after it is defined (Figureguide 12-9).
Figure 12-9 View Content window Accompanying
260 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 12. Other administrative portlets
As shown in Figure 12-10, note that no mapping is listed in the “Mapped to column.” The globe icon prompts the user to select a content node for the context of the label. Content nodes with children are displayed as clickable links. You can search for content nodes or browse the content node hierarchy to locate the context.
distribution for not Figure 12-10 Content node
Topic D: Custom names SPVC; This topic explains custom names and explains how to create them. for Defining custom names
Object IDs identify portal resources to guarantee that each one is unique.guide These generated values are extended alphanumeric strings that can be hard to remember. You can use the Manage Custom Unique Names portlet to assign human-readable names to these resources.
For example, moving resources from staging to production is much easier than using the XML configuration interface. Developers can use these resources to link portlets to other portal resources. The custom unique names are far easier to work with if security is managed by external access control systems.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 261 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Creating custom names
To access the Manage Custom Unique Names portlet (Figure 12-11), go to Administration pages and click Portal Settings → Custom Unique Names.
distribution for not
Figure 12-11 Manage Custom Unique Names portlet
Select the resources by type, such as Pages (Figure 12-12), and then browse or searchSPVC; for the resource. for
guide
Figure 12-12 Choosing a type
Accompanying
262 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 12. Other administrative portlets
Click the Edit icon to define or modify the unique name. Use caution when editing unique names. For example, pages are listed by name and show the object ID and unique name, if defined as illustrated in Figure 12-13.
distribution for not
Figure 12-13 Pages listed by name and showing the object ID and unique name SPVC; for
guide
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 263 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for not
SPVC; for
guide
Accompanying
264 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 12: Performing miscellaneous administration tasks
Lab
Lab 12: Performing distribution miscellaneous for administration tasks not
In this lab, you learn how to perform miscellaneous tasks.
This lab includes the following tasks: Using web clippingsSPVC; to import content Creating a URL mapping Creating customfor names Objectives
Thisguide lab has the following objectives: Use web clippings. Create a URL mapping. Create custom names.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 265 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Task 1: Using web clippings to import content
Web clippings are portlets that are created to display all or some of an external site’s content on a portal page.
To create a web clipping, complete these steps: 1. Click Administration → Portlet Management → Web Clipping. 2. Click New Portlet. distribution 3. In the Web Clipping Editor (Figure 12-14), provide values for the Name and default locale title field,for and the Description field. Enter the following URL in the URL to clip field: http://www-10.lotus.com/ldd/portalwiki.nsf . not
SPVC; for
Figure 12-14 Web Clipping Editor
4. Clickguide Advanced options.
Accompanying
266 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 12: Performing miscellaneous administration tasks
5. In the Modify Web clipper options panel (Figure 12-15), click Modify clipping type.
distribution for
Figure 12-15 Modify Web clipping options panel not 6. In the Modify clipping type panel (Figure 12-16), click one of the options and click OK.
SPVC; for
guide Figure 12-16 Modify clipping type panel
7. Back in the Modify Web clipper options panel, click Modify display options. 8. In the Modify display options panel (Figure 12-17), complete these steps: a. Click Inside an iFrame on the portal page. b. For the Width field, enter 900. c. Click Allow browser to access resources directly. Accompanying d. Click OK. e. Click Next.
© Copyright IBM Corp. 2011. All rights reserved. 267 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
distribution for
Figure 12-17 Modify display options notpanel
9. Click Next.
SPVC; for
guide
Accompanying
268 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 12: Performing miscellaneous administration tasks
10.In the Content preview panel (Figure 12-18), review the changes. Click Finish if you are satisfied with the changes.
distribution for not
SPVC; for Figure 12-18 Content preview panel
The new portlet is now displayed in the Web Clipping Editor (Figure 12-19). guide
Figure 12-19 Web Clipping Editor
11.Click Finish. Accompanying12.Click Home.
© Copyright IBM Corp. 2011. All rights reserved. 269 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Creating a new page
To create a page, named Clipping, complete these steps: 1. Click the Edit page icon. 2. Type the page name in the dialog box that displays. 3. Under Browse Content, select Customize and All. 4. In the Search field, enter pro and click the Search icon, as shown in Figure 12-20.
distribution for not
SPVC;
Figure 12-20 Clipping tab for
5. Add the Product Wiki portlet to the page. 6. Click Save and then click Exit. guide Task 2: Creating a URL mapping
Creating a URL mapping consists of defining a label and a context. The label must never match, or overlap, a term that is used for a friendly URL.
Accompanying
270 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 12: Performing miscellaneous administration tasks
To create a URL mapping, complete these steps: 1. Click Administration → Portal Settings → URL Mapping. 2. In the “URL mapping portlet —, Root contexts” panel (Figure 12-21), click New Context.
distribution for not
SPVC;
Figure 12-21 URL mapping portlet for
3. In the “URL mapping portlet” panel (Figure 12-22), enter SalaryPayroll in the Label field. This label is used in the URL.guide Then click OK.
Figure 12-22 URL mapping portlet
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 271 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
The label is displayed in the list of contexts after it is defined. Note that no mapping is listed in the “Mapped to” column, illustrated in Figure 12-23. 4. For SalaryPayroll, click the globe icon. Content nodes with children are displayed as clickable links (Figure 12-23). You can search for content nodes or browse the content node hierarchy to locate the context.
distribution for not
SPVC; for
Figure 12-23 URL mapping portletguide 5. Click Home → Human Resources → Payroll.
Accompanying
272 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 12: Performing miscellaneous administration tasks
6. As shown in Figure 12-24, click Salary and click OK.
distribution for Figure 12-24 URL mapping portlet
Notice that the “Mapped to” columnnot for SalaryPayroll indicates Salary as shown in Figure 12-25.
SPVC; for
guide
Figure 12-25 URL mapping portlet Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 273 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
7. In the browser, enter the following web address: http://portal99:10039/wps/myportal/SalaryPayroll The page displays. When you look at the URL, you see that it has changed.
Task 3: Creating custom names
To create a custom name for a page, complete these steps: 1. Click Administration → Portal Settings → Custom Unique Names. distribution 2. In the Manage Custom Unique Names portlet (Figure 12-26), for Resource type, click Pages. for not
SPVC; for
Figure 12-26 Manage Custom Unique Names window guide
Accompanying
274 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lab 12: Performing miscellaneous administration tasks
3. In the Manage Custom Unique Names portlet (Figure 12-27), scroll down to the Hourly page and click the Edit icon to modify the unique name.
distribution for not Figure 12-27 Manage Unique Custom Names portlet
4. In the “Edit unique name for Page” panel (Figure 12-28), enter PayrollHourly in the Unique name field and click OK. SPVC; for
guide
Figure 12-28 Edit unique name for Page panel
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 275 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
The Manage Custom Unique Names portlet (Figure 12-29) now shows a message indicating that the change was successful. The new unique name can now be used in administration scripts.
distribution for not
Figure 12-29 Manage Custom Unique Names portletSPVC; Adding unique names to pages enables you to reference them in scripts. Also, if youfor give a page a unique name, you can reuse any scripts that reference that page. This is different from an automatically-assigned unique identifier. An automatically-assigned unique identifier might not be the same across Portals. guide
Accompanying
276 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 13. WebSphere Portal usage analysis
Lesson 13
distribution Lesson 13.WebSphere Portal usage analysis for not This lesson shows how to gather data regarding IBM WebSphere Portal usage and how to analyze the data. You can collect the following types of data: Server-side data, which consists mainly of technical data that is internal to WebSphere Portal Behavioral data, whichSPVC; is how users use WebSphere Portal This lesson includesfor the following topics: Monitoring portal usage Active Site Analytics for user behavior analysis
Objectivesguide
This lesson has the following objectives: Explain how to use portal usage analysis. Determine how to analyze user behavior.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 277 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Topic A: Monitoring portal usage
Why is it useful to monitor portal usage? Organizations invest significant effort to implement a portal solution and need quantifiable answers to questions such as the following examples: Is the focus of use what we expected? How are users changing their usage, and how can we meet their new needs? What do users look for when using the search function? How do users arrive at our site? distribution WebSphere Portal has a logging function thatfor you can use to monitor usage data. It writes usage records to a dedicated log file if site analysis logging is enabled.
You can collect statistical data from notvarious areas by using multiple types of site analyzer logs, or loggers. The WebSphere Portal Server manages the data on its own. You can also log custom details of business events.
Data points availableSPVC; on the server side
The WebSpherefor Portal configuration server, SiteAnalyzerLogService, determines the type of site analysis data that WebSphere Portal logs at run time. The following events are logged based on the service configuration: Page management, such as creating, reading, updating, and deletingguide pages Page requests by users Portlet requests by users Session activities, such as login, logout, time out, and login failed User management actions, such as creating, reading, updating, and deleting users and groups
The resulting log entries comply with the National Center for Supercomputing Applications (NCSA) Combined industry standard. You can monitor the applications on your WebSphere Portal by analyzing the log entries. The site analysis infrastructure Accompanyingprovided by WebSphere Portal accommodates most scenarios.
278 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 13. WebSphere Portal usage analysis
Custom report: You must write a custom report to log custom business events that occur in portlets. You can obtain a more sophisticated evaluation of WebSphere Portal usage or generate reports for portlet action by writing such a report.
You can find more information at the following WebSphere Portal wiki pages: Analyzing portal usage data http://www-10.lotus.com/ldd/portalwiki.nsf/dx/ Analyzing_portal_usage_data_wp7 distribution Logging and analyzing server-side site data http://www-10.lotus.com/ldd/portalwiki.nsf/dx/ Logging_and_analyzing_server_side_site_data_wp7for
Enabling server-side loggingnot
Site analysis logging is not enabled by default. The names and locations of the log files must be specified as parameters in WP SiteAnalyzerLogService to enable site analysis logging. SPVC; The following steps to enable server-side logging are for reference only. You perform them in the lab that follows this lesson. 1. Specify the namesfor for the log files and backup log files. a. Specify the location and file name of the log file as follows. SiteAnalyzerFileHandler.fileName guideThe default value is logs/$APPSERVER_NAME/sa.log. b. Specify the location and file name of the backup file for the log file as follows: SiteAnalyzerFileHandler.backupFileName The default value is logs/$APPSERVER_NAME/sa_$CREATE_TIME.log. The current data is stored in the sa_$CREATE_TIME.log backup file, and a new sa.log log file is created when the log file is backed up. You can specify the following tokens as part of the directory location or file name: – $APPSERVER_NAME is the name of the application server. Use this token for vertical clusters to enforce that the different Accompanying application servers write to different files if they share the same file system.
© Copyright IBM Corp. 2011. All rights reserved. 279 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
– $CREATE_TIME is the date and time that the file is created. Specify the format of this token in SiteAnalyzerFileHandler.dateFormat. – $CLOSE_TIME is the date and time that the file is closed. Specify the format of this token in SiteAnalyzerFileHandler.dateFormat. 2. Specify the date format for tokens in the log file names: SiteAnalyzerFileHandler.dateFormat Specify a value to format the date and time for the $CLOSE_TIME and $CREATE_TIME tokens as in the following example:distribution SiteAnalyzerFileHandler.dateFormat=yyyy.MM.dd- HH.mm.ss 3. Specify the interval to back up log files.for The following parameter sets the backup interval in minutes. Specify the value between 1 and 60. SiteAnalyzerFileHandler.minutesPerLogFilenot The following line sets the backup interval in hours. Specify a value between 1 and 24. SiteAnalyzerFileHandler.hoursPerLogFile The following line sets the backup interval in days. Specify any value that indicatesSPVC; the number of days between backups. SiteAnalyzerFileHandler.daysPerLogFile for Tips for specifying the date and interval: When specifying the date and interval, consider these tips: Use the smallest interval if you enable more than one guidedate format interval. The file is backed up after 60 minutes if you specify 60 minutes. The file is backed up on the next full hour, for example, 01:00, 02:00, and so on, if you specify one hour. The file is backed up at 24:00 (midnight), if you specify an interval of days.
4. Activate the loggers as appropriate. Select the logger that you plan to activate and set the value to true, as in the following example: Accompanying SiteAnalyzerSessionLogger.isLogging=true
280 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 13. WebSphere Portal usage analysis
Tip: Site analysis logging can impact performance. Consider choosing to disable loggers for this reason when necessary. Set the value to false to disable loggers.
Table 13-1 lists and describes the available loggers.
Table 13-1 Available loggers WebSphere Portal Server analysis logger Description and activity logged SiteAnalyzerSessionLogger.isLogging HTTP requests that include the URLs: /Command/Login /Command/Logout distribution SiteAnalyzerUserManagement HTTP requests that include the URLs: Logger.isLogging /Command/UserManagement/for CreateUser /Command/UserManaement/ DeleteUser /Command/UserManagement/ CreateGroup /Command/UserManagement/not DeleteGroup SiteAnalyzerPageLogger. isLogging HTTP requests that include the URLs: /Page/* /Command/Customizer/ CreatePage /Command/Customizer/ EditPage /Command/Customizer/ DeletePage SiteAnalyzerPortletLogger. isLogging SPVC;HTTP requests that include the URL /Portlet/* SiteAnalyzerPortletAction Logger.isLogging HTTP requests that include the URL for /PortletAction/* SiteAnalyzerErrorLogger. isLogging HTTP requests that include the URLs: /Error/Portlet /Error/Page SiteAnalyzerApplication guide HTTP requests that include the URL ActionLogger.isLogging /ApplicationAction/* SiteAnalyzerJSRPortlet Logger.isLogging JSR 286 Web Content Viewer
SiteAnalyzerErrorLogger.isLogging: The Referrer field, shown in the following examples, points to a portlet name or a page name: http://your.server.name/Portlet/1/PortletName http://your.server.name/Page/1/PageName
Accompanying5. Restart WebSphere Portal.
© Copyright IBM Corp. 2011. All rights reserved. 281 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Reading the log files
The WebSphere Portal site analysis information is in the /wp_profile_root/logs/app_server_name/sa_date_time.log directory. In this path, wp_profile_root is the WebSphere Portal root directory, and date_time is the date and time at which the file is created. The current, active log file is the sa.log file.
Remember that the dateFormat parameter determines the interval at which the file is created.
The site analysis log uses the NCSA Combined logdistribution format, which is a combination of the NCSA Common log format and three additional fields: Referrer, user_agent, andfor cookie . Example 13-1 shows a sample entry in the log. Example 13-1 Sample log file entry not 9.37.3.88 - customer2 [10/Apr/2010:21:33:16 +0000] "GET /Portlet/146/Welcome_Portlet?PortletPID=146&PortletMode= View&PortletState=Normal HTTP/1.1" 200 -1 "http://myserver.company.com/Page/110/ Welcome" "Mozilla/4.0 (compatible;SPVC; MSIE 5.5; Windows NT 4.0)" "JSESSIONID-OXDFAPVR4SXYZOIHSLVGA2Y"for
Table 13-2 describes each field.
Table 13-2 Log field descriptions Field guideLog field name and description 9.37.3.88 Host. The IP address of the HTTP client that sent the request. The IP address that is logged is of the reverse proxy server rather than the HTTP client if a reverse proxy server is between the client and WebSphere Portal. - (hyphen character) ref931.The identifier user to identify the client making the request. The field is set to the hyphen character (-) if the client identifier is unknown. customer2 User Name. The user ID for the client. The field is set to the hyphen character (-) if the user ID is unknown. [10/APR/2010:21:33:16 +0000] Date:time time zone. The date and time of the HTTP Accompanying request.
282 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 13. WebSphere Portal usage analysis
Field Log field name and description "GET /Portlet/146/ Request. The HTTP method, the URL of the requested Welcome_Portlet? PortletMode= resource, and the version of the HTTP used by the client. View&PortletState= Normal HTTP/1.1" 200 Status code. The HTTP status code for the request. -1 Bytes. The number of bytes of data transferred from the client as part of the request. A value of -1 means unknown. "http://myserver.company.com/ Referrer. The URL that linked the client to the web site. The Page/110/Welcome" referrer might not be logged for some requests.distribution The field is set to empty double quotation marks (" ") in such cases. "Mozilla/4.0 (compatible; MSIE user_agent. The type of web browser used by the client. 5.5; Windows NT 4.0)" for "JSESSIONID=OXDFAPVR4SXYZOIHS cookies. The name and value of a cookie that was sent to the LVGA2Y" client browser. The list is delimited by the semicolon character (;) if multiple cookies are sent.not
Topic B: Active Site Analytics for user behaviorSPVC; analysis
WebSphere Portal provides Active Site Analytics (ASA), with which you can collectfor data on how your users use WebSphere Portal. A rich set of page metadata, including the following examples, is provided as part of WebSphere Portal’s themes and skins: Page title Pageguide identifier Portlet title Portlet identifier
You can write scripts, called aggregators, to retrieve the data. The WebSphere Portal Page Builder theme includes a sample aggregator named asa.sample.js. You can customize these aggregators or write your own to collect page metadata, such as the previously listed examples.
You add the aggregator scripts to pages as required. The aggregator is then injected into the markup of the page the next Accompanyingtime the page is rendered. You can select the point of injection
© Copyright IBM Corp. 2011. All rights reserved. 283 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
arbitrarily. For example, injection can occur just before the closing body tab of the HTML markup.
Figure 13-1 shows an example of how an aggregator fits into the regular flow.
distribution for not
SPVC; for Figure 13-1 How an aggregator fits into the regular flow
The user behavior data is retrieved for analysis from markup that is embedded in the WebSphere Portal pages. The aggregator that is associatedguide with the page formats the data so that it can correspond to the requirements of the external analytics server to which it is finally submitted. You can change the information that is retrieved from the page and submitted for analysis by changing the JavaScript.
The data is represented as a microformat in the WebSphere Portal page HTML Document Object Model (DOM) tree and tagged with cascading style sheet (CSS) classes. The following example shows a microformat: My Portlet Accompanying
284 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 13. WebSphere Portal usage analysis
Figure 13-2 shows the page structure with annotated portlets.
distribution for not
Figure 13-2 Page structure with annotated portlets SPVC; Samples and custom aggregator for You can write your own aggregators, or scripts, to retrieve data for Active Site Analytics from the WebSphere Portal themes and skins. Remember that the Page Builder theme includes the sampleguide aggregator asa_sample.js file. The WebSphere Portal themes and skins come with plugpoints that you can inject custom JavaScript snippets. You can write an aggregator to retrieve the instances of the microformat in which you are interested. For example, the aggregator can be all CSS classes that start with asa. You can extract that data and submit it to the external analytics service, where the data is then recorded and processed for evaluation.
The aggregator script is typically a JavaScript file. A standard JavaScript code implementation builds URLs with Active Site Analytics parameters. Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 285 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Tips for using the sample aggregator When you use the sample aggregator file, asa_sample.js, remember the following tips: Update the JavaScript variable trackingImg to point to a real HTTP server. Ensure that the tracking image exists and is available. Otherwise, the alternative text is displayed on the WebSphere Portal page. Additional tips for writing aggregators distribution Keep in mind the following additional tips for writing aggregators: The aggregator can iterate over all instances of metadata to retrieve the relevant information for the forHTML DOM tree. The aggregator collects and formats individual data according to the requirements of the external analytics service within the iteration loop. not The aggregator adds a new element (for example, an img element) to the HTML DOM tree of the current page after all instances of metadata are collected. Adding this element with the source URL, which points to the external analytics service, triggers a browser request from that remote location. The browsers submits SPVC;this data to the external analytics service, because the element URL contains the collected metadata as HTTP GET parameters.for The sample aggregators contain more detailed information about the process of collecting, formatting, and submitting data.
Identifyingguide and solving problems for Active Site Analytics Perform the following checks if Active Site Analytics is not working correctly: Verify that the HTML markup of the WebSphere Portal page contains the metadata for which the aggregator is looking. Ensure that the tagging method that is used in the themes, skins, and portlets matches the expected behavior of the aggregator. For example, the Page Builder theme is shipped with the portal tags and all metadata with CSS classes whose names start with asa. The sample aggregators look for those Accompanying CSS classes to retrieve portlet identifiers and portlet titles.
286 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 13. WebSphere Portal usage analysis
Specify the following trace string to review what occurs in the aggregator inclusion: com.ibm.wps.theme.extensions.ActiveSiteAnalytics=debug
Remember that aggregators are regular JavaScript files. All tools and helpers that are applicable to generic JavaScript debugging also apply to developing and debugging an aggregator.
Supported aggregator tags WebSphere Portal supports the following aggregator tags for Active Site Analytics: distribution Portlet window ID The unique identifier of the portlet. Tag it as asa.portlet.id. It is injectedfor into the skin. Portlet window title The title of the portletnot becaus e it is delivered to the client. Tag it as asa.portlet.title. It is injected into the skin. Page URL The friendly URL of the current page without navigational state. Tag it as asa.url. This element is empty if no friendly URL was set for the page. Page title The titleSPVC; of the page in the WebSphere Portal default language. Tag is as asa.page.title. It is forinjected into the theme. Web Content Management content querystring The unique identifier of the IBM Lotus Web Content Management content item that is displayed in a portlet. Tag it as guide asa.wcm.content_item.path. It is injected into the Web Content Management Rendering Portlet. Web Content Management content title This is the title of the Web Content Management content item that is displayed in a portlet. This is not necessarily the same as the portlet window title. Tag it as asa.wcm.content_item.title. It is injected into the Web Content Management Rendering Portlet.
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 287 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
Adding an aggregator to a page
You can assign an aggregator to one or more WebSphere Portal labels or pages. To assign an aggregator to a page, you edit the page properties and add a new parameter by using the WebSphere Portal administration portlets.
The following steps, to add an aggregator to a page, are for reference only. You perform them later in the lab. 1. Click Administration → Manage Pages. 2. Locate the page to which you want to assign thedistribution aggregator. Use the Manage Pages portlet to locate the page. The page must be under the WebSphere Portal contentfor root. 3. Click the Edit Page Properties button for the page that you selected. You cannot add an Active Site Anotnalytics aggregator to the content root. An Edit Page Properties button is not available for the content root. 4. Expand Advanced Options to expand the available choices. 5. Click the I want to set parameters link. 6. In the window thatSPVC; opens, complete the following tasks: a. In the New Parameter field, type asa_aggregator. b. In the Newfor value field, type the name of the aggregator script file. c. Click Add. 7. Verify that the new parameter has been added to the list. 8. Clickguide OK to return to the main Page Properties window. 9. Click OK to save your changes and return to the Manage Pages window.
Children and parent pages: Children pages inherit the script that was set on the parent page. You can use these same steps to make the appropriate assignment if you want to use a different aggregator on a child page.
You can also use these steps to block inheriting the aggregator setting from the “parent” page. The difference is to only leave the value in step 6b on page 288 blank. As a result, no Accompanyingaggregator is assigned for the page, and all children of the page will inherit the new setting.
288 © Copyright IBM Corp. 2011. All rights reserved. Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Lesson 13. WebSphere Portal usage analysis
Aggregators and themes
WebSphere Portal provides the Page Builder theme that is prepared and suitable with Active Site Analytics. You can also enhance the other portal themes or create your own custom theme to use the Active Site Analytics functionality.
Making Active Site Analytics work in a custom theme entails the following tasks: 1. Adding metadata to the page 2. Including an aggregator with the page distribution 3. Including microformats of interest that are related to the statistical data you want to collect for Adding metadata to the page An aggregator picks up information notthat is stored in the DOM tree of a page. This information must be present in the HTML source of the page. The preferred approach to add this information to a page is to implement the theme or skin so that it writes all the necessary information into the DOM tree of the page.
The following examplesSPVC; show adding metadata to a page: You can add the identifier of a portlet to the DOM tree by adding the followingfor line to the skin.html file in the theme WebDAV folder:
Accompanying
© Copyright IBM Corp. 2011. All rights reserved. 289 Course materials may not be reproduced in whole or in part without the prior written permission of IBM. Installation and Administration of IBM WebSphere Portal 7.0 on Windows: Student Guide
You can add the portlet title to the DOM tree by wrapping the
Including aggregators with the page The portal ships a default implementation of the theme extension point com.ibm.portal.theme.plugin.ActiveSiteAnalyticsItemsdistribution. It locates and includes a JavaScript with a name that corresponds to the value specified by the asa_aggregator key that is given with the page metadata. for
Add the code in Example 13-2 near the closing body tag (