CYAN MAGENTA
YELLOW BLACK PANTONE 123 CV
THE EXPERT’S VOICE ® IN CONTENT MANAGEMENT
EMPOWERING PRODUCTIVITY FOR THE CMS PROFESSIONAL
The Definitive Guide to Interwoven TeamSite
The Definitive Guide to
Brian Hastings
Justin McNeal
Interwoven TeamSite is the premier solution for enterprise-level web content management. Utilizing award-winning, patented technology, TeamSite is capable of hosting high-level enterprise applications, from intranet services to mission-critical websites. It interfaces seamlessly with a host of portal platforms and enterprise applications, including IBM, BEA, SAP, Plumtree, Siebel, and PeopleSoft. This is just one of the reasons why General Electric, Siemens, Cisco, and other blue-chip companies use TeamSite. The Definitive Guide to Interwoven TeamSite leads you through the process of defining your enterprise content management system (ECMS) requirements; designing the solution; implementing a robust, reliable, and efficient system; and delivering that system to your end users. We introduce you to ECMS concepts as well as the Interwoven TeamSite architecture, TeamSite’s key features, and the detailed implementation that you will need to understand in order to carry out each aspect of your ECMS project. We also provide guidelines for many different roles within an enterprise, including technical and nontechnical roles. The book uses the Rational Unified Process (RUP) as a software development methodology and teaches how to incorporate key RUP documents and principles while building an ECMS, upgrading an existing system, or just enhancing your current setup. We have many years of experience in the trenches performing ECMS implementations, and we have built this book around a case study of a fictional but typical financial-services firm, thereby exposing all the features of TeamSite. We will guide you from the project inception phase to the transition phase and help you avoid common pitfalls in the process. Whether you are a newcomer to ECMSs or a seasoned professional, you can use this book to achieve your goals. Brian Hastings and Justin McNeal
Join online discussions:
SOURCE CODE ONLINE
forums.apress.com
www.apress.com
FOR PROFESSIONALS BY PROFESSIONALS ™
Interwoven TeamSite
Dear Reader,
ISBN 1-59059-611-0 90000
Shelve in Web Development/Content Management Systems
6
89253 59611
1
Hastings, McNeal
The Definitive Guide to
Interwoven TeamSite Harness the power of this enterprise web content management platform
Brian Hastings and Justin McNeal Foreword by Russell Nakano, Cofounder and former Principal Consultant, Interwoven
9 781590 596111
User level: Beginner–Advanced
this print for content only—size & color not accurate
7" x 9-1/4" / CASEBOUND / MALLOY
6110_Ch00_FINAL
7/2/06
1:00 PM
Page i
The Definitive Guide to Interwoven TeamSite
Brian Hastings and Justin McNeal
6110_Ch00_FINAL
7/2/06
1:00 PM
Page ii
The Definitive Guide to Interwoven TeamSite Copyright © 2006 by Brian Hastings and Justin McNeal All rights reserved. No part of this work may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or by any information storage or retrieval system, without the prior written permission of the copyright owner and the publisher. ISBN-13: 978-1-59059-611-1 ISBN-10: 1-59059-611-0 Printed and bound in the United States of America 9 8 7 6 5 4 3 2 1 Trademarked names may appear in this book. Rather than use a trademark symbol with every occurrence of a trademarked name, we use the names only in an editorial fashion and to the benefit of the trademark owner, with no intention of infringement of the trademark. Lead Editors: Jason Gilmore and Keir Thomas Technical Reviewer: Tom Shell Editorial Board: Steve Anglin, Ewan Buckingham, Gary Cornell, Jason Gilmore, Jonathan Gennick, Jonathan Hassell, James Huddleston, Chris Mills, Matthew Moodie, Dominic Shakeshaft, Jim Sumser, Keir Thomas, Matt Wade Project Manager: Denise Santoro Lincoln Copy Edit Manager: Nicole LeClerc Copy Editor: Kim Wimpsett Assistant Production Director: Kari Brooks-Copony Production Editor: Kelly Winquist Compositor: Diana Van Winkle Proofreader: Lori Bring Indexer: Toma Mulligan Artist: Diana Van Winkle Cover Designer: Kurt Krames Manufacturing Director: Tom Debolski Distributed to the book trade worldwide by Springer-Verlag New York, Inc., 233 Spring Street, 6th Floor, New York, NY 10013. Phone 1-800-SPRINGER, fax 201-348-4505, e-mail
[email protected], or visit http://www.springeronline.com. For information on translations, please contact Apress directly at 2560 Ninth Street, Suite 219, Berkeley, CA 94710. Phone 510-549-5930, fax 510-549-5939, e-mail
[email protected], or visit http://www.apress.com. The source code for this book is available to readers at http://www.apress.com in the Source Code section. You will need to answer questions pertaining to this book in order to successfully download the code.
6110_Ch00_FINAL
7/2/06
1:00 PM
Page iii
This book is dedicated to my mother, Shirley Ruth McNeal (March 11, 1946–July 3, 2004). Mom, you were the strongest woman I have ever known, you taught me about hard work, you gave me my strength, and you taught me what love and sacrifice truly mean. I can never thank you enough for everything you have given me, and I hope you are proud of the man I have become. —Justin McNeal This book is dedicated to my family, who has worked together to form who I am. To my parents, Ron and Vickie Hastings, who spent the time and effort to provide me with a sense of morality and good judgment. To my grandparents, Paul and Tracy Piper, who always made sure I had what I needed, and to my uncle, Cletus Piper—without him introducing me to computers at such a young age, I would not have had a chance to write this book. I would also like to dedicate this book to my wife, Muffy Hastings, for supporting me through the long hours that this project forced me to undertake. —Brian Hastings
6110_Ch00_FINAL
7/2/06
1:00 PM
Page iv
6110_Ch00_FINAL
7/2/06
1:00 PM
Page v
Contents at a Glance Foreword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv About the Authors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii About the Technical Reviewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxix Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxi Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiii
PART 1
■■■
■CHAPTER 1 ■CHAPTER 2
PART 2
PART 3 ■CHAPTER ■CHAPTER ■CHAPTER ■CHAPTER ■CHAPTER ■CHAPTER ■CHAPTER ■CHAPTER ■CHAPTER ■CHAPTER ■CHAPTER
What Is Content Management? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Defining the CMS Project Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
■■■
■CHAPTER 3 ■CHAPTER 4
The Inception Phase
Introducing TeamSite and Friends . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Gathering Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
■■■ 5 6 7 8 9 10 11 12 13 14 15
Introducing the Rational Unified Process
The Elaboration Phase
Building the Hardware Infrastructure . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Installing the CMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Building the Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 Using FormsPublisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Working with Content in TeamSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 Using Tools and TeamSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Deploying Files and Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 Introducing Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 Authenticating and Authorizing Users . . . . . . . . . . . . . . . . . . . . . . . . . 289 Designing the CMS Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301 Determining Interface Needs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315 v
6110_Ch00_FINAL
7/2/06
1:00 PM
PART 4
■■■
Page vi
The Construction Phase
■CHAPTER 16 Authoring Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 ■CHAPTER 17 Understanding the Business Process Flow . . . . . . . . . . . . . . . . . . . . 381
PART 5
■■■
The Transition Phase
■CHAPTER 18 Delivering the CMS to the Customer . . . . . . . . . . . . . . . . . . . . . . . . . . 419 ■CHAPTER 19 Working with LiveSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433 ■CHAPTER 20 Seeing Interwoven’s Vision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451
PART 6
■■■
■APPENDIX A ■APPENDIX B ■APPENDIX C
Appendixes
FormsPublisher: Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461 FormsPublisher: Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475 Perl Modules for Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
■INDEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
6110_Ch00_FINAL
7/2/06
1:00 PM
Page vii
Contents Foreword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv About the Authors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxvii About the Technical Reviewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxix Acknowledgments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxi Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxxiii
PART 1
■■■
■CHAPTER 1
Introducing the Rational Unified Process
What Is Content Management? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 What Is Content? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Content Has a Classification Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Content Has a File Type/MIME Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Content Has Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Content Requires Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Content Has a Purpose Not Related to the CMS . . . . . . . . . . . . . . . . . 5 Defining Content Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Recognizing the Business Need for Content Management . . . . . . . . . . . . . 6 Amount of Dynamic and Static Content . . . . . . . . . . . . . . . . . . . . . . . . 7 Complexities of Your Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Frequency of Updates or Additions to Your Content . . . . . . . . . . . . . . 8 Archival and Retention Requirements of Your Content . . . . . . . . . . . . 8 Statutory or Legal Requirements for the Use of Your Content . . . . . . 8 Requirements of External Sources to Supplement Your Content . . . 8 Delivery Requirements for Your Content, Including Different Presentation Types and Data Layouts . . . . . . . . . . . . . . . . . . . . . . . 9 Authoring Requirements for Your Content, As Well As the Audience of That Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Metadata and Searching Requirements for Your Content . . . . . . . . 10 Syndication and Deployment Requirements for Your Content . . . . . 10 Separating Data and Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Introducing Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Using Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Understanding Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
vii
6110_Ch00_FINAL
viii
7/2/06
1:00 PM
Page viii
■CONTENTS
Introducing User Groups and Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Introducing Repositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Do You Understand Your Data? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 How Much Data Will Be Stored? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 What Is the Anticipated Future Growth of Your Data? . . . . . . . . . . . . 21 How Complex Are the Data Relationships? . . . . . . . . . . . . . . . . . . . . 21 What Are Your Data Retention Requirements? . . . . . . . . . . . . . . . . . . 21 What Are the Data Retrieval Requirements of Your System? . . . . . 21 Knowing What to Look for in a CMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Open and Flexible Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Support for Multiple Data Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Integration Capabilities with Existing Systems . . . . . . . . . . . . . . . . . 22 Separation of Data and Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Flexible and Configurable Workflow Engine . . . . . . . . . . . . . . . . . . . . 23 Effective Use of Standards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Content Authoring Toolset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Multiple-User Authoring Environment . . . . . . . . . . . . . . . . . . . . . . . . . 23 Metadata Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Easy to Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Version Management/Archival Capabilities and Rollback Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Should Meet Your Specific Content Needs . . . . . . . . . . . . . . . . . . . . . 24 Should Have a Strong Customer Base and Stable Performance Track Record . . . . . . . . . . . . . . . . . . . . . . . . . 24 Should Match Your Budget and Future Growth . . . . . . . . . . . . . . . . . 24 Investigate the Features and Functionality That This CMS Cannot Provide for Your Organization . . . . . . . . . . . . . . . . . . 25 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
■CHAPTER 2
Defining the CMS Project Scope
. . . . . . . . . . . . . . . . . . . . . . . . . . 27
Defining Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Security Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 User Interface Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Authoring or Content Creation Factors . . . . . . . . . . . . . . . . . . . . . . . . 28 Migration Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Content Types and Content Intelligence Factors . . . . . . . . . . . . . . . . 28 Search Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Workflow/Business Process Factors . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Publishing/Delivery Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Repository Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
6110_Ch00_FINAL
7/2/06
1:00 PM
Page ix
■CONTENTS
System Administration Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 Reporting Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Base CMS Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Training Factors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Delivery/Target Launch Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Defining the Functionality and Deliverables . . . . . . . . . . . . . . . . . . . . . . . . . 30 Project Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Project Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Project Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Project Risks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Delivery Date . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Introducing FiCorp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Learning All About FiCorp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Getting a Look at the Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Getting a Look at a Landing Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Getting a Look at the News Releases Summary Page . . . . . . . . . . . 42 Understanding FiCorp’s Needs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
PART 2
■■■
■CHAPTER 3
The Inception Phase
Introducing TeamSite and Friends . . . . . . . . . . . . . . . . . . . . . . . . . 47 Introducing TeamSite Content Management Server 6.5 . . . . . . . . . . . . . . 48 Branching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Supported Web Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Application Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Introducing TeamSite Search for TeamSite 6.5 . . . . . . . . . . . . . . . . . . . . . . 51 Index Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Search Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Introducing LiveSite 2.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Supported Client Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
ix
6110_Ch00_FINAL
x
7/2/06
1:00 PM
Page x
■CONTENTS
Introducing TeamXML 5.5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 TeamXML-Compatible Authoring Tools . . . . . . . . . . . . . . . . . . . . . . . . 54 Introducing OpenDeploy 6.0.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 N-tiered Deployments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Transactional Deployments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Introducing DataDeploy 6.0: Database Deployment for OpenDeploy . . . 57 TeamSite Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Supported Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Introducing ContentServices 1.1.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Introducing ControlHub 2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Introducing ReportCenter for TeamSite 6.5 . . . . . . . . . . . . . . . . . . . . . . . . . 59 Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Supported Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Introducing FormsPublisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Introducing MetaTagger 4.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Introducing MediaBin 4.5.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Application Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Supported Platforms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Supported Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Following Best Practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
■CHAPTER 4
Gathering Requirements
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Defining the Initial Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Introducing Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Defining and Documenting a Project Glossary . . . . . . . . . . . . . . . . . 64 Completing the Catalogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Creating a Use Case Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Understanding the Elements of a Use Case Document . . . . . . . . . . . . . . . 74
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xi
■CONTENTS
Examining a Use Case Document . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Use Case Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Log In to CMS Use Case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Defining Non-Use-Case Functional Requirements . . . . . . . . . . . . . . . . . . . 78 Conducting a Requirements Workshop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Defining Workflow Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Defining Template Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83 Defining External Program Requirements . . . . . . . . . . . . . . . . . . . . . 84 Mapping the Selected Vendor’s Product Offerings to CMS Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
PART 3
■■■
■CHAPTER 5
The Elaboration Phase
Building the Hardware Infrastructure . . . . . . . . . . . . . . . . . . . . . 89 Understanding How Release Cycles Affect Hardware Layout . . . . . . . . . . 89 Setting Up the Content Authoring Environment . . . . . . . . . . . . . . . . . 90 Customizing TeamSite Application Development and Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Coordinating Small and Large Development Efforts . . . . . . . . . . . . . 93 Choosing a Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Selecting FiCorp’s Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 TeamSite 6.5 and Interwoven Search . . . . . . . . . . . . . . . . . . . . . . . . . 95 OpenDeploy and DataDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 MetaTagger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Looking at the New FiCorp Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 TeamSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Content/Application Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Search Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Mail Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 MetaTagger Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
■CHAPTER 6
Installing the CMS
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111
Creating an Installation Plan . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Assembling and Organizing the Installation Team . . . . . . . . . . . . . 113 Training the Installation Team . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
xi
6110_Ch00_FINAL
xii
7/2/06
1:00 PM
Page xii
■CONTENTS
Considering TeamSite Installation Issues . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Considering Additional Server Installation Issues . . . . . . . . . . . . . . . . . . . 116 Determining the Content Preview Server . . . . . . . . . . . . . . . . . . . . . 117 Setting Up Repositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Determining TeamSite Command Responsibilities . . . . . . . . . . . . . . . . . . 118 Installing TeamSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 main . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 iwcgi . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 event_subsystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 teamsite_servlet_ui . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 teamsite_templating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 iwwebd . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 iwproxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 [iwproxy_fullproxy_redirect] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 [iwproxy_remap] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 global_default_map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 iwproxy_preconnect_remap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 iwproxy_preconnect_redirect . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 [iwproxy_failover_remap] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 iwproxy_hostheader_remap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 iwproxy_smartcontextedit_allowed . . . . . . . . . . . . . . . . . . . . . . . . . 122 iwproxy_access_control_enabled . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 iwproxy_external_remap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 iwserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 iwsend_mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 iw_workflow_ui . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 visualannotate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Considering Additional Component Installation Issues . . . . . . . . . . . . . . 127 Installing ReportCenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 Installing Content Transformation Services . . . . . . . . . . . . . . . . . . . 128 Installing TeamXML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 Installing TeamPortal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Installing OpenDeploy and DataDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Configuring Database Deployments . . . . . . . . . . . . . . . . . . . . . . . . . 130 Configuring OpenDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xiii
■CONTENTS
Configuring Neighbor Hosts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 Determining Deployment Schemes and Destinations . . . . . . . . . . 133 Choosing the Database Solution . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 Placing OpenDeploy Receivers for Database Deployments . . . . . 134 Installing MetaTagger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 Configuring and Optimizing MetaTagger . . . . . . . . . . . . . . . . . . . . . 134 Configuring MetaTagger Admin GUI . . . . . . . . . . . . . . . . . . . . . . . . . . 136 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
■CHAPTER 7
Building the Repository
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Understanding the Content Store Architecture . . . . . . . . . . . . . . . . . . . . . 137 What Is a Branch? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 What Is a Workarea? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 What Is TeamSite Staging? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 What Is an Edition? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Backing Up the Content Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Archiving and Retaining Your Data . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Asking the Right Questions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Accessing the Repository . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Defining a Branching Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Who Needs Access? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 Keeping It Simple . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 When Do You Create a New Branch? . . . . . . . . . . . . . . . . . . . . . . . . 147 What About Workareas? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 When to Create Editions? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Creating a Branching Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Creating the Branches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Determining Branch Ownership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Creating Workareas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 Utilizing the Branching Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Performing Get Latest Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Specifying Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Using the templatedata Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 Versioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 Reverting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
xiii
6110_Ch00_FINAL
xiv
7/2/06
1:00 PM
Page xiv
■CONTENTS
■CHAPTER 8
Using FormsPublisher . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Understanding Data Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Understanding Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Defining Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 Creating the Caption Box Data Capture Template . . . . . . . . . . . . . . 168 Creating the Global Caption Box Data Content Record . . . . . . . . . 170 Creating the Local Caption Box Data Content Record . . . . . . . . . . 171 Using FormAPI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 Promoting Reuse of Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Building Presentation Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 Creating a Caption Box Presentation . . . . . . . . . . . . . . . . . . . . . . . . . 177 Seeing the Final Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
■CHAPTER 9
Working with Content in TeamSite
. . . . . . . . . . . . . . . . . . . . . . . 183
Repurposing Your Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 Reusing Your Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183 Evaluating the ROI of Reuse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Evaluating the Time to Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Using Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Working with TeamSite Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Searching Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Editing Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Using the Local File Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 Importing Images/Content into ContentCenter . . . . . . . . . . . . . . . . 201 Using the Visual Format Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 Collecting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Collecting Digital Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 Managing Assets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
■CHAPTER 10 Using Tools and TeamSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Working with TeamSite Front Office . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Installing the TeamSite Front Office Server . . . . . . . . . . . . . . . . . . . 216 Installing the TeamSite Front Office Client . . . . . . . . . . . . . . . . . . . . 218 Understanding the Components of TeamSite Front Office Client . . . 219 Implementing Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 Using External Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xv
■CONTENTS
Working with MetaTagger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221 Using MetaTagger Studio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 Using the Content Intelligence Configuration Manager . . . . . . . . . 222 Using the Content Intelligence Metadata Viewer (CIViewer) . . . . . 222 Introducing Taxonomy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222 Creating a Taxonomy with MetaTagger Studio . . . . . . . . . . . . . . . . 224 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233
■CHAPTER 11 Deploying Files and Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 Using OpenDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 Understanding the OpenDeploy Components . . . . . . . . . . . . . . . . . 235 Introducing OpenDeploy Basics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 Understanding Deployment Types . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 Introducing Topologies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 Using Important Deployment Features . . . . . . . . . . . . . . . . . . . . . . . 245 Using DataDeploy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 Introducing Structured Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 Introducing Schemas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 Introducing Database Autosynchronization . . . . . . . . . . . . . . . . . . . 251 Introducing Database Deployments . . . . . . . . . . . . . . . . . . . . . . . . . . 252 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255
■CHAPTER 12 Introducing Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 Understanding Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 Building a Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 Mapping Out a Workflow Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 Creating a Workflow Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 Examining Workflow Template Components . . . . . . . . . . . . . . . . . . . . . . . 265 Using the Workflow Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266 Setting Up the template_script Element . . . . . . . . . . . . . . . . . . . . . . 266 Using Workflow Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271 Using Workflow Elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 281 Using Perl Modules for Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . 286 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 287
xv
6110_Ch00_FINAL
xvi
7/2/06
1:00 PM
Page xvi
■CONTENTS
■CHAPTER 13 Authenticating and Authorizing Users . . . . . . . . . . . . . . . . . . . 289 Introducing Authentication and Authorization in TeamSite . . . . . . . . . . . 289 Maintaining Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292 Managing Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293 Adding Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 294 Deleting Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 296 Integrating LDAP and TeamSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297 Integrating Active Directory and TeamSite . . . . . . . . . . . . . . . . . . . . 299 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
■CHAPTER 14 Designing the CMS Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301 Defining User Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 301 Out of the Box: User Roles Before Version 6.7 . . . . . . . . . . . . . . . . . 301 Out of the Box: User Roles in Version 6.7 and Later . . . . . . . . . . . . 302 Understanding Author Role Permissions . . . . . . . . . . . . . . . . . . . . . . 305 Understanding Editor Role Permissions . . . . . . . . . . . . . . . . . . . . . . 308 Administrator Role Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308 Understanding Master Role Permissions . . . . . . . . . . . . . . . . . . . . . 309 Creating and Customizing User Roles . . . . . . . . . . . . . . . . . . . . . . . . 310 Specifying Delegated Administration . . . . . . . . . . . . . . . . . . . . . . . . 311 Defining OpenDeploy Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 311 Defining DataDeploy Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312
■CHAPTER 15 Determining Interface Needs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315 Customizing ContentCenter Standard (CCS) . . . . . . . . . . . . . . . . . . . . . . . 316 Understanding the Target Audience . . . . . . . . . . . . . . . . . . . . . . . . . . 316 Understanding the Purpose and Usage . . . . . . . . . . . . . . . . . . . . . . . 316 Recognizing Icons in ContentCenter Standard . . . . . . . . . . . . . . . . 319 Customizing Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322 Customizing ContentCenter Pro (CCPro) . . . . . . . . . . . . . . . . . . . . . . . . . . . 335 Understanding the Target Audience . . . . . . . . . . . . . . . . . . . . . . . . . . 335 Understanding the Purpose and Usage . . . . . . . . . . . . . . . . . . . . . . . 335 Recognizing Icons in CCPro . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337 Customizing Displays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 339 Using the Administrative Tab Available in CCPro . . . . . . . . . . . . . . . 343
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xvii
■CONTENTS
Using Interwoven’s Casual Contributor Interface . . . . . . . . . . . . . . . . . . . 345 Using URL-Based Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 345 Using ContentServices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348 Using ContentServices JNI Libraries . . . . . . . . . . . . . . . . . . . . . . . . . 349 Using the ContentServices SOAP Libraries . . . . . . . . . . . . . . . . . . . 349 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 350
PART 4
■■■
The Construction Phase
■CHAPTER 16 Authoring Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 Laying the Foundation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353 Creating the Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355 Creating the Footer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 358 Creating the Caption Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 360 Creating the Content Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 368 Configuring the Proxy and File Permissions . . . . . . . . . . . . . . . . . . . . . . . . 378 Remapping the Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 378 Avoiding Problems with the Remap . . . . . . . . . . . . . . . . . . . . . . . . . . 379 Configuring the Submit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 379 Testing Submit Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 380
■CHAPTER 17 Understanding the Business Process Flow . . . . . . . . . . . . . . 381 Designing the Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382 Creating the Workflow Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 382 Creating the Workflow Components . . . . . . . . . . . . . . . . . . . . . . . . . 384 Developing the Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388 Developing the Workflow Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388 Developing the Work Review Component . . . . . . . . . . . . . . . . . . . . . 401 Developing the Review Component . . . . . . . . . . . . . . . . . . . . . . . . . . 407 Developing the Deployment Component . . . . . . . . . . . . . . . . . . . . . 411 Developing Another Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 415
xvii
6110_Ch00_FINAL
xviii
7/2/06
1:00 PM
Page xviii
■CONTENTS
PART 5
■■■
The Transition Phase
■CHAPTER 18 Delivering the CMS to the Customer . . . . . . . . . . . . . . . . . . . . . 419 Moving into the CMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 419 Importing Existing Content into the CMS . . . . . . . . . . . . . . . . . . . . . 420 Templatized or Not? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421 Delivering Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423 Creating the Template Development Guide . . . . . . . . . . . . . . . . . . . 423 Creating Help Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424 Using the Estimating Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 424 Training Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428 Developing a Training Strategy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 428 Conducting User Training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430 Selling the CMS Internally . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431 Creating Your Sales Kit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 431 Conducting Lunch-Bag Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432 Creating CMS/WCM Champions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432 Building Your Product/Service Catalog . . . . . . . . . . . . . . . . . . . . . . . 432 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
■CHAPTER 19 Working with LiveSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433 Using LiveSite vs. Using TeamSite Alone . . . . . . . . . . . . . . . . . . . . . . . . . . 433 Who Are the Users? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 434 How Does Everyone Benefit from LiveSite? . . . . . . . . . . . . . . . . . . . 435 Working with LiveSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436 Using the LiveSite Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 436 Using the LiveSite Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437 Using the Component Branch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437 Using LiveSite Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 439 Using the New Component Menu Item . . . . . . . . . . . . . . . . . . . . . . . 439 Using the New Template Menu Item . . . . . . . . . . . . . . . . . . . . . . . . . 445 Creating a New Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 448 Adding Pages to the Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 449 Publishing the Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 450
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xix
■CONTENTS
■CHAPTER 20 Seeing Interwoven’s Vision . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 451 Interwoven’s Offerings for Business Segments . . . . . . . . . . . . . . . . . . . . . 453 Product Management Themes for Web Content Management . . . . . . . . 454 Minimize Dependency on Core IT Resources . . . . . . . . . . . . . . . . . . 454 Configurable Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454 Delegated Administrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454 Local User Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454 Run As Nonroot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 454 Remove Requirements for Perl in Workflow . . . . . . . . . . . . . . . . . . . 455 Rich Text–Editing Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455 Linux Will Be a First-Tier Platform in Version 6.7.1 . . . . . . . . . . . . . 455 Global Enterprises and Customer Satisfaction . . . . . . . . . . . . . . . . . . . . . 455 Localization of Content and the User Interface . . . . . . . . . . . . . . . . 455 Incremental Enhancements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 455 Interoperability of Products . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456 Other Future Focus Areas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456 Translations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456 LiveSite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 456 Content Transformation Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457 Best-Practice Websites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457 Portal Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457 Personalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
PART 6
■■■
■APPENDIX A
Appendixes
FormsPublisher: Forms
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 461
Element . . . . . . . . . . . . . . . . . . . . . . . . . . . 461 Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462 Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 462 Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463 Container Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463 XML DTD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464 Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465 Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 465
xix
6110_Ch00_FINAL
xx
7/2/06
1:00 PM
Page xx
■CONTENTS
Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 Item Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 XML DTD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 The browser Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 466 The checkbox Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468 The hidden Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 469 The radio Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 470 The readonly Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471 The select Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 471 The text Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 472 The textarea Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473
■APPENDIX B
FormsPublisher: Presentation
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
TeamSite::DCRnode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475 TeamSite::DCRparser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475 TeamSite::PT::iw_case . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475 XML Node Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475 Operation Attribute (op) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476 expr Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476 Perl Variable Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 476 Expression Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477 TeamSite::PT::iw_comment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477 TeamSite::PT::iw_cscript . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477 language Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 477 debug Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478 ienc Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478 TeamSite::PT::iw_else . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478 TeamSite::PT::iw_if . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478 expr Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 478 TeamSite::PT::iw_ifcase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 name Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 TeamSite::PT::iw_include . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 –iw_include-location Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 file Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 file_val Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 ienc Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 pt Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479 pt_val Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480 mode Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xxi
■CONTENTS
TeamSite::PT::iw_iterate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480 var Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480 list Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480 order/filter Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480 iteration Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481 label Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481 TeamSite::PT::iw_last . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481 label Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481 TeamSite::PT::iw_load_dcr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 481 file Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482 file_val Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482 var Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482 mode Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482 global Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482 TeamSite::PT::iw_next . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 482 label Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483 TeamSite::PT::iw_ostream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483 file Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483 file_val Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483 buffer Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483 filter Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483 filter_all Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483 append . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483 mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484 oenc . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484 TeamSite::PT::iw_perl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484 iwpt_output($string,$ienc) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484 iwpt_get_dcr_value($element) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484 iwpt_get_list($element_name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484 iwpt_get_flag_param($flag) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 484 iwpt_get_ofile_name($section) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 iwpt_get_dcr_name($section) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 iwpt_get_pt_name($element) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 iwpt_open_osenc($file_path) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 iwpt_load_dcr($file,$mode,$global) . . . . . . . . . . . . . . . . . . . . . . . . . 485 iwpt_get_default_oenc() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 iwpt_get_ostream_name() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 iwpt_set_ostream_name($buffer) . . . . . . . . . . . . . . . . . . . . . . . . . . . 485 iwpt_get_ostream_data($buffer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486 iwpt_set_ostream_data($buffer_name,$string) . . . . . . . . . . . . . . . 486
xxi
6110_Ch00_FINAL
xxii
7/2/06
1:00 PM
Page xxii
■CONTENTS
TeamSite::PT::iw_pt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486 encoding Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486 –iw_pt-dcr Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486 –iw_pt-arg Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486 –iw_pt-preview Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486 TeamSite::PT::iw_repeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486 TeamSite::PT::iw_sql_iterate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 486 TeamSite::PT::iw_sql_open . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 487 TeamSite::PT::iw_sql_query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488 TeamSite::PT::iw_system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 488 TeamSite::PT::iw_then . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489 TeamSite::PT::iw_url_escape . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489 TeamSite::PT::iw_value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489 TeamSite::PT::iwov_xslt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490 iwpt_compile.ipl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 490
■APPENDIX C
Perl Modules for Workflows
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493
TeamSite::WFsystem . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493 new() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493 GetWorkflows() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493 GetActiveWorkflows() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494 GetTasks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 494 GetActiveTasks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495 CreateWorkflow($job_specification,$file_input) . . . . . . . . . . . . . . . 495 Refresh() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 495 TeamSite::WFworkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496 new($workflow_id) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496 GetId() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496 GetError() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496 SetError($error_message) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 496 IsValid() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497 GetTasks() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497 GetOwner() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 497 GetCreator() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498 GetName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 498 ($task_found_flag, $task_obj) = GetTaskByName($task_name) . . 498 GetDescription() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499 GetParentTask() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499 Invoke() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499 GetVariables() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xxiii
■CONTENTS
GetVariable($variable_name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 500 SetVariable($variable_name, $variable_value) . . . . . . . . . . . . . . . . 500 CreateVariable($variable_name, $variable_value) . . . . . . . . . . . . . 501 DeleteVariable($variable_name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501 SetDescription($description) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 501 SetOwner($user_id) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502 Refresh() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502 TeamSite::WFtask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502 new($task_id) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 502 GetType() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 GetOwner() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 GetName() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 GetState() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 503 IsTryingToLock() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504 NeedsAttention() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504 GetSharedBy(\@users, \@groups) . . . . . . . . . . . . . . . . . . . . . . . . . . . 504 GetTimeout() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 504 GetActivationTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505 GetUnactivationTime() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 505 GetDuration($duration,$ format) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506 GetDescription() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506 GetCommand() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506 Refresh() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 506 GetWorkflowId() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507 AddFile($path, $comment) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 507 AddMultipleFiles(\@paths, $comment) . . . . . . . . . . . . . . . . . . . . . . . 507 RemoveFile($path, $comment) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508 SetDescription($description) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508 SetComment($comment) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 508 SetOwner($user) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509 SetArea($area_virtual_path) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509 SetTimeout($timeout) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 509 SetAttribute($attribute_name, $value) . . . . . . . . . . . . . . . . . . . . . . . 510 AddUser($user_id) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510 RemoveUser($user_id) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 510 AddGroup($group_name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511 RemoveGroup($group_name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 511 TakeTask($user_id) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512 UntakeTask() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 512 SelectTransition($transition_number, $comment) . . . . . . . . . . . . . 512 CallBack($transition_number, $comment) . . . . . . . . . . . . . . . . . . . . 513
xxiii
6110_Ch00_FINAL
xxiv
7/2/06
1:00 PM
Page xxiv
■CONTENTS
IsValid() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 513 GetSubmitEvents() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514 GetUpdateEvents() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514 Getfiles() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514 GetFilesAndComments(\%f_and_c) . . . . . . . . . . . . . . . . . . . . . . . . . . 514 GetArea() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515 GetWftFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515 GetJobFile() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515 GetNestedJobs() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 515 GetComments(\@comments) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516 GetFileComments(\@comments) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 516 GetError() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517 SetError($error_message) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517 GetVariables() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 517 GetVariable($variable_name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 518 SetVariable($variable_name, $variable_value) . . . . . . . . . . . . . . . . 518 CreateVariable($variable_name, $variable_value) . . . . . . . . . . . . . 518 DeleteVariable($variable_name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . 519
■INDEX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 521
4c1b045c8cd4a20afc3b4a21b651d385
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xxv
Foreword A
digital flood is upon us. Content inundates us. It begins as bits of content swirling everywhere—a document, an image, a written corporate procedure, a web page, or an email. The binary mist mixes, combines, and rains down on us. It pools in laptops, on desktops, and in server farms. Creeks and streams meander to corporate reservoirs. Modern civilizations prosper and thrive as continents surrounded by oceans of content. But content is a resource that must be actively managed in order to safeguard its freshness. Left unmanaged, it seeps away, picks up funny odors, or simply becomes stale. It is no longer adequate to store content in odd-sized barrels and ladle out more to anyone who needs some. Interwoven TeamSite is a modern content distillery. It assists content creators who brew new tonics. You can combine an essence from here with an ingredient from there with the help of customized content-entry interfaces. Workflow enables the sequencing, routing, notification, and coordination between the stages of creation, review, post-processing, and dissemination. Search adds cohesion to the repository by vastly increasing individual productivity and by fostering the organizational reuse of existing content. Underneath it all hums a controlled storage repository where standard components interact with custom modules to bring carefully refined business logic to life. With this book, Brian Hastings and Justin McNeal have assembled a practical guide to help information technologists and business analysts grasp the essential concepts on which content management systems are built. Having constructed systems many times themselves, the authors know that practitioners learn best from case studies and true-to-life examples. For example, what is important to know, and what are common mistakes? What factors convince an organization to embark on a journey to bring its content under control? What principles and insights from the Rational Unified Process can be applied to content management? The Definitive Guide to Interwoven TeamSite answers these questions and more. The authors bring an impressive breadth of experience to this book. On one hand, a system architect can find example code for presentation templates and workflow tasks to give them a concrete understanding of the technical skills required to complete the intensive Construction phase of the project and give them a glimpse of possible features. On the other hand, in Chapter 18 a project manager will find suggestions for reaching out to the internal community during the Transition phase. Activities could include sponsoring information sessions, identifying potential solution champions within the organization, and devising a detailed training strategy. Content management has come a long way over the past ten years, compared to earlier times when it seemed that only software writers cared about building repositories and versioning content. The flood of content has risen to new heights. With this book, we all become better navigators. Russell Nakano Former principal consultant and cofounder of Interwoven, author of Web Content Management: A Collaborative Approach (Addison-Wesley, 2001), and current president and cofounder of Nahava
Sunnyvale, California June 2006
xxv
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xxvi
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xxvii
About the Authors ■BRIAN HASTINGS is the vice president and cofounder of Rational Solutions, an Internet technologies and web services consulting company based in St. Louis, Missouri. Brian has been working with Interwoven TeamSite for seven years and has worked as a CMS implementation specialist, developer, and architect for clients such as AG Edwards, MasterCard International, and FedEx. He is currently working toward his Sun Certified Enterprise Architect certification because he knows that when working within an IT field, it is critical to continue sharpening your skills and developing new ones. This is why Brian has written this book—to help individuals as well as enterprises continue to grow. ■JUSTIN MCNEAL is the president and cofounder of Rational Solutions, an Internet technologies and web services consulting company based in St. Louis, Missouri. He has the MCP, CCNA, I-Net+, CIW, Network+, and e-Biz+ certifications and is IBM certified as an E-Business–Solution Technologist. Justin has been a full-time consultant and technical trainer for ten years, during which he has consulted for major Fortune 500 companies such as IBM, FedEx, and Elsevier. Justin has been deeply involved with ECMSs with an emphasis on Interwoven TeamSite for more than seven years. During that time, Justin has worked as a lead analyst on CMS implementations and has conducted and led numerous technical training workshops, including teaching ECMS and TeamSite internationally for MasterCard International. Justin was one of five people chosen as a subject matter expert for CompTIA’s e-Biz+ test analysis and helped develop and conduct the final analysis of the e-Biz+ 2004 test. Justin enjoys the enrichment that technology, when implemented properly, can have on businesses and on people’s lives, and he loves discovering new ways to improve business processes. In his spare time, Justin enjoys hiking, fishing, and traveling.
xxvii
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xxviii
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xxix
About the Technical Reviewer ■TOM SHELL is an enterprise services executive for Interwoven, the leading provider of ECM solutions, located in Sunnyvale, California. He has more than twelve years of experience developing, selling, and supporting customer business solutions. In his eighth year with Interwoven, Tom brings his content management expertise and his broad mix of analysis, design, and implementation experience to his work. Most of all, Tom is deeply committed to applying technology to everyday challenges. This technologist and proudly self-proclaimed geek lives in Ann Arbor, Michigan, with his wife, three sons, and dog.
xxix
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xxx
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xxxi
Acknowledgments F
irst and foremost, we would like to thank our creator and heavenly father; without him, nothing is possible. We would also like to give special thanks to our friends and family for putting up with our long hours of work, for dealing with our endless excuses for skipping activities to work on the book, and for listening to no less than 10,000 iterations of “We’re almost done—only a couple of more weeks.” We would also like to thank our current colleagues who supported us and listened to us talk about the book incessantly, as well as our past colleagues who supported us during our voyages in the IT world. Thanks to everyone who allowed us to use their name in the finished book—you know who you are! Special thanks go out to Tom Shell from Interwoven for his considerable efforts and expertise as our technical reviewer. A thank you to Sunil Menin (senior product manager, web content management, at Interwoven) for his expertise, tireless conference calls, latenight emails, and can-do attitude. We would also like to thank Tom Brauch for his tremendous creative and visual design expertise in the fabrication of our fictitious company (FiCorp) for the case study. We would like to thank Mr. Russell Nakano for really making this all possible. If he had not founded Interwoven, then we certainly would not have written this book. Thank you again, Mr. Nakano—you are an inspiration. Finally, thank you to anyone who we might have inadvertently forgotten (P.S. let us know for the second edition)!
xxxi
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xxxii
6110_Ch00_FINAL
7/2/06
1:00 PM
Page xxxiii
Introduction T
he Definitive Guide to Interwoven TeamSite is the first comprehensive book about this enterprise-level content management system (CMS). Divided into six parts, it guides you through the Interwoven TeamSite architecture, key features, and detailed implementation. The book presents material using the Rational Unified Process as a development framework and project methodology. Each part of the book introduces the concepts and TeamSite features that you will need to understand in order to carry out each aspect of your TeamSite project. This book provides a complete road map for creating a working implementation and offers numerous visual guides by painstakingly covering the project process. We also include a crucial case study of a fictitious financial services firm called FiCorp. Throughout the book, we share the key development strategies, deployment principles, best practices, and insider tips that we have gathered over the many years of working in enterprise CMS environments at various Fortune 500 companies. We also discuss future Interwoven product releases, including LiveSite, MetaTagger, and SalesSite. Finally, we share insight into the future product vision of Interwoven and TeamSite.
In the Beginning . . . (Our CMS Beginning) When we were first exposed to TeamSite, we never thought what we were doing had a name. Content management was what they were calling it. The plan for how it should work seemed valid, but we quickly found out we had been using a tool called TeamSite that had been interestingly enough interwoven into the existing custom systems. We were given the task of upgrading the system and had no idea how hard it was going to be. You see, the team was fairly small when TeamSite was implemented, and they had created a demo to show management how the tool could benefit the company. When they showed off the demo, management decided they would start using the demo implementation for live content. From that day forward, they started building on top of the demo. Like most teams, the implementation had been done with little technical knowledge about how TeamSite worked or what it could really do. So, the team took their years of experience in Perl development and web development and did what they knew best. They tied a huge amount of custom code to the base functions provided by TeamSite. This worked wonderfully—until the upgrade came along. We soon found out that a lot of the customizations could now be handled using TeamSite base functionality. The problem was with all of the current customizations, the users had become lazy. They wanted all the new functionality that TeamSite could give them while keeping the existing functionality they been given through customizations. IT management was pushing hard for using functionality that came right out of the box, and marketing was pushing for customization. This struggle took almost a year to resolve while at the same time the new system was being built. After a lot of sleepless nights and hard work, both IT and marketing ended up with a great system.
xxxiii
6110_Ch00_FINAL
xxxiv
7/2/06
1:00 PM
Page xxxiv
■INTRODUCTION
The moral of this story is that if they had been able to access some good inside information about how to build the system, the team would not have built so much custom code around it. There is nothing wrong with custom code, but you should try to limit the amount built by fully utilizing functionality provided to you by TeamSite. If you do decide to build custom code, make sure you build it in the most intelligent and extensible way. Custom code should not be the deciding factor for not upgrading to the latest and greatest TeamSite version. Once you fall behind in versions, it can become difficult to catch up (and many times if you are building it, Interwoven is planning for it in a future release). So, when we started in content management, there really weren’t any good references available for someone to learn more about this technology. This means we made a lot of mistakes; however, you don’t have to make the same ones. After reading this book, you will be armed with the knowledge needed to build a successful CMS. This means you will be able to build a system that makes life easy for its users, and you will be able to upgrade to the next version of TeamSite with as little effort as possible.
Why You Should Buy This Book This book is the only book of its kind available on the market today. In fact, no other source exists for self-paced home training on TeamSite, LiveSite, and MetaTagger. This book will teach you what you need to know about Interwoven TeamSite including best-practice implementation steps.
Who Is This Book For? We, as TeamSite consultants, wrote this book specifically for enterprise CMS (ECMS) professionals. We designed this book to aid technical individuals as well as nontechnical individuals. This book contains a great deal of hands-on information that we gathered from years of implementing CMSs in Fortune 500 companies. The goal of this book is to educate all those involved in the product evaluation, business analysis, technical sales, project management, and ECMS architecture/development of a CMS implementation. For example, technical individuals such as software developers will gain detailed knowledge of Interwoven code modules, which will aid in creating custom code. For system analysts and architects, we have laid out the overall picture of what a CMS should look like, how it should be designed, and how it should be implemented. This will help when putting together the requirements and designing the overall enterprise solution. If you’re a technical salesperson, you will gain insight into how a CMS is implemented. Whether you are selling the Interwoven system or another CMS, you will understand the products available from an implementation viewpoint. For nontechnical individuals such as project managers, this book provides a great up-front look at creating a project plan. In addition, business analysts will learn some of the ways to solve business needs and will learn the questions that need asking. No matter what your role is in an organization, you will find this book useful. We also sincerely hope you enjoy this book as much as we enjoyed writing it for you.
6110_Ch01_FINAL
7/2/06
1:01 PM
PART
Page 1
1
■■■
Introducing the Rational Unified Process The Rational Unified Process (RUP) is a process framework for developing software engineering projects. The RUP is comprised of four phases, namely, the Inception, Elaboration, Construction, and Transition phases. Within each phase, disciplines organize activities by the nature of those activities. Disciplines group the activities with the roles that perform them and the artifacts that must be produced for each workflow. Disciplines are guidelines that instruct you on how to perform specific activities. Some disciplines include the Requirements, Analysis and Design, and Implementation disciplines. Roles are specific job functions with specific responsibilities in the RUP. Some examples include the requirements reviewer, the requirements specifier, and the system analyst. Artifacts are work products that are developed during the project and used to convey information about the project. The RUP focuses on six specific best practices for software development. These are best practices not so much because you can precisely quantify their value but, rather, because they are observed to be commonly used in the industry by successful organizations. These best practices are as follows: Develop software iteratively: This best practice talks about the impossible goal of defining all the requirements before starting to develop the software. What this teaches is that a better approach is to define, develop, and deploy the software iteratively, with each iteration involving end user and project stakeholder feedback. This allows issues to be caught early in the process rather than later and for those issues to be corrected and the software to be refined along the way. Manage requirements: The RUP describes how to elicit, define, and derive requirements that are agreed on by project stakeholders. Requirements are broken down into use
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 2
case requirements and functional requirements that are not specific to use cases and that seek to maintain traceability between those gathered and derived requirements. Use component-based architectures: The RUP focuses on early proof-of-concept development of a prototype. Development is empowered to use new and existing software components that have a clearly defined purpose. Using components in software helps ensure software reuse. Visually model software: The process describes how to visually model software, thereby reducing ambiguity between analysis, design, and development. The industry standardized Unified Modeling Language (UML) is utilized as the foundation for successful modeling. Verify software quality: Continually verify software quality during each iteration of the development. The quality of a software product should be reviewed in regard to reliability, functionality, and performance. Control changes to software: The ability to manage change is being able to accept those changes (which are inevitable) and manage those changes across development efforts. The process describes how to track, control, and monitor changes to ensure successful iterative development. As is often the case in organizations where the RUP is used, the full RUP is never realized or fully implemented; this is indeed the case in this book. The RUP does not have to be implemented fully to be effective and to add significant value. This book is not a book that will teach you everything about the RUP, and you will not be a RUP expert after reading this book. You will, however, understand more about the RUP, and you will understand how to apply that process to a content management system (CMS) implementation and to your future CMS projects.
6110_Ch01_FINAL
7/2/06
1:01 PM
CHAPTER
Page 3
1
■■■
What Is Content Management? H
ello, and welcome to The Definitive Guide to Interwoven TeamSite. You have made an extremely important investment for yourself and your company that will pay large dividends for your content management system (CMS) implementation. We have written this book hoping to assist others in tackling the daunting task of implementing an enterprise CMS (ECMS). We have drawn upon our combined decade of experience implementing and managing the Interwoven CMS, gathering tips and tricks learned along the way, and combined the knowledge into one source, this book. With the help you’ll find in this book, you will have fewer sleepless nights and a more successful CMS implementation.
What Is Content? Before we speak about content management, you should take a moment to better understand the concept of content itself. Only in this way can you more fully understand content management, the impact it has had in modern-day e-business, and the effectiveness, usefulness, and vital role of CMSs. We define content in an organization as any organizational informational asset that exists in an electronic medium. Although it can be argued that any physical information resource can be classified as content, in the context of this book we will not consider any source as content until it exists in an electronic form. Some typical examples of content include e-books, manuals, publications, web pages, video files, music, instructional material, promotional material, help text…the list goes on and on. You can classify anything as content for an organization if it fits into all of the following sections.
Content Has a Classification Type Typically the classification type is organizational; in other words, content can be categorized by an organizational unit such as marketing content, legal content, general content, privacy content, and so forth. A company that performs only legal services may use contracts, wills, deeds of trust, billing invoices, summons, and other legal type content, while a medical publishing company may depend upon drug data sheets, patient handouts, medical books, and drug news as content.
3
6110_Ch01_FINAL
4
7/2/06
1:01 PM
Page 4
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Content Has a File Type/MIME Type Any piece of content has an associated file type, that is, the file extension that is tied to a particular program or standard. On the Windows platforms, file extensions tell the operating system the program or application to launch to service the specific file type. For example, an image file will generally have an extension such as .gif, .jpeg, .jpg, .bmp, .png, or .tif. In a CMS, file types are important to drive storage placement and delivery requirements, as well as to determine how certain files will be viewed. For example, in CMSs, the file type may control whether certain files are displayed in an iframe, a separate window, or the current window.
Content Has Metadata Content has data attributes that describe it. These data attributes are described collectively as metadata. Metadata is used for many functions within a CMS: Indexing data for search-related capabilities: You can intelligently add keywords to each content type via a defined taxonomy. A taxonomy is an intelligent mapping of taxons (the highest-level grouping) and taxa (subgroups under each taxon) that are unambiguous and, when taken together, consider all the possible values. For example, have you ever played the guessing game 20 Questions? This game usually starts with someone thinking of something that you then have to guess based on the responses of the 20 questions you get to ask. Usually you start by asking something similar to “Is it an animal, vegetable, or mineral?” If the other person playing with you answers your question by saying “Animal,” then you may ask “Is it a dog, cat, or human?” You will then continue until you guess the subject or you run out of questions. Each of those high-level categories of Animal, Vegetable, or Mineral would be a taxon. The taxa would then stem from the higher-level taxon; for example, the taxa for the Animal taxon might be Dog, Cat, and Bird. Clustering on metadata and exposing that clustering to search: For example, by clustering metadata, you can list all books or all documents from the marketing department or list all the content about a certain topic. With clustering metadata, you can capture important information such as the author name or publish date. When exposed to a search engine, you then provide the ability to list all books published by a certain author or, for example, all books published from 1995 to 2001. You could also capture the subject for specific topicbased searching. By clustering with metadata, you can accomplish advanced searches such as retrieving all the books published by a certain author, of a certain subject, and published from 1995 to 2001. By having clustering data available, you can group search results and create dynamic drill-down capabilities by dynamically rebuilding the search query. Automating system-created content using an intelligent method: You can create new and complete content dynamically, where pieces of content are combined or aggregated into an entirely new piece of content based on system requirements or at run time. If content authoring is performed where content is created at the smallest possible level, then this is possible but still difficult to accomplish. Synthesizing content is especially useful for content such as marketing collateral and presentations that should be shared across an organization or several diverse sales teams.
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 5
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Determining when data should be archived and when data should be removed: These topics are often overlooked in a CMS application. By setting metadata attributes and associating those attributes with content, you can manage the demotion or deletion of content. Additionally, if your corporation has retention standards, you can programmatically control when content is archived and even where the archived content is stored. Determining when content is promoted or published: By associating metadata with your content, you can program that content’s promotion date and time. A business content review process will control when the content has reached an acceptable publishing state, but why not also control when that content is made live?
Content Requires Storage Simply put, content takes up space, which is typically database space or space on a file system. Some examples of storage space used to store content include network-attached storage devices such as those provided by EMC, relational databases such as Oracle or SQL Server, and file systems such as the Unix file system or NTFS. No matter what the content or the content’s type, you must have adequate space in which to store it. All content has a certain number of bits and bytes that compose it. This collection of bits and bytes takes up disk space and must be accounted for in a CMS.
Content Has a Purpose Not Related to the CMS Configuration files, templates, or any other files that are used by the CMS should not be considered actual content. Basically, any file that does not provide value to a consumer of the content is not considered content. People who use content are also known as content consumers.
Defining Content Management Content management is the organizing, directing, controlling, manipulating, promoting, and demoting of content and/or digital informational assets within an organization. Promoting content means deploying content from the authoring environment to the content delivery environment, which is usually a web server. Demoting content means removing or rolling back content from the content delivery environment to the content authoring environment. A CMS manages those various pieces of content described earlier. This is extremely important for organizations because as a business grows, so do the complexities of its content. Businesses have hundreds, thousands, and sometimes millions of pages of content, and with the overwhelming flood of this content, they need help! A CMS is much more than an off-theshelf piece of software that a company purchases and configures for its specific needs. To understand content management, you not only have to have a view of the proverbial forest but also need to know where each tree belongs. Implemented properly, content management and a CMS can do the following: • Improve delivery time from content creation to content promotion • Improve content quality
5
6110_Ch01_FINAL
6
7/2/06
1:01 PM
Page 6
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
• Reduce the cost of managing an organization’s global or departmental content • Reduce redundancies in content and reduce human error • Eliminate orphaned files and broken links • Automate content notifications and the review process • Enforce legal and branding standards • Improve content visibility and accountability throughout the delivery chain Implemented poorly, a CMS system can be a virtual money pit, where no efficiencies are gained and many hours are wasted on a project that may provide little to no value to end users or consumers. You must understand two important facts regarding a CMS: • A CMS will not improve your business process. You will have to expend some analysis cycles and rethink existing processes and procedures to enhance your business flow. Only by improving your existing process will you realize the true benefit of content management. • A CMS is not free. Skipping the cost of the solution itself, you will be burning hours to implement a system. Once everyone starts to use the system and find out what the system can do, they will want more. This will also lead to additional implementations and maintenance. This is a topic we cannot reinforce strongly enough: setting up a CMS is more expensive than just building an initial website. You must be willing to accept the initial cost of building and deploying a CMS before you experience a return on investment. But you will have to trust that all of the hard work, project hours, and budget allotments will pay off in the end.
Recognizing the Business Need for Content Management In the early days of the Internet, the need for sophisticated content management mechanisms did not exist. At that time, all you had were a few engineers who were more interesting in transmitting technical and scientific data than they were in using the Internet as the incredible ________. Well, you fill in the blank. These days the Internet is commonly relied upon as a marketing vehicle, supply-chain management channel, and distribution channel, among many other uses. Indeed, the Internet as a medium or transportation vehicle for content has come a long way. The bulk, complexity, and necessity of content management were not a problem in the past. The techie renegades did not worry about how their content would look, about when it would reach the other end of the world, or about how their company image (or brand) may be injured or helped by how their data was arranged or how fresh or stale that content was; they didn’t even care about performing any specialized integration with unique application or business logic servers. When companies came around to using the power of their content, you still found the renegades who knew the technology inside and out and the business folks who would try to explain exactly what they wanted for their content. These content renegades were in high demand because they were the only ones in an organization who understood the technology,
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 7
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
and therefore they were the only ones who could update that content. This was a problem in the past because the content was so tightly coupled with the technology. In today’s world, the needs of corporations are complex, and equally complex, if not more so, are their content (basically the data that makes up their Internet, extranet, and intranet sites) management needs.
GETTING TO KNOW SOME TERMS An Internet site is any website that is publicly available over the World Wide Web. The Internet uses the public telecommunication networks infrastructure, HTTP over TCP/IP, and any computer that is connected to it to connect billions of users around the world. A company’s Internet site usually contains marketing content and other nonconfidential information and may also serve to provide an entry point to secured site areas. An extranet site is any website that is privately available and serves to connect users of the extranet site to the company that manages the extranet site. An extranet site uses Internet technologies and requires security and privacy that is usually managed via encryption, passwords, and tokens, as well as uses virtual private networks. An intranet site is any website that uses Internet technologies and is available only to internal resources. An intranet is usually available only to employees of an organization and is usually used to provide information to those employees or to facilitate their working environment.
As the complexities of content has grown, the complexities of available tools required to access, implement, and modify that content have been reduced, allowing the ability for the true content experts (the marketing, sales, administrative, and managerial staffs) to better manage that content. The business need for content management cannot be explained with a one-size-fits-all mentality; rather, it is driven by your own organization’s need. Generally, all companies need some content management. However, the level of content management for individual companies will vary greatly. Your company’s need for a CMS is determined by the following factors.
Amount of Dynamic and Static Content Does your organization have several thousand pieces of content? If your organization has a large amount of content where the storage and management of that content is complex, then a CMS will help you. Managing many pieces of content and making that content available for content consumers can be a tricky undertaking. We typically find that the more discrete pieces of content an organization has, the more it must increase its information technology (IT) staff or administrative staff to manage this content. Having a CMS means never having to worry about where documents and content are stored or how to retrieve that content.
Complexities of Your Content Complex content needs demand a CMS. Content built dynamically from many sources and content that depends on other content can lead to content management headaches. Without a CMS, content updates are forgotten, navigation is updated incorrectly, and content quality suffers.
7
6110_Ch01_FINAL
8
7/2/06
1:01 PM
Page 8
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Frequency of Updates or Additions to Your Content When content changes frequently, typically more than once per day, a CMS is imperative. Humans simply cannot keep up with frequent content updates. A good rule of thumb is that if your content has more than 20 to 30 updates a month and one or more of the other factors apply, then you need a CMS. A CMS can contain the intelligence to know about dependent pieces of content and can alert the author to make those required changes. Without this system in place, controlling content updates can be confusing and time-consuming. A CMS will also streamline the authoring process with authoring tools such as what-you-see-is-whatyou-get (WYSIWYG) editors.
■Note A WYSIWYG editor is a piece of software that allows content creation without the use of complicated markup characters and shows the content author exactly how the finished content will look while the authoring is taking place. For example, creating a Microsoft Word document in Print Layout mode gives you a WYSIWYG view. Some popular Hypertext Markup Language (HTML) WYSIWYGs include Microsoft FrontPage and Adobe GoLive.
Archival and Retention Requirements of Your Content CMSs can facilitate archival requirements by housing all the content in one location. Interwoven TeamSite has a concept called an edition, which is a snapshot of all web content at a point in time. With editions, entire content stores can be moved to tape or another backup media or retained in the CMS itself. If editions are maintained in the CMS, browsing and retrieving the content is as simple as selecting the edition and browsing to the appropriate content. By providing snapshots of content retention, requirements are easily met. For example, we have worked with clients who had to meet a U.S. Securities and Exchange Commission (SEC) retention requirement of three years. This meant at any time the SEC could mandate that this company’s content be reproduced exactly as it was originally displayed anytime during the past three years. With editions, solving this requirement was easy. (You’ll learn more about editions in Chapter 7.)
Statutory or Legal Requirements for the Use of Your Content Do you have requirements to always publish content in two formats, one for the Web and one for print or optical media? Why continue to produce content in two formats manually when a CMS can produce this content automatically? Addressing legal issues—such as the Health Insurance Portability and Accountability Act (HIPAA), which requires you to always include legal approval for each content deployment—is easy with a CMS and a workflow.
Requirements of External Sources to Supplement Your Content Content feeds from external entities, whether they are news feeds, stock feeds, or weather updates, can greatly enrich content and boost the usability of that content. A CMS can automatically detect these types of external data feeds, notify the appropriate content approvers, and begin the deployment process. Without a CMS, once again you rely on human interaction, which is error prone and lacks the efficiency of a CMS.
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 9
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Delivery Requirements for Your Content, Including Different Presentation Types and Data Layouts A CMS allows you to publish content in a variety of presentation types. By separating your data and presentation in a CMS, you can support clients that need print-ready documents, web-ready documents, and even documents for personal digital assistants (PDAs) or cell phones. By keeping the data separate, you can combine multiple data sources into an aggregate document. Think about this—if you have a single document or piece of content that requires multiple content authors, the CMS is the ideal solution. For example, company XYZ is producing a product catalog for a new gadget being produced in the company. Company XYZ has marketing authors for the marketing section of the product catalog, sales authors for the price and licensing section of the catalog, and product engineer authors for the technical specification sections of the product catalog. By maintaining each section as a discrete piece of content, all authors can work collaboratively at the same time on what will become the finished product catalog. When the content components are ready to be published, the CMS can facilitate the approval process and bind the components together into the final product catalog. The CMS can even generate the product catalog into any number of supported output formats such as Portable Document Format (PDF), HTML, or Wireless Markup Language (WML). Figure 1-1 depicts how content can be turned into the final format by combining a presentation with the data. . .. ...
. .. ...
Component Bundle
. .. ...
Content Aggregation and Generation Within the CMS
PDA
Web Content Document
Figure 1-1. Delivery requirements and componentizing of content in a CMS
9
6110_Ch01_FINAL
10
7/2/06
1:01 PM
Page 10
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Authoring Requirements for Your Content, As Well As the Audience of That Content Content authoring without a CMS is limited to technical authors and authors with specialized authoring tools. Dependent on the output format, an author will need HTML editors such as FrontPage or Macromedia Dreamweaver, PDF creation programs such as Adobe Acrobat, and any number of others depending on the publishing requirements for your content. Authors without a CMS will also need specialized knowledge of the content, knowledge of how to use the authoring tools, and technical knowledge of markup characters for some output formats. All this specialized knowledge means hiring people who have technical skills and who can be expensive. Maintaining and supporting several different authoring tools across your enterprise is also expensive. Licensing and deploying these authoring programs can equate to thousands of dollars per year. With a CMS, you eliminate these significant costs. CMSs have built-in editing and content authoring capabilities that eliminate the need for specialized editing and authoring tools. Additionally, the CMS editors have a user-friendly interface that anyone with basic word processing skills can use. Within a CMS you can also intelligently specify a specific organizational glossary where common terms can be reused automatically. This means you will provide content consumers with a consistent corporate voice, if you will, thereby reducing confusion with interpreting your content.
Metadata and Searching Requirements for Your Content ECMSs such as Interwoven TeamSite have connectors to metadata creation programs. One such world-class solution is MetaTagger, also from Interwoven. Using these applications to manage your content, you can automatically associate the correct metadata with all your content. By having a consistent metadata schema, search engines are more productive, and indexing overhead is greatly reduced.
Syndication and Deployment Requirements for Your Content Syndication is the process of integrating external content into your own company’s content through a paid subscription. Without a CMS, this can be a manual process. The person responsible for content syndication will either be notified of content updates via an email or be notified by actually checking the source location constantly for content updates. If this person is sick or on vacation, content updates are missed, meaning that the subscription fees are not being utilized to their full potential. Once content updates are identified, the person responsible for adding the updated content usually has to copy the updated content and then use a predefined content authoring method to integrate that newly acquired content into their own content. Using this manual process, content updates are frequently missed, or worse, content is outdated before it even reaches the destination location. Often, a manual process such as this requires the newly acquired content be reformatted extensively to match the destination’s style requirements. A CMS eliminates these problems. Content updates can be performed automatically within the CMS. The CMS can be notified by the subscription service and can intercept the email to ingest the content update. The CMS, once notified, can integrate the content automatically and appropriately. The CMS can then route the content for approval by a predefined human user of the CMS. When the content updates are approved, the content can be deployed to the destination location. By working with a subscription service, you can define the ingestion format ahead of time, and the CMS can programmatically modify the content to match the destination format.
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 11
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Separating Data and Presentation Separating data and presentation is a core concept and practice in regard to a CMS. We touched on that it is essential to separate your data completely from the presentation. Doing this allows your business solutions to be flexible. By separating or decoupling the data and presentation, you greatly improve data reuse. Enterprises spend vast amounts of resources manipulating their data into usable assets. For this reason, a major consideration when creating your data is the importance of storing it properly from the beginning. If successful, the remaining steps in the process for creating a CMS should come much easier. Some industries have requirements that require the data be stored in its reproducible form. This means if a presentation has been placed on the data before it was published, not only would the data have to be kept for historical reasons but there would also have to be a way to reconstruct the document, unless the final document is stored as well. This could cost considerably more resources to store the same data that has been manipulated by several different presentations. Presentations can be defined as the final look of the data or content. This finalized and presented content may be of various mediums, such as a website, a document for printing, or perhaps an email to all of your current customers. It does not matter what the final product will be; each presentation can be completely different. The fact is the same data can be used many times, in many time spans, and in many data formats. Figure 1-2 shows the concept of separating data from presentation.
Data Capture Web Content Presentation Templates Content Generation
Raw Data
Document
Figure 1-2. Separation of data and presentation In Figure 1-2, data is entered into a data capture screen. This data is then stored in eXtensible Markup Language (XML) format in the raw data store or repository. Predefined presentation templates are then used to merge with this raw data to create the final generated output formats, one for the Web and one for print.
11
6110_Ch01_FINAL
12
7/2/06
1:01 PM
Page 12
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
To illustrate this concept further, refer to the sample XML data file in Figure 1-3.
Figure 1-3. Famous quotes XML data file Even if you do not understand XML at this point, bear with us for a minute. We’ll discuss XML in detail in Chapter 8, but for now it is not important to understand XML but rather to examine the general context of this file. This XML data file contains groups of famous movie quotes; each stored quote contains the movie title (annotated by a tag), the text of the actual quote (annotated by a tag), and the character who spoke it (annotated by a tag). Important to note is that this file contains only data. A web browser does not know how to display a quote, but we will tell the browser how to display this data by applying “presentation” templates to it. By separating the data, in this example the movie quotes, from the presentation, we can then generate and present that data in multiple formats. Figure 1-4 shows an example of this data presented with an HTML table. In Figure 1-4 the XML data, containing famous movie quotes, has been transformed via a template into an HTML file in table format. But the same XML data can be presented in any number of formats, depending on the number of presentation templates applied to it. Figure 1-5 shows the same data, presented in an HTML list format. By keeping the data and presentation layers separate, data can easily be presented in multiple formats. If the data was coupled or intermingled with the presentation, the arduous task would then be to strip all the data from its current presentation and insert that data into another differently formatted presentation. This would be nonefficient, error prone, and expensive.
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 13
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Figure 1-4. XML data movie quotes file presented in an HTML table
Figure 1-5. XML data movie quotes file presented in HTML list format
13
6110_Ch01_FINAL
14
7/2/06
1:01 PM
Page 14
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Presentations can be layered on top of each other. A good example of this is in an organization’s corporate website. In a corporate site, a style guide provides the overall look and feel, and it can specify the various presentation templates of how everything fits together. Within an organization’s content, several types of pages usually exist. There are frequently asked questions (FAQ), site maps, and general content. Instead of creating several pages of content containing redundant information, one can create content sections. Defined content sections within the overall presentation can allow one to build smaller pieces that will fit within the overall structure. This is often referred to as synergy, where the sum of the pieces as a whole is greater than the sum of those individual parts.
■Note Generating content is the process of taking the data record, usually in ASCII (XML or text) format and combining it with the presentation template to “generate” the desired end product. The presentation template’s responsibility is the overall look of the final product. The generated content is usually constructed through the combination of the two structures. The first would be the presentation template, and the second would be the XML data record. In a CMS, the generation process or generation engine may be a proprietary application, or it may be based on open standards.
Introducing Metadata Metadata is data that describes other data. Picture a book for a second. Who wrote the book? How many pages does the book have? How much does the book weigh? What color is the book? How many chapters does the book have? All of this information describes the book and is known as metadata. Metadata is collected so that content can be categorized and searched. To illustrate this point, imagine the following scenario: You have just started a job at a large hospital, and a doctor would like for you to retrieve Mr. Smith’s medical chart from the records department. Upon entering the records department, you are inundated with a plethora of shelves filled with file folders, any of which could be Mr. Smith’s. Now, you could wander aimlessly around each shelf flipping through charts until you get lucky enough to stumble upon the correct chart, or you could use the records department lookup terminal to point you to the exact location. When you type Mr. Smith’s name into the terminal, a search is executed on all the metadata collected and indexed for each patient. Any patient who has a match with the search terms you entered is returned to you as a search result, probably with directions on how to locate the patient’s physical chart. Mr. Smith is returned as a search result, and you are able to quickly locate his chart. Let’s dig a little deeper—using this example, you can see how the following types of information would be useful as metadata for each patient: • Social Security number (SSN) • Patient last name • Patient first name • Date of birth • Primary care physician • Phone number • Gender
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 15
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
For the example, the SSN, patient last name, patient first name, and so on, are effective pieces of metadata. However, you must use the most appropriate metadata for the type of content used in your organization. Although it may make sense to gather the SSN as metadata for a person, it definitely does not make any sense when your content is of type Book or any other content that does not have an SSN. Discovering and collecting appropriate and useful metadata is one of the difficult steps that must be performed when implementing a CMS. To assist you, and the team you are working with, on this grueling task, you must ask five questions regarding each type of content in the proposed system: • What data describes this content type? • If I were looking for this content and I wanted to understand this content type, what information would I want to know? • What about this data makes it unique among other pieces of content? • What about this data makes it similar with other pieces of content? • Is there any CMS feature or downstream function that must be done to the content and that relies on certain metadata for this purpose? For example, you may have archival requirements where it is necessary to have metadata such as archival date, published date, and expiration date. These dates would be set at content creation and content publish time so that the CMS application could then archive, delete, and so on, this content at the appropriate date. Finally, always work with the content owners during this process, because they will know the best way to describe their data and will be instrumental in the metadata-uncovering process. To illustrate the concept of metadata further, Figure 1-6 shows the metadata stored for the file Ibm.html.
Company Research — ibm.html — Microsoft.html — AMD.html — Intel.html — Cisco.html — Sun.html
Metadata KEYWORDS: EXPIRATION: TYPE: PUBLISH DATE: AUTHOR: DEPARTMENT:
IBM, technology, research 10/12/2009 Eternal Content 10/05/2009 Brian McNeel Research
Figure 1-6. Metadata stored for the Ibm.html file Imagine for a moment that within a website directory structure there is a directory named Company Research. This Company Research directory stores several pages of content: Ibm.html, Microsoft.html, AMD.html, and so on. Each respective page of content possesses its own associated metadata. From the IBM example, it is evident that keywords, expiration, content type, published date, author, and department are stored for each page of HTML content.
15
6110_Ch01_FINAL
16
7/2/06
1:01 PM
Page 16
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
No matter what type of metadata is captured for your content, remember that time spent analyzing and capturing the appropriate metadata for your content is time well spent. Keep in mind that discovering halfway through the implementation process that you should have been keeping another piece of metadata can be frustrating and costly.
Using Templates Templates within a CMS allow content to be created once and used multiple times in a variety of formats. You may need to display information for printing, information for a website, or information for wireless devices. You can accomplish all this via templates. Using one XML data file and three templates, you could generate PDF files for printing, Extensible HTML (XHTML) files for web publishing, and WML files for wireless devices such as cellular telephones or PDAs. You can create templates in many ways depending on the CMS implemented. Typically in a CMS two main types of templates exist. The first type is the presentation template, and the second type is the data template. The presentation templates generate (believe it or not) presentations, or the look and feel, of the content. The second type collects the data that will be stored in XML format and be used as the substance, or the meat and potatoes, so to speak, of the content itself. Figure 1-7 shows an example of what a typical presentation template configuration could look like. In this example, several sections are created separately and then assembled together as one page. The page includes header template and footer template sections so that the entire generated web page could have the same header and footer. The navigation section could be generated, and the promotions section could also be generated based on what content is being viewed on this page in the main content area of the page. This HTML page (comprised of different template sections) could be generated in advance to help reduce the strain of creating it each time it is requested. This is usually determined based on how often the content is updated, the processing power required to generate the pages, and what architecture is being used to serve the content.
Header
Promotion
Navigation
Main Content Area
Footer Figure 1-7. A typical presentation layout
Completed and generated page composed of multiple template sections with each section potentially containing separate pieces of content
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 17
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
The data template ensures that the data that is collected is the same in each record or XML file and could be as simple as an HTML form. By using data templates, it is easier to maintain data integrity because the data-entry tasks can be rigidly controlled and validated at the time of data entry. Without this integrity, the template system does not work. In Figure 1-8 and Figure 1-9, we have taken the template concept and applied it toward an actual website. In Figure 1-9, the previously described template components are outlined to show how a generated page could be built based upon discrete template sections.
Figure 1-8. Generated and completed site
Figure 1-9. Generated and completed site with content sections outlined
17
6110_Ch01_FINAL
18
7/2/06
1:01 PM
Page 18
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Understanding Workflows For almost anything you have to do in life that requires a predefined process, you must follow certain steps. In the CMS world, this process of steps is known as a workflow. More specifically, the process for which a document goes through during development can be turned into a series of steps that is a workflow. The workflow should model your business process as closely as possible. However, do not neglect the need to examine your existing process and make the business process more efficient before implementing that process as a workflow. A workflow allows the CMS to enforce steps that could otherwise be averted. You can perform steps such as mandatory validations as needed. Workflow ensures that each step is fulfilled before the content is released to the public. Figure 1-10 illustrates a simple workflow process. In this scenario, the content contributor submits content to the content approver. The approver can approve the content, sending it to the legal department, or they can reject it and return it to the contributor. If the content is rejected, then the content contributor will receive the content with instructions on what needs to be changed. After alleviating the problems, the content is then resubmitted for approval. Once the content approver has approved the content, the content goes to the legal department for review. If the content is rejected at this level, it will be returned to the original contributor for modifications, and the process repeats until the legal department gives the final approval needed to publish the content. The content is generated and distributed in two ways. The first is generated in a web-ready format in the form of HTML, PDF, or some other web format. The second is generated in a format that is optimized for print. As this illustrates, the system, even at a simple level, can be effective in contributing to the document development process. Legal Rejection
Submit Content Contributor
Approved
Approved Content Approver
Legal Review
Generation
Internet
Generation
Publication
Approved
Content Rejection
Figure 1-10. Simple workflow process The logical conclusion of a workflow is the deployment of content. The deployment of the content deals with the path that the content takes through the physical and networking infrastructure of an organization. In Figure 1-11, the workflow would execute in the content server, and upon workflow completion, the three types of presentation would have been generated and moved to the deployment server. The deployment server would have access through the corporate firewall to the web server. A process running on the deployment server would be responsible for placing the content into the appropriate location on the web server. The web server is then responsible for serving the content to its various requesting clients.
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 19
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Content
Editor
Legal Approval
Internet
PDA
Content Server Deployment Server
Firewall
WWW Server
PC
Publication
Figure 1-11. Deployment path of content
Introducing User Groups and Permissions User groups and permissions are common to all technology-based systems, but if implemented properly in a CMS, they become one of the most powerful and important parts of the system. Any CMS implementation has many types of users; however, most user types can be divided into one of the following roles or groups: Initiator role: This role can start a workflow for content creation, content deletion, or one of any number of defined workflows in a CMS. Content contributor role: This role is responsible for creating and modifying content. Reviewers/approvers role: This role is responsible for reviewing, approving, and rejecting content. Hybrid role: This role’s responsibilities can combine any of the previous three job roles. This role may also have distinct capabilities that are not present in other roles such as the ability to bypass workflows, approve processes, and submit multiple changes. Typically this role is reserved for administrators and super or power users. Multiple interfaces into the CMS may be constructed and utilized based on the user type. There are many reasons to implement multiple user interfaces: Training: Because you are using multiple interfaces, the interface can be kept clear of extra functions and features, which may confuse the trainee and may not be used by the specific role for which they are being trained. Security: By eliminating additional functionality that is outside the security boundaries of this role, you can avoid many mishaps. Why allow access to an interface that, for example, allows the user to delete content when the user role should not even have that ability? Keep in mind that not all security breaches are purposeful, but many are caused accidentally. The interface should remove user temptation to find out what “this option does.”
19
6110_Ch01_FINAL
20
7/2/06
1:01 PM
Page 20
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
The bottom line is that if the role should not perform certain actions in the system, then do not present them with that option. Branding: By having separate interfaces—between your clients, for example—personalization options can present a corporate brand image in each interface.
■Note If you decide to implement multiple interfaces, you will be need to maintain both interfaces when adding new functionality. Also, individuals with multiple roles may be forced to log in to different interfaces depending upon what action they are performing.
Introducing Repositories Repositories, or the data stores in a CMS, usually hold two types of data: binary data and ASCII data. ASCII data often comes in the form of XML. XML data, coupled with presentation files, will actually compose the generated content. XML data within the CMS is usually grouped into logical containers to facilitate the creation of the content and the generation of that content. Often times this logical structure is ordered in much the same way as a typical directory structure. The binary data can take many forms and is typically proprietary in nature, such as PDF files, images, audio files, and video files. A quality CMS should not restrict you to one repository but should allow open and flexible integration with many different architectures and systems. Some possible integration points may include directory structures whether Unix or Windows based, relational database management systems (RDBMSs), Lightweight Directory Access Protocol (LDAP), and web services. The following sections cover some questions to consider and answer when constructing your repository.
Do You Understand Your Data? Do you understand how your data will be used in the enterprise? How will data be packaged, and in what formats must that data be presented? Understanding the purpose of your data, which will become your content, is critical to a successful CMS implementation. We recommend meeting not only with your database administrators but also with your business owners. Do you understand what each field in your data repository (database or file system) represents? You must answer all these questions in order for you to make sound decisions while implementing a CMS.
How Much Data Will Be Stored? What is the current size of your data that will be used to form content for your company? By knowing the current size of your data, you can derive requirements for storing that data. You must become intimately familiar with the current size of your data because this will impact the retrieval, archival, and retention requirements of your CMS.
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 21
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
What Is the Anticipated Future Growth of Your Data? You do not want to have your company potentially spend millions of dollars on a system that is not scalable for the immediate and midterm future. The best way to evaluate your future growth needs is to first look at the amount of storage your current data requires. Next look at any anticipated new sites or new data stores that will be migrated to your CMS once the system is in place. Finally, you should develop a multiplier to apply to the size of your current data plus any anticipated new site or new data stores. Your multiplier should take into account many factors, including acquired data from internal sales and new business development. Your final data size should include the ability to scale for the next three to five years. Luckily, Interwoven has developed some metrics to assist you with your sizing requirements. Let’s look at an example to illustrate this point. Assume for a second that your current data storage is 500MB and the planned new site migration and new data store integration size adds up to 1GB in size. Interwoven states that the TeamSite CMS requires more storage space for TeamSite metadata, space to store multiple versions of the site content, and space to allow for future site growth. So taking all of this into consideration, you have 500MB + 1GB, which equals 1.5GB of total storage size. Remember the multiplier number—Interwoven recommends multiplying by 10 to 20 times the current storage size to allow for future growth. We recommend taking the higher number. Based on all of these factors in the example, the estimated storage requirements for the data in the example should be approximately 30GB of storage space.
How Complex Are the Data Relationships? Does your data cross multiple repositories? What is the average size of each content component? Do you have numerous many-to-many relationships? A many-to-many relationship is one where data entities have many possible relationships to each other. An example of this is if you were modeling an article of clothing such as different models of pants. Each model of pants could come in different sizes, and each available size could relate to multiple models or types of pants.
What Are Your Data Retention Requirements? This is really a question of how much money you are prepared to spend to support your requirements. How much data storage are you prepared to purchase? Do you know how long that data must be maintained for historical purposes? Do you plan on purchasing any additional storage space to provide data redundancy for your system? You must answer all these questions to ensure a successful implementation.
What Are the Data Retrieval Requirements of Your System? How quickly must content be served up or presented from your repository to the calling program? Does the data have to be repackaged or transformed into a different format? Do style sheets have to be applied based on the system requesting the data? For example, one repository can serve multiple systems: one legacy system and a web-based system. The legacy system requires its data to be in a predefined EBCDIC 80-column format, while the web-based system requires its data to be presented in a base64-encoded XML format.
21
6110_Ch01_FINAL
22
7/2/06
1:01 PM
Page 22
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Knowing What to Look for in a CMS The following information will allow you to draw from our considerable content management experience and provide you with CMS best-practice recommendations for the attributes that a quality CMS should possess. This information is extremely valuable when you or your company is evaluating a CMS for purchase.
Open and Flexible Architecture A quality CMS should not force you to use proprietary technologies. It should be extensible with other technologies and highly scalable within an organization. The actual system should be modular, allowing the purchase and installation of pieces on an as-needed basis. If you need only workflow, then you can purchase only workflow functionality; if you need templating, then you need only purchase templating functionality.
Support for Multiple Data Formats A quality CMS should allow integration with a variety of data sources, RDBMSs, XML database management systems (XDBMSs), and LDAP, for instance, and should allow storage of ASCII and binary data.
GETTING TO KNOW MORE TERMS In an RDBMS, a management program allows you to create, update, and administer a relational database. A relational database is a structure where data is organized in formally described tables that allow you to retrieve and use that data without having to reorganize the data. In a relational database, the data is arranged in a way that maintains the data’s relationship to the other data in the database. Some industry-known relational databases include Oracle, Microsoft SQL Server, and IBM DB2. In an XDBMS, the data is arranged in a hierarchical XML format. This database format is extremely document-centric and allows extremely fast data retrieval but for specific purposes. Arranging the data in an XML format allows you to easily prune that data for specific component retrieval. For example, in the publishing environment, data can be placed into the XML database in its raw XML format. Then when you want to retrieve a specific chapter, a specific section, or even a specific paragraph, you can prune the data quickly, and only the section of content requested will be served. Typically, XDBMSs use the XML-based XQuery language to retrieve their data; some industry-known XML databases include Mark Logic Content Interaction Server, Xyleme Zone Server, and Virtuoso. LDAP is based on the X.500 standard. In LDAP the data is represented as objects. Each object can be queried based on supplied attributes of that object. This allows objects to be queried without the requesting program knowing the location of that object.
Integration Capabilities with Existing Systems A quality CMS should allow integration with many disparate systems, including repositories, legacy systems, and platforms.
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 23
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Separation of Data and Presentation This is a fundamental quality of a CMS; to facilitate the reuse of content and deployment in multiple presentation formats, data and presentation must be kept separate.
Flexible and Configurable Workflow Engine A CMS should allow multiple workflows to be constructed, which will have the ability to replicate 90 percent of existing business processes. You will want a CMS that can house multiple workflows for multiple user groups, with multiple tasks or steps in each. Workflows must have the ability to move content through a delivery chain that is not part of the CMS; in other words, a quality workflow should have the ability to make changes in systems external to the CMS.
Effective Use of Standards Does your CMS support XML as defined by the World Wide Web Consortium? Does it support PDFs, XHTML, XSL Transformations (XSLT), and connections to standard RDBMSs? The effective use of standards by a CMS platform will ensure that your organization is not locked into a proprietary format.
Content Authoring Toolset This is a powerful factor in selecting a CMS. Does the CMS allow you to import non-templatecreated content? This would include Word files, PDF files, and Dreamweaver templates. The CMS should also inherently possess its own method of entering content, without the dependency on external or third-party tools, and may include such noteworthy features as spell check and autocomplete.
Multiple-User Authoring Environment The CMS you choose must allow team-based collaboration of the content. If you have enough content to warrant a CMS, then you must be aware of the need to have multiple content authors, content contributors, and reviewers. The system must allow multiple users from multiple locations to manage, review, approve, and create content. A CMS is an enterprise application.
Metadata Creation A CMS should allow for the seamless integration of metadata with the content it is defining. The metadata should not be limited in the data format that can be used. The system should be able to store binary metadata as well as ASCII metadata. Additionally, a quality CMS should be able to automatically extract some metadata from content files, such as when you need to extract PDF properties for the author, title, and date of creation from an imported PDF file.
Easy to Use This cannot be stressed enough: a quality CMS should not force you to use highly technical resources to manage your content; with minimal training (which is therefore much less expensive), the administrative staff should have few problems navigating and using the CMS.
23
6110_Ch01_FINAL
24
7/2/06
1:01 PM
Page 24
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Version Management/Archival Capabilities and Rollback Capabilities Version management can help eliminate risk from content authoring. The ability to roll back to any version gives the author the chance to easily correct any inadvertent mistakes such as forgetting to change an image on a certain web page. Also, the ability to archive those versions and easily restore each specific version may be essential for historical and legal requirements. Most good CMS have versioning and rollback functionality built into the repository. We will go into more detail later about this when we address the repository in Chapter 7.
Should Meet Your Specific Content Needs This may be the most important consideration when choosing a CMS. If the system does not match your content, you will be forced to make customizations to the CMS to ensure it fits your organizational needs. Some level of customization may be (will most likely be) required; however, choosing an appropriate CMS from the beginning should always minimize this.
Should Have a Strong Customer Base and Stable Performance Track Record Does the CMS software vendor have several clients similar to your organization, with a proven history of successfully meeting their content needs? Will the vendor allow you to contact some of their current clients for feedback regarding their product? A quality CMS vendor should be able to provide you with a résumé of sorts of its accomplishments. The vendor should participate in trade shows, industry special-interest groups, and best-practice organizations. Investigate all the product offerings to find the best match for your organization’s needs and future needs. See whether other CMS vendors are attempting to play catch-up with this CMS vendor. Look for awards and achievements relating to the CMS product. Also look for quality support and a good history of deploying this CMS solution to various clients. You do not want to purchase a CMS from a fly-by-night company that will leave you with a solution that cannot be upgraded, that will not have service packs available, and that will not be able to meet a support contract.
Should Match Your Budget and Future Growth Does this CMS have the capability to add storage, are patches and service packs released regularly, how scalable is this CMS architecture, and does this CMS allow usage by your European offices? A CMS is an expensive investment for an organization. You may be rolling out the system only to your United States offices now, but what about in five years when you expand into the European market? How much will your content grow in five years when all departments in your organization are using it? Balancing your current technology budget with your future forecasted growth is a difficult decision but is one you must take seriously. The CMS you choose must allow for expansion.
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 25
CHAPTER 1 ■ WHAT IS CONTENT MANAGEMENT?
Investigate the Features and Functionality That This CMS Cannot Provide for Your Organization If the vendor cannot identify some of its product’s weaknesses when addressing your needs, then perhaps the vendor does not fully understand your content needs. CMS is not a magic bullet; do not be too wooed by slick marketing and salespeople hype to forget that the CMS will not do some tasks. Specifically, will you need to customize the product, hire specialized and technical support and development staff, or rely on third-party applications for your content? Is this CMS vendor aware of its product’s weaknesses, and does the vendor have a plan, experience, and suggestions on how to defeat those weaknesses? Your organizational needs and budget will determine the type of CMS it needs; however, most companies will benefit from some level of content management. Implemented properly, a CMS is one of the smartest purchases that an organization can make. Using this chapter as a guide, you will be well informed to make recommendations on that purchase and assist with the implementation.
Summary In this chapter, we discussed content and what content is. We then described content management and let you know the business need for content management. You learned how CMSs separate the data and the presentation to ensure content reuse. Next we discussed metadata and how critical metadata is for content intelligence. We then discussed templates that allow for content creation and generation and for workflows that are system-based models of your business process for the content creation life cycle. We talked about user groups and security permissions in a CMS and repositories to store your content and content generation. Finally, you learned about the most critical attributes of an enterprise-class CMS. In the next chapter, we will introduce you to the CMS case study that the remainder of this book will be based on, and we will jump into the first task, namely, defining the scope of the case study for FiCorp.
25
6110_Ch01_FINAL
7/2/06
1:01 PM
Page 26
6110_Ch02_FINAL
7/2/06
1:05 PM
CHAPTER
Page 27
2
■■■
Defining the CMS Project Scope C
hapter 1 introduced you to the world of content management. We told you what content management was and gave you a high-level understanding of the key requirements that content management addresses. This chapter will teach you how to define the project scope for a content management project. This chapter will delve into common issues you must consider when defining the scope of your content management project. To further illustrate the concepts in this chapter, we will be using FiCorp to show you how the activities in this chapter map to a real-world scenario.
Defining Scope The success of any project ultimately hinges upon a well-defined project scope, which can be defined as the expectations of what you (the CMS implementer or project team member) will deliver in accordance to the expectations of the project stakeholders and customers. Many people tend to misinterpret the project scope definition as being solely related to time and cost; however, by more closely examining project scope, you will find that it really involves developing a complete understanding of what is and is not included in the project. Once you have an understanding of the scope, you can calculate the time and schedule. You should also continually revisit a content management solution (one that makes use of a CMS as the underlying infrastructure) to accommodate changes in business needs. Business needs change because of external market factors. Any particular project or phase of a project should be scoped properly, but only within the context of the solution’s ever-changing life cycle. You must think of content management as an ongoing process. When thinking in terms of project scope, the most important advice we can give to you is to assume nothing! Many projects have failed because a project manager assumed all involved parties knew what a requirement meant, only to find out later that the assumptions were incorrect and that the customer actually had different expectations. These factors should all be combined into the evolving vision artifact for the project. We recommend using the Word template for the vision artifact that comes with the RUP product; you can then customize it to fit your specific needs. Within the context of a CMS project, you need to consider some important factors in regard to project scope.
Security Factors Security factors include address authentication, encryption requirements, user security and permissions, and groups. Do you have sign-on requirements? Should the sign-on process to your CMS also authenticate your user to another system? Your CMS implementation will have
27
6110_Ch02_FINAL
28
7/2/06
1:05 PM
Page 28
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
security requirements that will cover the system login and the possible security within the CMS structure itself. Security within the CMS structure will prevent content authors from playing with content that does not belong to them. Security is one of the most important factors of a CMS, so make certain it is defined appropriately.
User Interface Factors User interface factors include client types, portal issues, thick or thin client issues, and the actual customizations of the chosen user interface. How will content authors access the CMS? How much functionality will be exposed to content authors? What type of interface should be built? With an ECMS such as Interwoven TeamSite, you have many interface options available to you. You can use ContentCenter Standard, ContentCenter Professional, or the Casual Contributor interface, or you can build your own. Chapter 15 covers more about the available interfaces. For now, you should just document how the stakeholders envision their users working with the system.
Authoring or Content Creation Factors How will content be created in the system? Will content be imported? What formats will be accepted, and what will any output format be? Will you need to integrate the CMS with external or third-party content creation tools? Will you use only the included HTML editing tool, and will you customize this tool? We have been involved with projects where the WYSIWYG editing tool was customized to pull digital assets such as images into the content page or pages. You should also strive to get a mental picture of who will be contributing content in the CMS. This type of analysis will directly feed the use cases developed in Chapter 4.
Migration Factors Migration factors include application and content migration. Do any content-aware applications exist that must be migrated to the CMS, and if so, which components of those applications will be managed by the CMS? Interwoven’s flexible architecture allows you to integrate with many applications. Applications that depend on content for their functionality are known as content-aware applications. With TeamSite, you can define output formats that match the source format for the application. This way, TeamSite can send data directly to the application. Using a TeamSite workflow, you can even trigger the external application to begin a read process for that data. This is the typical maturation of TeamSite implementations from serving static content only to then delivering dynamic content and to supplying content to content-aware applications. Once the CMS is implemented, you will want to begin moving any non-CMShosted sites into the CMS. This will enable you to fully recognize the return on investment of implementing the CMS. In fact, part of your implementation should be identifying one or two of these sites that will be implemented as pilots in the completed CMS.
Content Types and Content Intelligence Factors Content types and content intelligence include the types of content and the metadata that will be stored for each type of content. Do you need an enterprise-level content intelligence application? Our presumption is that you will indeed need this. One such application is the Interwoven MetaTagger product. (We’ll cover MetaTagger in detail in later chapters, beginning with Chapter 3.) Getting the content out to content consumers is not enough. Consumers must
6110_Ch02_FINAL
7/2/06
1:05 PM
Page 29
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
easily be able to retrieve the content they want, when they need it. Content intelligence adds value to the content by enriching the content with a predefined vocabulary. We recommend you research this important factor. The Subject Matter Experts (SMEs) at your company should be able to assist you with this research. These experts could be team members from any team that supports any external application that will rely on your content or on the content from the CMS. As another option, you can hire a professional indexer or librarian to assist you. Discover what external systems will rely on this data and what format of data these systems will expect. Make sure you include domain experts in the discovery and definition of this factor.
Search Factors How will the content be indexed, and where will the visibility to this index live? What types of search will be supported…natural language, fuzzy, full-text, keyword? You must consider this information to get a good understanding of the scope of your CMS implementation.
Workflow/Business Process Factors These factors include the current content life cycle and business process. Translated into the CMS, this business process will be re-created as one-to-many workflows. What is the review and existing production process, who is notified, and at what point in the process are they notified? Who must approve work, and who is responsible for initiating a work request? Does this process ever change, and do exceptions exist? If so, what are these exceptions? The “Investment or Market Research Content Review Process” section will discuss review processes.
Publishing/Delivery Factors Where will the content be delivered, and in what time frame will it be delivered? What type of generated output must be supported…WML, HTML, JavaServer Pages (JSP), Active Server Pages (ASP), and PDF, for instance? Once the content is approved, how quickly must that content be deployed from the CMS to the website? Many times content must be deployed across multiple network segments and to multiple web servers. Try to identify as many delivery or publishing requirements as possible, because this will save you a great deal of time later. The more information you gather during the scoping exercise, the better and more informed your decisions will be later in the project.
Repository Factors Repository factors address the amount of data to be stored. What is the average size of each content type, and how many types are present? Do you want to allow space for assets or only content? What is the projected content growth over the next three years? Repository factors will vary from installation to installation and depend entirely on the unique requirements for each company. Once you find all the content that must be implemented, calculate the size of that content and any deltas that may also be involved.
System Administration Factors System administration factors address the administration of the system. How are changes implemented in the system? Who is responsible for starting and stopping the system? Who does the backup and restore? Who installs new patches and performs other administrative type of work?
29
6110_Ch02_FINAL
30
7/2/06
1:05 PM
Page 30
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
Reporting Factors These factors include the internal and external reports of the system. Is there a need for customized or ad hoc reporting? Where will the reports be available from? What data must be included in the reports, and what system events must be captured? We will talk more about reporting in Chapter 8. For most customers, the Interwoven TeamSite add-on product ReportCenter provides more than adequate reporting functionality. However, you should define or at least identify any reporting that is required once the system is in place.
Base CMS Factors Base factors include versioning, check-in/checkout, file locking, content preview (both static and dynamic), application server integration, and much more. The goal with this factor is to determine what the project stakeholders envision a CMS to provide. This factor relates to educating the stakeholders while they inform you of the functions they need.
Training Factors Training factors include the training requirements for users of the system once the system goes live. Questions to answer are as follows: Who will be trained (this could be technical and nontechnical people)? Will specialized training be needed depending on the job role? What type of training shall be provided? Will you provide classroom training or web-based training? How many users must be trained? Keep in mind that training will encompass both your end users and the people who will administer the system.
Delivery/Target Launch Date When will the product be live? What is the deadline for implementation, and is there any flexibility in this date? If the date is unrealistic, are the project stakeholders or IT management willing to hire additional resources?
■Note Keep in mind that you will not have a complete view or understanding of every one of these factors at this stage in the project; however, if you keep these at the level of features or high-level components, then you will be well on your way to project success.
Defining the Functionality and Deliverables You can determine project scope in many ways; however, we recommend defining project scope by defining functionality and deliverables. To define the scope of a CMS engagement, you must begin by defining and reaching consensus on the final outcome of the project. You must also document all project assumptions and then maintain that list for possible changes. This finished scope will then be documented in a vision artifact for historical purposes. Once the Vision artifact is finalized, it is imperative that you receive project stakeholder sign-off on the document.
6110_Ch02_FINAL
7/2/06
1:05 PM
Page 31
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
■Note A vision document, or vision artifact, is an artifact in the RUP where you recount the vision of the project. In the RUP, an artifact can be any deliverable that the project produces, such as formally defined artifacts that include the vision artifact, use case models, iteration plans, and so forth, and informally defined artifacts such as code modules. The vision artifact is a document template that contains the purpose and scope of the project as well as the business opportunities, risks, and constraints.
To define the project scope for a CMS project, you must have a scoping workshop. Out of this workshop you should produce a project description. You should also be able to produce a list of potential project risks and assumptions as well as the major features that are required by the project to be implemented. All this information will feed your vision document. You can obtain the majority of this information from meetings with stakeholders and in a scoping workshop, which must be held to ensure that an accurate vision is captured and complete. The scoping workshop should be from a half day to a full day in length but can often stretch into a second day. The scoping workshop must contain all project stakeholders, or a designee from each, and one or more SMEs in the corporation’s content. These individuals will constitute the invitees from the business side. You should also make certain that a meeting facilitator is present; a business analyst or project manager usually fills this position. You should invite one or more scribes to the meeting and, if possible, record the audio from the meeting for later transcription. These individuals combined with the earlier business-side representatives will be the complete attendee list. The attendees and their responsibilities are follows: Project stakeholders: These individuals will be responsible for dictating the purpose of the project and for making any decisions that will drive the remainder of the project. One or two SMEs: These individuals will be responsible for answering any content-centric questions or questions that require in-depth product knowledge. One meeting facilitator: This individual will be responsible for keeping the meeting on track and ensuring that all meeting objectives are met. One or two scribes: These people will be accountable for capturing all statements and meeting minutes. The scribes will be responsible for taking the minutes of the meeting. If everyone has a clear understanding of the project objective, it will make the job of creating the project description easy; however, this is usually not the case. We recommend that all stakeholders write down their project description independently and then submit those to the meeting facilitator. The meeting facilitator will then post each one in the workshop room. Once posted, all common points can be immediately included in the finalized project description. Next you can tackle the divergent points. Ask each stakeholder why the divergent points are valid, and ask the author of the point why this is a valid point. When you reach a consensus, then update the finalized project description. Repeat this process until you have added all agreed-upon points to the finalized project description. Finally, reorganize, if needed, the finalized project description so that it is written in a clear and logical fashion.
31
6110_Ch02_FINAL
32
7/2/06
1:05 PM
Page 32
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
Project Description If someone asked you to summarize the entire project in just a few sentences, what would you write as the project description? Project descriptions can range from one paragraph to a few pages in length. The project description is essential for setting a common objective among all project members and should be the first topic discussed during your scoping workshop. The project description is the “what” that must be accomplished upon completing your project; keep away from the “how” at this point in the process. To achieve consensus on the project description, it is imperative that the decision makers are in the scoping workshop. We have seen many hours wasted on producing a problem description only to have to start all over again because the right decision maker was not in the room.
Project Assumptions Assumptions are criteria and project decisions that you make with little or no supporting evidence. Assumptions are needed to ensure the success of the project. Incorrect assumptions can be very costly to a project. All project assumptions should be documented and later verified for correctness if possible. An example assumption could be something like “A CMS solution that matches our requirements for this project can be commercially purchased.”
Project Features Project features are high-level requirements of what the system can do. Features are not as detailed as project requirements, and the trend is for a feature to map to multiple detailed requirements. At the Inception phase of the project, you will typically gather (during the requirements workshops) a combination of features and detailed requirements. At this point in the project, it is important only to write all information down; you can categorize that information later.
■Note The RUP is an iterative and incremental development methodology comprised of four main phases. Each phase is arranged around a set of disciplines. These disciplines have defined activities and include certain topics. Some disciplines are the Business Modeling, Requirements, and Analysis disciplines. The phases are the Inception phase, the Elaboration phase, the Construction phase, and the Transition phase. Each phase has certain objectives and deliverables or artifacts.
Project Risks Project risks are factors that can cause harm to your project. Basically, risks are everything and anything that can go wrong on your project. The goal is to document as many risks as possible and then develop contingency plans to mitigate those risks. Consider several areas when assessing risks such as the availability of hardware, changes in technology or standards, the availability of resources, a lack of funding, and any corporate policy changes or considerations.
6110_Ch02_FINAL
7/2/06
1:05 PM
Page 33
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
Delivery Date This date will be set by the stakeholders of the project and will include many factors. Some examples of possible factors may include market drivers, key business initiatives, and corporate strategic initiatives. This date will most likely be loosely defined during the Inception phase but will quickly become an actual calendar date, during later phases.
Introducing FiCorp For this book’s case study, our intention is to provide you with enough information and detail to successfully implement your own CMS but not overwhelm you with details that will make you a domain expert regarding the requirements of a fictitious corporation. That being said, we will show you examples of artifacts that must be created for your project, but we will not bore you with complete artifact examples. Remember, when working through the RUP—or any methodology, for that matter—it’s worth maintaining only those artifacts that will truly add value to your project. Unnecessary documentation and planning will only add unnecessary overhead to your project. For this case study, we will pretend that you have been asked to implement a CMS for a fictitious financial services firm named FiCorp. We will begin by introducing you to the company and telling you about its existing publishing process and infrastructure. The remainder of the book will take you through using Interwoven TeamSite to implement a robust CMS that meets this company’s needs.
Learning All About FiCorp FiCorp is a financial services firm that specializes in banking, investment, and wealth-building strategies for consumers and different-sized businesses. FiCorp has been in business for more than 15 years and has added to its product offerings over that time. Over the same time, the content for the main Internet website and customer extranet have grown to where the company now has more than 4,000 pages of content. As the business and content has grown, so has the administrative nightmare of managing that content. The company currently publishes both HTML and JSP pages to its corporate site. Some of the content pages are purely static HTML, and some are JSP pages that, once published, pull some content from an Oracle database. The crux of the problem lies in FiCorp’s workflow arrangement. All updates are performed either by way of a request to the IT staff for content modifications or through a simple publishing tool that has been made accessible to the respective content authors in each topic area. The updates done via FiCorp’s publishing tool do not follow a system-based approval process. The updates performed by the IT staff can sometimes take from two days to four weeks depending on IT resource availability, which is an unacceptably slow process in the financial services industry. The notifications of content updates that must be sent out are difficult to manage, and sometimes they’re forgotten completely. Content deletions from the production website must be done by IT staff, and the business owners would like to have the ability to perform their own content deletes. To further complicate matters, the SEC has mandated that all content in the FiCorp site must be reproducible for a period of three years from the time it was last available for viewing on the site. Should the SEC ask to see it, FiCorp has 48 hours to reproduce the site as it looked on the requested date and time.
33
6110_Ch02_FINAL
34
7/2/06
1:05 PM
Page 34
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
Figure 2-1 shows the FiCorp site structure, which is the site that will be implemented into the CMS.
Figure 2-1. FiCorp site structure The FiCorp site is broken into five main content sections: Personal, Small Business, Commercial, About Us, and My Account (an extranet section that allows the customers to log in to their own accounts). Each main content section contains its own subsection of content. Each section also includes its own left-column navigation. The left-column navigation is visible as the main navigation in the site map diagram (Figure 2-1). Each subsection of content contains several topics. Each topic then contains several pages of content. Different FiCorp SMEs are responsible for their own content sections and topics. FiCorp also has several application integration points within the site: • The Find a Location application, which is located in the header section of the website. This application allows a customer to find the nearest banking location by providing different input criteria, such as a ZIP code and a mileage radius.
6110_Ch02_FINAL
7/2/06
1:05 PM
Page 35
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
• The Sign-On application, which is located in the header section of the website. This application allows customers to authenticate to FiCorp and retrieve the available services for that particular customer. • The Open an Account application, which is also located in the header section of the website. This application allows a customer or potential customer to open different types of accounts with FiCorp or create an account as a new customer. • Several other smaller applications, such as Contact Us and Search. FiCorp has content topics with several pages of content that need to be changed each day. Some examples of this content are FiCorp’s press release section and the home page for the site. IT staffers are unable to keep up with the demand to promote these content changes so they have built a simple publishing tool that the FiCorp content authors use to publish these changes. The publishing tool has several limitations. It has no built-in spell checker, so frequently typos appear in the content. Also, the publishing tool does not have the ability to accept many types of rich content; only a few formatting tags are allowed that control spacing, the bolding of text, the italicizing of text, line breaks, and image insertion. The publishing tool is maintained by the IT department and does not allow for or follow any type of review process. The review process is manually managed outside the publishing tool. All content authors are given access to the publishing tool but are individually responsible for managing their own content and ensuring that the correct approvals have been given for all content updates. FiCorp has several approval processes for different content sections of this site; these approval processes are based on the type of content being updated. Three of the approval processes are covered in the following sections. Some of these processes can be consolidated in order to make the review process less awkward to the user.
Investment or Market Research Content Review Process Investment/market research content can change rapidly and needs to be updated on a regular basis. Any content that follows this review process is for internal use only. In fact, “INTERNAL USE ONLY” is displayed on all content that has been through this process. If an analyst wants to give this information to a client, the content page must go through a legal review first. All market research and investment data must go through this process before it can be deployed to the corporate intranet site. Figure 2-2 shows the market research review process, which is initiated by a research analyst whose job it is to watch certain stocks or investments. The moment a trend is spotted in the market, a request for a content change has to occur. Once the research analyst prepares a recommendation—for example, a buy, sell, or hold—they must send it to a senior analyst for review. The senior analyst is typically responsible for reviewing recommendations and other content updates from several research analysts. After the senior analyst reviews the recommendation, they decide whether the content changes are approved. If the content modifications are not approved, then the content is returned to the research analyst for revision and must follow the approval process again. If the content is approved, the content goes to an editorial assistant. The editorial assistant is responsible for checking the grammar and spelling of the recommendation or content. After reviewing the content, the editorial assistant must then decide whether to approve or reject it. If the content modifications are not approved, then the content goes back to the research analyst for revision, and it must follow the approval process again. This process
35
6110_Ch02_FINAL
36
7/2/06
1:05 PM
Page 36
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
continues until the content is finally approved; then IT is notified and deploys the content to the test system and finally to the production website.
A market change
The research analyst sends the recommendation note to the senior analyst.
The research analyst compiles a recommendation note.
The senior analyst reviews the recommendation.
The senior analyst sends the recommendation back to the research analyst with rework comments.
The editorial assistant sends the recommendation back to the research analyst with rework comments.
No
No
Approve?
Approve?
Yes
The senior analyst sends the recommendation to the editorial assistant.
The editorial assistant reviews the recommendation.
Yes
The editorial assistant sends the recommendation to IT for update to the site.
The senior analyst performs a final review before the content is deployed to the site.
IT notifies the senior analyst for final review.
The editorial assistant notifies the research analyst and senior analyst of the approval.
IT deploys the update to the staging area/ preview area.
Figure 2-2. Market research review process
Legal Content Review Process This review process allows for content changes that might subject FiCorp to litigation such as payroll and tax content, the privacy policy, the terms and conditions page, and external research information to be displayed externally. All this content needs to have a legal review prior to the content being deployed to the Internet site. Figure 2-3 shows the legal content review process, which can be initiated by the corporate communications team, a topic SME, or a member of the legal research team. Once the process has been initiated, it is the responsibility of the content author to create or modify the content. When this is done, the content author sends the updated content to the topic review lead (TRL) who is in charge of that specific topic area. The TRL must then review the content. If the content
6110_Ch02_FINAL
7/2/06
1:05 PM
Page 37
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
modifications are not approved, then the content goes back to the content author for revision and must follow the approval process again. Once the content is approved, the content must then be sent to the corporate communications team for review. The corporate communications team must now review the content to ensure compliance to corporate communications standards. If the content modifications are not approved, then the content is returned to the content author for revision and must follow the approval process again. If the content is approved, the content is sent to the legal research department for final review. If the content is not approved, the content is once again sent to the content author for rework. Finally, when the content has received legal approval, the content author places the content into the publishing tool and pushes the content to production. A corporate communications (CC) team member, a subject matter expert, or a legal researcher initiates a request for a content change.
The content author (CA) for the topic or content section creates/modifies the content.
The CC sends the completed content via an email to the Topic Review Lead (TRL).
The TRL sends the requested changes back to the CA for rework.
The CC team sends the content back to the CA for rework.
The TRL reviews the content.
No
No
Approve?
Approve?
Yes
The TRL sends the content to the CC team for review.
CC reviews the content.
Yes No
Approve?
The legal department reviews the content.
CC sends the content to the legal department for review.
Yes
The CA places the content into the publishing tool and deploys the content to the website.
The legal department notifies the CA that the content is approved via an email.
Figure 2-3. Legal content review process One exception to this process is for content that has been through the investment or market research content review process already: in that case, the corporate communications team is usually bypassed, and the content is sent straight to the legal review. This usually happens when a financial analyst requests permission to send this content to a client.
37
6110_Ch02_FINAL
38
7/2/06
1:05 PM
Page 38
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
General Content Review Process This review process allows for general content promotions such as marketing information (for example, promotional text boxes) and other general content. This process recommends a legal review before deployment, but this step can be skipped. This process is initiated by the specific departmental SME for that content subsection or topic, and the content has to be reviewed by the corporate communications team, prior to being published to the site. Figure 2-4 shows the general content review process, which is initiated by the departmental SME for the given topic or subsection of content. This process allows the promotion of all other content in the FiCorp site. This approval process allows the departmental SME to include or exclude the legal content review. The remainder of the process is similar to the legal content review process described previously. The departmental SME initiates a request for a content change via email to a CA.
The CA sends the completed work to the departmental SME for review.
The Content Author (CA) creates/modifies the content.
The departmental SME reviews the content change.
The departmental SME determines if legal review is needed.
Yes
Approve?
No
The departmental SME requests rework.
No
Approve?
CC reviews the content.
Yes
Need Legal?
No
The departmental SME sends the content to CC for review.
The departmental SME sends the content to CC for review.
Yes
CC sends the content to the legal department for review.
No
Approve?
Yes
No Approve?
The legal department reviews the content.
Yes
Figure 2-4. General content review process
The CA is notified that the content is approved.
The CA places the content into the publishing tool and deploys the content to the website.
CC reviews the content.
6110_Ch02_FINAL
7/2/06
1:05 PM
Page 39
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
Getting a Look at the Home Page FiCorp has spent a great deal of time and money designing its site and thinks the site has an appealing look and flows quite nicely. The first page a web surfer experiences is the FiCorp home page, as shown in Figure 2-5. This is the entrance page for all customers of FiCorp.
Figure 2-5. The FiCorp home page This page is broken down into several component sections and already lends itself to being put into a CMS. Breaking content pages down into components allows for better management of your content. We have compiled a list of each component in the FiCorp site and included a brief summary of each in the following sections. You will probably find that your content has similar content areas.
39
6110_Ch02_FINAL
40
7/2/06
1:05 PM
Page 40
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
Page Header The page header is included in every content page for the Internet site. A significant amount of functionality is packed into the page header, which is a great area to include global type features of the website: • Existing customers can log in to a secured section of the website. This is visible on the header, designated by the “sign in” link. • The common Find a Location application is visible via the “locations” link on the header. • A new or existing customer can open an account. This is visible on the header and is designated by the “open account” link. • Search is exposed to the user. This is visible on the header and is designated by the “FIND IT HERE” input text box. • Global navigation to main site sections is visible on the header and is designated by the Personal, Small Business, Commercial, About Us, and My Account navigation tabs. • Although not displayed on the home page, the header also contains subsection navigation when displaying a main section landing page. (This was visible in the site map shown in Figure 2-1.)
Page Footer The footer also appears on every page throughout the site. The footer includes links to the site map, the terms of service, and the privacy policy for the site, all of which are required even if rarely used.
Left-Column Navigation The left-column navigation consists of a series of links. These links can be on the same page as other content within a subsection. The home page is a little different in that the links are more diverse and can be outside the current subsection.
Content Box Area The content box areas are designed to be changed as needed. This page is not a fully implemented portal but does mimic some of the basic functionality of a portal.
Main Content Area The main content area can contain any type of content. This is the meat of the page and in this case includes promotional boxes that change frequently.
Getting a Look at a Landing Page Each main section has a landing page. This landing page is a smaller version of the home page, and in fact, content is organized on this page to act as a home page for the subsection.
6110_Ch02_FINAL
7/2/06
1:05 PM
Page 41
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
Figure 2-6 shows the Personal subsection of the site. We will introduce in the following sections only the components that differ from the home page.
Figure 2-6. FiCorp main subsection landing page Let’s take a look into the components that appear on this page. We will define each and then briefly describe its function.
Breadcrumb The breadcrumb on the FiCorp site is identified by the “YOU ARE HERE” text. A breadcrumb navigational system helps identify where the web surfer is while allowing them to move to any level “above” the current page. Most often this navigation is constructed at run time based on previously defined navigation rules. For the FiCorp website, the breadcrumb is simple and is built by the tag that is included in each content page. Figure 2-6 shows the Account
41
6110_Ch02_FINAL
42
7/2/06
1:05 PM
Page 42
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
Choices subsection of the Personal section. This is a common feature, and there are no real complicated aspects to it.
Left-Column Navigation The left-column navigation differs from the home page, as you can see. The left-column navigation that appears depends on the section of the site that the user is currently in and on that section’s associated content pages. In the case of the landing page, the links are specific to this page.
Page Header It’s worth noting that the second-level navigation now appears. The surfer has navigated to a subsection of the site. This is yet another clue to inform the user of their current location in the website. As you can see, the page that you are on, Account Choices, is highlighted.
Getting a Look at the News Releases Summary Page The News Releases summary page, as shown in Figure 2-7, is a watered-down version of the landing page. We call this a basic content page layout. This page is currently being generated as static content on different sites. The business owner wants to be able to update the news releases in one location and have the content pages be updated on all the sites.
Figure 2-7. FiCorp topic landing page
6110_Ch02_FINAL
7/2/06
1:05 PM
Page 43
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
This page consists of the four most recently published news releases and must be updated each time manually.
Understanding FiCorp’s Needs In the project scoping meeting(s), you have determined that FiCorp’s needs are as follows: • You must enforce corporate legal and branding standards. • You must create a content audit trail. • The system must version all managed content. • You will eliminate the dependency on the publishing tool. • You will remove the dependency on IT to make certain content updates. • You need a system that helps organize FiCorp’s content and manage that content effectively. • The system should be intuitive to use, with minimal training needed. • You need to create a mandatory and system-enforced review process. • The standard business processes must still apply in the new system. • You must have the ability to remove content from the website. • You will migrate the entire FiCorp site to the CMS structure. Now that you have some basic background about FiCorp and some of its high-level requirements, you can take a quick look at FiCorp’s current infrastructure. Figure 2-8 offers a basic network diagram of FiCorp’s pre-CMS environments. Because of security concerns, the network is segmented into an Internet environment and an internal environment. The internal environment is broken up into a development environment and a testing environment. All code changes performed by the IT staff are completed in development, moved to the testing environment, and then finally promoted to the production or Internet environment. The publishing tool is located in the Internet environment, which allows users to publish into this environment. To protect the site, FiCorp has attempted to secure this tool. The publishing tool is a web application that uses a username and password for access. The tool is also installed on a nonstandard port number, and users of the tool must have a certificate from the internal certificate server. Even with these measures in place, the FiCorp security team would like to have a more robust and secure application for content changes. Additionally, all users of the tool would like to be able to preview their content before the content is deployed to the site.
43
6110_Ch02_FINAL
44
7/2/06
1:05 PM
Page 44
CHAPTER 2 ■ DEFINING THE CMS PROJECT SCOPE
FiCorp Basic Network Diagram (Pre-CMS) Apache
Oracle
Apache Web Logic
Internet Environment
WebLogic
Development Environment
External Mail Gateway
Gateway Apache
DMZ `
Web Logic
Developer Workstation Apache Test Environment
Figure 2-8. FiCorp basic network diagram
Summary In this chapter, we taught you how to define the project scope for a CMS implementation and gave you a best-practice methodology to help you construct the vision artifact. We also introduced you to the RUP and the FiCorp case study. We then discussed the structure of the FiCorp website and its existing publishing processes. At this point in the book, you should have a good idea of the solution that is desired to implement the FiCorp site in a CMS. In the next chapter, you will look at Interwoven’s products and learn how you can use each of these products to build world-class enterprise content management solutions. We will describe these products based on our extensive experience with them. This will allow you to make an informed decision when choosing the Interwoven products, which will be extremely beneficial to you and your organization.
6110_Ch03_FINAL
7/2/06
1:06 PM
PART
Page 45
2
■■■
The Inception Phase In the Rational Unified Process (RUP), the Inception phase is really the beginning of all project-related work activities. This phase should start with a meeting with project stakeholders and conclude with group consensus of the projects goals by all project stakeholders and proverbial purse-string holders. This is also the phase where the business case is developed and justified. It seems simple enough, but the Inception phase is one of the most misunderstood and misused phases in the RUP. In this part of the book, we will describe the events that should take place in the Inception phase of the project, as well as explain their relevance within the entire project structure. We will not focus on all RUP activities, or artifacts, because this book is not about RUP but rather uses it as a road map for its methodology. We will explain how to accomplish goals in the shortest time possible; in addition, we will describe all of this within the context of content management systems (CMSs). The Inception phase of the project should be one to four weeks long for most projects and should accomplish the following goals: Establish the project’s scope and boundaries in a vision artifact: This artifact should contain the general vision of the project’s objectives, key features, and constraints. Document the project’s critical success factors and other acceptance criteria: This will produce a business case document, which will list the business justifications for the project. (Most likely, this document will have already been created for you by the project stakeholders and is the reason that you may have been engaged for the CMS project.) Develop an initial draft of the known project risks: This will produce a risk assessment document, which is critical to helping you identify and document all the known project risks so that you can create later contingency plans to mitigate those risks.
6110_Ch03_FINAL
7/2/06
1:06 PM
Page 46
Make the decision to move ahead with a prototype of the CMS technology: If a prototype will be included, you then design, develop, and demonstrate that prototype. If you create a prototype and display it to stakeholders, you can provide the “proof-isin-the-pudding” view to cement further funding of the project. You can also use a prototype to gain further insight into the tool or technologies that will be used. Estimate the overall project cost and create an initial schedule: You should generate a project plan showing the timeline, the phases, and the iterations. This will, of course, change as your knowledge of the project increases throughout the remaining phases. Identify an initial use case model survey: This will contain all the actors and their associated use cases that can be identified at this point. This will serve to begin the requirement process and will facilitate discussions in future phases of the project. Use cases will constantly be evolving throughout the life of the project, but now is the time to begin the identification of the most glaring and critical ones. Identify a project glossary: This will contain any important or unfamiliar terms specific to the problem or business domain. This is important for consistency because the most successful projects are those in which everyone speaks the same language. This artifact will help you achieve that goal. Remember, even if you think you are familiar with a term, it is always best to seek a definition for the term from the group and experts to facilitate a common understanding among project team members. Well, that’s enough about the Inception phase; we’ll stop discussing it and start doing it.
6110_Ch03_FINAL
7/2/06
1:06 PM
CHAPTER
Page 47
3
■■■
Introducing TeamSite and Friends T
he bulk of this chapter describes the applications in the Interwoven product line. The better you understand each product, the more likely you are to purchase the right software for your needs. Every large enterprise will probably need most of Interwoven’s products, but it is not reasonable that every enterprise should start out with every application. Since we outlined and prioritized FiCorp’s project requirements in Chapter 2, you now need to determine which software will best meet your requirements. An ideal strategy for accomplishing this goal is to insert your project requirements into a spreadsheet. As you read this chapter, put the name of the product that is best suited to fulfilling a particular requirement next to the appropriate item. Some requirements will be solved by multiple products, so make sure you signify how well the product will solve that requirement. You should also categorize each product with a difficulty identifier: Out of box: A feature that can be solved without having to change a single line of code or configuration. An example is Microsoft Word’s ability to save a document. Configuration: A feature that will require a change in the default configuration. An example is modifying Word’s default behavior to save in a format other than the .doc format. Customization: A feature that will require custom code to fulfill the requirement. Returning to the Word analogy, you might add a menu that allows you to import images from a custom database application. You do not have to use these categories, but make sure you understand how each of your categories is defined. Making sure your categories have precise definitions will aid you later in identifying the effort involved with meeting each requirement. When you have finished this chapter, you should have a high-level understanding of the products required to fulfill your needs. This spreadsheet will reduce the amount of research needed by limiting the products you have to examine.
■Note Most of Interwoven products can be highly customized to fit your business, but the more detailed the product selection process you go through, the less customization you will need to make. When it becomes time to upgrade the system later, it is much better to have a system that is less customized. With that being said, if your customizations are carefully designed, they will not affect the upgrade to any great degree. 47
6110_Ch03_FINAL
48
7/2/06
1:06 PM
Page 48
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
Introducing TeamSite Content Management Server 6.5 TeamSite Content Management Server (or TeamSite) is the foundation of Interwoven’s CMS product line. It will be the foundation for your applications and can handle virtually all content types. TeamSite handles many of your base content functions: • Versioning • Check-in/checkout • Data organization • Metadata • Content interfaces This chapter will cover each of these base features. Understanding how each works will become clear as you learn about how TeamSite allows user interaction. Understanding how you can organize content within the repository will provide you with the vocabulary you will need to understand in order to see how TeamSite can work for you. Interwoven calls this content area the content store. We will start building your knowledge of the content store by describing the functionality known as branching.
Branching TeamSite uses a technique Interwoven calls branching, which is the methodology employed by Interwoven to handle content divisions. You can also think of branching as separate paths for the same content, and with this technique the content may or may not be merged in the future. Three main division types accomplish this: Branch: You can think of a branch as a project in a source repository. The branch is the largest division type and contains all other types. You can have as many branches as you want, and a branch can contain sub-branches. Staging: The staging area in TeamSite is where you find all the approved versions of a piece of content. Once a version is created, it cannot be deleted from the repository; in fact, if you delete a file from the workarea, a version of the delete will be created, but all the previous versions will still appear. Since you can create versions for each branch in only one area, each branch has only one staging area. Workarea: The workarea is where an author makes changes to files that need to change. The content in this area includes the working version or pieces of content that are checked out. The workarea contains links to all the assets in the staging area until they have been modified. Once a piece of content has been modified, a copy of the file is created in the workarea. Once the author is satisfied with the content in the workarea, the author can submit the content to the staging area for versioning. A branch can have as many workareas as needed.
6110_Ch03_FINAL
7/2/06
1:06 PM
Page 49
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
Although these are the three divisions of your data, another important area appears inside the content store. This area contains what Interwoven calls editions. An edition is a snapshot of the staging area as it appears when the edition is created. An edition is good for rolling back large changes in your content. You may not want to create an edition every time you make a content change, but you could if you saw a need for creating this many editions. Over the years, Interwoven has reduced the impact of creating editions, so the decision of when to create an edition is now purely based on your needs.
■Note Editions are helpful when you are deleting content from the staging area. When you delete a piece of content from the content store, you are not actually removing it. What happens is the next version of the file is actually a “delete.” What this means is if you browse the staging area, the file appears not to exist, but the older versions of the content still exist. You can restore a file in many ways, but the easiest way to get the previous version is to restore the file from the edition you created before deleting the content.
Figure 3-1 shows what a typical branch looks like. In this example, the Financial_Data branch consists of data from two groups. One group maintains the Stocks section, and another group maintains the Bonds section. The Workarea branch pictured contains the content from both the Stocks and Bonds directories, but the directory permissions allow only those personnel from each group to modify their own content. Although multiple workareas are not necessary, it may be easier to keep track of who should be approving the content by using workareas instead of by maintaining a list of directories and mapping each directory to the appropriate approvers. Financial_Data Staging Stocks A-C
Financial_Data Workarea Stocks A-C Stock AA Version 2 Version 1
D-E F-G Bonds Research Reports
Stock AA
v2
D-E F-G Bonds Research Reports
Figure 3-1. A branching structure that supports multiple groups through workareas that separate content within the same physical structure
49
6110_Ch03_FINAL
50
7/2/06
1:06 PM
Page 50
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
You may also notice that the staging area is at the same level as the workarea; although two Financial_Data sections appear, they represent a single entity. The staging area is a special read-only workarea where versioning happens. The actual content for this branch is stored underneath the staging area, and the workareas actually point back to a particular version of a file in the staging area. Once the content changes in a workarea, a copy of the file is created in the workarea where the change was made and will reflect the modifications that were made. In other workareas under this branch, this file will not show that a modification has been made. This allows the workareas to provide parallel development. Since two groups are working with the content in this branch, we would create two workareas. Each workarea would be used by a separate group of employees from the finance department, so by creating workareas for each group, we could easily change the permissions in each of the workareas to isolate the Stocks directories from the Bonds directories. The benefit of using the same branch but different workareas is that both groups can easily see the other’s content but not be able to change it. This helps them preview content if there is any interaction between each group’s content. This is by no means the only way to handle this scenario. Depending upon how many contributors a particular group has, we could have created a workarea for each author. We could have also created additional branches to handle the separation of the Stocks and Bonds content. This, however, can add a lot of overhead and external processing to bring the entire site together. Chapter 7 will cover more about branching.
Metadata Chapter 1 discussed metadata and what some of its uses are. The content store allows metadata to be stored for every piece of your content. The content store does this with what Interwoven calls extended attributes. Interwoven uses extended attributes to define proprietary application data for your pieces of content, but they also allow you to define your own custom attributes and your own custom content categories. For example, when an author is looking for a piece of content for a new article, these categories can help narrow their search by indexing the custom attributes. You can also use extended attributes to help determine what kind of review a piece of content needs or whether it can be published on a public site. If any data needs to be kept regarding your content, you can use extended attributes to store it. These attributes are stored inside the content store but can also be stored inside a database by installing an add-on called DataDeploy. We’ll discuss DataDeploy in the “Introducing DataDeploy 6.0: Database Deployment for OpenDeploy” section.
Application Type This is a stand-alone application.
Supported Platforms TeamSite supports both Solaris (versions 8 and 9) and Windows (2000 Service Pack 4 and 2003 Enterprise 32-bit).
6110_Ch03_FINAL
7/2/06
1:06 PM
Page 51
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
Supported Web Servers On Solaris, TeamSite supports the following web servers: iPlanet 6.0 Service Pack 2; IBM HTTP Server 1.3.19 and 2.0.47; and Apache 1.3.17, 1.3.22, and 1.3.26. On Windows, it supports Internet Information Services (5.0 for Windows 2000 and 6.0 for Windows 2003); Apache 1.3.29; iPlanet 6.0; and IBM HTTP Server 1.3.19 and 2.0.47.
Application Servers Apache Tomcat is the main application server that ships with TeamSite; however, TeamSite supports two optional application servers: BEA WebLogic 8.1 Service Pack 2 and IBM WebSphere 5.1.
Databases TeamSite supports several databases, including IBM DB2 8.1, Oracle 8i, Oracle 9i, and Microsoft SQL Server 2000.
Introducing TeamSite Search for TeamSite 6.5 In most cases when you are creating content, you have a single purpose in mind for that content. Whether it’s a press release or a marketing brochure, ideally that content might be reused. A huge problem for large enterprises is the duplication of effort, and the reason for this is the person assigned to creating the content does not possess an efficient means for finding previously created content on the desired topic. Based on the Verity K2 search engine, the TeamSite Search component allows for content to be located, not on a website but inside your CMS. Two main components comprise the TeamSite Search system: the content index manager and the search manager. Both are introduced next.
Index Manager The index manager can create a file with all the index information for each branch you choose to index. You can configure the index manager to read a configuration file to determine which branches to index, or you can execute a command manually to indicate a specific branch. The index manager also contains a listener, which is a program that constantly runs in the background while waiting for a specific operation to take place. To activate the listener, you select the incremental updates option when installing TeamSite search. When the listener detects that content has been updated within the index manager, it will automatically update the index for this content. This ensures that user searches are up-to-date. The index manager uses what is known as a document cracker to open and read different types of file-based content. Without the cracker, the index manager would not be able to recognize different content types and pull out data that is relevant. The cracker enables the indexer to pull out data for the full-text search and pull out metadata for keyword-type searches. (Recall from Chapter 1 that metadata is data about the data and helps define a specific piece of content.)
51
6110_Ch03_FINAL
52
7/2/06
1:06 PM
Page 52
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
■Note Although fast, the index manager is processor intensive. This is why Interwoven recommends that the index manager be installed on a separate machine other than the TeamSite machine. Chapter 5 covers this in more detail.
Search Manager The search manager is responsible for performing the queries against the indices. When users need to perform a search, they can utilize the search manager in two ways. They can use the search client built into the TeamSite interface, which will be covered in detail in Chapter 9, or they can use a command-line client. The command-line client allows a user to create a query, in the form of XML, without having to use the TeamSite user interface. If you are tasked with integrating external systems into the TeamSite search functionality, this will be the tool you would use.
Introducing LiveSite 2.2 If your team is overwhelmed with the need to create numerous sites, you may want to delegate some of the control to someone other than your developers. The problem with creating sites is that every time a new site is created, the developers have to create new presentation templates. However, once the basic site layout had been determined, it is nice to have a set of template components that a user can mix and match to create new content page layouts. You probably have created components in other systems, but unlike LiveSite, most systems don’t allow you to drag and drop your components around to generate a page layout.
Components A component is a portion of a web page. No one portion can represent an entire website; it takes two or more components to create one web page. LiveSite allows you to create two types of components: internal and external. An internal component is self-contained and does not require any external data source. An external component uses an external data source including those retrieved using SOAP, Java Database Connectivity (JDBC), XML, Rich Site Summary (RSS), or a uniform resource locator (URL). You can also create custom data sources if this is required. Once you have created all the components that you need, you can start looking at the basic layout for your new sites.
Layout You can create as many layouts as needed. For instance, you may need to create a specific layout for the landing pages for your sites. Figure 3-2 shows a landing page with six customizable component locations. In this example, now that you have the basic site layout and the custom components, you can hand over the creation of a new site to a business owner. The business owner will be able to select a location and insert any given custom component. The business owner can also move the components around on the screen and position them in any of the six positions. Chapter 19 covers this in greater detail.
6110_Ch03_FINAL
7/2/06
1:06 PM
Page 53
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
2
1 4
3
4
5
6
Figure 3-2. How you might divide sections on a landing page This product allows the business user to create sites easily. If you are wondering why a business user would want many different sites, consider the desires of your end users. Do they want to look through hundreds of pages for what they want? Most enterprises have specific content requirements for each content customer. The more you can customize the content to that customer, the more likely they are going to use your site. For example, a health insurance company could provide one site to doctors and another site to patients. Most sites are designed to eliminate the need to talk to someone to get the information that is needed, so why not design a site with the exact information the customer needs?
Application Type This application must be installed on the same server as TeamSite.
Supported Platforms This application supports Windows 2000 Service Pack 4, Windows 2003 Enterprise Edition, and Solaris 2.8 and 2.9.
Supported Client Platforms This application supports Windows 2000 with Service Pack 4 and Windows XP with Service Pack 1 or newer.
Introducing TeamXML 5.5.2 Although not a new concept, XML is still in the early phases of adoption within many organizations. We have experience working with many XML-based content management server products, but most of these products are very limited. XML can really spread its wings when you are publishing large documents where many groups or people are working on the same document. We have seen people try to use Word for this, but ultimately Word is rather limited
53
6110_Ch03_FINAL
54
7/2/06
1:06 PM
Page 54
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
in this capacity. Once your user base begins surpassing the limits of Word, you will require a more capable authoring tool. After obtaining such a solution, you must come to grips with where the XML will be stored. You could store it on a network share or put it in a database, but if you do this, it is hard to utilize the XML in a way that could be most profitable to your company. What you really need is a system that was designed to handle all these tasks. This is where TeamXML comes into play. TeamXML is a repository that makes it much easier to create XML-based components. By breaking your document down into components, TeamXML helps you spread the workflow across multiple responsible parties. Additionally, many documents can use the same component, allowing for shared content to be managed from a single location. TeamSite understands what XML is and how to implement the reuse of XML components. Once you have installed TeamXML, you can start to define your XML documents as categories. Categories define how your documents should be broken down into its components. Once your documents have been broken down into its components, TeamSite can finally allow you to reuse these components. For example, an author can modify an individual component if they are altering a large document, or they can load and modify the entire document. You can also import entire XML documents without breaking it into components. With the proper authoring techniques, componentization, and process, you can create synthesized content, which is the repackaging of separate documents into a new document with a new look and feel. When you have your components in place, you need to be able to modify them. TeamXML integrates with Arbortext and SoftQuad, which produce two of the leading XML-authoring tools. This integration provides easy access to your XML data right through the authoring tool interface. Some of the features available through the authoring tool interface are as follows: • You can render XML documents from TeamSite. • You can modify specific components by selecting a component from the repository. • You can search the components that have been created for specific content to help you reuse the content. • You can view a list of dependant documents for a specific component. When a component is reused within a document, that content component becomes dependant on the new document. • You can version files by checking them in and out of the repository. TeamXML offers many other features, but this should give you good idea of what you will get by using TeamXML. If you have a large team working on XML documents or just have many overlapping documents, then TeamXML is the tool that you need to add to your authoring environment.
Application Type This application requires TeamSite.
TeamXML-Compatible Authoring Tools This application supports Arbortext Epic Editor and SoftQuad XMetaL.
6110_Ch03_FINAL
7/2/06
1:06 PM
Page 55
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
Introducing OpenDeploy 6.0.2 Once your content has been approved, you need to deploy your content from the server where it was created to where it will be used. OpenDeploy makes this process particularly efficient, because although you could do it manually through scripting, OpenDeploy can do it for you automatically. You can also use OpenDeploy in conjunction with Interwoven’s ControlHub, which is covered later in the “Introducing ControlHub 2.0” section, which can be a powerful solution for managing your code. When combined with ControlHub, your code can be versioned, releases can be created, and then these releases can be deployed to testing servers and to then production. Defining a deployment strategy is not something you should take lightly because there are many different aspects of deployment, and Interwoven has addressed those issues with this product by offering n-tiered and transactional deployments.
N-tiered Deployments Many implementations require a more complex deployment strategy than simply moving files from one server to another server. A deployment strategy may require that a deployment cross multiple network segments before reaching its destination. If this is the case, OpenDeploy can solve this problem for you. Figure 3-3 shows what a tiered deployment could look like. Server A initiates the deployment. This server is located in network segment 1 and has access only to the OpenDeploy server in segment A. Network segment 2 may be acting only as a buffer between segment 1 and segment 3, as shown in Figure 3-3. Server B will then transmit the deployment to server C where the deployment could end at an OpenDeploy receiver or, as pictured here, could then be deployed to server D. Server D may be a web server where content is served from or an application server where you could be deploying an application. In this scenario, server C is not really needed, but if you set up OpenDeploy in this way, you could perform reverse deployments where server C could initiate a request for server A to start a deployment. This is useful in environments where your information security team does not allow content to be pushed into production, only pulled.
A
B
C
D
OpenDeploy Base Server
OpenDeploy Base Server
OpenDeploy Base Server
OpenDeploy Receiver
Segment
Segment
Segment 3
Figure 3-3. An n-tier deployment using OpenDeploy
Transactional Deployments You’ve probably heard of, and in fact even extensively worked with, database transactions. This transactional state is similar to how OpenDeploy treats a transaction. We have been
55
6110_Ch03_FINAL
56
7/2/06
1:06 PM
Page 56
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
talking about content in a generic sense, but we will cover some specific content in this section to show how transactions will quickly become a powerful resource in your new system. If you were deploying only one type of content, maintaining a transactional state would not be that difficult, but once you start deploying content of multiple types such as files to a file system, data to a database, and an application in the same deployment, everything gets much more difficult. You can handle such situations in different ways, but OpenDeploy has been designed specifically to handle this situation. Figure 3-4 shows how OpenDeploy can handle a deployment consisting of these components. As you can see, the figure shows two separate network segments. The deployment would be initiated from server A to server B inside segment 2. Once the deployment has reached server B, the deployment will then fan out to its appropriate server. If one of the servers fails, then the entire transaction can be rolled back. Each server will be returned to its previous state. Transactional deployments are slower to perform, so you should use them only when necessary. Segment 1
A
Segment 2
C
Application Server
B D
E
OpenDeploy BaseServer
OpenDeploy Receiver
OpenDeploy BaseServer
Oracle
Transactional Rollback Figure 3-4. Transactional deployment using OpenDeploy You can use several other configurations with OpenDeploy. Chapter 11 covers these in detail, but for now you should see that this product is powerful. It lends itself to solving most any deployment needs.
Adapters OpenDeploy supports adapters, which enable it to interface with many different repositories. Some of the approved adapters include FTP, Polytron Version Control System (PVCS), WebLogic, Oracle 8i and 9i, Microsoft SQL 2000, Hypersonic, and Unix file systems.
6110_Ch03_FINAL
7/2/06
1:06 PM
Page 57
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
Application Type This application does not require TeamSite to be installed.
Supported Platforms This application supports Windows 2000 Server (Service Pack 2 or later); Windows 2003; Solaris 2.8 (Solaris 8) and 2.9 (Solaris 9) (32-bit and 64-bit); AIX 5.1 and 5.2; Red Hat Linux 8.0 and 9.0; Red Hat Enterprise Linux 2.1 and 3.0; SuSE Linux 8.1; SuSE Enterprise Linux 8.1; and HP-UX 11i.
Introducing DataDeploy 6.0: Database Deployment for OpenDeploy One of the most common places to store content is in a relational database. Interwoven has recognized that this is a valuable part of any CMS. DataDeploy was designed to incorporate database repositories into Interwoven’s CMS. DataDeploy supports many different databases such as Oracle, Microsoft SQL, MySQL, and DB2. Interwoven has linked DataDeploy with OpenDeploy to help solve some deployment needs such as providing the ability to perform target-side database deployments, which allow your content to be deployed across network segments. Take a moment to reconsider Figure 3-4. The deployment taking place from server A to server E is an example of this type of deployment. The content that is being deployed to the database is being pulled from an XML file and is referred to as structured content. The database schema can be configured using XML so that DataDeploy can deploy content to databases that are also used by your applications. The configuration allows your schema to comply with any database model created within your organization.
TeamSite Integration Integration with TeamSite allows TeamSite to trigger database updates based on certain events that occur. Some of the events that can be triggered are creating, modifying, and removing data records. Metadata for each record can be automatically stored or removed from the database. If you decide to configure the database to be updated automatically, you do have less control over when the update actually is performed.
Application Type This application must be installed with OpenDeploy.
Supported Databases This application supports Oracle 8i, Oracle 9i, Microsoft SQL Server 2000, and IBM DB2 8.1.
57
6110_Ch03_FINAL
58
7/2/06
1:06 PM
Page 58
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
Introducing ContentServices 1.1.2 The ContentServices software development kit (SDK) allows you to connect to Interwoven’s underlying application programming interfaces (APIs). Figure 3-5 shows how you can use this functionality. As you can see, ContentServices allows your Java applications to be modified to interface with the TeamSite subsystems.
Existing Applications
New Application
Content Services SDK
Interwoven
TeamSite
OpenDeploy/ DataDeploy
Workflow
Figure 3-5. Interwoven’s API model ContentServices allows you to start workflows, transition tasks, deploy content, and much more. You can update existing applications to integrate with TeamSite without having to rewrite the entire application. Your new applications should be designed to use one of the TeamSite interfaces such as ContentCenter Standard or ContentCenter Professional.
Application Type This is a web service API for integrating your applications into Interwoven products.
Supported Platforms This application supports Windows 2000 Server (Service Pack 2 or newer); Windows 2003 Server; Solaris 2.8 (Solaris 8) and 2.9 (Solaris 9); Red Hat Linux 7.2, 7.3, 8.0, and 9.0; Red Hat Enterprise Linux 2.1 and 3.0; SuSE Linux 8.1; SuSE Enterprise Linux 8.1; AIX 5.1 and 5.2; and HP-UX 11i.
■Note When using the ContentServices SDK, make sure you do not reinvent the wheel. Use this only if you don’t have a way to do what you want to do in TeamSite. When it comes time to upgrade TeamSite, you do not want a lot of code depending on the older version. One way to help this is to make sure you create interface classes that access your CMS. You have to change your interface classes only when upgrading to the new version. By doing this, external systems will be decoupled from the Interwoven interface.
6110_Ch03_FINAL
7/2/06
1:06 PM
Page 59
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
Introducing ControlHub 2.0 ControlHub enables you to develop your applications and promote those applications through TeamSite. The traditional application promotion process is manual and may not be as easy to manage as it once was. ControlHub gives the power back to a smaller set of individuals, ensuring that the releases are more consistent across each of the development environments. ControlHub provides the following abilities: • You can create a release for your application. • You can compare source code versions from release to release. • You can pull source from source repositories such as PVCS. • You can build your application inside ControlHub. • You can manage the promotion process with your own custom workflows. You can achieve all this through the integration of ControlHub and OpenDeploy. ConrolHub is built over TeamSite and does not require a separate installation of TeamSite.
Application Type This application is a stand-alone application installed in conjunction with OpenDeploy.
Supported Platforms This application supports Windows 2000 Server (Service Pack 2 or newer), Windows 2003, and Solaris 2.8 (Solaris 8) and 2.9 (Solaris 9) (32-bit and 64-bit).
Introducing ReportCenter for TeamSite 6.5 TeamSite employs an event subsystem that enables events within TeamSite such as creating a content file or deleting a branch to be tracked. ReportCenter further extends the event subsystem to provide you with a more detailed record of each event. ReportCenter enables you to create reports using Crystal Reports that are based on events that are triggered within the CMS. How ReportCenter achieves this is by querying the workflow engine or the templating engine to gain additional information such as the file list for a deployment or who the approvers are for a workflow. Once ReportCenter has captured all the data necessary for the event, it then stores this information in a database. ReportCenter offers many features, some of which include the following: • Keeps historical data, user activity, and workflow • Integrates with Crystal Enterprise • Ensures content change tracking, deletions, and additions of files • Reports on published editions and branch/workarea creation and deletion • Reports on the duration of workflows, tasks, and files attached to workflows
59
6110_Ch03_FINAL
60
7/2/06
1:06 PM
Page 60
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
Application Type This application must be installed with TeamSite.
Supported Databases This application supports Oracle 8i, Oracle 9i, Microsoft SQL Server 2000, and IBM DB2 8.1.
Introducing FormsPublisher If you are planning on enforcing a style guide, FormsPublisher can help you effectively do so by enabling you to separate your raw data from its end presentation. Your data is divided into groups known as categories, and these categories are further subdivided into types. FormsPublisher uses these types to map different presentations to your data. Separating your data from the presentation allows you to reuse your data over several document types. Once you have aggregated the data, you can define separate channels that can be used to generate different content types. An enterprise can generate PDF, HTML, XML, and Microsoft Office documents from a single data type or record.
■Note The term style guide is used when a company has created guidelines that are required to be followed when creating content for a specific medium. Many corporations maintain a style guide for web content and printed content.
Once content can be generated, it should be safe to start automating your content deployments to your target sites using OpenDeploy and Interwoven Workflow. Moving your content into place in this way eliminates the need for your content to be promoted along with your code promotions. Your content could be updated much more quickly and by people who have much less technical knowledge.
Application Type This application is installed with TeamSite.
Introducing MetaTagger 4.1.0 This application helps you attach metadata to your content. One problem with relying on metadata is that end users will decide upon different values for the various metadata fields. Because of this, you cannot rely on these values because everyone has a different idea of what the metadata values mean. MetaTagger can intelligently identify portions of your content and automatically identify the right category based on a predefined taxonomy, which is a predefined set of characteristics that can be used to categorize your data. You can train MetaTagger to extract fields, titles, and descriptions using an extensible pattern-matching engine. The system can then automatically create data summaries for the content. This entire process can be set to be completely automated or to give suggestions and then leave the categorization to a user.
6110_Ch03_FINAL
7/2/06
1:06 PM
Page 61
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
This intelligent metadata creation can increase your return on investment and content reuse significantly because your content is more valuable to its users. One reason for this is that it is much easier to find content that can be reused in manuals or articles, thus reducing the cost associated with re-creating the same content repeatedly.
Application Type This application does not require TeamSite to be installed.
Introducing MediaBin 4.5.3 The need for a better system to manage an enterprise’s digital assets has never been greater. People are creating new digital assets at a faster pace than ever before. This need has in turn generated the need for companies to utilize a digital asset management (DAM) tool. Some companies have built custom applications to handle the assets, but this could be a waste of resources. MediaBin can solve the enterprises needs of a DAM system. MediaBin was built with the idea of simplifying basic functions such as ingesting your assets, versioning, collecting metadata, and searching your assets. Ingesting content is often not looked at as an important aspect of the asset management system until it is time to start migrating all your assets. Often your images are in many different formats; MediaBin can translate images to a standard format or create a duplicate image in the following formats: PSD and EPS, vector EPS, TGA, TIFF, JPEG, GIF, PNG, BMP, Photo CD, and STiNG. Another problem experienced by large corporations with offices around the world is that it takes a lot of resources to move large assets to remote offices. MediaBin allows you to set up asset servers local to your users around the world. When an asset is modified, the MediaBin Syndication Manager uses a business rule system to determine which servers need to be updated with the asset changes. Many other MediaBin features enable you to share your content; you can schedule content deliveries, cluster your media servers, and utilize MetaTagger integration to classify your assets. Also, an SDK allows you to create your own application extensions.
■Note The terms ingestion an ingesting content are used when a system takes content in and can readily use this content without much user interaction.
Application Type This application does not require TeamSite to be installed.
Supported Platforms This application supports Windows 2000 Server (Service Pack 2 or newer) and Windows 2003.
Supported Databases This application supports Oracle 9.2.0.5 or newer and Microsoft SQL Server 2000.
61
6110_Ch03_FINAL
62
7/2/06
1:06 PM
Page 62
CHAPTER 3 ■ INTRODUCING TEAMSITE AND FRIENDS
■Note DAM systems can prove to be expensive. If you do not need a robust DAM system, it is better to make due with what you are currently using. Remember to take into account your asset growth when making this decision.
Following Best Practices While you are making your decisions on which products to buy and how to integrate your systems, keep the following tips in mind: • Match your requirements to the Interwoven product offerings to help narrow down your product selection and evaluation process. • Perform additional research on products that seem to fulfill your requirements. Make sure the products you have selected fulfill your requirements in a way that is satisfactory to both you and the business owner. • ContentServices will allow you to fill in the holes by adding functionality to your existing applications. • Make sure you take into account your future growth. If you do not plan for your future growth, a year or two from now you will not have a warm, fuzzy feeling about your CMS. • Try to make the implementations as generic as possible. This allows you to create a foundation for new applications and teams that become part of the CMS.
Summary Now that we have covered some of the more important Interwoven applications, you should have a better understanding of your Interwoven needs. You may also have an idea of how much work is ahead of you. You should not take CMS implementations lightly. The decisions you make today will either be your saving grace or become nightmares in a year or two. When a CMS is implemented wisely, it can offer many benefits to your content customers such as a faster time to market, a more standardized look and feel, and a more reliable facility to make updates to your content. The keys to this are to make informed decisions about your product selection and to keep your customizations to a minimum. In the next chapter, you will learn how you can take the information you have discovered here and create some useful artifact documentation from it. This documentation will carry you forward through the remainder of the FiCorp project. We will also show you how to gather requirements in a CMS project and what to do with those requirements once you collect them. We will talk about the types of requirements and how to catalog those requirements. We will also show how the FiCorp requirements map to the CMS system requirements.
6110_Ch04_FINAL
7/2/06
1:06 PM
CHAPTER
Page 63
4
■■■
Gathering Requirements B
efore we talk about defining requirements, we’ll take a step back and define what a requirement is. Requirements are capabilities or functions that a system must perform to meet a user or external system need. In other words, requirements are the “what” for a system. For example, what types of reports are needed? What fields should be available on a form? What happens when the admin user clicks the Set Up button? Everyone has, at one time or another, done their own requirements gathering. How often have you asked your spouse or roommate if they needed something from the grocery store or gas station? You might have followed this question up with others. What size? How many? What colors? What brand? All of these types of questions allowed you to gather requirements for your trip to the store. Requirements fall into many different categories. The two main categories for all requirements are use cases and other functional requirements. Use cases are stored in a use case document, and other functional requirements are stored in a supplemental requirements specification. This chapter will discuss both of these types of artifacts. We will also teach you a structured methodology for deriving use cases and other functional requirements in the context of a CMS.
Defining the Initial Requirements The requirements for a CMS are not unlike the requirements for any other system in that all the requirements fall into the use cases category or other functional requirements category. The following sections discuss what use cases are and clear up some confusion that is prevalent in the industry as it relates to use cases. We’ll also discuss another RUP artifact, which is the project glossary. The project glossary is separate from the use case documents and helps provide a common vocabulary for the project.
Introducing Use Cases The RUP defines a use case as a predefined sequence of events yielding value to an actor. An actor can be a user or another system that interacts with the system you will be documenting or designing. Use cases define the sequence of events that one or more actors will perform in order to use the proposed system. Use cases should be kept at the level of an elementary business process. This means any use cases you document should include only one set of functionality. A good example of this kind of use case is a system login. When an actor logs in to the system, 63
6110_Ch04_FINAL
64
7/2/06
1:06 PM
Page 64
CHAPTER 4 ■ GATHERING REQUIREMENTS
many other processes may take place for this event to occur, but those other processes should be kept separate from the base use case of a system login. We will discuss this in much more detail in the “Examining a Use Case Document” section. For the Inception phase, you should identify the “low-hanging-fruit” use cases; in other words, pick only those use cases that are easily identifiable at this early stage in the process. Additionally, you should try to identify any architecturally significant use cases, which are any use cases that will have a profound effect on the design of the proposed system. At this stage in the RUP, you will not be able to completely define the identified use cases, but you can identify the need for most use cases. You will then refine these use cases as you progress through the process. A major component of a use case is the actor, which is the system or user who initiates the use case or acts on the use case. By defining the actors, you define specific sets of functions that the system/user can perform when interacting with the CMS. Some examples of actors include people (or more accurately, roles), hardware, other systems, and reporting applications. For example, if you are designing a database to store customer sales data and you have another system (System A) that retrieves summary sales data from that database system, then you could say that System A is an actor of the database system. The concept of an actor will become clearer as you proceed in the case study. When gathering requirements and conducting requirements workshops with users, keep in mind that the users will have a desire to name specific people as the actors; your task will be to remove the individual and define the role that the individual fulfills. For example, when you ask users “Who starts the system?” they may respond by saying “Debra does that.” Your task is to dig deeper into that response. What else does Debra do? Does anyone else do what Debra does? Can anyone else do what Debra does? What is the process that Debra follows to do this? Of course, the next step is to interview Debra to further cement your understanding of the system to be developed. This chapter will discuss the artifacts that should be generated during the Inception phase and provide samples of those artifacts for the case study. We will start with the project glossary artifact.
Defining and Documenting a Project Glossary Early in the process it is critical to establish and maintain a common vocabulary of terms and their definitions. This ensures that all the project team members are using the same vocabulary. Think of this as the driver for all members of the project team and stakeholders to speak the same language. This common vocabulary will help reduce misunderstandings during the project life cycle. The best way to begin to compile this glossary artifact is through your interactions with project stakeholders and domain SMEs who you will interview and work with during the project. A sample of the FiCorp glossary is as follows: APR: Stands for Annual Percentage Rate. An APR is the cost of acquiring a loan. This is the interest rate paid on a loan and all applicable fees over the period of a year. Affinity cards: These are cards that behave much like credit cards but are usually tied to a charity or organization. They may impose fees based on each transaction.
6110_Ch04_FINAL
7/2/06
1:06 PM
Page 65
CHAPTER 4 ■ GATHERING REQUIREMENTS
Cash cards: These are plastic cards issued by banks or other institutions used for withdrawing money from automated teller machines (ATMs). Credit card: These are plastic cards issued by merchants to extend credit to the individual holding the card. These cards can usually be used to withdraw money or to purchase items on credit. Debit card: These are also plastic cards issued by banks or merchants; instead of extending credit, these cards actually withdraw funds from the cardholder’s bank account usually within a few days of the purchase. The sample glossary section just provided is far from complete; however, it should give you an idea of the information that belongs in the glossary. This information will probably change based on each project or organization. Once your glossary begins to take shape, it is the responsibility of the systems analyst to maintain this document throughout the life of the project. Additionally, the systems analyst should verify the document with all project members to achieve sign-off and to guarantee that the artifact is accurate.
Completing the Catalogs As you start to define the requirements for the proposed system, you must define the actors that will use the system. You will also identify what those actors do in the system or how they interact with the system. The project team, facilitated by the systems analyst, must also define a description for each actor. All of this information will be compiled into a use case catalog and an actor catalog. You can think of the use case and actor catalogs as the inventory documents that list all the use cases and actors. You will find that the information in each catalog may change as you progress in your project, but it is imperative that the information be maintained and updated with any changes. As new project team members are added, this information will help them come up to speed on the problem domain. This information will also help the project manager complete the iteration plans and assign resources to use cases. The associated resources will include analysts to research and write the use cases and developers that will actually implement the use cases into the system. We recommend developing the actor catalog first and then refining it as you go. When you are defining the actors, you will notice that some of the previously identified actors perform the same function in the system and so should be combined into one actor. When combining actors, you should maintain the actor name that makes the most sense to all project team members. Actor names should be as descriptive as possible. The following section covers the process for defining actors.
Defining the Actor Catalog Defining the actors in a system can be a tricky process. On one hand, you have to derive all actors in the system, but you have to be careful not to create imaginary actors or actors that may not belong to your system. You must invite some of your users and project stakeholders to a workshop where you can define the actors. The main reason for this is that only they will know the non-IT component of the system you are developing. Also, you will need their direct input to give the actors descriptive names.
65
6110_Ch04_FINAL
66
7/2/06
1:06 PM
Page 66
CHAPTER 4 ■ GATHERING REQUIREMENTS
One of the values in this type of development process is that you earn the stakeholders’ respect and make them champions of the CMS. No longer will they feel like IT is a black hole where they send large amounts of money in the hope that they get something useful (software) from the bargain. Including these individuals in all areas of development means they will feel like their opinions are respected and valued. This relationship building is highly reciprocal and will pay off in large dividends to your project. The first step in defining actors for your CMS is to identify the common roles used in the system. You should have one to several meetings with the business owners to determine the actor catalog. Questions to ask during these meetings/requirements workshop sessions include the following: • Who will need to use the CMS? • Who/what will monitor the system? • Who will need to log in to the CMS? • Who will be responsible for starting and stopping the CMS? • Who will be responsible for performing maintenance on the system? • Who or from where will content originate that is ingested into the CMS? • Who will be responsible for updating or creating content in the CMS? • What external systems will the CMS need to communicate with? • What external systems will use this CMS? • Does anything happen automatically at a certain point in time? If so, who/what initiates this action? • Where will the content reside? • Where will the content be sent? It is unreasonable to think you will identify every single actor for the CMS at this point. In fact, we can assure you that you will discover others during later project phases. Just do the best you can at this point, and remember to run any identified actors by the business owner, project stakeholder, and other company representatives for validation. Also important to keep in mind are systems such as content intelligence systems (MetaTagger), search systems, and repository systems. All of these systems could be potential actors that you will want to document and capture. As part of the actor discovery or requirements workshop, you should decide on a specific description for each actor and keep this up-to-date in the actor catalog. You must also attempt to ascertain what functions each identified actor performs in the system. This way, duplicate roles can be combined into a single actor definition. See Table 4-1 for a sample actor catalog.
6110_Ch04_FINAL
7/2/06
1:06 PM
Page 67
CHAPTER 4 ■ GATHERING REQUIREMENTS
Table 4-1. Sample FiCorp Actor Catalog
Actor Name
Actor Description
Characteristics
TeamSite Role
Research analyst
Creates and updates content specific to their market segment.
FiCorp has several research analysts. Each one is responsible for researching and analyzing market information and specific market segments.
Editor
Topic SME
Initiates a workflow request.
Reviews and approves content modifications. Performs topic-specific content review. Each topic SME represents one to many users.
Administrator
Legal researcher
Initiates a workflow request.
Reviews and approves content modifications. Performs legal content review. Each legal researcher represents one to many users.
Editor
Search index manager
Performs index creation used in query operations.
N/A
TBD
Search manager
Performs queries against indices. Responsible for returning results to the user.
N/A
TBD
Workflow engine
Manages various process flows in the CMS.
N/A
TBD
OD admin
Allows access to the OpenDeploy’s administrative functions.
N/A
OD admin
OD user
Allows access into OpenDeploy
N/A
OD user
Technical lead
Creates branches, workareas, and other content structures such as templates and workflows.
Each technical lead represents one to many users who are responsible for maintaining the CMS infrastructure components.
Master
As you can see from Table 4-1, the actor catalog contains four columns: Actor Name, Actor Description, Characteristics, and TeamSite Role. These columns contain the following information: Actor Name: The actor name will be used throughout your CMS design. The name should be as descriptive as possible and should be a familiar title or name for your particular business domain. Actor Description: This column should contain a brief description of the actor, including the actor’s sphere of responsibility in the CMS.
67
6110_Ch04_FINAL
68
7/2/06
1:06 PM
Page 68
CHAPTER 4 ■ GATHERING REQUIREMENTS
Characteristics: This column contains important details regarding the actor such as the number of users the actor represents and any other important actor characteristics you need to capture. Examples include the actor’s level of system knowledge, domain knowledge, and demographic knowledge, as well as the other applications this user knows how to use. TeamSite Role: This column will contain the anticipated TeamSite role. Interwoven technical advisors can greatly assist with this analysis. Let’s look at this actor catalog a little more closely. You should notice some familiar names in Table 4-1. The research analyst, topic SME, and legal researcher actors were mentioned in Chapter 2 when we defined the business process flows. For the purposes of the FiCorp case study, you would have determined (during the requirements workshop meetings) the values for the remaining columns that are associated with these actor names. You may not have all this information at this point in time, and it is not critical for you to have it; however, remember that you will need to update most documentation periodically throughout the project. You should make updates each time you make new discoveries and requirements or modify design-level details. When you uncover any new information, review your documentation to ensure that changes are reflected in the documentation. The best way to capture this information is in a spreadsheet. By using a spreadsheet, you can set up a data filter to view only the data you want to see. By having the actors defined and documented in this way, your project will be much better organized. These actor definitions will also feed into test cases that must be developed to ensure that your implementation has been a success. Some of these roles will probably already be defined at your organization; however, it is still worthwhile to document them. With these definitions, you will have a complete picture of all the roles and responsibilities in the CMS that you are implementing. The next and most time-consuming part of the process is to begin to identify and document the use cases for the CMS.
Defining the Use Case Catalog After gathering and defining actors, you must begin to derive potential use cases in which those actors will participate. The first use cases will be preliminary and will require multiple iterations to become stable. The best way to identify potential use cases is to ask what each actor requires of the system. Also, if the actor requires any additional functionality, then this may be a good candidate for a use case. Remember to keep your use cases modular so that they can be reused across multiple actors. For each actor, ask the following questions: • Will the actor need to create, read, update, delete, store, or upload content through/into the system? • What are the primary tasks that the actor will perform in the CMS? • Will the actor need to inform the system about any external events? • Will the actor need to be notified of any events occurring in the CMS? • Will the actor need to approve or deploy content inside the CMS?
6110_Ch04_FINAL
7/2/06
1:06 PM
Page 69
CHAPTER 4 ■ GATHERING REQUIREMENTS
IDENTIFYING TEAMSITE ROLES You should begin to identify the TeamSite roles that you will use for each actor you have documented. TeamSite up until version 6.7 contained four basic roles. Each role has specific access and optimized user interfaces. The four default roles are Author, Editor, Administrator, and Master. In version 6.7 of TeamSite, you can define user roles for your specific CMS implementation that have capabilities across the default TeamSite base roles. For example, you could define a corporate communications user with all the Author role default abilities that also owns a workarea. Workarea ownership is typically reserved for the Editor role, but in this example the corporate communications user could have responsibilities across those roles. Here are the roles broken down: • Authors are primary content contributors, and their access is usually restricted to a specific workarea in the CMS. This user is primarily responsible for updating and creating content and does not have to be a technical user. This user usually accesses the TeamSite system via the ContentCenter Standard or Casual Contributor interface. • Editors own workareas and typically assign content work to Authors. Editors can perform content updates, perform content creation tasks, and also create editions of content. Editors have all the abilities of Authors but also have access to advanced TeamSite functions. • Administrators own workareas. Administrators control functions at a branch level and can create new workareas for Editors and Authors. Administrators manage content creation projects performed in their branches. • Masters have the highest level of authority in TeamSite. Typically these users interact with the TeamSite system via the ContentCenter Professional interface. These users have permissions that supersede those of any other user. In fact, this user can perform functions across all branches and workareas. Masters have all the abilities that Administrators have and more. Do not worry if you do not understand all of this information at this point in the book. Chapter 14 will cover TeamSite user roles in more detail.
You get the idea. For each actor, put on that actor’s hat, and working with the SMEs and project stakeholders, validate all functionality that the specific actor will need access to in the CMS. The answers to the previous questions will become candidate use cases. Document all use cases discovered. Only by documenting the main success scenario or the basic flow of each use case will you be able to determine its relevance to the CMS. For every discovered and documented use case, record a description of the use case goal. As you are documenting the use cases, refer to the glossary document to ensure that you are using terms appropriately and you are adding any new terms to the glossary. The next step in the process is to begin to associate the newly discovered use cases with your actor list. We recommend that you create a use case catalog to track this association. See Table 4-2 for a sample use case catalog.
69
6110_Ch04_FINAL
70
7/2/06
1:06 PM
Page 70
CHAPTER 4 ■ GATHERING REQUIREMENTS
Table 4-2. Sample FiCorp Use Case Catalog
Use Case ID
Use Case Name
Associated Actor(s)
Description
UC1
Log In to CMS
Research analyst, topic SME, legal researcher
This use case describes the sequence of events for a login to the CMS. This allows the actors to gain access to the CMS and perform all their functions within the boundaries of this system.
UC2
Log Out of CMS
Research analyst, topic SME, legal researcher
This use case describes the sequence of events to log out of the CMS. This allows the actors to sign out from the CMS and close all open sessions and windows.
UC3
Create Content
Research analyst
This use case describes the sequence of events used to create content.
UC4
Spell Check Content
Research analyst
This use case describes the sequence of events used to check the spelling of content.
UC5
Choose Content Type
Research analyst
This use case describes the sequence of events used to select a content type, such as a header, footer, promotional text box, or any other type of CMS template.
UC6
Choose Presentation
Research analyst
This use case describes the sequence of events used to associate the selected content type to a presentation format.
UC7
Generate Content
Research analyst
This use case describes the sequence of events used to merge the content type data with the selected presentation.
As you can see from Table 4-2, the use case catalog contains four columns: Use Case ID: The Use Case ID column identifies the specific use case. This information is important if you are using some type of requirements management software such as IBM Rational RequisitePro. Generally, you should give the use cases an ID beginning with the two letters u and c for use case. Later, if you want to break your use cases into businesslevel use cases (use cases specific to the business user or role) or system-level use cases (use cases that are system specific and hidden from the business user), you can identify the use cases with a bluc or sluc identifier respectively, based on the type. Use Case Name: This column should contain the name of the use case as identified in your requirements workshop. This name should be unique across your CMS development effort. Associated Actor(s): This column contains any actors that you think will need to use this specific use case. Remember, if any actor shares the same use cases of another actor, then you should combine those actors into a single actor. In this example, you should notice that all of the human actors have to log in and log out of the CMS. The system actors are used within the system and therefore do not need to log in. Also note that the method and procedure of each actor’s login may differ significantly even though they each have to log
6110_Ch04_FINAL
7/2/06
1:06 PM
Page 71
CHAPTER 4 ■ GATHERING REQUIREMENTS
in to the system. These different methods of logging in to the system could be documented in a single use case document but as variant use cases or alternative flows. Description: This column should contain the goal and brief description for the identified use cases. Let’s take a deeper look at one of the use cases in this use case catalog. In this example, UC1 is the Log In to CMS use case. Notice that three human actors are associated with this use case. The reason for this is that each human actor who uses the CMS will have to log in before using it. Make certain that each use case has been agreed to by all project members. Once again we recommend you use a spreadsheet to document your use case catalog. This way you can filter the data to display only the information that is relevant at a given time. Additionally, you could insert other columns into your use case catalog that could list information such as the developer or development team the use case is assigned to or the iteration in which the use case will be developed.
Following Use Case Best Practices Here are some use case best practices: • Use cases should be written and named in “verb + noun” fashion. • Use cases should be as descriptive as possible. • Use cases must provide measurable value to the actor that initiates the use case or uses the use case. • Add all identified use case nouns to your project glossary, and validate their existence in the problem domain with project team members. • Use cases must have unique names.
Creating a Use Case Model Use cases define the outwardly visible aspects of a system and can be classified as a system use case or a business use case. Usually the business use cases can be further split into multiple system use cases. During the Inception phase, your goal is to identify the most architecturally significant use cases that you will later refine. You should define and create at least one use case model for each actor in the CMS. This use case model will visually depict all use cases associated with each actor. This will help you trace use cases that may be affected by changes in any other use case. In the use case document, you include a section to insert the use case model or models of the actor(s) involved in the specific use case document. The following are some industry-standard nomenclature for describing and documenting use cases. To allow you to become familiar with the terms, we have defined them for you. Uses: In a use case, the “uses” relationship signifies that the base use case utilizes another use case to accomplish the sequence of events. You will use the “uses” relationship to signify functionality that must be included for the base use case to achieve its goal. You will include the “uses” relationship for any functionality that will be reused significantly. Not every use case will lend itself to being in a “uses” relationship, but if this use case is called
71
6110_Ch04_FINAL
72
7/2/06
1:06 PM
Page 72
CHAPTER 4 ■ GATHERING REQUIREMENTS
more than once, a good rule of thumb is to put it in its own use case and use the “uses” relationship. An example of this is the save functionality of Microsoft Word, which would lend itself to the “uses” relationship. When modifying a Word document, you then save the document to retain your changes. The save would then be included via a “uses” relationship. In a use case diagram, the “uses” relationship is modeled as an arrow pointing toward the base use case with displayed above it. Additionally, the actual modification of the Word document would also be a use case. Extends: In a use case, the “extends” relationship signifies that this functionality will extend the base use case. We know this may sound confusing at first, but trust us, this will make sense as you work through the case study. The “extends” relationship is significant in that the extension point does not necessarily have to occur for the base use case to accomplish its goal. For example, consider the use case of creating a Word document. When the Word document is first created, you have to use the Save As function to actually finalize the creation of the Word document. The Save As functionality allows you to give the newly created file a name and choose a location for the new document to reside. Even if you have clicked the Save button, Word calls the Save As function because you have not given the Word document a name yet or a location. However, if you have given the Word document a name and then click the Save button, Microsoft Word saves your changes in the existing document. You could then classify the Save As function as an extension of the Save functionality. Of course, you can bypass this extension by initiating a Save As directly, if for example you wanted to create a new copy of the existing document under a new filename. Another example of the “extends” relationship would be if you were buying a snack from a vending machine. If you supply exact change for the price of the item, then the snack machine will dispense your chosen snack. However, if you supply a dollar bill for a 60-cent item, then the snack machine has to provide you with 40 cents of change. You could name this sequence the Provide Change use case. The Provide Change use case would be an extension to the base use case of Dispense Snack. In a use case diagram, the “extends” relationship is modeled as an arrow pointing toward the base use case with displayed above it. Actor: An actor is anything that interacts with your system. An actor can be a person or an external system. When defining actors, it is important to define roles and abstract the actual users from the use case view. You will find when defining actors that one person may fill several different roles in the system and therefore may be shown as two or more actors in the use case view. Alternatively, different people may fill the same role in the system and therefore will be represented by the same actor. In a use case diagram, an actor is identified as a stick figure with the actor name displayed underneath the stick figure. Use Case: A use case is a sequence of events that yields an observable value to an actor. The use case is an invaluable component of the total requirements for your system. One or more actors always initiate a use case. In a use case diagram, the use cases are identified as bubbles with the use case name displayed inside them. Association lines: An association line is a straight line that is drawn from the actor to the use case bubbles that the actor uses. In a use case diagram, the association lines are identified as straight lines connecting the actor with the use cases. See Figures 4-1 and 4-2 for sample use case models.
6110_Ch04_FINAL
7/2/06
1:06 PM
Page 73
CHAPTER 4 ■ GATHERING REQUIREMENTS
FiCorp CMS system Import Content
Request Content Approval Log In to CMS
ContentCenter Create Favorite
Attach Content «uses» Research Analyst
Delete Content Initiate Content Promotion
Delete Favorite Edit Content
Figure 4-1. Research analyst use case diagram1
FiCorp CMS system Associate Assets
«extends»
ContentCenter
Create Content
«uses»
Select Asset(s)
«uses» «extends»
Choose Content Type
«uses»
«extends» «uses» Choose Presentation
Generate Content Research Analyst
Spell Check Content
«extends» Save Content
Save As Content
Figure 4-2. Research analyst use case diagram2 In the sample use case model for the research analyst, notice that several, but not all, of the use cases are associated to the research analyst. In the real world, this model artifact would list all use cases associated to the research analyst actor. For the sake of brevity, we have left this use case incomplete while providing you with enough information to understand the method. When you discover new use cases, you would add them to this model to have a complete view of the use cases for the research analyst. Every use case bubble on the model represents a use case artifact or document that should contain the sequence of events for that use case. The following section details exactly what belongs in a use case document and how to construct one. By following this methodology, you can have a complete understanding of the CMS to be built.
73
6110_Ch04_FINAL
74
7/2/06
1:06 PM
Page 74
CHAPTER 4 ■ GATHERING REQUIREMENTS
Stay with us here while we walk you through the model shown in Figure 4-2. On the left side of the figure you can see what looks like a stickman with the words Research Analyst under it. This stickman represents the actor for this model. In a use case model, every actor, human or otherwise, is represented in the model by a stickman. The next thing you may notice is the large square that the actor sits outside. This square represents the boundaries of the CMS. Any use case that must be built into the system is represented as a use case bubble, and the actor must sit outside the system boundary because the actor will not be part of the CMS. Take a look at the Create Content use case. Several use cases are linked to this use case via either an or an . If you look at the use case named Spell Check Content, you will see that it extends the functionality of the Create Content use case. Why is this? Well, in FiCorp’s CMS, forms will be used to enter the data that becomes the actual content. There will probably be some type of structure on this form (a link or button) that initiates the spell check function for the recently entered content. However, the user does not have to initiate a spell check on their content, and therefore this use case extends the Create Content use case. The Spell Check Content use case would also extend the Edit Content use case or any use case that exposes this functionality. Now take a look at the Choose Content Type use case. The Create Content use case this use case because the flow of the Choose Content Type use case is always involved when using Interwoven TeamSite to create content. This makes a great deal of sense—basically, you have to know what you are making before you make it. Use case models give you a good view into all the ways each actor will use your system and are an invaluable analysis tool. This is especially true when designing a complex system such as a CMS. Many good books and references are available to assist you in developing use cases and use case models. One of the very best is Applying Use Cases: A Practical Guide, Second Edition (Addison-Wesley, 2001), by Geri Schneider and Jason P. Winters. We suggest that you find some good references, read them, and put them into practice. By doing that, you will greatly reduce your missed requirements, improve customer satisfaction, reduce software defects, and reduce your testing effort.
Understanding the Elements of a Use Case Document These are the elements of a use case document: Description: The description should be one to three sentences about the purpose of the use case. In most instances, the description will be one sentence in length, but more is always better (while not being excessive). If you can give the description to someone who is not on the project and they can understand what the use case accomplishes, then that is enough of a description. Level: The level of the use case signifies the visibility or detail of the use case. For example, if the use case details technical events, the level would be system, but if the use case details only user-level events or a business-level sequence, then the use case would be a business-level use case. If you have broken the proposed system into architectural layers, you could specify a use case at each architectural layer. For example, you might have repository-level use cases, web service–level use cases, or search-level use cases. Primary actor: This is the name of the actor that initiates the use case. Remember, this can be a human role or an external system. Other actors can be involved in the use case, but
6110_Ch04_FINAL
7/2/06
1:06 PM
Page 75
CHAPTER 4 ■ GATHERING REQUIREMENTS
this element will list only the primary actor involved. Multiple actors may be listed, but only if each actor can initiate the use case. Stakeholder: This element will list the associated stakeholder for the proposed system. Usually the stakeholder element will be replicated across several use cases. If you are detailing a system use case or architectural use case, then this element can contain the name of the architectural lead or development lead. Precondition(s): What must be in place, or what must have occurred for this use case to successfully complete? This element is important to establish the starting conditions for the use case. By thinking about this element and supplying the appropriate information, you can also find holes that were missed during previous system analysis. Success end condition: What is the outcome of this use case, and what conditions will be fulfilled when this use case ends? This element will provide that information. Keep in mind when writing this element, the element will supply the success criteria only for the basic flow of the use case. Alternative flows will not lead to the outcome specified by this element. Failure end condition: What will be the outcome of this use case if the basic flow of events is not completed successfully? The failure end condition will usually be the opposite action of the success end condition. Trigger: The trigger element will be the action, performed by the primary actor, that causes the basic flow of the use case to begin. For example, a trigger could be when the content contributor selects the CMS login link. Main success scenario: This is the basic flow of events for the use case. The main success scenario element will list (usually in a table) the flow of events for the use case. This flow of events is also referred to as the happy path or happy day scenario. This section of the use case document will contain all the steps needed in the sequence to achieve the success end condition. This flow of events should be discussed and documented in the use case workshops that you will be having. All steps should be numbered sequentially and should appear on their own line. It is important to keep only one step per line in this element; in that way, the alternative scenarios can branch from each discrete step. You may also find as you document use cases that some set of steps or functionality is repeated in several use cases. In this case, you should remove these repetitive steps from those use cases and put those steps in their own use case. The original use cases will then call the new use case. Alternative scenario(s): The alternative scenarios will list exception paths or alternative flows for the use case. For example, when documenting a login use case and the wrong password is supplied, then an alternative flow would list the sequence of events where the user is prompted to supply a valid password. All alternative scenarios will not be discovered during initial analysis, but keep in mind that the use cases written for your project will be constantly evolving as it progresses. Some alternative flows may be uncovered during initial use case workshops, but uncovering all alternative flows is not likely. Associations: Remember how we said that repeated sequences should be broken out into their own use case and then called from the original? Well, the Associations section will list any called use case, used use case, or extensions to this use case. In this way, you will
75
6110_Ch04_FINAL
76
7/2/06
1:06 PM
Page 76
CHAPTER 4 ■ GATHERING REQUIREMENTS
be able to maintain the use case traceability, and when a use case changes, you will have an easy way to remember all other associated use cases and can check those use cases for changes. Error condition(s): It is a good idea to maintain error conditions in your use case documents. By supplying anticipated error conditions in the use case, the use case implementer or engineer will know the types of errors that can be generated during the execution of the use case. You should document error conditions in a table with several columns. The recommended columns are the actual error condition such as Incorrect Password, the technical description or meaning that will probably be written to a log file, and a column for the displayed message (if any) that will be presented to the end user if the error occurs. This may seem like a great amount of documentation, but you may be surprised to see the number of previously uncovered requirements that will surface simply because use cases will make all project stakeholders think through the flow of events. You will find a sample use case document in the “Examining a Use Case Document” section.
VALIDATING ACTORS AND USE CASES If you uncover an actor during the use case and requirements workshop that is not documented in the actor catalog, be suspicious of it. Check that the actor is really part of your CMS or interacts directly with it. Sometimes when conducting the workshop, actors are uncovered that should not be a part of the system that you are creating. If the actor passes these tests, then add it to the actor catalog. Keep in mind, though, that the actor must have use cases associated with it; if none is found, then most likely the actor is already accounted for by a different actor. Additionally, if a use case is uncovered with no associated actors, then you should be suspicious of it as well. Most likely this means you have missed something. At least one of your actors should be associated to this use case in a use case diagram. If either of these conditions occurs, validate your use cases and your actor catalog immediately and discuss the situation with all team members. The goal of this discussion is to reach a consensus with what to do in this particular situation.
Examining a Use Case Document In the following sections, you’ll look at a sample use case document to further cement your understanding of use cases. Please refer to the “Understanding the Elements of a Use Case Document” section while reviewing the following use case. This will help you understand why we have constructed the use case document as we have.
Use Case Diagram This section contains the use case model or models referenced by the use case document.
6110_Ch04_FINAL
7/2/06
1:06 PM
Page 77
CHAPTER 4 ■ GATHERING REQUIREMENTS
Log In to CMS Use Case This section of the document describes the use case and identifies who uses the use case.
Description This description will be inserted directly from the use case catalog. This use case describes the sequence of events for a login to the CMS. This allows the actors to gain access to the CMS and perform all their functions within the boundaries of this system.
Level Business.
Primary Actor Research analyst, topic SME, legal researcher.
Stakeholder Kimberly McNeal, vice president of Corporate Communications, FiCorp.
Precondition The actors are valid users within the CMS. The actors have valid usernames and passwords.
Success End Condition Actors gain successful entry into the CMS and are allowed to perform all functions to which they have access.
Failure End Condition Actors are unable to gain access to the CMS.
Trigger Actors initiate the login action via a login screen.
Main Success Scenario The main success scenario is as follows: 1. The actor accesses the URL for the CMS login screen. 2. The actor supplies the following information on the login screen: • Username (system/company IT assigned) • Password (eight-character minimum, uppercase/lowercase, and numeric)
77
6110_Ch04_FINAL
78
7/2/06
1:06 PM
Page 78
CHAPTER 4 ■ GATHERING REQUIREMENTS
3. The actor initiates the login action. 4. The system verifies the actor’s credentials. 5. The system loads the ContentCenter Standard or ContentCenter Professional interface.
Alternative Scenarios The alternative scenario is as follows: 1. The actor-supplied password is incorrect. 2. The CMS informs the actor that their login is incorrect and prompts again the actor for log in. 3. The actor-supplied username is incorrect. 4. The CMS informs the actor that the username is not found and prompts again the actor for login.
Associations List any associated use cases here. The FiCorp use case is not complete but would probably contain use cases for the load of the ContentCenter Standard and ContentCenter Professional interfaces, depending on which interface each actor (research analyst, topic SME, or legal researcher) required.
Error Conditions This section contains any error conditions and specially defined error messages.
■Note Although the FiCorp use case document is not complete, it should show the structure and methodology to follow when developing use case documents.
Defining Non-Use-Case Functional Requirements We spoke earlier about the two types of requirements that will come from your requirements workshops; these include use case requirements and non-use-case requirements. We have described in detail the use case requirements, including how to capture them and how to structure the use case analysis. In this section, we will cover any other requirements that are not visible to a use case and how to categorize them. These requirements collectively form the supplementary requirements specification. The recommended categorization scheme for non-use-case requirements is the FURPS+ model. FURPS stands for Functional, Usability, Reliability, Performance, and Supportability and Scalability. The + stands for any other requirements not visible to a use case. The FURPS+ model was developed by Robert Grady and documented in his book Practical Software Metrics for Pro-
6110_Ch04_FINAL
7/2/06
1:06 PM
Page 79
CHAPTER 4 ■ GATHERING REQUIREMENTS
ject Management and Process Improvement (Prentice Hall, 1992). This model is extremely useful as a guide when deriving software requirements. This model also provides a way to categorize those non-use-case-centric requirements. The following describes the FURPS+ model: Functional: This requirements type can contain feature sets, capabilities, and securityrelated requirements that do not fall in the boundaries of a use case. For most applications, this category will contain the largest percentage of requirements in the supplementary requirements specification and should be written in a natural language style. Usability: This category takes into account aesthetics, consistency, human factors, documentation, user interface considerations, online context-sensitive help and self-service requirements, frequency/severity of failures, wizards and other selection/start-up requirements, recoverability, and last but certainly not least training materials. Reliability: This category is composed of requirements that deal with the frequency and severity of failure, including the mean time to failure and predictability of failure. This category also contains accuracy, efficiency, recoverability, and allowable defects. Performance: This category can sometimes share requirements with the reliability category, and in some circumstances a fine line exists between these two categories. The point is not to argue where a requirement belongs but rather that the requirement is documented somewhere in the supplementary requirements specification. Usually this category contains resource consumption requirements, throughput, average response times for user and system events, capacity (the number of concurrent users and events the system can or should support), recovery time, testability, adaptability, and availability. Supportability and scalability: This category encompasses configurability, extensibility, adaptability, maintainability, compatibility, serviceability, stability, and localization requirements. This requirement category is key and should be the section of the document where you put any languages that the system must support, including types of character encodings. Arrange your supplemental requirements under these categories and list them one by one. Review this requirements list with your stakeholders and other team members to receive sign-off. As you develop your system, make certain these requirements, and those captured in use cases, are included in your test plans. These requirements along with the use case requirements will lead to a complete understanding of all CMS requirements.
Conducting a Requirements Workshop We recommend that during the Inception phase of a CMS project that you conduct at least one requirements workshop and one to two use case workshops. A requirements workshop will help you gather further requirements from project stakeholders if they haven’t supplied any or clarify the requirements that project stakeholders have already supplied. Most supplied business requirements will be at a feature level if understandable, but most if not all of these business requirements will require clarification. The requirements workshop is the opportunity for you to meet, greet, and gain commitment from project stakeholders.
79
6110_Ch04_FINAL
80
7/2/06
1:06 PM
Page 80
CHAPTER 4 ■ GATHERING REQUIREMENTS
Think about this: the easiest way to get someone’s buy-in on a project is to include them in that project. When people are part of something, then they become emotionally tied to it and will fight to ensure its success. A qualified business or systems analyst who is experienced in meeting facilitation should run the requirements workshop. This person must be nonbiased and willing to give everyone in the room a chance to speak. We recommend the following guidelines be followed in a requirements workshop: • The workshop size should be limited to 8 to 12 people. This number should not include the one to two scribes whose function is to record only. • The workshop should have representation from the business staff and the technical staff or IT. • Everyone should be given the opportunity to speak. If grandstanding or filibusters occur, then speaking time for all participants should be limited to three minutes each. • The workshop should be an all-day workshop with a one-hour break for lunch and two 15-minute breaks. Have one break before lunch and one break after lunch. • If possible, after lunch, we recommend the facilitator decrease the temperature of the room by 5 degrees or more. This will ensure that no one gets sleepy. Soda and coffee should also be provided to meeting participants. • The facilitator must keep everyone and the meeting on track. Document all ideas from all meeting participants, and then later in the day rule out any impossibilities or out-ofscope requirements. The task objectives with your requirements gathering sessions (either the requirements workshop or a use case workshop) are as follows. We recommend that you complete these objectives in this order because this is the most logical and productive arrangement: 1. Define required features. This may be supplied by the stakeholders and should be documented in the vision document. 2. Define and elicit requirements via the requirements meetings. 3. Define and describe the actors during the use case workshops. 4. Define and describe the use cases. 5. Define the basic flow for all defined use cases. 6. Ensure that all features and business requirements trace to requirements defined in a supplementary requirements specification or a use case. If they do not, then something was probably missed and should be revisited. 7. Define alternative flows in the use cases if possible. Some other goals for the facilitator are to get everyone excited about attending the requirements workshop and to supply an agenda and any preparatory documents such as the vision document to all attendees. At the conclusion of the workshop, all notes from the scribes and the facilitator should be compiled and distributed to all meeting participants.
6110_Ch04_FINAL
7/2/06
1:06 PM
Page 81
CHAPTER 4 ■ GATHERING REQUIREMENTS
The requirements workshop should produce several types of requirements: Supplemental requirements: These are any requirements that are not visible to a use case. These requirements should be added to the supplemental requirements specification. Use case requirements: These are requirements that belong to a use case, and these requirements will be defined in the use case workshops.
Defining Workflow Requirements We have already discussed what a workflow is, but just to make sure that the concept is firmly cemented in your mind, we will go over it again. A workflow is a business process that is implemented in a CMS. This process comprises three subcomponents; these are roles that are the actors involved in the workflow, tasks that are the steps that the workflow performs, and subprocesses that are the flow of tasks performed by each actor. Also, from the earlier discussion, remember that the actor involved in the workflow can be a human or system actor. Workflow is an amazing thing, and a properly implemented workflow is a thing of beauty. With a workflow, you can control who gets notified and when, when content is deployed, what steps are followed, and what approvals are required—basically the entire content creation life cycle from start to finish. Now that we have reviewed what a workflow is, we can get to the exciting part—defining workflow requirements. Many methodologies exist for defining workflow requirements, but you can benefit from the past mistakes of others and do it right the first time! When defining workflow requirements, the first step is to see what the existing content creation process is. This does not mean you will duplicate it exactly with a CMS workflow; in fact, the opposite is true: you will be looking for ways to streamline and improve the process. However, you must understand what is done today in order to build the best solution of tomorrow. Remember in Chapter 2 how we outlined FiCorp’s existing publishing process? This will be your starting point. Using these processes as a guide, we recommend that you hold a workflow workshop. In the workflow workshop, you should have three separate whiteboards or other large drawing surfaces. On the first drawing surface, you should write the word create, on the second you should write approve, and on the third deploy. Working with the SMEs and project stakeholders, identify which steps in the process go in each drawing pane. For the create pane, ask the following questions: • Who initiates the workflow? Is this the same person each time? • Does workflow ever get automatically created, and if so, how? • Where does the content come from that gets attached to the workflow? Can content be imported? • Who creates the content? What steps do they perform? • How does content get attached to the workflow, and who does this? • Are notifications sent when content is created or imported? Where and to whom are these sent? • At which step in the content creation process does the workflow begin? What should this look like? • Are there any steps that should be performed in parallel with each other? What are those steps or tasks?
81
6110_Ch04_FINAL
82
7/2/06
1:06 PM
Page 82
CHAPTER 4 ■ GATHERING REQUIREMENTS
For the approve pane, ask the following questions: • Who approves content and at which point in the workflow does this happen? • What does this approval look like? • When approving content, the actor should also have the ability to reject content. Does the rejection follow a reverse approval route? If not, how are the rejections routed? • Are notifications sent out when content is approved? How about when content is rejected? To whom are these notifications sent? • Are there specialized approvals required for different content types? What are these? What does this process flow look like? For the deploy pane, ask the following questions: • Once final approval occurs, where is content published? • Is there any post-approval content processing that must occur (converting the text to PDF, for example)? What are these processing requirements? • Should the deployment process initiate any logging functions? This would include when content was deployed as well as the type and identity of the content. • To where should content be deployed? • What notifications are sent when content is deployed? To whom are these sent? • What external systems are notified when content is deployed? What should this notification look like? What format should the notification be in? Now you should begin to create these panes as sequences in a flowchart. Label each task in the flowchart. Use special flowchart symbols to differentiate between actors, tasks, and notifications. Look for ways to streamline any process that you add to the flowchart. We suggest you use a spreadsheet to really map out all the discrete flowchart steps. Using a flowchart, you can also identify what each step is. Some examples of this identification are an external task, a group assignment task, a user assignment task, or a timer task. Chapter 12 will include more information about identifying the task type. Repeat these steps for every workflow you will need in the CMS.
■Note The modus operandi for most teams when deciding notification details is to include too many! Keeping the communication channels open seems like a good idea; however, six months after the CMS is implemented, users will begin screaming that their inboxes are being flooded with email. What this means to those users is that they will stop responding to any CMS notifications. What that means to you is a redesign of workflows or that a request to disable workflow notifications will be coming in short order. Heed our advice; make certain you build only necessary notifications into the workflow. If a particular actor is listed too many times on the notify list, ask that actor about setting up a separate inbox just for their workflow notifications.
6110_Ch04_FINAL
7/2/06
1:06 PM
Page 83
CHAPTER 4 ■ GATHERING REQUIREMENTS
Defining Template Requirements When defining templating requirements, it is helpful to have composites of the finalized output files. To explain this in another way, if you have the final product to look at, then you can more easily define how to perform the data collection for that piece of content. You can then use these composites by deconstructing them into their content components. Within a CMS, you really have two components to worry about: the form or data capture template and the presentation template. You can use these composites to develop requirements for the data capture templates or forms, and you can plug the HTML in the composites directly into the presentation templates. If you are moving a live site into the CMS, then you can look at the HTML used in the current live site. If you are building a completely new site, you should still ask that the business owner or project stakeholder deliver some composites or wireframes of what the finished pages will look like. Once you have the composites or wireframes, you should begin to create content components from them. For example, if an image is displayed in the composite, you ask the following: • Can any other type of nontext asset be displayed in this area of the page? • Where is this asset retrieved from? • How does this asset get inserted into the generated content? If you determine that an image is the only asset that will be used in this area, then you should break the image into its component sections. These should include a Browse button to locate the image, whether it is from an external DAM system, from the local or network drive, or from within the CMS. You will also need alternate text for the image. This will require a field through which to accept this data. Is the image clickable? If so, you will need an input box on the data capture template for the target link. You must do this type of analysis for every component on the composite, including images and other digital assets, paragraphs, navigation, rich media files, links, and so on. Basically, if you see it in the composite, you will need to account for its existence in the data capture template or presentation template. We recommend you organize this information in a Word table. This table should have the following columns: Field Name: This column will contain the field label. If you have a corporate style guide, then this column should contain that element’s name. For example, you could use Title, Keyword, Header1, Header2, Header3, Ad Graphic, and so on. Required: This column will contain information alerting the data capture template implementer whether this field is required. If required, the user will be unable to save the form without populating this field. Replicant: This column will identify whether this field should be a replicant, which is a reusable container that is present on a TeamSite form. In object-oriented terms a replicant is an object that can be instantiated repeatedly, with each instance containing different data values. Additionally, if the field is identified as a replicant, then you should also determine the maximum number of allowable fields. Format: This column will identify whether the field will be text, a callout, inline, a dropdown list, or an image. Field Constraints: This column will contain any constraints associated to the field on the data capture template. Examples could include the number of characters allowed in the field, any special character limitations, whether the field uses the visual format editor, and the number of replicants. You should also include tab order in this field.
83
6110_Ch04_FINAL
84
7/2/06
1:06 PM
Page 84
CHAPTER 4 ■ GATHERING REQUIREMENTS
Field Description: This column will contain a description of the field and any other information that should be documented pertaining to this field, such as cross-field logic implemented via FormAPI. FormAPI (which is part of FormsPublisher) allows you to create data capture forms that respond dynamically to user-initiated events. In your supplemental requirements specification document, you should list the data capture template breakdown and its associated presentation. The presentation will come directly from the composites or mock-ups that were provided to you. On the presentations you should draw callouts that identify which field is being referenced by the field name. This will allow implementers to more easily build these components. If the data capture template has external dependencies, then you should also list them in the table. Keep in mind when gathering templating requirements that you should ask whether specialized metadata fields must be captured on a template-by-template basis. Additionally, you may have requirements to capture global metadata, so look out for this as well. Some examples of global metadata are the keywords, the copyright, and the publish date. Another gotcha to watch out for are fields used by web reporting tools such as Web Side Story or Web Analytics. These tools usually require a specialized tag that records when and how the page was accessed. You want to build a construct for these in the template in case you switch web reporting vendors or the reporting applications require a modification in their tags. By following the advice in this chapter, you will have a methodology for gathering templating requirements. Interwoven’s technical advisors are skilled in this area and can assist you greatly in gathering templating requirements.
Defining External Program Requirements External program requirements in the context of a CMS can take many forms. You must consider external callouts at the template level, external tasks at the workflow level, and external systems that the CMS must communicate with. Keeping all these external programs straight can be a daunting task. The best way to document these types of requirements is to identify which actors are external to the CMS. Once you have identified these actors, identify who is responsible for these external actors. Is your team responsible for them or someone else’s team? Is an external vendor responsible for these actors? Once you decide who is responsible, the next step is to determine what information is needed from the CMS for this program to function properly. In IT there is a time-tested concept for creating a program. That concept is input, process, and output. Although you shouldn’t necessarily be concerned with the process part of an external program (unless your team is responsible for it), you definitely must be concerned with the input and output components. Ask the person or party responsible for the external program what information the program requires. Find out what protocol is used for communication and in what formats the input can be accepted. We recommend always using XML and web services, if possible. Document all information relating to every external program including its interface, its protocol, any return codes, and the team or contacts that support this program. If your team is not responsible for this program, then you must develop an understanding or SLA with this external team. You should establish a communication procedure so that if the interface needs to change, your team is notified about the updates prior to them actually changing it. With the output, many of these same factors apply. You must communicate to these external parties
6110_Ch04_FINAL
7/2/06
1:06 PM
Page 85
CHAPTER 4 ■ GATHERING REQUIREMENTS
what type of output is needed by CMS. We cannot give you specific instructions in this area, but if you are diligent in documenting these requirements, then your interface will be successful. Just remember to input, process, output, and test everything!
Mapping the Selected Vendor’s Product Offerings to CMS Requirements Once you have gathered the requirements, the next step is to map these to a vendor’s products. There is no better ECMS to use for your solution than Interwoven TeamSite and its enterprise content management capabilities. Interwoven technical services are invaluable during this process. Once your listing of requirements is complete, you should go through a mapping exercise to discover whether your chosen CMS vendor can meet all your requirements. You may have even received proposals from several CMS vendors and now must decide which to use. This is a difficult task, and your future with your company could depend on you making the right decision. See Table 4-3 for a way to create a mapping of your requirements to a given vendor’s features. Table 4-3. Requirements Matrix to Vendor’s Offerings
Feature/Requirement
Description
TeamSite 6.7
Feature, Configuration, or Customization
Versions of the content must be maintained.
Supports versioning with number of versions of the files to be kept can be configured. History of all modifications are maintained by the content store.
✔
Feature
All content on the site must be able to be reproduced for historical purposes.
TeamSite supports editions, which are snapshots of the current staging environment at any given point in time.
✔
Feature
Simple-to-use GUI interface.
It has a well-defined GUI.
✔
Feature
File-level access control.
Permissions on files created through the file system interface are determined by file system interface configuration.
✔
Feature
Maintain multiple content areas.
Branches and sub-branches (for different projects or initiatives) that contain individual workareas, staging areas, and editions, which allows for massively parallel development on a single platform.
✔
Feature
Check-in and checkout
TeamSite supports three types of file locking: submit locking, optional write locking, and mandatory write locking.
✔
Feature
Customizable GUI
Menu items can be enabled or disabled as per user role.
✔
Feature
85
6110_Ch04_FINAL
86
7/2/06
1:06 PM
Page 86
CHAPTER 4 ■ GATHERING REQUIREMENTS
This table contains several columns of information; the first column contains the text of your defined feature or requirement. You would get this information from your supplemental requirements specification. The Description column should contain the description of the requirement (if needed) and the way that problem is solved by the technology located in the next column. The third column is where you list the vendor technology. A check mark indicates that the feature or requirement is supported. However, it does not indicate the degree to which it is supported. The next column, Feature, Configuration, or Customization, should identify whether the feature or requirement is an out-of-the-box feature of the given vendor’s product or a configuration or customization of that product. The final column allows you to set a level of difficulty for the customization or configuration of that product to match the documented requirement or feature. You should create a matching sheet for each product evaluation and choose the one that most closely fits your requirements and matches your budgetary constraints.
Summary When documenting CMS requirements, it is important to document everything. This seems like a lot of documentation, doesn’t it? Well, you are correct—it is a lot of documentation, but the added value for doing this documentation is immeasurable. You can use this documentation later if you go through a prioritization effort with the stakeholders. You will do this if you do not have enough implementation time, resources, or budget left to get the complete listing of requirements in the system. You can then group these postponed requirements into a second- or third-phase rollout for later implementation. Make sure you read and understand everything in this chapter, and when you understand it, read it again! Gathering/documenting accurate requirements is the most important part of any development effort. We are not saying that you won’t have any snags along the way, but this chapter will help you navigate these turbulent requirements waters.
6110_Ch05_FINAL
7/2/06
1:07 PM
PART
Page 87
3
■■■
The Elaboration Phase In the Rational Unified Process (RUP), the Elaboration phase is where the majority of difficult engineering work takes place. At the end of this phase, you must decide whether the company should invest more money and expense to continue to the Construction phase. During this phase, you should develop a prototype of the architecture and demo it for project stakeholders. This prototype allows the project team to really lock down the remaining project phases in terms of schedule and duration. This phase involves a deep and exhaustive analysis into the core use cases of the system. Documentation evolves according to lessons learned from the prototype, and you’ll further refine the functional requirements. The Elaboration phase may encompass one to many iteration cycles; with each completed iteration, you derive more detail, and you develop further understanding. The chapters in this part will not give you a complete view of the Elaboration phase, but they will show you many of the activities related to this phase. The Elaboration phase of the project should be one month to two months long for most projects and should accomplish the following goals: Create a validated architecture that is feasible for the organization: This will prove that the proposed architecture is possible to implement. This goal will also provide a means to acquire additional funding and project resources, if needed. Create a detailed work plan project schedule for the Construction phase: At the least, you should create a detailed plan for the first iteration within the Construction phase; ideally, you will create a plan with all the remaining iterations defined. This will be derived from the amount of work that has been done already. By considering the time involved during prototype development, you should more easily be able to calculate
6110_Ch05_FINAL
7/2/06
1:07 PM
Page 88
the time remaining to finish the development. You will not only use any prototypes you have as a calculation factor, but you will also learn from the previous development efforts and project team member experience. Elaborate on the architecture, software, infrastructure, and use case requirements: Have a target goal of completing 80 percent of the use case requirements and the functional requirements (maintained in the supplementary requirements specification). This will produce high-fidelity use cases for the remaining iterations and a more complete supplementary requirements specification. This collection of artifacts should also receive sign-off from all impacted stakeholders. Create a revised risk list and risk assessment document: You will need to document the new risks that you have uncovered up to this point in the process, as well as the anticipated risks. At the conclusion of this phase, you and the project stakeholders will determine whether to move forward to the other phases or to scrap the existing work and look for an alternative method to solve the business problem.
6110_Ch05_FINAL
7/2/06
1:07 PM
CHAPTER
Page 89
5
■■■
Building the Hardware Infrastructure O
nce you have decided on the products you will be using, it is time to start looking at how your infrastructure is going to change. This is a time-consuming task and one that is difficult to get through without getting behind schedule. Most corporations have a lengthy process for buying hardware, and hardware is expensive. Therefore, you should account for this process in your business plan. We won’t tell you there is only one way to build your hardware. What we want to accomplish in this chapter is to make you aware of some of the steps you can take to make your implementation much more effective. Upon completing this chapter, you should be able to strike up a two-way conversation with the people who are responsible for making hardware decisions. If you are that person, then some of the topics in this chapter may be apparent to you, but you should get some insight into some of the questions the development team faces.
Understanding How Release Cycles Affect Hardware Layout Content management is an ongoing process that never stops. It must be planned well, budgeted annually, and updated often to be successful. When you introduce a CMS into a company, you must follow many steps to ensure that the rollout is successful. Many times people put a great deal of planning into how the system will work but little time into how the application will be updated. You should create some plan as to how software updates are released. Certain parts of the application are vital to the operation of the system, and you do not want developers “futzing” with them while your CMS users are working. Certain changes affect major components of the system that will need to be tested before going live. You should handle these changes in the same way you handle any other application with a release cycle. This means you will need more than one TeamSite environment to enable software releases to be promoted in a progressive process, such as from development to test to production.
89
6110_Ch05_FINAL
90
7/2/06
1:07 PM
Page 90
CHAPTER 5 ■ BUILDING THE HARDWARE INFRASTRUCTURE
■Note You will handle the content changes and the code changes differently. The changes made to content should be made, approved, and deployed from the authoring environment. Content changes do not have to go through the normal code promotion process.
Setting Up the Content Authoring Environment In this section, we’ll show how an authoring environment that is set up properly will make your life so much easier. Determining your hardware configuration is the first step in setting up your software environment (see Figure 5-1).
Preview
App/WWW Development
App/WWW Preview
CMS Authoring
App/WWW Testing
App/WWW Production
Figure 5-1. The interaction between the CMS authoring environment and the different application environments As you can see, Figure 5-1 demonstrates that an authoring environment must support four application environments: production, preview, development, and testing. The following sections discuss these environments, as well as other benefits of building your environments in this manner.
Production We always hear chuckles from application team members when we tell them the CMS team will be updating the content directly in production. You cannot directly update “production” servers. That is why the TeamSite’s production environment is called the authoring environment. You need to be able to update content in a production-like environment to keep system teams from restarting their servers anytime they think it is necessary. When you call them on it, they will say your box is not a production machine. The authoring environment is your TeamSite working environment; content will be updated directly on this server. Your content authors are depending upon this server to be available during business hours, so you should not allow developers to change your CMS application directly on this server. It seems that every team that implements TeamSite seems to want to change application components directly in the content authoring environment. It is important that your application development follows the same procedure for updating code
6110_Ch05_FINAL
7/2/06
1:07 PM
Page 91
CHAPTER 5 ■ BUILDING THE HARDWARE INFRASTRUCTURE
that other applications do. This is why it is also important to distinguish between what you consider CMS code and what you consider content. Yes, TeamSite is a tool, but you will have a custom application that grows up around it, and those changes need to have their own development environment. The correct mandate to the system team is that content changes will be made directly in the authoring environment, but code will need to be promoted.
Preview Now that we are done preaching, take a closer look at Figure 5-1. You’ll see an environment named preview. The preview environment should match the production TeamSite server as closely as possible to allow your changes to be viewed in a production-like environment before they are deployed to production. The content that needs to be previewed here is content that has not been deployed to the development or testing environment. You could be updating content for a system that cannot be mimicked within these other environments. This is a good idea: you will find ways to use this environment and will be grateful that you took the time to set it up in advance.
■Note Something to keep in your mind while you are reading about your environments is that not every environment needs to be running a top-of-the-line system. Some of these servers can be older machines, which will allow you to see your content in a live state instead of just a virtual state. You will discover many more errors if you can look at the content before going live.
Application Development Environment Application teams are constantly put in the situation of making adjustments to their code to accommodate something that has been discovered at the last moment. This last moment usually takes place when all the work that different teams have developed is integrated. Integration can require much less effort if the content team can make immediate updates as the business owners change their minds or discover content that they overlooked in the original design. You can’t ensure that everything will be correct after the first draft of the requirements. These last-minute changes are common, but unfortunately the changes in the content often do not reach the application team until the eleventh hour. The application should have all the latest changes and be tested with as close to production-like content as possible. This should be the case in each application environment. A lot of companies fail to achieve integration between their content and the application because they cut off the connection between the authoring environment and the applications’ development environments. Once your corporation starts forcing their application teams to start using the CMS to update their application content, the content teams will not have to zip the content manually and move it out to each application environment.
Testing/User Acceptance User acceptance is often one of the largest hurdles for the CMS. Building your authoring environment in this way will speed along user acceptance. A CMS is often thought of as a system that isn’t connected properly. Instead of reducing the workload and reducing your delivery time from concept to production, the content can become even slower to market, with the
91
6110_Ch05_FINAL
92
7/2/06
1:07 PM
Page 92
CHAPTER 5 ■ BUILDING THE HARDWARE INFRASTRUCTURE
CMS team as the new bottleneck. The reason for this is once the first version of the system is rolled out, everyone thinks they can now leverage the system like any other system. The problem with this approach is that most corporations decide to start small with their initial release. This means the system has been set up for a simple scenario, and not much thought has been put into what is going to make this system successful over time. With a good percentage of applications, a corporation can be successful by building out as they need extra bandwidth because they can just add a server when necessary. If this is your philosophy, you need to also think of the best possible state to be in. You should ask questions such as, what are my more sophisticated needs, and what are problematic areas that could be fixed by the CMS? It pays to know some of these answers in advance because, just like any other initiative, you need to know where you are going, especially if you build the additional connections as Figure 5-1 describes.
Customizing TeamSite Application Development and Configuration The other goal of your new CMS is enhancing the user experience. You will achieve this by customizing TeamSite to your industry and automating tasks that can be completed without human intervention. Just because you are working with a system that handles content, TeamSite itself is an application; therefore, you should handle it in the same way as other applications. The deployment should have at least three basic tiers, as shown in Figure 5-2.
Testing CMS
App/WWW Integration
Development CMS
App/WWW Integration
These servers are for the TeamSite development team’s use only. Both of these instances could reside on the same machine if necessary.
The lab is a good place to play around in. You can install new patches, and try out crazy ideas without stopping development.
Lab CMS
Figure 5-2. A three-tier deployment environment Figure 5-2 demonstrates how you should set up the testing and development environments to ensure proper testing and development. The figure does not depict the authoring environment or production environment, but we have added a “lab box” because this is helpful for experimentation. The lab box is normally isolated from your other systems, which allows you to install patches and perform tests that may bring down the server. The lab box should not cause anyone a second thought if it needs to be rebuilt.
6110_Ch05_FINAL
7/2/06
1:07 PM
Page 93
CHAPTER 5 ■ BUILDING THE HARDWARE INFRASTRUCTURE
Typically, the testing environment mimics the production servers’ size and strength, but if you do not plan on performing stress tests, you don’t need to spend all of that money. We do not want to beat you over the head with information that most development teams already know, but it is important to treat this as a true application development environment for your CMS infrastructure code changes. We have often found implementations of TeamSite where it is possible to test the workflows that have been developed only in production. When you are adding new workflows, this is not a problem because no one is using them; however, when updates need to be tested, it is not a good idea to wait until production to test them. Large corporations with international teams have content authors using the system 24 hours a day, so any outage is not acceptable.
Coordinating Small and Large Development Efforts The three-tier layout will allow you to be testing one release, to be developing one release, and to have one release ready to be deployed to production. Realistically, you would maintain only two releases at any given time using the three-tier layout. We are not saying that three can’t be handled effectively, but it requires a well-organized team and a team that communicates effectively. If your corporation decides to set up your environment this way, make sure you employ an effective code-versioning system. Since most implementations have only one development server for their TeamSite initiatives, a common problem is overwriting one another’s changes. A great way to solve this problem is to use TeamSite to help manage your development efforts in conjunction with your current source control tool, as shown in Figure 5-3.
CMS Deployments CMS Authoring
CMS Testing
Source Control
CMS Development
Figure 5-3. Versioning system and TeamSite In Figure 5-3 you can see that the source control services are augmented by using the TeamSite server. This connection between TeamSite and the source control server does not have to be an automated process, but Interwoven has integration points if you are interested in automating this process. Using TeamSite to perform your deployments enables you to utilize the full power of the workflow engine and to add intelligence to your deployments.
93
6110_Ch05_FINAL
94
7/2/06
1:07 PM
Page 94
CHAPTER 5 ■ BUILDING THE HARDWARE INFRASTRUCTURE
An additional benefit to this system is you can time slice the testing and development environments by deploying a version of the entire site. Time slicing your environment means breaking your testing or development server time into blocks. For instance, you could deploy the entire site for a defect in the morning and redeploy it for a different team for user acceptance testing in the afternoon. This system as described could easily handle an emergency fix; you could test it simply by putting your current testing on hold and deploying the production release to the testing environment. You could then move the newly fixed code to the testing environment and perform any necessary testing before promoting this change to production. This process does not eliminate the need to merge the new fix into any existing development efforts but does allow for testing the fix with code that is in production before it goes live.
Choosing a Platform Your choice of platform will have a direct effect on the hardware you purchase. You have three platform options for your TeamSite implementation: Windows, Unix, and Linux. The hardware infrastructure team will probably choose the platform, but if it has not been decided, then we recommend discussing these three platforms with Interwoven Technical Services to help you identify possible roadblocks for each platform given your current environment. It may be easy to say that Linux will be much cheaper, but you must take into account such issues as having the proper internal resources to handle such a platform. You may not have the expertise to manage a Linux environment in-house, or you may have to buy all new servers to support Linux. In any case, you are not limited to only one platform.
Selecting FiCorp’s Products In this section, you’ll look at the software choices FiCorp has decided to purchase. Search comes with TeamSite, but it has its own requirements. The following list of products will be the focus of the rest of the book, but we will still talk about others where necessary: • TeamSite 6.5 • TeamSite Search • OpenDeploy • DataDeploy • MetaTagger The following sections will review these products and cover how they will look after they are installed. FiCorp will need some new servers, but some of the software will find its way to existing servers. We will cover some of the hardware requirements and ports required for each of the servers. Basically, no right way works for every enterprise. Ten companies in the same industry could choose the same software and have the same requirements but choose to build different systems. Each system will function well for its users, but with that being said, there are some ideal ways to handle things.
6110_Ch05_FINAL
7/2/06
1:07 PM
Page 95
CHAPTER 5 ■ BUILDING THE HARDWARE INFRASTRUCTURE
■Note When setting up your hardware, take in account your growth rate. At first the user acceptance will be low, but as you gain momentum, people will be flooding in to use the system. Make sure you do not make a bad name for yourself by not being able to keep up with the demand. Also, remember to take into account backing up the content store and separating backing stores into multiple stores in order to allow content to be frozen region by region while being backed up.
TeamSite 6.5 and Interwoven Search In contrast with some software packages we have used, the performance of TeamSite over the years has greatly improved. Also, as Java has matured, the TeamSite application has benefited greatly. When determining the sizing of your TeamSite server, you must take into account that TeamSite sits at the center of your CMS services. The server that houses the TeamSite application will need plenty of room for growth. This section will show three tables to determine how to set up FiCorp’s hardware. Table 5-1 shows some of the server configuration recommendations from Interwoven (source: Interwoven TeamSite Installation Guide Unix, Release 6.5). This table has been designed to meet the needs of the TeamSite application only; if you want to install search on the same server, you need to refer to Table 5-3. Table 5-1. System Usage for TeamSite 6.5 Stand-Alone Server
Heavy*
Moderate**
Light***
15 concurrent users
2 CPUs
2 CPUs
1 CPU
100 total licensed users
4GB RAM
2GB RAM
2GB RAM
50 concurrent users
4 CPUs
2 CPUs
2 CPUs
300 total licensed users
4GB RAM
4GB RAM
2GB RAM
150 concurrent users
4 CPUs
4 CPUs
2 CPUs
1000 total licensed users
8GB RAM
8GB RAM
4GB RAM
300 concurrent users
8 CPUs
8 CPUs
4 CPUs
3000 total licensed users
16GB RAM
12GB RAM
8GB RAM
2GB total content
5GB total content
15GB total content
50GB total content *
Numerous Get Latest, Submit, Publish, or Compare operations; ongoing website or directory navigation; frequent data record generation; frequent development of workflows, presentation templates, and other file editing
**
Occasional Get Latest, Submit, Publish, or Compare operations; ongoing website or directory navigation; occasional data record generation or file editing; few development activities
*** Infrequent Get Latest, Submit, Publish, or Compare operations; occasional website or directory navigation; occasional data record generation or file editing; no development activities
95
6110_Ch05_FINAL
96
7/2/06
1:07 PM
Page 96
CHAPTER 5 ■ BUILDING THE HARDWARE INFRASTRUCTURE
■Note The tables in this chapter should not be used for your final sizing of your servers. These tables, although taken from Interwoven’s documentation, may not be up-to-date. Please refer to the Interwoven documentation for this purpose.
It is easy to see that TeamSite will require a good-sized machine to fulfill a corporation’s needs. When looking into which server chassis to purchase, we recommend buying the largest you can afford. You may not need to fill up the processors and memory, but expansion is inevitable. Now take a look at Table 5-2, which shows you how search performs when installed on a server by itself. This is the base performance given the data type that is being queried (source: Interwoven TeamSite Installation Guide Unix, Release 6.5). Table 5-2. Interwoven’s Search Performance on a Server by Itself Based on Content Type
Documents
Data Records
Extended Attributes
Response time
Less than 5 sec
Less than 3 sec
Less than 5 sec
Less than 3 sec
Less than 5 sec
Less than 3 sec
100 queries per hour
N/A 1GB RAM
1 CPU,
N/A
1 CPU, 1GB RAM
N/A
1 CPU, 1GB RAM
1000 queries per hour
N/A
1 CPU, 1GB RAM
1 CPU, 1GB RAM
2 CPUs, 4GB RAM
1 CPU, 2GB RAM
2 CPUs, 4GB RAM
2000 queries per hour
1 CPU, 2GB RAM
2 CPUs, 4GB RAM
2 CPUs, 4GB RAM
N/A
2 CPUs, 4GB RAM
N/A
As the number of queries grows, search can become rather CPU intensive. Therefore, FiCorp will be using a separate search server; besides, Interwoven suggests that separating these servers is the best solution. We will, however, still show server recommendations for installing search with TeamSite, because you may not be in an environment that allows the sharing of file systems across servers. Table 5-3 shows what search and TeamSite on the same box can do (source: Interwoven TeamSite Installation Guide Unix, Release 6.5). Table 5-3. System Usage for TeamSite 6.5 and Combined Search
Heavy*
Moderate**
Light***
15 concurrent users
4 CPUs
2 CPUs
2 CPU
100 total licensed users
4GB RAM
4GB RAM
2GB RAM
50 concurrent users
4 CPUs
4 CPUs
2 CPUs
300 total licensed users
8GB RAM
4GB RAM
4GB RAM
150 concurrent users
Contact
8 CPUs
4 CPUs
1000 total licensed users
Interwoven
8GB RAM
4GB RAM
2GB total content
5GB total content
15GB total content
6110_Ch05_FINAL
7/2/06
1:07 PM
Page 97
CHAPTER 5 ■ BUILDING THE HARDWARE INFRASTRUCTURE
Heavy*
Moderate**
Light***
300 concurrent users
Contact
Contact
8 CPUs
3000 total licensed users
Interwoven
Interwoven
8GB RAM
50GB total content *
Numerous Get Latest, Submit, Publish, or Compare operations; ongoing website or directory navigation; frequent data record generation; frequent development of workflows, presentation templates, and other file editing
**
Occasional Get Latest, Submit, Publish, or Compare operations; ongoing website or directory navigation; occasional data record generation or file editing; few development activities
***
Infrequent Get Latest, Submit, Publish, or Compare operations; occasional website or directory navigation; occasional data record generation or file editing; no development activities
The problem we have seen with putting both search and TeamSite on the same box is that this does not leave much room for growth on your server. FiCorp claims if it can implement a usable CMS, you will have a high user acceptance rate; therefore, you do not want to limit its growth potential from the start.
OpenDeploy and DataDeploy Before really getting down to what hardware FiCorp will need, we’ll present a high-level diagram of how the network will be laid out. As you can see in Figure 5-4, FiCorp has an additional hop between the TeamSite server and the target server.
Web Server Not Allowed
Zone C
Gateway Zone B
Zone A
TeamSite
Figure 5-4. OpenDeploy will need a gateway machine to get through the firewall between Zone A and Zone B.
97
6110_Ch05_FINAL
98
7/2/06
1:07 PM
Page 98
CHAPTER 5 ■ BUILDING THE HARDWARE INFRASTRUCTURE
The gateway server allows Zone A and Zone B to communicate with each other. FiCorp will be installing an OpenDeploy base server on the TeamSite box, but you will also need a base server on the gateway server. The gateway server will act as a relay server. The Zone C servers will be sharing an OpenDeploy receiver server. This means one server in Zone C will utilize shared file systems to move files between servers. Zone B already contains several servers, so FiCorp will be using an existing server as the OpenDeploy gateway. Through Zone B you can reach much more of FiCorp’s networks. Note that for each server you put into production, you have to put in one at your disaster recovery center. Sizing an OpenDeploy server is made easier by using Table 5-4, which is the minimal sizing chart from the OpenDeploy release notes (source: Interwoven OpenDeploy Release Guide, Release 6.0.2). Table 5-4. OpenDeploy Sizing Chart
Operating System
CPU Power
Windows 2000 Server (Service Pack 2 or later)
600MHz Intel or compatible (32-bit)
Windows 2003 Server
600MHz Intel or compatible (32-bit)
Solaris 2.8 (Solaris 8), 2.9 (Solaris 9) (32-bit and 64-bit)
400MHz SPARC (32-bit and 64-bit) and 375MHz PowerPC
AIX 5.1, 5.2
IBM RS/6000
Red Hat Linux 8.0, 9.0
400MHz Intel or compatible (32-bit)
Red Hat Enterprise Linux 2.1, 3.0
400MHz Intel or compatible (32-bit)
SuSE Linux 8.1
400MHz Intel or compatible (32-bit)
SuSE Enterprise Linux 8.1
400MHz Intel or compatible (32-bit)
HP-UX 11i (32-bit and 64-bit)
300MHz PA-RISC
Remember, these figures are for the bare minimum. If you have other services running on the machine or have a high number of deployments, you will not want to limit yourself to the bare minimum. Do not forget to perform some projections for the next five years to help you determine your true needs. As you can see from Table 5-4, you have several operating system choices.
■Note You should discuss your sizing requirements with Interwoven Technical Services. You should also discuss some content-processing topics, such as the number of transactions expected per peak hour and the size of your deployments.
6110_Ch05_FINAL
7/2/06
1:07 PM
Page 99
CHAPTER 5 ■ BUILDING THE HARDWARE INFRASTRUCTURE
MetaTagger MetaTagger has several features, although you may not be able to use all the features immediately. FiCorp will be installing MetaTagger on a separate server from TeamSite inside the authoring environment. This may change as FiCorp better understands all that MetaTagger can provide. MetaTagger will not increase the size of the box needed but can be broken up onto separate servers as the need arises.
Looking at the New FiCorp Network A new picture should be starting to form of what the new FiCorp network will look like. FiCorp has a new TeamSite server, a new OpenDeploy server, a new search server, and a new MetaTagger server. Figure 5-5 shows the new authoring environment. Gateway Segment
Mail Server TeamSite
OpenDeploy/ DataDeploy
Search Server
Content/Application Integration MetaTagger Oracle
Authoring Environment
Figure 5-5. The network communication that is necessary You will now take a closer look at each of these servers and how they integrate with each other at this point. Once FiCorp has these servers integrated, it will have a top-notch authoring environment.
99
6110_Ch05_FINAL
100
7/2/06
1:07 PM
Page 100
CHAPTER 5 ■ BUILDING THE HARDWARE INFRASTRUCTURE
TeamSite The TeamSite server will be busy, as you can see looking at Figure 5-6. Eleven separate services are listening for the TeamSite server. This is one of the reasons some of the other services are on separate servers. When the entire TeamSite server is up and running with the addition of the OpenDeploy services, the server has its hands full. We are concerned with the ability to scale the application, so we have kept this in mind as we have determined this configuration. This hardware configuration will allow for this.
8081
8080
80
OD Admin
Servletd
HTTP
3035
443 JNDI TeamSite
3030 OpenJMS
HTTP
1099 OpenAPI
20014
9173
81
Event Subsystem
Proxy
NFS Search