Composite Application Tutorial I: NSF Components 1 Copyright Under the copyright laws, neither the documentation nor the software may be copied, photocopied, reproduced, translated, or reduced to any electronic medium or machine- readable form, in whole or in part, without the prior written consent of IBM Corporation, except in the manner described in the documentation or the applicable licensing agreement governing the use of the software. The information contained in this publication is provided for informational purposes only. While efforts were made to verify the completeness and accuracy of the information contained in this publication, it is provided AS IS without warranty of any kind, express or implied. In addition, this information is based on IBM’s current product plans and strategy, which are subject to change by IBM without notice. IBM shall not be responsible for any damages arising out of the use of, or otherwise related to, this publication or any other materials. Nothing contained in this publication is intended to, nor shall have the effect of, creating any warranties or representations from IBM or its suppliers or licensors, or altering the terms and conditions of the applicable license agreement governing the use of IBM software. Licensed Materials - Property of IBM © Copyright IBM Corporation 1985, 2007 Lotus Software IBM Software Group One Rogers Street Cambridge, MA 02142 All rights reserved. Printed in the United States. US Government Users Restricted Rights - Use, duplication or disclosure restricted by GS ADP Schedule Contract with IBM Corp. Revision History: Original material produced for IBM Lotus Notes and IBM Lotus Domino Release 8.0. List of Trademarks IBM, the IBM logo, AIX, DB2, Domino, iSeries, i5/OS, Lotus, Lotus Notes, LotusScript, Notes, Quickplace, Sametime, WebSphere, Workplace, z/OS, and zSeries are trademarks or registered trademarks of IBM Corporation in the United States, other countries, or both. Additional IBM copyright information can be found at: http://www.ibm.com/legal/ copytrade.shtml This information also refers to products built on Eclipse™ (http://www.eclipse.org) Java and all Java-based trademarks and logos are trademarks of Sun Microsystems, Inc. in the United States, other countries, or both. Microsoft, Windows, and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both. Intel and Pentium are trademarks of Intel Corporation in the United States, other countries, or both. 2 The Graphics Interchange Format© is the Copyright property of CompuServe Incorporated. GIF(sm) is a Service Mark property of CompuServe Incorporated. UNIX is a registered trademark of The Open Group in the United States and other countries. Linux is a trademark of Linus Torvalds in the United States, other countries, or both. Other company, product and service names may be trademarks or service marks of others. All references to company name(s) refer to a fictitious company and are used for illustration purposes only. 3 Composite application tutorial overview Composite applications are available with IBM Lotus Notes 8 Beta. These composite applications can be accessed from the local Notes data folder, the IBM Lotus Domino server, or an IBM WebSphere Portal server. Using new functionality, you can create combine one or multiple Notes applications into composite applications that boost organization productivity by providing the end user with a single context in which to complete their business process. Multiple components in the composite application can be wired in a causal relationship; when the end user performs a behavior in one component, the other wired components can react and perform a predefined behavior. IBM Lotus Domino Designer 8 Beta provides new features to help you, the developer, set up causal relationships for Notes applications used as components. The new Composite Application Assembly feature allows you to assemble multiple components into a single composite application and to define the wiring of the components in a 1-to-1 or 1-to-many relationship. This tutorial describes how to create a local composite application using procedures that make use of new features in IBM Lotus Notes 8 Beta and IBM Lotus Domino Designer 8 Beta. It provides an end-to-end scenario for creating and running a simple composite application using Notes applications as components. When you complete this tutorial, you will have a composite application with inter-component communication, similar to that shown below. Whenever you select a row in the upper component, the lower component will display the documents that have an identical category value in its embedded view. The upper component is a view in a Notes discussion database. In order for it to participate as a component in causal relationships with other components in the composite application, you will enhance it so that it publishes a value from the currently selected document. The lower component is a Notes form that contains an embedded view. The lower component has pre-defined behavior where it reacts to the published value to list, in the embedded view and documents which have a matching value. This is a causal relationship with the upper component. Tasks to be performed 4 Developing composite applications is a process that involves multiple procedures. This tutorial has organized the process into the following procedures, which you should perform in the order in which they are presented. Note This tutorial contains all the steps you'll need to create your first Notes-based composite application. You can also reference these procedures when creating your own unique composite applications. Lesson 1 -- Creating a new discussion database and documents Lesson 2 -- Creating a new Notes form with an embedded view Lesson 3 -- Creating a WSDL file to support inter-component communication Lesson 4 -- Defining Notes view columns that publish properties Lesson 5 -- Defining Notes actions that consume properties Lesson 6 -- Creating a composite application Lesson 7 -- Adding components to the composite application Lesson 8 -- Wiring components in the composite application Before you begin This tutorial assumes that you are familiar with creating new Notes databases in the Lotus Notes client. It also assumes that you are comfortable using prior versions of Lotus Domino Designer to modify Notes views, create simple Notes forms, and use the Programmers pane to input Notes formulas and LotusScript code. In addition to satisfying the system prerequisites for a Lotus Notes 8 Beta install, found in the release notes, be sure that you or your administrator have installed the following: IBM Lotus Notes 8 Beta (Standard edition) IBM Lotus Domino Designer 8 Beta Composite applications toolkit As a prerequisite activity, you may also wish to read through the composite applications toolkit documentation to gain a sense of supported functionality and application intent. You can find reference information about the composite applications tools and their functionality in the composite applications toolkit documentation supplied as a PDF file in your toolkit installation. For reference information about the latest release of Notes and Domino, see the release notes and the Beta documentation supplied with Lotus Notes 8 Beta. Note The term "Lotus Notes 8 Beta (Standard configuration)" refers to the Eclipse-based edition of Lotus Notes being introduces in version 8. The term will be shortened to Lotus Notes 8 Beta throughout this document. 5 Lesson 1 -- Creating a new discussion database and documents Welcome to Lesson 1. To complete all lessons in this tutorial, you need the Lotus Notes 8 Beta and Lotus Domino Designer 8 Beta software installed and set up. Lesson 1 objective In this lesson you will use two procedures to accomplish the following tasks: Create a new local Notes database based on the discussion template. Create documents in your discussion database. In later lessons of this tutorial, you will enhance this Notes discussion database to be used in a two component composite application that supplies inter-component communication through property broker functionality. 6 Lesson 1 - New Notes discussion database with documents This lesson has two procedures that, when completed, produce a new Notes database based on the discussion template with documents. In later lessons of this tutorial, you will enhance this Notes discussion database to be used in a two component composite application that supplies inter-component communication through property broker functionality. Procedure 1.1 - Complete the following steps to create the new discussion database 1. If needed, start the Lotus Notes 8 Beta client. 2. Click File > Application > New. Result: The New Database dialog appears. 7 3. Leave the Server field value at 'Local'. 4. Type MyDiscussion in the Title field. 5. Verify that the File Name field contains MyDiscussion.nsf. 6. Select Discussion - Notes & Web (7) in the Template list. 7. Deselect the 'Inherit future design changes' option. Note: Your new database will not inherit changes from the template. Therefore any design changes you make in later lessons of this tutorial will not be overwritten. 8 8. Click OK to close the New Database dialog and create the new database. Result: The new database is created and the About this Application page is displayed in your Lotus Notes 8 Beta client. 9. Close the window tab titled About MyDiscussion. Result: The default view of the newly created Notes application, MyDiscussion.nsf, appears in your Lotus Notes 8 Beta client as shown in the following screen capture. You have completed the first procedure in this lesson. 9 Next, you will create documents in this new discussion database. These documents must have values in the Subject and Category fields to successfully complete the later lessons of this tutorial. Procedure 1.2 - Complete the following steps to create documents in your discussion database 1. Click New Main Topic in the action bar. Result: The Main Topic form appears, in which you will specify the field values for the Subject and Category fields in the new document.