Lotus notes developers toolbox tips for rapid and successful deployment

developerWorks® Series Lotus® Notes® Developer's Toolbox: Tips for Rapid and Successful Deployment By Mark Elliott Publisher: IBM Press Pub Date: October 10, 2006 Print ISBN-10: 0-13-221448-2 Print ISBN-13: 978-0-13-221448-3 Pages: 744 Table of Contents | Index Lotus®Notes® Developer's Toolbox will help you streamline and improve every phase of Notes development Leading IBM Lotus Notes developer Mark Elliott systematically identifies solutions for the key challenges Notes developers face, offering powerful advice drawn from his extensive enterprise experience This book presents best practices and step-by-step case studies for building the five most common types of Notes applications: collaboration, calendar, workflow, reference library, and Web site This book is for Notes developers at all levels of experience, using recent versions from V5.0 through V7.0, and beyond Like all IBM developerWorks® Series books, it is fully integrated with comprehensive Web resources, including working examples of each project, enhanced versions that go beyond the book, sample graphics, and tools for addressing real-world business scenarios Coverage includes · Getting started with Domino Designer®, and using the design elements it provides · Developing Notes databases, step-by-step: considerations, code instructions, design tips, and project plans · Mastering and customizing Lotus Formula and LotusScript · Customizing forms, views, agent behavior, application interfaces, and more · Building calendar applications with simple and complex recurrent events · Developing applications that distribute information via email, response documents, and other methods · Creating reference library applications, and generating Excel® spreadsheets for analysis · Constructing sophisticated workflow and Web-based Notes applications · Securing, deploying, and maintaining Notes applications, and managing their data · Enhancing database functionality: more than 95 ready-to-use code modules and customizations · Exclusive Web resources available only to book registrants The IBM Press developerWorks® Series is a unique undertaking in which print books and the Web are mutually supportive The publications in this series are complemented by resources on the developerWorks Web site on ibm.com Icons throughout the book alert the reader to these valuable resources developerWorks® Series Lotus® Notes® Developer's Toolbox: Tips for Rapid and Successful Deployment By Mark Elliott Publisher: IBM Press Pub Date: October 10, 2006 Print ISBN-10: 0-13-221448-2 Print ISBN-13: 978-0-13-221448-3 Pages: 744 Table of Contents | Index Copyright IBM Press: The developerWorks® Series IBM Press Preface Acknowledgments About the Author Chapter 1 An Introduction to the Lotus Domino Tool Suite Product Overview Links to developerWorks Chapter 2 Getting Started with Designer Installing the Designer Client Launching the Designer Client Creating My First Notes Database Links to developerWorks Chapter 3 Navigating the Domino Designer Workspace An Introduction to Designer The Design Pane The Work Pane The Object Pane The Programmer's Pane The Action Pane Design Tabs Language Selector Client and Browser Selector Status Bar Properties Dialog Links to developerWorks Chapter 4 Domino Design Elements Building Blocks of a Notes Database Naming Design Elements Working with Forms Working with Fields Working with Layout Regions Working with Sections Working with Buttons Working with Views Working with Application Menus Working with Folders Working with Framesets Working with Pages Working with Shared Code Working with Shared Resources Working with Events Links to developerWorks Chapter 5 An Introduction to Formula Language What Is Formula Language? What Is a Formula? Working with Variables Formula Language Keywords Working with Operators General Syntax Rules What Are Functions and Commands? What Are Commands? Working with Text Strings Working with Conditional Branching Working with Iterative Loops Working with Lookup Functions Working with Dates Working with Lists Working with User Prompts Debugging Formula Language Links to developerWorks Chapter 6 An Introduction to LotusScript Introduction to Object-Oriented Programming LotusScript Classes Keywords Variables Constants Operators Comments Defining Variables and Constants Defining Object Reference Variables Working with Conditional Branching Working with Iterative Loops Communicating with Users Working with Arrays Using Formula Language in LotusScript Code Compiling LotusScript Code Links to developerWorks Chapter 7 Fundamentals of a Notes Application The Five Primary Application Types The Application Development Life Cycle Elements of a Project Plan Elements of a Project Schedule Questions to Ask When Designing a Database Designing a Notes Application Project: Build a Database to Track Web Sites Links to developerWorks Chapter 8 Calendar Applications Application Architecture Managing Recurring Events Using Single Documents Managing Recurring Events Using Multiple Documents Project A: Build an Event Calendar Project B: Build a Conference Room Reservation System Links to developerWorks Chapter 9 Collaborative Applications Collaborative Applications Project A: Build a Discussion Forum Project B: Build a Project Control Notebook Links to developerWorks Chapter 10 Reference Library Applications Reference Library Applications Project A: Build a Connection Document Database Project B: Build a Spreadsheet Generator Chapter 11 Workflow Applications Defining a Workflow Application Project: Building a Workflow Database Architecture Links to developerWorks Chapter 12 Web Applications Defining a Web Application Project: Building a Domino Web Site Security Troubleshooting Links to developerWorks Chapter 13 Design Enhancements Using LotusScript Custom LotusScript Functions and Routines Compare Two Dates Check for an Element in an Array Replace an Element in an Array Remove a Character from a String Remove an Element from an Array Compare Two Arrays Working with Dynamic Arrays Create a Custom Popup Dialog Box Refresh a Document from the User Interface Search for a Document Working with Dates and Times Compute the Day of the Week How to Reference "$" Fields How to Set the "ReturnReceipt" for LotusScript-Generated Email Add Field Validation to a Form Display an "Are You Sure?" Message Format a User's Name Automatically Update a "History" Field When a Document Changes Prompt the User to Describe Document Changes and Update the "History" Log Create a Unique Document Record Number Limit the Ability to Create Documents on a Local Database How to Zero Pad a Text Number How to Add Text to a Rich Text Object How to Attach a File to a Rich Text Object How to Format Text in a Rich Text Object Change Document to Edit Mode Obtain the Current Roles Assigned to a User Generate a Document in Another Database Generate a New Document by Duplicating an Existing Document Prompt in LotusScript Sending Email to Multiple Recipients Using LotusScript Add a View Icon and Mood Stamp to an Email Retrieve and Update NOTES.INI Environment Values Assign One Rich Text Object to Another Rich Text Object Add a Document, View, or Database Link to a Rich Text Field Create a Button to Add a Calendar Event Links to developerWorks Chapter 14 Design Enhancements Using Formula Language Formula Language Enhancements Compare Two Lists Expand and Collapse All Document Sections Expand and Collapse All View Categories Get the Current Day of the Week Get the Current Month of the Year Create a Formatted Date String Create an Attach File Button Display the Windows File Finder Dialog Create a New Document Create a "Last Updated By" Field Create a "Last Modified On" Date Stamp Format a User's Name Hide Text and Design Elements Based on a User's Role Working with @DBColumn Working with @DBLookup Parse a Text String How to Format Field Values Using "Input Translation" How to Add Field Validation Display an "Are You Sure?" Warning Message Generate Email Using Formula Language How to Sort a List of Values Chapter 15 View Enhancements View Enhancements Create a New Document by Double-Clicking on a Calendar Date Display Documents in a View by Year and Month Display an Icon in a View Retrieve All Views in a Database Retrieve All Columns in a View Retrieve All Columns for Each View in a Database How to Manage Conflict Documents Display All Documents by Form Name Disable the Ability to Paste Documents into a View Links to developerWorks Chapter 16 Sample Agents Agent Enhancements Simple Action Agent to Modify All Documents LotusScript Agent to Modify All Documents Containing a Specific Field Value Agent to Manually Generate an Email Report Schedule Agent to Send a Daily, Weekly, or Monthly Email Report Links to developerWorks Chapter 17 Miscellaneous Enhancements and Tips for Domino Databases Miscellaneous Enhancements Disable the Ability to Print, Copy, Cut, and Forward Documents Using Field Hints on a Form Using Static Popups to Display Help Messages How to Inherit Fields Between Forms Add an Icon to an Action Button Create a Custom Application Interface How to Set the Field Tab Order on a Form Domino Shortcut Keys Chapter 18 Data Management Importing Data Exporting Data Migrating Data Creating Tables Modifying Data Using a LotusScript Agent Archiving Data Using an Agent Refreshing All Documents Chapter 19 Security Access Control List Fundamentals Managing Database Access How to Enforce Consistent ACL Settings Across Replicas Encrypt the Database Managing Access to Views Managing Access to Forms and Documents Managing Access to Fields Managing Access to Source Code Hiding a Database Design Hiding a LotusScript Library How to "Sign" a Database How to Cross Certify Domino Servers Links to developerWorks Chapter 20 Application Deployment and Maintenance What Are Templates? Establishing a Development Environment Migrating a Database Design Preserve a Copy of the Database Design Deploying the Production Database The Importance of Database Backups Process Synopsis Links to developerWorks Chapter 21 Troubleshooting Troubleshooting LotusScript Troubleshooting Agents Common Database Problems Where to Find Additional Assistance Links to developerWorks Appendix A Online Project Files and Sample Applications About the Online Materials About the Companion Web Site About the Developer's Toolbox About the "Chapter 07 Fundamentals Project" Folder About the "Chapter 08 Calendar Project" Folder About the "Chapter 09 Collaboration Project" Folder About the "Chapter 10 Reference Library Project" Folder About the "Chapter 11 Workflow Project" Folder About the "Chapter 12 Web Site Project" Folder About the "Chapter 18 Data Management" Folder About the "Development Tools and Files" Folder Installing a Notes Database Appendix B IBM® Lotus® Notes® and Domino®What's Next? Developer-Specific Enhancements What Is a Composite Application? Composite Application Development Tools Adding Value into the Future Endnotes Index Copyright The authors and publisher have taken care in the preparation of this book, but make no expressed or implied warranty of any kind and assume no responsibility for errors or omissions No liability is assumed for incidental or consequential damages in connection with or arising out of the use of the information or programs contained herein © Copyright 2007 by International Business Machines Corporation All rights reserved Note to U.S Government Users: Documentation related to restricted right Use, duplication, or disclosure is subject to restrictions set forth in GSA ADP Schedule Contract with IBM Corporation IBM Press Program Managers: Tara Woodman, Ellice Uffer Cover design: IBM Corporation Published by Pearson plc Publishing as IBM Press IBM Press offers excellent discounts on this book when ordered in quantity for bulk purchases or special sales, which may include electronic versions and/or custom covers and content particular to your business, training goals, marketing focus, and branding interests For more information, please contact: U.S Corporate and Government Sales 1-800-382-3419 corpsales@pearsontechgroup.com For sales outside the United States, please contact: International Sales international@pearsoned.com The following terms are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both: DB2, CICS, IMS, Lotus, Tivoli, WebSphere, Rational, IBM, the IBM logo, and IBM Press Java and all Java-based trademarks are trademarks of Sun Microsystems, Inc in the United States, other countries, or both Microsoft, Microsoft NET, NET, Windows, Windows NT, and the Windows logo are trademarks of the Microsoft Corporation in the United States, other countries, or both Linux is a registered trademark of Linus Torvalds Intel, Intel Inside (logo), MMX, and Pentium are trademarks of Intel Corporation in the United States, other countries, or both OSF/1 and UNIX are registered trademarks and The Open Group is a trademark of the The Open Group in the United States and other countries UML is a registered trademark of the Object Management Group (OMG) Other company, product, or service names mentioned herein may be trademarks or service marks of their respective owners Any persons, businesses, government entities, academic institutions, locales or events used in this book are fictional and for the purpose of illustrating concepts related to the subject matter of this book Any resemblance to actual persons (living or dead), businesses, government entities, academic institutions, locales or events is entirely coincidental Library of Congress Cataloging-in-Publication Data Elliott, Mark, 1968 Lotus Notes developer's toolbox : tips for rapid and successful deployment / Mark p cm ISBN 0-13-221448-2 (pbk : alk paper) Lotus Notes Computer software-Development Computer security Business Computer programs I Title HF5548.4.L692E45 2006 005.5'7 dc22 2006023492 All rights reserved Printed in the United States of America This publication is protected by copyright, and permission must be obtained from the publisher prior to any prohibited reproduction, storage in a retrieval system, or transmission in any form or by any means, electronic, mechanical, photocopying, recording, or likewise For information regarding permissions, write to: Pearson Education, Inc Rights and Contracts Department 75 Arlington Street, Suite 300 Boston, MA 02116 Fax: (617) 848-7047 Text printed in the United States on recycled paper at RR Donnelly in Crawfordsville, Indiana First printing, October 2006 Domino document shared resources Index [SYMBOL] [A] [B] [C] [D] [E] [F] [G] [H] [I] [J] [K] [L] [M] [N] [O] [P] [Q] [R] [S] [T] [U] [V] [W ] [X] [Y] [Z] VALUE variables field name variables Formula Language LotusScript 2nd object reference variables regular variables scalar variables variant variables object reference variables, defining in LotusScript temporary variables variant variables, LotusScript VIEW view categories collapsing in Formula Language expanding in Formula Language view enhancements view icons, adding to email view objects conference room reservation systems project setting in event calendars project view properties conference room reservation systems project setting in event calendars project View properties dialog view selection criteria, setting in Domino web sites workflow databases view selection formula discussion forums meeting view view, action buttons (creating in event calendars project) $$ViewBodyField, creating in Domino web sites views 2nd action items by date view, creating in project control notebooks action items by person view, creating in project control notebooks adding buttons to Rich Text fields Admin\Messages, workflow databases application views, workflow applications By Author view creating in discussion forums workflow databases By Category view, creating in discussion forums By Number, creating in workflow databases By Status, workflow databases By Topic view, creating in discussion forums Calendar view 2nd conference room reservation systems project creating event calendars project Categories Administration view, creating in discussion forums categorized views 2nd conflict documents, managing contact view, creating for spreadsheet generators creating new documents by double-clicking on calendar dates creating action buttons for conference room reservation systems project databases disabling to paste documents into views displaying documents by year and month icons documents by category view, creating in project control notebooks documents by date view, creating in project control notebooks Domino web sites Email Queue Administration view, creating in discussion forums hidden views late action items view, creating in project control notebooks managing access to meeting view, creating in project control notebooks RecordNo, Domino web sites Request Number, workflow databases retrieving all columns all columns for each view in a database all views in a database servers view, connection document databases Standard Outline view creating Subscriptions Administration view, creating in discussion forums team member view, creating in project control notebooks Work Queues\Approvers, workflow databases Work Queues\Procurement, workflow databases workflow databases $$ViewTemplateDefault form, creating in Domino web sites @ViewTitle visibility of documents, restricting Index [SYMBOL] [A] [B] [C] [D] [E] [F] [G] [H] [I] [J] [K] [L] [M] [N] [O] [P] [Q] [R] [S] [T] [U] [V] [W] [X] [Y] [Z] web applications defining troubleshooting Web browsers, Domino Designer client web pages buttons, creating in Domino web sites web pages, creating in Domino web sites Web services, shared code web site applications web sites, troubleshooting assistance WebQuerySave event, updating in Domino web sites Website LotusScript library, creating for Domino web sites WebSphere Portal and Workplace Collaboration Services Application Library Template Library @Weekday 2nd Weekday function welcome screens, creating @While WHILE statement, iterative loops Window Titles conference room reservation systems project workflow databases Windows File Finder dialog, displaying (Formula Language) Windows NT authentication Withdraw button, workflow databases wizards, Domino Designer Install Wizard wMenuBottom subform, Domino web sites wMenuTop subforms, Domino web sites wNextPrevBottom subform, Domino web sites wNextPrevTop subform, Domino web sites @Word 2nd 3rd 4th Work pane, Domino Designer client Work Queues\Approvers view, workflow databases Work Queues\Procurement view, workflow databases workflow application, configuring optional configuration System Profile workflow messages 2nd workflow applications 2nd defining workflow databases ChangeStatus subroutine CheckEditMode subroutine CheckFieldValues function CheckMsgfieldValues function configurations creating Admin\Messages view Admin\System Profile view Approved button By Author view By Number view By Status view Close button Complete button controlled sections 2nd 3rd databases Denied button fields In Process button labels message forms request forms Request Number view Submit button System Profile forms Withdraw button Work Queues\Approvers view Work Queues\Procurement view workflow script libraries database roles, setting declarations email notifications forms Initialize subroutine options 2nd QueryPaste event QuerySave event setting ReplaceElement routine roles security SendNotice subroutine view selection criteria views window titles workflow messages, configuring workflow script libraries, creating in workflow databases workflow stages wSaveDocAgent agent, Domino web sites Index [SYMBOL] [A] [B] [C] [D] [E] [F] [G] [H] [I] [J] [K] [L] [M] [N] [O] [P] [Q] [R] [S] [T] [U] [V] [W ] [X] [Y] [Z] XLS Index [SYMBOL] [A] [B] [C] [D] [E] [F] [G] [H] [I] [J] [K] [L] [M] [N] [O] [P] [Q] [R] [S] [T] [U] [V] [W ] [X] [Y] [Z] @Year function 2nd @Yesterday Function Index [SYMBOL] [A] [B] [C] [D] [E] [F] [G] [H] [I] [J] [K] [L] [M] [N] [O] [P] [Q] [R] [S] [T] [U] [V] [W ] [X] [Y] [Z] zero padding text numbers