Академический Документы
Профессиональный Документы
Культура Документы
Guide
RELEASE
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 Lotus Development Corporation, except in the manner
described in the documentation.
Copyright 1997 Lotus Development Corporation
55 Cambridge Parkway
Cambridge, MA 02142
All rights reserved. First edition printed 1997. Printed in the United States.
List of trademarks
Domino, Lotus Components, Lotus Notes Desktop, Notes, NotesFlow, and Notes/FX are
trademarks and DataLens, Freelance, Freelance Graphics, Lotus, Lotus Notes Mail, Lotus Notes,
LotusScript, 1-2-3, ScreenCam, SmartIcons, SmartSuite, Symphony, and Word Pro are registered
trademarks of Lotus Development Corporation. cc:Mail is a trademark of cc:Mail, Inc., a wholly
owned subsidiary of Lotus Development Corporation. OS/2 is a registered trademark of
International Business Machines Corporation.
International Correctspell English licensed from Houghton Mifflin Company.
Copyright 1991 by Houghton Mifflin Company. All rights reserved.
Reproduction or disassembly of embodied algorithms or database prohibited.
Based upon The American Heritage Dictionary.
Other product and company names mentioned herein may be the trademarks or registered
trademarks of their respective owners.
Contents
Customizing Notes Designer templates . . . . 22 Adding static text to a layout region ... 41
Adding a graphic to a layout region ... 41
3 Designing Forms . . . . . . . . . . . 25 Aligning and rearranging elements in
About forms . . . . . . . . . . . . . . . . . . . . . . . . . 25 a layout region . . . . . . . . . . . . . . . . . . . 42
About the parts of a form . . . . . . . . . . . . . . . 26 Setting the tab order for fields in a
layout region . . . . . . . . . . . . . . . . . . . . 42
About tips for creating forms . . . . . . . . . 27
Changing the size and style of a
Creating a form ................... 28
layout region . . . . . . . . . . . . . . . . . . . . 42
Deleting a form . . . . . . . . . . . . . . . . . . . . 29
About hiding a layout region . . . . . . . . . 43
About naming, renaming, and creating
Hiding a layout region under certain
synonyms for form names . . . . . . . . . . 29
conditions . . . . . . . . . . . . . . . . . . . . . . 43
Contents iii
About creating form sections . . . . . . . . . . . . 44 Designing a form that lets users make
About types of forms . . . . . . . . . . . . . . . . . . 45 selections from a view . . . . . . . . . . . . . 61
Contents v
About identifying unread documents . . . . . 141 About agents and the access control
About refreshing view indexes . . . . . . . . . . 143 list . . . . . . . . . . . . . . . . . . . . . . . . . . . 175
Contents vii
Glossary of Notes Designer terms for About providing menu replacements
Web developers . . . . . . . . . . . . . . . . . 245 for Web users . . . . . . . . . . . . . . . . . . . 266
About planning a Web site . . . . . . . . . . . . . 248 About adding HTML to a Web
About Web settings in the Server application . . . . . . . . . . . . . . . . . . . . . 267
document . . . . . . . . . . . . . . . . . . . . . . 249 Formatting documents with HTML . . . . 267
About Web site home pages . . . . . . . . . . . . 249 Typing HTML directly on a form or
About specifying the Web site home document . . . . . . . . . . . . . . . . . . . . . . 267
page in the Server document . . . . . . . 250 Treating documents as pure HTML . . . . 268
About Web databases . . . . . . . . . . . . . . . . . 251 Adding HTML attributes to a field . . . . . 268
Migrating Notes databases to the Web . . 251 Storing HTML in a field . . . . . . . . . . . . . 268
Specifying an opening page for Web Adding HTML header information to
databases . . . . . . . . . . . . . . . . . . . . . . 252 Web documents . . . . . . . . . . . . . . . . . 269
About creating Web content . . . . . . . . . . . . 253 Using HTML formatting for views . . . . . 271
About previewing your design work on Adding pass-thru HTML to a column . . 271
the Web . . . . . . . . . . . . . . . . . . . . . . . 253 Embedding HTML in agent scripts . . . . 272
Hiding features from Web or Notes users . . 254 About Web graphics and colors . . . . . . . . . 272
About Web documents . . . . . . . . . . . . . . . . 256 Adding text descriptions to graphics
About creating new documents on the and applets . . . . . . . . . . . . . . . . . . . . 274
Web . . . . . . . . . . . . . . . . . . . . . . . . . . 257 About Web fonts and styles . . . . . . . . . . . . 275
Adding computed text to a document About Web agents . . . . . . . . . . . . . . . . . . . . 276
or form . . . . . . . . . . . . . . . . . . . . . . . . 258
About running agents before Web
Creating an attachments field for Web users open or save documents . . . . . . 276
documents . . . . . . . . . . . . . . . . . . . . . 258
About setting up security for Web
About Web views and folders . . . . . . . . . . . 259 applications . . . . . . . . . . . . . . . . . . . . 277
Customizing which column links to Setting up the access control list for a
Web documents . . . . . . . . . . . . . . . . . 261 Web database . . . . . . . . . . . . . . . . . . . 279
About Web navigators . . . . . . . . . . . . . . . . 261 Setting up roles for a Web database . . . . 280
About displaying views and navigators About restricting access to Web views,
with documents . . . . . . . . . . . . . . . . . 261 forms, and fields . . . . . . . . . . . . . . . . 280
Embedding a view, folder pane, or About enforcing encrypted Web
navigator . . . . . . . . . . . . . . . . . . . . . . 262 transactions for a database . . . . . . . . 281
Displaying the view navigation bar About setting up links within a Web site . . 281
for embedded views . . . . . . . . . . . . . 264
About setting up Web searching . . . . . . . . . 282
Using a form as a view or navigator
template . . . . . . . . . . . . . . . . . . . . . . . 264 Setting up view searches . . . . . . . . . . . . 282
Overriding an embedded navigator Setting up multiple-database searches . . 282
with a navigator template . . . . . . . . . 265 About customizing search forms for
About Web buttons and actions . . . . . . . . . 266 Web users . . . . . . . . . . . . . . . . . . . . . 283
About URL commands for searching Giving users the form design . . . . . . . . . 327
for text . . . . . . . . . . . . . . . . . . . . . . . . 303 About mailing features and Web
About URL commands for requiring applications . . . . . . . . . . . . . . . . . . . . 328
authentication . . . . . . . . . . . . . . . . . . 305 About fields that control mailing options . . 328
About URL commands for processing Table of fields that control mailing
SSL certificates . . . . . . . . . . . . . . . . . . 306 options . . . . . . . . . . . . . . . . . . . . . . . . 329
About editing the HTTPD.CNF file to About designing a form for optional
add MIME type mappings . . . . . . . . . 308 mailing . . . . . . . . . . . . . . . . . . . . . . . . 332
Setting up a database to receive mailings . . 333
Contents ix
Using an agent to send automatic replies . . 333 Designing a form for documents that
Using an agent to mail notices . . . . . . . . . . 334 open as modal dialog boxes . . . . . . . 354
Using an agent to send announcements . . . 335 Designing a form to hide the Notes
document . . . . . . . . . . . . . . . . . . . . . . 355
13 Designing Applications Hiding an embedded object in a
That Share Information . . . . . . . 337 document . . . . . . . . . . . . . . . . . . . . . . 357
About designing applications that share About using ODBC to access non-Notes
information . . . . . . . . . . . . . . . . . . . . 337 databases . . . . . . . . . . . . . . . . . . . . . . 358
About using NotesFlow tools . . . . . . . . . . . 338 About the files required to use ODBC . . . . . 358
About exchanging data using Notes/FX . . 339 About registering data sources for
ODBC . . . . . . . . . . . . . . . . . . . . . . . . . 359
Preparing a Notes form to exchange
data . . . . . . . . . . . . . . . . . . . . . . . . . . 340 Registering a data source through the
operating system . . . . . . . . . . . . . . . . 359
Enabling and disabling field exchange . . 342
About writing formulas and scripts to
About publishing actions . . . . . . . . . . . . . . 343 access non-Notes databases . . . . . . . . 360
Publishing an action . . . . . . . . . . . . . . . . 344
About linking and embedding objects in 14 Making, Distributing, and
forms . . . . . . . . . . . . . . . . . . . . . . . . . 345 Controlling Design Changes . . . 363
Linking and embedding objects in About making and distributing design
forms . . . . . . . . . . . . . . . . . . . . . . . . . 346 changes . . . . . . . . . . . . . . . . . . . . . . . 363
Adding OLE custom controls to a Renaming a database . . . . . . . . . . . . . . . 364
form . . . . . . . . . . . . . . . . . . . . . . . . . . 346 Renaming forms, views, navigators,
Creating a form that sizes an and agents . . . . . . . . . . . . . . . . . . . . . 364
embedded object . . . . . . . . . . . . . . . . 347 Changing database and design
Creating a form that sizes an OLE properties . . . . . . . . . . . . . . . . . . . . . . 365
custom control . . . . . . . . . . . . . . . . . . 348 About creating a design synopsis . . . . . . . . 365
Creating a form that runs a custom Creating a design synopsis . . . . . . . . . . . 366
control in read-mode . . . . . . . . . . . . . 349
About updating documents after
Letting documents update objects redesigning a form . . . . . . . . . . . . . . . 367
created by forms . . . . . . . . . . . . . . . . 349
About checking field values in a
About forms that launch objects document . . . . . . . . . . . . . . . . . . . . . . 368
automatically . . . . . . . . . . . . . . . . . . . 349
Checking field values in a document . . . 368
Designing a form that launches an
object automatically . . . . . . . . . . . . . . 350 About using agents to update documents
affected by form changes . . . . . . . . . . 369
Designing a form that launches a new
object automatically . . . . . . . . . . . . . . 352 About templates and master templates . . . 371
Replacing the design of a database . . . . . 378 About writing a .COL file for a tabular
text file . . . . . . . . . . . . . . . . . . . . . . . . 396
About design changes and replication . . . . 378
About writing formulas for .COL files . . . . 397
About preventing design changes . . . . . . . . 379
About exporting views . . . . . . . . . . . . . . . . 398
Protecting design elements from being
replaced or refreshed . . . . . . . . . . . . . 379 Exporting a view . . . . . . . . . . . . . . . . . . 399
About file formats you can export and Table of Notes text styles that are not
import . . . . . . . . . . . . . . . . . . . . . . . . 389 supported on the Web . . . . . . . . . . . . 411
About importing options . . . . . . . . . . . . . . 390 Table of Notes view properties that are
not supported on the Web . . . . . . . . . 411
About importing worksheets . . . . . . . . . . . 390
Table of Notes navigator properties that
Importing worksheet data into a view . . 391 are not supported on the Web . . . . . . 412
About importing tabular text . . . . . . . . . . . 391 Table of Notes actions and agent
Importing tabular text into a view . . . . . 392 properties that are not supported
on the Web . . . . . . . . . . . . . . . . . . . . . 413
Contents xi
Table of Notes @functions that are not
supported on the Web . . . . . . . . . . . . 414
Index . . . . . . . . . . . . . . . . . . . . . . 417
Creating a database
Every Lotus Notes application uses at least one database to organize and
store data and design elements. Database file names end with .NSF and
reside in the Notes data directory or a subdirectory of a Lotus
Domino server a networked machine to which Notes or Internet users
have access. If youre accustomed to Web design, the concept of a database
may be unfamiliar; think of it as a storage area for related Web pages.
The Domino/Notes software includes pre-designed databases called
templates (distinguished by file names that end with .NTF) that help you
create new databases quickly.
1
When you see an introduction entitled About Discussion, choose File -
Close to proceed directly to the database interior.
The database is now open. Double-clicking the database icon from the
Notes workspace also opens the database. If you close this window, you
close the database. Leave the database open for now.
Creating documents
Documents store the data for an individual database. If youre familiar with
other database products, think of each document as a database record. If
youre accustomed to Web design for the Internet, think of each document
as a Web page.
When you create a new database, it contains no documents. To add a
document, Notes users open the database, choose Create and the name of a
form, fill in information, and close and save the document. Web users click
a button to open a form, fill in information, and then click a Submit button
to close and save the document.
Documents can contain a variety of elements, such as text and graphics. All
documents also have fields data holders that contain one piece of
information, such as a persons name, a comment, a number, a date, or the
results of a calculation.
Click the Save button on the action bar, then the Close button to save the
document in the database. The view pane on the right shows the name of
your new document. With the highlighting still on the line that contains the
name of your new document, click the Response button.
Fill in the Document title and Message Content fields for this second
document, then click Save and Close. The second document, which is a
response, appears indented under the first document in the view pane.
Click the Edit Document button. Brackets reappear around the editable
fields, allowing you to change information that you entered before.
Opening navigators
A navigator provides a graphical way for users to find documents or take
actions in an open database without having to open views or know menu
commands. A navigator that you design to open automatically when a
database opens can also be an entry point for the database or Web site.
Open a navigator
With the database open, choose View - Show - All Documents to replace the
folders list with the navigator named All Documents.
Opening forms
A form is a framework for entering and viewing information in a database.
The Notes Create menu lists the forms that users can choose for creating
new documents. Most databases have forms for different kinds of
information. For example, a discussion database usually includes a form to
begin a new topic of discussion and another form to respond to topics.
You have already seen and used two forms when you created your sample
documents: Main Topic and Response. Compare the list of forms you see in
the right view pane against the list of forms available from the Create and
The upper left pane is the builder pane where you create and arrange fields,
graphics, and other form elements. For new forms, this pane is empty until
you add the form elements. Click the pane now to make it active, open the
Create menu, and view the kinds of elements you can create on forms.
The action pane in the upper right lists predefined shortcuts built into this
form. Actions display as action bar buttons at the top of documents or as
items on the Actions menu. You can size the right pane by clicking and
dragging its left border.
The design pane at the bottom provides tools for programming form
elements. You can size the pane by clicking and dragging its upper border.
Notice that the leftmost form name is the one you saw on the Create menu
when you created a Main Topic document. Each design element, as well as
the database itself, has a properties box that stores its name, styles, and
options. Click the X in the top right corner to close the properties box.
Choose File - Close to close the document. Click No if you are prompted to
save any changes.
Choose File - Close to close the document. Click No if you are prompted to
save any changes.
Each database you create comes with an icon. To open the icon in design
mode, click Other from the Design toolbox and double-click Icon.
Using a template
The easiest way to create a database is to use a template, which is a file that
contains the structure for the database that is, forms and views but
does not contain documents. Notes Designer comes with a collection of
templates that you can use to create applications quickly. For example, to
design a discussion database, use the Discussion template
(DISCUSS4.NTF), which contains forms that track discussion threads in a
hierarchy, as well as views that display the entries by date, author, or
category.
A template file has a .NTF as its file extension. You can set the database you
create to continue to inherit design changes from the template. Then if
someone redesigns the master template, your database automatically
inherits the new design.
As you consider how to design an application, know who your users are.
Users with Lotus Mail licenses can only see applications created from
templates stamped for their use. You cannot customize those templates in
any way, or the stamping becomes invalid.
17
For a complete list of Notes Designer templates and information on which
templates are available for users with a Lotus Mail license, see Appendix A.
Copying a database
If you have read access to a database that contains the design elements that
you need for your application, copy the existing design and use it as the
basis for a new application. If you copy the design of an existing database,
keep in mind that:
The settings for the full text search index are copied as part of the
design. When you complete the new application, be sure to ask the
database manager to create a new index.
Before you copy the design of a database, check its Database Properties.
If Design is hidden is shown on the Design tab in the Database
Properties box, you will never be able to modify the design of the new
database.
In addition to copying the entire design of a database, you can copy
individual design elements.
For information on creating a full text index, see the Database Managers
Guide.
Details
Title
The Title can have a maximum of 32 characters. It appears on the database
icon.
Database file name
Specify a unique, descriptive name of fewer than 8 characters, followed by
the extension .NSF. As part of the file name, specify a drive and directory to
store the new database in a specific directory. Otherwise, the database is
stored in the Data directory.
Customizing a database
After creating a database from a template, you will probably customize the
database. Keep in mind that many of the templates that ship with Notes
Designer are master templates. This means that changes made to the
master template are passed on to the databases created from the template.
One side effect of this is that changes you make to a database can be
overwritten by a new version of a template.
If you plan to customize a database and want to avoid the possibility of
overwriting design changes, either deselect the Inherit future design
changes option as described in the steps above, or deselect Inherit design
from template on the Design page of the Database Properties box for the
database.
For information on inheriting design changes, see Chapter 14. For
information on encrypting a database, see Chapter 8.
Details
Title
The Title can have a maximum of 32 characters. It appears on the database
icon.
Database file name
Specify a unique, descriptive name of fewer than 8 characters, followed by
the extension .NSF. As part of the file name, specify a drive and directory to
store the new database in a specific directory. Otherwise, the database is
stored in the Data directory.
Details
Title
The Title can have a maximum of 32 characters. It appears on the database
icon.
Database file name
Specify a unique, descriptive name of fewer than 8 characters, followed by
the extension .NSF. As part of the file name, specify a drive and directory to
store the new database in a specific directory. Otherwise, the database is
stored in the Data directory.
Examples
Customizing a master template
You need to add a Confidentiality field to all discussion databases, so that
authors can mark specific documents as Confidential For internal use
only. All databases that base their design on the Discussion template will
inherit this field.
This chapter introduces the kinds of elements you can place on a form,
shows you how to create a form and define its characteristics, and describes
how to design an attractive, readable form.
About forms
A form is a framework for entering and viewing information in a database.
A Notes database contains documents created from one or more forms. A
form can contain:
Fields that store data
Text that labels fields or gives instructions
Subforms that store a collection of form elements you want to use on
more than one form
Layout regions that combine graphics and fields in a way that affords
greater design flexibility
Graphics that make forms easier to understand
Tables that summarize or organize information
Objects (OLE, Subscriptions, Notes/FX fields), file attachments, and
links that extend the reach of Notes documents
Actions and buttons that perform functions automatically
Background color and graphics that enhance the look of a document
If the form you need is similar to one that exists in the same database or
another database, its easiest to copy the form and then modify it. You can
also copy individual forms from the Notes Designer templates. If no
existing form suits your purpose, create a new form.
25
About the parts of a form
Use the following elements to structure the data in a document.
Fields
A field holds a particular type of data. For example, a field might contain
text, a number, or a graphic. You can place fields anywhere on a form. A
field can be unique to that form or shared among forms within a database.
You can encrypt data in a field, attach an electronic signature, or use hidden
fields that calculate data. You can also add LotusScript programs that run
when users move to or from certain fields. Text attributes, such as bold type
or color, that you apply to fields affect the appearance of the data in the
finished document.
Fields can also be Notes/FX fields that exchange information with other
products.
Subforms
A subform is a collection of fields, sections, actions, and other form
elements that are stored as a single object. A subform can be a permanent
part of a form or can appear conditionally, depending on the result of a
formula.
Subforms save redesign time. When you change a field on a subform, every
form that uses the subform updates. Common uses of subforms include
adding a company logo to business documents or adding mailing label
information to mail and memo forms.
Layout regions
A layout region is a design area on a form that affords greater flexibility for
combining and arranging text and graphics. A layout region can contain
static text, graphics, buttons, and all fields except rich text fields. You can
hide or collapse a layout region and all its components under certain
conditions. Layout regions are not supported for Web applications.
Text
You can place static (unchanging) text anywhere on a form and apply text
attributes, such as color, size, and font styles to the text. Text is often used
to label fields so users understand the purpose of each field.
Graphics
You can place a decorative graphic anywhere on a form, and it will appear
on every document created with the form. For example, on a form for
correspondence, place your company logo at the top to create a letterhead.
OLE objects
A form that has an OLE object allows users to view and update data
created in another product from a Notes document. For example, an
Employee Information form can include an OLE object that links to a Word
Pro file where the employee annual performance reviews are stored.
Notes/FX 2.0 fields create a two-way exchange between Notes and a
supporting application by allowing field data to be shared and updated
from either application.
Attachments
You can attach files to a form so users can detach files locally or launch
them from every document created with the form.
Links
Within a form, you can add links to databases, views, or specific
documents. You can design the form so when a user opens the document
created with the form, the links automatically launch.
Creating a form
To create a blank form
1. Select the database and choose Create - Design - Form.
2. If you receive a message about invalidating authorization, click OK if
you do not have Lotus Notes Mail IDs at your site; otherwise, click
Cancel.
3. If you see a list of subforms, click Cancel.
4. Create fields, static text, and other elements on the form.
5. Choose Design - Form Properties to assign a name and other form
properties.
6. Close and save the form.
Deleting a form
Remove a form when users no longer need it. After you delete the form,
documents that were created with the deleted form are displayed in the
default form instead.
1. Open the database.
2. In the navigation pane, choose Design - Form.
3. Choose the form you want to delete.
4. Choose Edit - Clear.
5. If you receive a message about invalidating authorization, click OK if
you do not have Lotus Notes Mail IDs at your site; otherwise, click
Cancel.
6. Click Yes to confirm.
7. Close the database.
Tip To prevent users from seeing a message that the form cant be found
when they open existing documents, create an agent that reassigns the form
name.
For information on using agents to reassign documents to a new form, see
Chapter 7.
Name requirements
The name is case sensitive and can be any combination of characters,
including letters, numbers, spaces, and punctuation.
The full form name, including all synonyms and the cascading name,
cannot exceed 256 bytes. If youre using multibyte characters, 256 bytes
is different from 256 characters.
Only the first 64 characters of a form name appear in the Create menu.
To name a form
1. Create a new form.
2. Choose Design - Form Properties and enter a name for the form.
To hide a form
Another way to remove a form from the Create menu is to hide it. Hiding
allows you to specify conditions under which the form is hidden or
displayed. For example, you can hide a form from Notes clients, but display
it for Web clients.
1. Open the form in Design mode.
2. Choose Design - Form Properties.
To import a BMP (bitmap), JPEG, GIF, PCX Image, or TIFF 5.0 bitmap
1. Open the form in Design mode.
2. Move the cursor to the location in the form where you want to place the
graphic.
3. Choose File - Import.
4. Choose the file to import and click OK.
5. Close and save the form.
Details
Highlight the table or individual rows or columns and choose Table -
Table Properties to change border styles and spacing for the highlighted
area.
Highlight the table or individual rows or columns and choose Text -
Text Properties to change the style of text or to hide text for the
highlighted area.
For more information, see Ways to format tables in Notes Help.
Creating a subform
If you cant find a subform that is similar to the one you need, create a new
subform and build its design yourself.
1. Select the database that will have the new subform and choose Create -
Design - Subform.
2. If you receive a message about invalidating authorization, click OK if
you do not have Lotus Notes Mail IDs at your site; otherwise, click
Cancel.
3. Choose Design - Subform Properties.
4. Enter a name for the new subform.
5. Choose options for displaying the subform.
6. Create the subform using the same elements you use to create a form.
7. Close and save the subform.
Examples
In the Main Topic form of a discussion database, you want to display the
NewDocSubform if a document is new and the SavedDocSubform if the
document has been saved. Each subform contains different fields and
graphics. The Insert Subform formula is:
@If(@IsNewDoc;NewDocSubform;SavedDocSubform);
Details
When a user opens a document that references a deleted subform, the
message Cannot locate Subform: <subform name> appears. After the user
clicks OK, the document opens with a representation of the deleted
subform. When a designer opens a form that references a deleted subform,
the message Cannot locate Subform: <subform name> appears. After the
designer clicks OK, the form opens. When a designer clicks the deleted
subform area on the form, the message Invalid or nonexistent document
appears and the designer cant open the subform in Design mode.
To avoid these messages, add another subform to the database and give it
the same name as the deleted one.
Listbox
Each keyword choice is displayed with an expanded list box. Users click an
entry to select it, or, if Allow multi-values is selected for the field, users
can click more than one entry. The Allow values not in this list option is
not available.
List boxes have frame, size, and placement options. To resize the list box
without dragging it, change the Width and Height measurements. To move
the list box in the layout region without dragging it, change the Left and
Top measurements.
To collapse a section
1. Open the form in Design mode.
2. Click the section marker and choose Section - Section Properties.
3. Click the Expand/Collapse tab.
4. Select options for showing the section expanded or collapsed
depending on whether a document is being previewed, printed, or
opened.
5. Select Hide title when expanded if users dont need to see the section
title when the fields are displayed.
To delete a section
1. Click the section title and choose Edit - Clear.
2. Close and save the form.
Details
You can restrict access to a section by creating an access control list.
For information on creating an access-control list for a section, see
Chapter 8.
Default forms
A default form is the form that you designate to display a document when
the documents associated form is not available.
Response forms
The Response form creates response documents associated with a main
document. A response document appears under whichever main document
is highlighted when the user composes a response. Designers often create
response documents that inherit data from main document for example,
the topic title.
The Response-to-response form creates response documents associated
with either a main document or a response document.
Details
For complete anonymity, be sure that the author name does not appear
elsewhere on the document for example, in a visible computed field.
Examples
Title includes creation date and company name
This formula displays the date the document was created, form name, and
company that was billed. @Text converts the date to a text string, and the
extra spaces within the quotation marks force the words in the title to be
properly spaced.
@Text(@Created) + + Inventory Invoice + for +
CompanyName
Title includes number of responses
This formula is useful for a main document form in a discussion database.
@If(@IsNewDoc;New Topic;Subject +
@DocDescendants( (No Responses); (1 Response); (%
Responses)));
If the document has never been saved, New Topic shows in the title bar
while the user composes the document. After the document is saved, the
title is the subject combined with the number of responses. If the subject is
Icebox 2000 and there are no responses, the title of the document is Icebox
2000 (No Responses). With one response, the title becomes Icebox 2000 (1
Response). With two responses, the title becomes Icebox 2000 (2 responses).
Response includes the subject
When the response or response-to-response is first composed, this formula
displays New Response To and the subject of the main document.
@If(@IsNewDoc;New Response to + Subject;
Response + @DocNumber() + of + @DocSiblings + to
+ Subject);
When a user reads the response, the window title displays the total number
of responses to the main document, the response being displayed, and the
subject of the main document. For example if the response document is the
second of four responses to Icebox 2000, the title displays as Response 2 of 4
to Icebox 2000.
Details
Headers and footers have three preset, permanent tab stops: left, center,
and right. When you insert one tab, text to the left of the tab is left justified,
and text to its right is right justified. With two tabs, text to the left of the
first tab is left justified; text between the two tabs is centered; and text to
the right of the second tab is right justified. For example:
&D|&T|&P Left justifies the date, centers the time, and right justifies the
page number.
|URGENT| Centers the text URGENT.
||URGENT Right justifies the text URGENT.
Details
Use the @functions GetProfileField and SetProfileField to access and edit
field values in a profile document.
Use the LotusScript method NotesDatabase EditProfile to edit an existing
profile document.
For information on creating or editing profile documents using an
@Command formula or a LotusScript program, see the Programmers Guide.
Details
Design guidelines
To match the Notes user interface as closely as possible, follow these
guidelines:
For the dialog form, use a layout region with the 3D property selected.
Although you can design the dialog form in any way, a 3D layout
region most closely resembles a dialog box. A layout region that is 3
inches square is big enough to display a few fields and two or three
buttons.
In the @DialogBox formula, include the [AutoVertFit] and
[AutoHorzFit] options to size the dialog box to fit the layout region.
Use 8 point Helvetica for static text, fields, and buttons.
Place static text labels above or to the left of fields and end them with a
colon (for example, Name:).
Place buttons at the bottom of forms.
OK and Cancel buttons appear automatically to the right of the layout
region. You cannot remove these buttons or add buttons next to the OK
and Cancel buttons.
Use the multi-column display option with radio button and check box
keyword fields to arrange the keywords horizontally; use None for the
frame option so they blend with the dialog box background.
For button text, use initial capital letters for multiple words. Use
ellipses for buttons that lead to another dialog box or task for
example, Show Details....
Field values entered through the dialog box
When users enter field values in the dialog form, the values are shared with
fields on the host form that have the same names. For example, if a host
form called Memo has a button that uses @DialogBox to bring up the
dialog form called Memo Options and both forms have a field called
Examples
To make it easy for users to add customer information to a database, you
design a Customer Information form with a button that uses @DialogBox to
call the Dialog Box form.
When users choose Create - Customer Information, they click the button to
add a new customer.
The Customer Information form contains the same field names as the
Dialog Box form fields. When users fill out the necessary information in the
dialog box and click OK, the entries are saved in the Customer Information
document automatically.
Examples
[YesNoCancel]
This formula displays a warning before sending the memo and gives the
user a chance to select Yes, No, or Cancel.
Result := @Prompt([YesNoCancel]; Send memo?; This memo
will be sent to everyone listed in the To, CC, and BCC
fields. );
Designing forms
Avoid large bitmaps or graphics.
Avoid the form property Automatically refresh fields.
Instead, use the Refresh fields on keyword change for a keyword
field, or write a LotusScript field event to recalcaulate the document or
update other fields when users move from a specific field.
Avoid long tables with many computed fields.
Designing fields
Use @DbColumn or @DbLookup formulas sparingly, or replace them
with LotusScript programs which are generally faster and support error
checking.
Use simple formulas for hide when conditions.
Avoid recalculating fields, if possible. Otherwise, change such fields to
computed-when-composed fields, which calculate only when the
document is composed, but can be updated later if needed through
buttons, actions, or agents.
Use LotusScript form events rather than conditional formulas in the
field itself to set field values.
For example, to reset the status field if the document is being saved,
create a script for a QuerySave event, rather than write a formula that
uses @If(@IsDocBeingSaved;x;y).
Minimize the number of fields, especially hidden fields, and use form
events rather than field formulas to execute processing logic and avoid
unnecessary recalculations.
Testing a form
Always test a new form before giving it to users. For forms that contain
multiple actions or formulas, test and fix each formula or task first. When
everything is working correctly, test the complete form.
1. Select the database and choose File - Database - New Copy to make a
test copy of the database.
2. Select the database and choose Create - <form name>.
3. Fill in all the fields and save the document.
About fields
Fields are the individual elements on a form that store data. Fields
determine what data a single document can contain. Each field in a
document stores a particular kind of data, such as text, numbers, dates, or
user names. Often users can enter and edit field values, but sometimes data
is filled in or changed automatically.
The contents of a field can be displayed in documents and views or can be
retrieved for use in formulas. A field can be defined for use on a single form
or can be defined to be shared among multiple forms in a database.
A field definition has five elements: a name, a data type, a computed or
editable attribute, display options, and formulas or scripts associated with
the field.
Text
Create a text field to hold letters, punctuation, and spaces, as well as
numbers that are not used in calculations, such as postal codes and phone
numbers.
Create a rich text field to hold pictures, graphs, hotspots, attachments, and
embedded objects. Also, use rich text fields to hold text, the font and color
of which you want to change and/or style with bold, italics, and
underlining.
65
Create a keywords field to hold lists of predefined text choices. Presenting a
list of choices to users makes data-entry easy and ensures that field values
are consistent.
Names
Create a Names field to display user or server names as they appear on
Notes IDs. Use Names fields to display names when you dont need to
assign access rights to documents. Use a Names field to display the creator
of a document or to maintain a list of users who edit the document.
Computed
Create a computed field to hold a formula that you want to recalculate each
time a user creates, saves, or refreshes a document. After you create the
field, you write a formula to calculate the field value, which is stored with
the document.
Creating a field
The field name is surrounded by a rectangle. You can use tabs, returns, and
other formatting tools to refine the fields position.
1. Open the form in Design mode.
2. Place the insertion point where you want the field to appear.
3. Choose Create - Field.
4. In the Field Properties box, assign a name to the field.
5. Assign a data type and select Editable or a computed option.
6. (Optional) Click the form and type a text label next to or above the
field.
7. (Optional) Highlight the label and choose Text - Text Properties to
change the text style.
Details
You assign field names, and Notes uses them to recognize and classify
fields. A field name must begin with a letter and can include letters,
numbers, and the symbols _ and $. The name can contain up to 32 bytes. If
youre using multibyte characters, remember that 32 bytes is different than
32 characters. Use short, descriptive field names that you will remember
when you write formulas that refer to the fields.
Since field names cannot contain spaces, run multiple words together for
example, ModifiedDate or separate them with an underline
Modified_Date. The Designer templates use the convention of an initial
capital letter followed by lowercase letters for example, SendCopyTo.
Renaming a field
Unlike forms and views that can have synonym names, a field can have
only one name. Renaming a field has the same effect as deleting a field from
a form. Rename fields only if absolutely necessary.
Renaming single-use fields
After renaming the field, revise all formulas that refer to the former field
name. If you already used the form to create documents, create and run an
agent to reassign data to the new field name and to computed fields.
Copying fields
If you copy a field from the same form, each additional copy of the field has
a sequential number appended to its name to preserve name uniqueness.
You can rename the field after copying it. If you copy a shared field, the
new field changes to a single-use field.
Details
You cannot convert fields in a layout region.
Details
Allowing user-defined keywords and multiple values
Select Allow values not in list (not available for all types of keywords) to
let users enter their own keywords. With most of the interface choices, you
can also select Allow multi-values to let users choose more than one
keyword. Multiple items are stored as a text list. If these properties arent
selected, users are limited to one selection from the set of predefined
keywords.
Examples
You want to make it easy for users to include a product number when they
fill out a Purchase Request. You create an editable keywords field named
ProductNumber and use the View Dialog for choices property to
generate choices.
You select the Inventory Database, the By Product Number view, and
Column 1, where product numbers are listed.
Creating a formula-generated list
A Travel Request form contains an editable keywords field called Country
that uses the following formula to show only those countries relevant to the
location selected by the user:
@If(Location=Europe;France:Germany:Italy:Spain;Loca
tion=Far East;Japan:Singapore:South
Korea;Location=North America;Canada:Mexico:United
States;)
Details
Choose any of these number formats:
General displays numbers as they are entered; zeroes to the right of the
decimal point are suppressed. For example, 6.00 displays as 6. The
default thousands separator is based on the type of measurement
(Imperial or Metric), which users set in the international User
Preferences.
Fixed displays numbers with a fixed number of decimal places. For
example, 6 displays as 6.00 when 2 is selected in the Decimal Places
list.
Scientific displays numbers using exponential notation. For example,
10,000 displays as 1.00E+04. Select the number of decimal places from
the Decimal Places list.
Currency displays values with a currency symbol. For example, $15.00
is displayed when the value is 15 and 2 is selected in the Decimal
Places list. The currency symbol is determined by the international
settings of the users workstation.
Notes recognizes the following formats for numbers:
Integers 123, -123
Decimal fractions 1.23, 0.12, -.12
Scientific notation 1.23E2, -1.23E12
Currency $2.50, ($600.09)
Notes can store numbers from 2.225E-308 to 1.798E308 with 14-digit
accuracy.
Details
The following are valid date and time formats:
10/30
10/30/95
Today
Examples
Tracking modification dates
You want to track the dates on which purchase requisitions are created and
modified. On the Purchase Requisition form, you create a computed-when-
composed Time field called CreationDate with the formula @Created.
This date always shows the date the author first saves the document. To
track editing dates, you also created a computed Time field called
ModifiedDate with the formula @Modified. This date is the same as the
CreationDate the first time the document is saved but is updated
automatically each time the document is modified.
Determining the daily age of a document
In your Service Tracking database, you want to track the age of request
documents. On the Request form, you create three fields to calculate the
information.
The first field is a computed Time field called DateCreated containing this
formula:
@Created
The second field is a Time field named CurrentDate containing this
formula:
@Now
Lookup options
None
If you select None, you rely on a formula or on authors to create the list of
names.
Examples
The default value formula can provide a value or use a formula to calculate
one. For example:
The formula Returns
0 The number 0
@Now The current time and date
@Name([CN;@Username) The common name portion of a users
hierarchical name
Price The value of the field named Price
Connecticut:New York:New Jersey A text list containing Connecticut, New
York, New Jersey
Product + , + Department The value of the field named Product,
followed by a comma and a space, and
the value of the field named Department
Details
@Failure prevents the user from saving the document until the user enters a
value that meets the criteria. As part of the formula, include text that clearly
indicates what is wrong and how the user can correct it.
The following illustrate two common uses for an input validation formula:
Field criteria Formula
User must enter a value that is less @If(Cost<100;@Success;@Failure(Cost must
than 100 in Cost field be less than $100.));
User must enter a value for the @If(Subject = ; @Failure(You must enter a
Subject field subject for your document.); @Success)
For information on writing formulas for fields, see Chapter 1 of the
Programmers Guide.
Details
Use New Line and Blank Line separators for display separators to make
multiple entries easy to read.
To align and separate multiple values on the form, use the ruler
(CTRL+R) to create a hanging indent where the field begins. Select New
Line for both the input and display separator.
Hiding options
You can hide a field and any other associated text or graphic all the time or
only at certain times. For example information useful only when users
create or edit documents can be hidden during reading, printing, and
copying; information that is used for display, such as a computed field that
displays the result of an authors choice in an editable keywords field, can
be hidden during editing.
The following are options for hiding fields:
Hide from Notes client
Information is hidden when the application opens on a Notes
workstation.
Hide from Web Browsers
The information is hidden when the application opens on a Web
browser.
Previewed for reading
The hidden information isnt visible when users read documents in the
preview pane.
Previewed for editing
Hiding a field
If you have computed fields that users dont need to see or if you create
two fields one for display when reading and one for use when editing
you can stipulate when to hide the fields.
1. Select the field and any related text or buttons you want to hide.
2. Choose Text - Text Properties.
3. Click the Hide tab.
4. For basic options, select Hide paragraph when document is: and click
all situations when users dont need to see the field information.
5. For programmer options, select Hide paragraph if formula is true
and write a formula in the formula window to describe the situations
when users dont need to see the fields.
For more information on using a formula to hide a paragraph, see the
Programmers Guide.
Details
Choosing Refresh fields when keywords change displays documents
faster than the form property Automatically refresh fields. It is useful for
showing or hiding parts of the form when you have hide-when formulas
that are dependent on values in the field.
This chapter describes how to design views that help users find the
documents they want and serve as summaries of the database contents. For
information on importing or exporting views, see Appendix B.
Standard views
A standard outline view acts like a table of contents for a database and is
the most common type of view. It organizes documents in rows and
columns. Rows display selected pieces of information from one document.
To open a document, Notes users double-click a row; Web users click a link
in one of the columns.
These screens compare how a Discussion view as it appears to both
Netscape Navigator users and Notes users.
103
Calendar views
A calendar view groups documents within date blocks. Such views are
useful for organizing schedules, meetings, and appointments.
When you create a calendar view, users have access to the following
features:
Choices for viewing entries in a Two-Day, Week, Two-Week, Month,
Year format.
Point-and-click navigation among days, months, and years.
The ability to create new calendar entries and edit existing entries.
Integrated Task, Event, and Anniversary display.
The ability to print calendar entries for a selected range of days.
Shared views
Shared views are views that are available to any users with at least Reader
access to the database. Most views that you design for databases are shared
views. Users with Designer or Manager access can create shared views, as
can Editors for whom the manager has selected Create personal
folders/views in the access control list.
Naming tips
Views appear in alphabetical order in menus and lists. To force names
to appear in a different order, number or letter them.
When possible, assign a name that indicates how the view sorts
documents for example, By Company Name or All by Category or
specifies which documents it includes, for example, New Customers.
Use consistent names across databases to make it easier for users to
recognize views.
Naming techniques
Hidden views
When you surround a name with parentheses for example, (All) the
view does not appear to Notes users in the Notes view menu or to Web
users or Notes users in the folders pane.
For other ways to hide views, see About hiding a view later in this
chapter.
Shortcut keys
The shortcut (an underlined letter) is easy to see on the View menu because
its the first letter of the name, and Windows, OS/2, and UNIX users can
type the letter to select the view. But if views or folders begin with the same
letter, the default shortcut is the first letter that has not already been used
by a preceding name. This can result in shortcuts that are difficult to see
and remember. For example, the shortcuts (underlined) for these views are
By Author
By Date
You can rename the views and omit the repeated word, but in some cases
the word is needed to make the names understandable.
Authors
Dates
Cascading views
If you dont want to overwhelm users with long lists or if you have related
views that should be grouped together, you can arrange them in a hierarchy
so that a group of related menu items are organized under one item in the
navigator pane. A user clicks on the higher-level name to display the
cascaded list.
If you didnt specify a cascading view when you created the view, enter the
name you want to appear on the Create menu followed by a \ (backslash),
followed by the view name. For example, the Personal Address Book
template has two views related to servers:
Server\Certificates
Server\Connections
Omitting a title
If you leave the title blank, the column doesnt have any identifying text.
Omit a title if the column is:
A responses-only column that indents response documents
A categorizing column
Hidden (and designers dont need any identifying text when the view is
in design mode)
Not relevant to users
Details
If you select the column sorting option Show multiple values as separate
entries for the first column, documents display within multiple date
blocks. Otherwise, they display only in the first matching date block. The
Mail template uses this technique for displaying repeating events.
Troubleshooting a calendar view
If the calendar view does not display as you expect, there may be a problem
with the selection formula or with the definition of the first column.
Check the selection formula for the view. Make sure the documents you
want to display in the view match the selection formula. To test the
selection formula, change the view to a standard view or refresh the view
while in design mode. If the documents display, the selection formula is
valid.
Make sure the first column of the view is based on a date/time field and is
sorted in ascending order. Display the column in design mode. Both the
date and time should display. The date determines where the document
displays in the view, and the time sorts entries in the correct order, so that a
9:00 AM appointment displays before a 3:00 PM appointment.
Formula
Formula allows you to create a program for document selection that uses
the @function formula language. In the design pane, click Formula and
write the formula in the window below.
Examples
Selecting documents by form name and field value
If a database contains an Action Item form and a Status field on that form, a
view in the database can select all documents that were created with the
Action Item form whose Status field contains the value Open. The
selection formula is:
SELECT Form =Action Item & Status=Open
Selecting only non-response documents
To select only documents that were created with main document forms and
exclude documents created with response or response-to-response forms,
use this formula:
SELECT !@IsResponseDoc
Selecting main and response documents
If a database contains a form called Action Item, you can select all
documents that were created with the Action Item form, as well as
responses to these documents, using the formula:
SELECT Form = Action Item | @IsResponseDoc
By form name
When selecting By Form as a condition for a selection formula, the
condition works only with forms that are part of the database design, not
with forms stored in documents.
Simple functions
Simple functions allow you to add programming without knowing a
programming language. In the design pane, click Simple function and
choose the function you want. The default selection for a new column is #
in View which numbers documents according to their internal sequence.
Formula
Formula allows you to create a program for a column using the @function
formula language. This is useful when you need to process values in a
document first (such as changing field values to a text value) or calculate a
value. Typical uses for formulas include converting field data to a text
value (because only text values display in columns), writing a formula that
displays an icon instead of a value, and adding text to field values. In the
design pane, click Formula and write the formula in the window below.
Use the Fields & Functions button to paste fields, @functions, or
@commands into the formula. Column formulas can consist of a
combination of @functions, @commands, field values, and text enclosed in
quotation marks.
Always convert information to the data type that your formula expects. For
example, to append a numeric value to a text value in a column, use a
formula like:
Product + : + @Text(Quantity)
Examples
Determining text, based on a field value
You can show custom text in a column, based on various conditions for
example, whether sales were above a certain number. This formula tests the
value in the Sales_February field (a number field) and displays text based
on that value:
@If(Sales_February>60000;Great month!;)
Determining text, based on the form name
The Subject column in the All Documents view of the Combined Mail (R4.6)
template uses the following formula to display a subject line that is
appropriate to the form with which the document was created:
@If(Form = NonDelivery Report; DELIVERY FAILURE: +
FailureReason; Form = Delivery Report; DELIVERED: +
Subject; Form = Return Receipt; RECEIVED: + Subject;
Form = ReturnNonReceipt; NOT RECEIVED: + Subject;
Subject)
Auto-sorted columns
To set up a sorting style in advance, select the option Sort: Ascending or
Sort: Descending on the Sorting tab of the Column Properties box. The
sorting column is usually one that appears on the left side of the view.
User-sorted columns
Users see a triangle next to a column title whose values can be resorted.
Users click the column and choose a sorting method to see the documents
in the order they choose.
Details
Show
Today and time shows values resulting in the current date with the word
Today. Values resulting in the previous day display Yesterday. All
other values display the date.
Date format
If you have an international date format set in your operating system, these
choices change, for example to suit the national conventions, for example,
from month/day to day/month.
Time format
If you have an international time format set in your operating system, these
choices change, for example, from 02:30 to 14:30.
This chapter explains how to create graphical navigators that help users
find documents and use the database.
About navigators
A database navigator is like a roadmap that directs users to particular parts
of an application. The basic Notes navigator presents a graphical display of
folders, views, and design elements, but you can create a custom navigator
that uses graphics, formulas, or scripts to best present your application.
Most navigators include hotspots that is, programmed areas that a
user clicks to execute an action. A hotspot can be text, graphics, or a
combination.
For example, Notes Help has a navigator to help users find specific topics
quickly. When users open Help, the introductory screen shows graphic
buttons. Clicking a graphic button leads to a particular view in the Help
database.
In most applications, you want the navigator to display automatically when
the application opens.
If your navigator inherits its design from a master template, do not make
any changes to the design of your navigator, since any changes you make
will be over-written by the master template.
Navigator objects
You create a navigator by combining objects. These might include a
background graphic for display only, and some combination of graphic
buttons and text objects. To create navigator objects, import or paste objects
from another application, or use the drawing tools Notes supplies. The
drawing tools include hotspot tools that you use to define a clickable area in
a navigator.
147
Navigator actions
A navigator action determines what happens when users click an object.
You can add actions to all navigator objects except those pasted or
imported as graphic backgrounds.
Designer provides the following simple actions that you can attach to
navigators:
Open another navigator
Open a view
Serve as an alias for a folder
Clicking the object displays the contents of the designated folder in the
view pane; dragging and dropping a document in the folder object adds
the document to the actual folder.
Open a database, view, or document link
Open a URL
To create more complex flexible actions use @function formulas or a
LotusScript program. LotusScript programs can perform tasks that arent
possible with @function formulas for example, manipulating a database
ACL.
For more information on writing formulas and scripts for buttons and
hotspots, see the Programmers Guide.
Editing a navigator
To edit an existing navigator, open the navigator in design mode. Choose
Design - Navigator Properties and make changes as needed.
Details
Run options specify what happens when users click the object.
Click Simple action to choose a predefined automation, such as Open a
View.
Click Formula to define an action using the formula language.
Click Script to define an action using LotusScript.
For more information on adding an action, formula, or script to a navigator,
see Automating a navigator later in this chapter.
To create a hotspot
1. Open a navigator in design mode.
2. Select a hotspot tool from the SmartIcons palette. Hotspot tools are
red.
3. Click on the navigator and drag to create the hotspot. The polygon tool
allows you to create a line segment each time you click. Double-click to
complete the drawing and close the polyline hotspot.
4. Double-click the hotspot to edit its properties.
Custom actions
You can use an @function formula or a LotusScript program to define a
custom action. A navigator that runs an @function formula allows you to
create specialized actions that arent related to switching to a view, a folder,
a navigator, or a link.
Automating a navigator
To attach an action
1. Select the database and choose View - Design.
2. In the navigation pane, click Design - Navigators.
3. Double-click the navigator.
Examples
Opening a view
A navigator that switches to another view gives users a graphical way to
choose a view so they dont have to know the name of a view in the view
pane. The Main Navigator in the Discussion template uses objects to open
these views: All Documents, By Category, and By Author.
Making a navigator object that opens a navigator
A navigator that switches to another navigator is a graphical way to guide
users through a series of decisions to reach the information they need.
This navigator displays a bar chart created in 1-2-3. Users click a bar that
represents an areas sales to find out more information. Each bar in the first
navigator is a hotspot rectangle whose Switch to another navigator action
specifies the Weekly Details by Country navigator.
The action for the icon is Run a formula with the formula:
@Command([Compose];;3. Action Item)
Details
Open designated navigator in its own window causes the chosen
navigator to display as a full screen. The regular navigation, view, and
preview panes are not available from a full-screen navigator, but users can
choose View - <view name> to return to a specific view.
Testing a navigator
1. Select the database and choose View - Design.
2. In the navigation pane, click Design - Navigators.
3. Double-click the navigator.
4. Choose Design - Preview in Notes or Design - Preview in Web Browser.
5. Highlight and click each object to see if the highlighting and actions are
as you expected.
Clicking an object while previewing in Notes describes the
programmed action but does not perform it.
Clicking an object while previewing for a browser loads the browser
specified in the current location document and performs the action.
6. If the test produces unexpected results, choose Design - Preview in
Notes or Design - Preview in Web Browser to return to design mode.
7. Correct the problems and run the test again.
8. When the test shows no problems, close and save the navigator.
For information on previewing using a Web browser, see Chapter 10.
159
Automation features
Context User-activated automation Event-driven automation
Database Agents Agents
Database events
View Agents Agents
View actions View events
Document Agents Agents
Form actions Form events
Document buttons Field events
Document hotspots Action events
Button events
Hotspot events
Agent events
Users see the form action bar when they open a document created with a
form that has form actions that were designed to display in the action bar.
Naming tips
Choose short names for form and view actions that you design to
appear as action bar buttons.
Choices on the Actions menu appear in alphabetical order. To force
names to appear in a different order, number or letter them.
Use consistent names across databases to enable users to recognize
identical agents and actions.
Naming techniques
Alias names
An alias is an internal name for an agent. Using an alias, you can change or
translate the name that users see without disabling formulas that reference
the original name. Aliases follow the same naming rules as regular names.
Alias names dont work with form and view actions.
Shortcut keys
A shortcut key is an underlined letter in a choice on the Actions menu.
Windows, OS/2, and UNIX users type only the shortcut letter to select the
menu item. To specify a shortcut, type an underscore before the letter you
want to assign as the shortcut. For example, S is the shortcut for this Save
action:
_Save
Notes ignores the underline when it displays the name of an action on the
action bar.
Cascading names
If you dont want to overwhelm users with long lists or if you have related
actions or agents that should be grouped together, group them so that
related menu choices appear under one main menu choice. You can create
only one level of cascading names.
Enter the name you want to appear on the Actions menu followed by a \
(backslash), followed by the action or agent name. For example:
Mail Tools\Add Sender to Address Book
Mail Tools\Choose Letterhead
Actions that also display in the action bar show only the name after the
backslash.
The Calendar Profile agent in the Combined Mail (4.6) template contains a
name that has a shortcut key, a cascading name, and an alias:
_Calendar Tools\Calendar Profile... | Calendar Profile
From the agent view pane, you can run, test, and enable or disable agents.
Highlight an agent name and choose Actions - Run, Actions - Test, or
Actions - Enable. Double-click the name of an agent in the list to open it in
Design mode.
Details
Manually From Actions Menu
Choose this for all user-activated agents or those triggered by
WebQuerySave or WebQueryOpen agents or formulas. It is the only choice
that allows users to see the agent in the Actions menu.
Manually From Agent List
Use for hiding agents that are run by another agent or that are that are still
being developed.
If the agent is called by another agent (the main agent), the document
selection is ignored. The main agent always determines the document
selection.
If New Mail Has Arrived
Use for processing incoming mail to respond to it, forward it, or file it.
Interactive functions and functions that impede the progress of the mail
router are ignored when documents are mailed into the database. For
example:
@DbColumn
@DbCommand
@DbLookup
@MailSend
@Prompt
@Command
@PostedCommand
If Documents Have Been Created or Modified
Use for workflow tasks where an action is performed based on new or
changed documents.
About events
When users open a database and work with documents, Notes identifies the
events for example, opening a database, opening a view, opening a
document that occur as users proceed through the database. To
automate a piece of work, check for errors, prohibit certain actions, or
prompt for user input, you can attach programming to these events.
Examples include displaying an error message if a user closes a document
without filling in a required field, recalculating fields when a user saves a
document, preventing users from pasting documents, or displaying a
prompt when a user clicks a button. Choose programmed events rather
than agents when the timing of the program must be precise or the program
is tied to a particular design element.
Hide when previewed for editing; Hide when opened for editing
Hides the object when a document is opened in edit mode from the preview
pane or as an open document. These are useful for actions that are relevant
only to completed documents for example, moving documents to
another database, creating response documents, or marking documents as
unread.
Simple actions
Using the simple actions supplied with Designer, you can add automation
to elements without knowing a programming language. In the design pane,
click Simple action(s), then click Add Action and choose an action from
Action list. To delete a simple action, click it in the formula window, and
choose Edit - Clear. Simple actions cant be customized and are not
supported in Web applications.
Formulas
You can write an @function formula that runs by itself or with a simple
action. You cannot combine an @function formula with a LotusScript
program.
To write a stand-alone formula, click Formula in the design pane and
write the formula in the window below.
To combine a formula with a simple action, click Simple action(s) and
then click Add Action. Choose @function formula from the Action list
and write the formula in the editing window.
Click Fields & Functions to select an @function or field and paste it into
your formula. Click @Commands to select and paste an @command into
your formula.
LotusScript
To write a LotusScript program, click Script and write the program in the
editing window.
Java
To attach a Java program to an agent, write the program in a Java
development environment, and then click Java and click Import Class
Files to import the files into the agent.
Details
Copy to Database
You can copy and paste selected documents in the same database or
another database. They are marked as read in the destination database.
Copy to Folder
Using an action to copy a document from one folder to another does not
remove the document from the source folder. A duplicate of the document
is not created; instead the document is displayed in a new place.
Examples
Using a button to add a database to a users workspace
The Human Resources department sends new employees a mail message
that welcomes them to the company and gives them orientation
information. You decide to add a button to the Welcome form to make it
easy for new users to find Benefits information. New employees see the
button when they read their Welcome message. Double-clicking the button
adds Server1s Benefits Information database to the users workspace (if it
isnt already there) and opens it to the View by Category view. The button
uses this formula:
@Command([FileOpenDatabase];Server1:BENEFITS.NSF;View by
Category)
Examples
Using a hotspot graphic to give users additional information
You want to give users information about printing a Conference Room
Schedule document. You create a hotspot graphic (with a picture of a
printer) on the Schedule form and add the following formula. You choose
the hide option for the graphic so that it is hidden when the document is
printed.
@Prompt([OK]; Printing Tip; Click the Print button. Then
select Setup... and choose Landscape orientation. This
picture will not show on the printout.)
Examples
Displaying a message when users close a document
The following QueryClose event script for a form displays a message when
users close a document theyve edited:
Creating an agent
1. Select the database and choose Create - Agent.
2. Give the agent a name.
3. Click Shared agent.
4. Select an option for When should this agent run?
5. Select an option for Which document(s) should it act on?
6. (Optional) To refine the document selection, click Add Search and
specify additional selection conditions.
7. (Optional) Click Options to add a short description or to make search
results visible to users.
8. Add the programming for the agent, using the Initialize event.
9. Save the agent.
201
Electronic signatures confirm that documents or document sections
mailed from one user to another are not tampered with before reaching
their destination.
To restrict access to parts of the design, use these features:
Restrict who can create agents and where the agents can run. Most
users can create private agents to run on local databases; some users
can also create shared agents that run on servers for use by other users.
Secure the design of a database to prevent users from changing design
elements.
For information on restricting agents, see Chapter 7. For information on
securing a database using the access control list, see the Database Managers
Guide.
Details
Do not create a read access list for the default view of a database.
Servers that need to replicate a database need access to views that are
read-restricted so that view design changes can replicate.
Authorized readers
The following people can read a document that has restricted read access:
Users listed in the forms read access list
Users listed in the forms Readers field
Readers field names are added to a documents read access list.
Users listed in the author name field in the document
Details
To ensure that the database will replicate correctly, include the names of
replicating servers in the reader names list.
Choices for generating a list of readers or authors
Unless None is selected as the lookup option, users either press
CTRL+ENTER or, if chosen for the field, the entry helper button to see a list
of possible entries. If the Readers field is located inside a layout region,
leave None selected; other lookup options do not apply.
Choose one of these options for generating a readers or authors list:
None
If you select None, you rely on a formula or on authors to create the list
of names. Select Look up names as each character is entered to speed
up typing in editable fields. Notes fills in the first name that matches
the characters the user types.
Use Address dialog for choices
This option displays the Names dialog box so users can select names
from a Personal or Public Address Book. Select Look up names as each
character is entered to help users fill in a name quickly. Notes looks up
a match for the typed letters in the open Address Book.
Use access control list for choices
This option brings up a list of people, servers, groups, and roles in the
access control list.
Use View dialog for choices
This option brings up a dialog box containing entries from a column in
a Notes database view. Select the database to look up, select a view,
and select a column number.
Examples
Adding a Readers field to a form
You want to be sure that employees can read only their own Employee
Information documents. Create a computed-when-composed Readers field
named AuthorizedReader that uses this formula:
@UserName
To add additional authorized readers, create a read access list in the
Document Properties box for individual documents.
Details
You have three choices for associating encryption keys with documents.
Encrypt all documents with the same encryption key
This is the most convenient for users, but doesnt give them the
flexibility of choosing an encryption key.
Create a field that generates a list of frequently used keys
Examples
For an Employee Information database, the Salary History form has a create
access list that allows only members of the Financials group to create Salary
History documents. The database managers want to allow only four people
in the Financials group to see salary information and to edit Salary History
documents.
The database manager can create an encryption key and distribute it to the
select group or identify the four people and encrypt the information using
their public encryption keys.
In the first instance, the database manager creates an encryption key called
Salary and sends it to the four people in the Financials group, and to the
database designer. The database designer enables encryption for the
CurrentSalary field and associates the Salary encryption key with the form.
This allows the four people in the Financials group who have the Salary
encryption key to create, read, and edit encrypted salary history
documents, including the data in the CurrentSalary field.
In the second case, the manager provides the names of the four people to
the database designer, who chooses their names from the Public Encryption
key list associated with the CurrentSalary field. Then the people from
Details
Encryption keys and private keys in Notes IDs
Every Notes User ID has a public key and private key that encrypt mail,
fields, and documents and verify a writers identity. A User ID may also
contain additional encryption keys that encrypt and decrypt regular
documents.
When you design a form, you can use the public key for encryption or
create a new encryption key. If you create a new encryption key, Notes
automatically stores it in your User ID. If someone sends you an encryption
key, Notes stores the new key in your User ID, along with any other keys.
North American and International encryption keys
Notes uses two schemes for creating encryption keys. One scheme is for
North American (United States and Canada) use only, and the other is for
use anywhere in the world. If you are designing a database for users in the
United States and Canada and in other countries, create domestic and
international versions of the encryption key.
Details
To encrypt all documents created with a form, you enable encryption for
one or more of its fields in the Field Properties box and assign one or more
existing encryption keys to the form in the Form Properties box. If you use
secret rather than public encryption keys, the database manager is in charge
of distributing the encryption keys to all users who need them.
Whenever someone saves a new document composed with that form, all
the encryptable fields in that document are encrypted using the key(s) you
Details
Users must have a copy of the encryption key so that they can save
documents. The database manager is in charge of distributing secret
encryption keys to all users who need them.
If the SecretEncryptionKeys field is empty (null), the document isnt
encrypted.
Examples
Computing an editors list from the access control list
The status section of a Business Card Request form has an access-controlled
section whose formula allows only administrators (an access role in the
access control list) to change the status of a request. The formula for the
computed field is:
[Business Card Administrators]
Allowing the author to name section editors
An editable section of a Status Report form has an access-controlled section
whose default value formula always allows the author to edit the status
report.
@UserName
The author can choose Section - Define Editors to name additional editors
for a particular status report.
227
Creating a database icon
You can create a database icon by copying an icon from another database
and pasting it in, by pasting a bitmap from a graphics application, or by
creating an icon in Notes.
Examples
For a text field named Supervisor:
Enter the name of the person to whom you report.
For a keywords field that presents check boxes:
Select as many options as apply.
For a required Subject field:
Required: You must add a brief description.
Details
Setting the database property to launch the first link in the About This
Database document gives users access to information in another application
from a Notes database. For example, to collect spreadsheet data for use in
the application, launch a link to a spreadsheet application so users
immediately see the spreadsheet when they open the database. Data
entered in the spreadsheet can be used to populate fields in the application
Details
Database information
Select Database to display the database title, location, categories, and so
on.
Select Space usage to display the file size, number of documents, space
used by the database, and so on.
Select Replication to display the database replication settings.
Select Access List to display a name-by-name listing of the ACL, with
the access level and access roles assigned to each.
Design information
Select Shared field to display the options chosen for each shared field in
the database.
Select Stored query to display the formula and selected options for full
text search queries saved with the database.
Select Agent to display the options and formulas chosen for each shared
and private agent.
Select Forms and select one or more forms or subforms to display the
options chosen for the component and its non-shared fields.
Select Views and select one or more views or folders to display the
options chosen for each shared view or folder and its columns, as well as
any navigators in the database.
243
Glossary of Web terms for application developers
This glossary helps you understand Web terminology within the context of
the Notes Designer application development environment.
Home page
A home page is a special Web page that you designate as the entry point for
a Web site. It usually contains information about the site, a contents listing,
and links to other parts of the site. When you create Web databases within
Notes, you can use the Web Pages template to create home pages within a
Web pages database or choose from several methods for assigning your
sites home pages, including auto-launch About This Database documents,
auto-launch navigators, and stand-alone HTML files.
HTTP
Hypertext Transfer Protocol (HTTP) is the standard Internet protocol that
enables Web clients to access information stored on Web servers. The
Domino server speaks HTTP 1.1, enabling Web clients to communicate
with Notes servers and access databases stored on the servers. Any Domino
server can serve Web users if the Notes system administrator loads the
HTTP server task.
HTML
Hypertext Markup Language (HTML) is the code Web developers use to
format text for the Web. Each page you see on the Web uses HTML
instructions to display images and text. Domino uses HTML when it
displays database information to Web users.
URL
The Uniform Resource Locator (URL) interface is the standard Internet
protocol that enables Web clients to request specific pages from Web
servers. When you type in a URL for example, http://www.lotus.com
the Web client (your browser) sends the request to the HTTP server. Each
Web page has its own URL.
Traditional Web servers use URLs to determine which pages to display to
users. Domino servers, unlike traditional Web servers, assign URLs to
database elements to determine where data is located and how to display it
to users. You can build URLs into forms and views to automatically open
databases, views, forms, and so on. This example opens the database
webapp.nsf on a fictitious server named www.mercury.com:
http://www.mercury.com/webapp.nsf?OpenDatabase
Web site
A traditional Web site is a collection of related HTML files that have
interconnected links which users use to jump from one file to another.
When you create Web databases within Notes, your Web site consists of
one or more databases that store the content and design of the site. Views,
navigators, hotspots, and links give users access to different parts of the
site. Web sites that you use Notes Designer for Domino to construct have
links that are dynamically generated. You do not have to code them
manually.
Documents
Documents are individual Web pages that store the data for a database.
Web developers create documents to provide information about the
database or Web site. Web users create documents to participate in
discussions and workflow processes. Documents can contain text, graphics,
fields, applets, HTML, embedded navigators, and embedded views.
To create documents from the Web, users need a button that simulates the
Notes Create - <form> menu command. You can build the button into a
view, a navigator, or an About This Database document. Web users fill in
the necessary information on the form and then click the button to save the
document in the database.
Fields
A field in a document contains one piece of information, such as a persons
name, a comment, a number, a date, or the results of a calculation. When
developers create fields on forms, theyre creating a data holder for that
piece of information. In Web applications, fields also can contain Web
pages, multimedia objects, graphics, and files. The form Web users choose
when they create a document determines which fields the document
contains.
Forms
Forms are design elements that give users a framework for entering new
information in a database and for viewing existing information. They are
similar to Web input forms that solicit information from users, but are used
not only for inputting new data, but for displaying existing data. Most
databases have forms for different kinds of information. For example, a
discussion database usually includes a form to begin a new topic of
discussion and another form to respond to topics. You can associate forms
with other design elements, such as views and navigators, to create
sophisticated Web effects.
Templates
A template is a pre-designed database that you use to create new databases
quickly. When you create a database and base its design on a template, you
receive a number of forms, views, and navigators that determine how this
database looks and functions. Templates have file names that end in .NTF.
Several Notes Designer templates are helpful for Web developers,
including:
Web Pages (R4.6) (pagesw46.ntf)
Discussion - Notes & Web (R4.6) (discsw46.ntf)
Doc Library - Notes & Web (R4.6) (doclbw46.ntf)
Frameset (R4.6) (framew46.ntf)
For more information about Notes Designer templates and sample
databases, see Appendix A.
Views
A view is the entry point for opening and reading documents. Web users
click a link to open a document. Most database designs use several views to
organize and present documents in different ways. Think of views as
HTML index files that have automatic updating functions, programming
features, and graphics.
About specifying the Web site home page in the Server document
To make a Notes design element the site home page, edit the Home URL
field in the Server document or a Virtual Server document and specify a
URL that includes the design element.
If you set an About This Database database document, navigator, or
document to launch automatically when a user opens the database, the
Home URL need only open the database to launch the design element. The
syntax is:
/databasename.nsf
This URL opens the Our Home database and displays whatever is selected
in the On Web Open launch setting:
/ourhome.nsf
To open a navigator automatically, include the navigator name in the URL.
The syntax is:
/databasename.nsf/navigatorname
This URL opens the Main Navigator in the Our Home database:
/ourhome.nsf/Main+Navigator
To open a view automatically, include the view name in the Home URL.
The syntax is:
/databasename.nsf/viewname
This URL launches the Contents view of the Our Home database:
/ourhome.nsf/Contents
Requirements
Windows 95 or NT workstation
The Web preview process uses the access assigned to -Default- or, if
available, an entry called Anonymous. One of those entries needs
Reader access to let you preview Web documents, navigators, and
views. One of those entries needs Author access to let you preview Web
forms.
The element to be previewed must reside in a database under the Notes
data directory on the local machine or on a server running the HTTP
task.
The element to be previewed must not be marked as hidden from Web
browsers.
Set up your browser(s) to override proxy settings (described below).
Examples
The Our Companys Web Site document in the Site 3 Samples database
(site3w46.nsf) uses computed text and HTML code to find an image file
within the current database.
The computed text (shown with a border in the figure above) uses the
formula:
tmpDb
to return the value of the field whose formula:
@Subset(@DbName;-1)
generates the name of the database.
Standard views
Unless you use HTML formatting to customize a view, it maintains the
column and row format of standard Notes views, but with these
differences:
Domino generates a Web navigation bar at the top and bottom of the
screen. This navigation bar contains buttons that users click to expand,
collapse, and scroll the view.
Users open documents by clicking a document-link column rather than
clicking anywhere in the row.
Compare the Discussion view shown through Netscape Navigator with the
same view shown through Notes.
Calendar views
Web users can see all calendar entries. Domino converts calendar views to
HTML tables. Therefore, Domino restrictions for tables also apply to
calendar views. Conflict bars and the clock are not supported on the Web,
nor are creating new appointments and scrolling through entries within a
single day.
Folders
Web users cannot drag documents into folders.
Details
A form can have only one embedded view and one embedded folder pane.
You can embed navigators and views anywhere on a document, form, or
subform, including in tables, as part of collapsed sections, and as left-,
right-, or center-aligned design elements.
Domino disregards the view title and background color of embedded views
and uses settings on the Server document to determine the number of lines
to display. Domino prevents view opening if there are create or read access
lists on a form in which views are embedded.
$$ Fields
For compatibility with previous releases, the reserved fields $$ViewBody,
$$ViewList, and $$NavigatorBody still work. The fields must be text fields
that are editable or any computed type. You can combine these fields on the
same form for example, one $$ViewBody field, one $$ViewList field, and
several $$NavigatorBody fields.
Field name Value Comments
$$ViewBody View name (in quotes) or Same as Embedded View.
a formula that computes
the view name
$$ViewList None Same as Embedded Folder Pane.
$$NavigatorBody, Navigator name (in Same as Embedded Navigator. To
$$NavigatorBody_n quotes) or a formula that create multiple $$NavigatorBody
computes the navigator fields on a form, append an
name underscore and a character to
each subsequent field name.
Examples
The following examples use a $$HTMLHead field in a database.
Adding a Meta tag
A $$HTMLHead field with the following formula adds the Meta tag
keyword with a value of gold to the Head tag in a document.
<meta name=\keyword\ content=\gold\>
Preparing graphics
Your goal, when preparing a graphic, is to have it look as much as possible
like the graphic you created in your drawing program. How graphics look
depends on the users:
Viewer Notes client or a Web browser
Operating system Macintosh, Windows NT, Windows 95, OS/2, or
UNIX
Color mode 16-color mode, 256-color mode or High/True/24-bit
color mode
Sizing graphics
Domino passes the size and scaling information for graphics to the browser.
If the browser supports scaling, the graphic has the same size and scale as it
does in Notes; otherwise, the graphic appears in its original size, regardless
of how you size it in Notes.
Fonts
If the fonts used are not the system defaults for example, in Windows,
Helvetica and Times Roman Domino converts font instructions to the
HTML <FONT> tag and FACE= attribute to approximate the original font
choice. Text may look different to a Web user than it does to a Notes user
because the browser determines which fonts to use.
Size
Domino maps the text size you select in Notes to an HTML text size. The
following table lists the text size in Notes Designer and the corresponding
HTML size.
Preserving spaces
To align a column of numbers or preserve or insert spaces, use the default
monospaced font. On a Windows system, the default monospaced font is
Courier. Domino converts the default monospaced font to a monospaced
font on the Web and preserves any spaces you enter.
WebQueryOpen events
A WebQueryOpen event runs the agent before Domino converts a
document to HTML and sends it to the browser. Domino ignores any
output produced by the agent in this context.
Examples for using this agent include performing large computations that
arent possible with @commands or collecting statistics about who opened
documents and when.
Examples
ACL for high-security confidential database
Default No access
Anonymous No access
Authorized readers Reader
Contributors Author
Supervisors Editor
Maximum Internet name & password access Reader
ACL for medium-security project database
Default Reader
Anonymous No access
Authorized readers Reader
Project team members Editor
Maximum Internet name & password access Editor
Linking to URLs
To add a link to an external site, use Create - Hotspot - URL Link to create a
URL in a document or form.
Examples
This script uses the Print statement and the CGI variable remote_user to
display User = and the Web users name. The script sets the
DocumentContext before executing the rest of the script. The variable
assumes a text list.
Dim session As New NotesSession
Dim doc As NotesDocument
Set doc = session.DocumentContext
Print User = + doc.remote_user(0)
Syntax Guidelines
Domino URLs do not use the server name. Host identifies the server.
Special identifiers used in Domino URL commands include:
$defaultView, $defaultForm, $defaultNav, $searchForm, $file, $icon,
$help, $about, and $first.
NotesObject can be any of the following: for a database, the database
name or replica ID; for other objects, the Notes objects name, universal
ID, NoteID or special identifier. For example, to specify a view in a
URL, you can use any of the following: the view name, view universal
ID, view NoteID, or $defaultView.
A Notes objects name and universal ID are identical in all replicas of a
database, but the Notes objects NoteID will probably change in
database replicas. Therefore, it is best to use the Notes object name or
universal ID in URLs. One name or alias can refer to two objects for
example, two forms with the same name when one is hidden from
Notes users and one is hidden from Web users.
Action can be explicit or implicit. Examples of explicit actions include
?OpenServer, ?OpenDatabase, ?OpenView, ?OpenDocument,
?OpenForm, and ?EditDocument. Examples of implicit actions include
?Open, ?Edit, and ?Delete. If you do not specify an action, Domino
defaults to the ?Open action.
To require user authentication, append the Login argument to any
Domino URL.
Because URLs cannot contain spaces, use the + (plus sign) as a
separator. For example:
http://www.mercury.com/discussion.nsf/By+Author
Separate arguments with & (ampersand). For example:
http://www.mercury.com/leads.nsf/By+Salesperson?OpenView&
ExpandView
Separate hierarchical names with / (slash). For example, to open a view
named Docs\By Author in a database named Discussion, enter:
http://www.mercury.com/discussion.nsf/Docs/By+Author
OpenServer
Syntax
http://Host/?OpenServer
Example
http://www.mercury.com/?OpenServer
OpenDatabase
Syntax
http://Host/DatabaseFileName?OpenDatabase
http://Host/DatabaseReplicaID?OpenDatabase
Examples
http://www.mercury.com/leads.nsf?OpenDatabase
http://www.mercury.com/sales/discussion.nsf?OpenDatabase
http://www.mercury.com/852562F3007ABFD6?OpenDatabase
OpenView
Syntax
http://Host/Database/ViewName?OpenView
http://Host/Database/ViewUniversalID?OpenView
http://Host/Database/ViewNoteID?OpenView
http://Host/Database/$defaultview?OpenView
Examples
http://www.mercury.com/leads.nsf/By+Salesperson?OpenView
http://www.mercury.com/leads.nsf/DDC087A8ACE170F8852562F300702
264?OpenView
http://www.mercury.com/leads.nsf/00000196?OpenView
http://www.mercury.com/leads.nsf/$defaultview?OpenView
OpenAbout
Use the OpenAbout command to access the About This Database
document.
Syntax
http://Host/Database/$about?OpenAbout
Example
http://www.mercury.com/leads.nsf/$about?OpenAbout
OpenHelp
Use the OpenHelp command to access the Using This Database document.
Syntax
http://Host/Database/$help?OpenHelp
Example
http://www.mercury.com/leads.nsf/$help?OpenHelp
OpenIcon
Use the OpenIcon command to access the database icon.
Syntax
http://Host/Database/$icon?OpenIcon
Example
http://www.mercury.com/leads.nsf/$icon?OpenIcon
OpenForm
Syntax
http://Host/Database/FormName?OpenForm
http://Host/Database/FormUniversalID?OpenForm
http://Host/Database/FormNoteID?OpenForm
http://Host/Database/$defaultform?OpenForm
Examples
http://www.mercury.com/products.nsf/Product?OpenForm
OpenNavigator
Syntax
http://Host/Database/NavigatorName?OpenNavigator
http://Host/Database/NavigatorUniversalID?OpenNavigator
http://Host/Database/NavigatorNoteID?OpenNavigator
http://Host/Database/$defaultNav?OpenNavigator
$defaultNav opens the folders pane in a database.
Examples
http://www.mercury.com/products.nsf/Main+Navigator?OpenNavigator
http://www.mercury.com/products.nsf/7B5BC17C7DC9EB7E85256207004
F8862?OpenNavigator
http://www.mercury.com/products.nsf/000001AA?OpenNavigator
http://www.mercury.com/products.nsf/$defaultNav?OpenNavigator
OpenAgent
Syntax
http://Host/Database/AgentName?OpenAgent
http://Host/Database/AgentUniversalID?OpenAgent
OpenDocument
Syntax
http://Host/Database/View/Document?OpenDocument
Where:
Document is any of the following:
DocumentKey the contents of the first sorted column in the specified
view.
DocumentUniversalID
DocumentNoteID
$first the first document in the view
Examples
http://www.mercury.com/products.nsf/By+Part+Number/
PC156?OpenDocument
http://www.mercury.com/leads.nsf/By+Rep/35AE8FBFA573336A852563
D100741784?OpenDocument
http://www.mercury.com/leads.nsf/By+Region/
0000229E?OpenDocument
EditDocument
Syntax
http://Host/Database/View/Document?EditDocument
Example
http://www.mercury.com/products.nsf/By+Part+Number/
PC156?EditDocument
CreateDocument
The CreateDocument command is used as the POST action of an HTML
form. When the user submits a form, Domino obtains the data entered in
the form and creates a document.
Syntax
http://Host/Database/Form?CreateDocument
Example
http://www.mercury.com/products.nsf/b9815a87b36a85d9852563df004a9
533?CreateDocument
SaveDocument
The SaveDocument command is used as the POST action of a document
being edited. Domino updates the document with the new data entered in
the form.
Syntax
http://Host/Database/View/Document?SaveDocument
Example
http://www.mercury.com/products.nsf/a0cefa69d38ad9ed8525631b00658
2d0/4c95c7c6700160e2852563df0078cfeb?SaveDocument
OpenElement
Use the ?OpenElement command to access file attachments, image files, and
OLE objects.
SearchSite
Use SearchSite URLs for text searches in multiple databases. Because the
URL requires the name of a search site database, be sure to create one
before using a SearchSite URL.
Syntax
http://Host/Database/[$SearchForm]?SearchSite[ArgumentList]
Where:
SearchView
Use SearchView URLs to limit a search to documents displayed in one
database view.
This URL is useful for views that display all documents (so you can have a
full-database search) or for views in which you can predict what users need
to see, such as all documents whose status is Completed.
Syntax
http://Host/Database/View/[$SearchForm]?SearchView[ArgumentList]
Where:
$SearchForm and ArgumentList are optional arguments. The special
identifier $SearchForm indicates that Domino will present a search view
form for search input. If this identifier is provided, the ArgumentList is
ignored.
Example
http://www.mercury.com/products.nsf/By+Product+Number/
$SearchForm?SearchView
Login argument
To force user authentication regardless of the database access control list,
append the Login argument to any Domino URL. This ensures that
anonymous Web users who werent initially prompted for a name and
password when they entered the site are required to supply a name and
password to complete tasks that require user identity.
Syntax
http://Host/?OpenServer&login
http://Host/DatabaseDirectory/DatabaseFileName?OpenDatabase&login
Examples
http://www.mercury.com?OpenServer&login
http://www.mercury.com/sales/leads.nsf?OpenDatabase&login
Examples
http://www.mercury.com/certs.nsf/UserCertificateRequest?OpenForm
&SpecialAction=SubmitCertField
http://www.mercury.com/certs.nsf/ServerCertificateRequest?OpenForm
&SpecialAction=ServerRequestField
http://www.mercury.com/certs.nsf/Certificate?OpenForm
&SpecialAction=ServerPickupField
This chapter describes adding Java applets to forms or documents. Use Java
applets to enhance a document or Web page.
311
Restrictions and requirements for Java applets
Supported browsers include Internet Explorer 3.0 or 4.0 and Netscape
3.0 or 4.0.
Java applets created with a Notes 4.6 client will not work with any
earlier clients, unless the applet resides on a Web server and has no
parameters.
Java applets created with a Notes 4.5 client will work with a Notes 4.6
client. If you modify the applet parameters in 4.6, however, the applet is
saved as a 4.6 applet and ceases to work in 4.5.
Details
If you have more than one applet on a form or document, Notes stores just
one copy of common files. Files can be of the following types:
Class *.class
Archive *.jar, *.zip, *.cab
Resource *.jpg, *.jpeg, *.gif, *.au
Source *.java
In most cases you must select all applet class and resource files. Include the
source files if you plan to send the applet to another user, who can export
the source files and edit the applet.
Details
When entering a URL for an applet, provide the name of the URL where the
applet resides, not the document that references the applet. For example,
use
http://java.sun.com:80/applets/Bubbles
instead of
http://java.sun.com:80/applets/Bubbles/index.html
Java is case-sensitive, so check the capitalization of the class file.
To delete an applet, select it and choose Edit - Delete or Edit - Clear. You
cannot undo the deletion of an applet.
Details
If you are running an applet through a browser, you can add JavaScript to a
form or document to stop the applet and to set parameters.
Details
To stop all applets in a form or document, choose View - Show - Java
Applets Running. Then you can click to select an applet.
To export files
1. Select the applet and choose Java Applet - Export.
2. Choose the directory to which you want to export the files, and click
OK.
Notes exports all of the class files associated with the applet and creates
subdirectories as needed.
Details
If the applet is running, you cannot click on the applet to select it. Click to
the right of the applet and use the left arrow key to select the applet.
Printing an applet
When you print a form or document that includes an applet, the applet
prints as a light gray box with the same dimensions as the applet.
Using getDocumentBase
The least reliable means of specifying resource files is the getDocumentBase
method. The getDocumentBase method of specifying resource files returns
the base URL of the document in which the applet is located. That is, the
full document URL minus the document file name. For example, if an
applet is running in a document at
http://www.someplace.com/test/example.html
the getDocumentBase method would return a URL specifying
http://www.someplace.com/test
Some applets use this method to specify a URL for resource files for
example, getImage(getDocumentBase(), image.gif). Using the above URL
as an example, the applet would be looking for the image file at the URL
http://www.someplace.com/test/image.gif
Note, however, that the Domino URL for a document does not simply refer
to a file; instead, it is a command for the Domino server to generate the
HTML representing a document. If you use the getDocumentBase method
on such a URL, you will not get unexpected results. For example, suppose
you have inserted an applet into a document with the following Domino
URL:
http://www.someplace.com/database.nsf/MasterView/862..12E?
OpenDocument
In this case, using the getDocumentBase method in conjunction with the
getImage call returns
http://www.someplace.com/database.nsf/MasterView/image.gif
Using getCodeBase
The most reliable means of specifying a resource file for an applet is the
getCodeBase method. The getCodeBase method returns the base URL from
which the applet was loaded. The codebase for an applet can be specified
by the CODEBASE attribute in the APPLET tag. When Domino generates
the HTML for an applet which has been inserted into a Notes document, it
generates a full URL for the CODEBASE attribute. For example, given the
example above, the getCodeBase method would return
http://www.someplace.com/database.nsf/MasterView/862..12E/
$FILE
325
Method Advantages Disadvantages
Sending Easier for remote users because Workflow process may take
documents they only need to replicate mail longer since work is done
sequentially; requires more
server disk space than a
central database because
forms must be stored with
documents; replication times
may be longer because of
document size
Sending documents
Build in features for mailing whole documents if users work on documents
sequentially from individual mail databases or to send documents to a
mail-in database. The form must have a SendTo field that specifies the
recipients, unless you use a formula or program that includes the SendTo
information.
For fields that users can change, use an editable keywords field. To make
the options easy to understand, write a readable name followed by a |
(vertical bar) and the value
Tip If you write a LotusScript program that uses the Send method of the
NotesDocument class or a formula that uses @MailSend, you can include
many of the above mailing options in the script or formula.
For more information on using LotusScript, see the Programmers Guide.
Details
Interactions with the Mail Send dialog box
The MailOptions field with a value of 1 overrides the users choices in the
Mail Send dialog box if the form is set up to enable optional mailing. With a
MailOptions field set to 1, users can click Yes to save the document, No to
close without saving, or Cancel to return to the document.
The Sign, Encrypt, and SaveOptions fields with values of 1 override the
property On Close: Present mail send dialog in the Form Properties box,
but they dont actually change what is displayed to users in the Mail Send
dialog box.
Interactions with the Document Save dialog box
The values in SaveOptions, Sign, and Encrypt fields override the users
settings in the Document Save dialog box.
MailFormat
A computed MailFormat field can have one of the following values:
Encapsulated (E)
The document is encapsulated in a Notes database, which is attached to
the cc:Mail memo. The cc:Mail recipient must have Notes installed on
the workstation. This preserves the document exactly as it looks in
Notes. To read the document, the cc:Mail user double-clicks the icon
representing the attached database; this launches Notes and opens the
database. Use this format only if information will be lost if the
document were to be converted to Text or Memo format. The
Encapsulated format creates larger documents, so it uses more server
disk space. To ensure that the document is displayed correctly when a
Examples
An editable SendTo field with a default value
You want to give users the name of the mail-in Employee Survey database,
and the option of mailing surveys to other people. Create an editable
SendTo field, select Allow multi-values, and write a default value
formula that contains the mail-in database name, enclosed in quotation
marks:
Employee Survey
337
About using NotesFlow tools
The assortment of NotesFlow tools extends the potential of Notes. You can
use each alone or in combination with other NotesFlow tools.
One-way fields
These fields provide information for exchange in only one direction.
One-way fields supply information about a file for example, file size and
creation date. These fields exist by default in the OLE server application;
you create the corresponding fields in your Notes form.
For example, Word Pro documents have a field called SizeInK, which
contains the size of the Word Pro document in kilobytes. To exchange the
data in this field with a field in a Notes form, create a field named
SizeInK in the Notes form. After you set up field exchange, changes to the
Word Pro field appear in the Notes field; however, changes made to the
Notes field do not affect the Word Pro field.
User-defined fields
These fields exchange data in two directions, but you must create these
pairs of fields since they do not exist by default in the OLE server
application file. User-defined fields usually exchange working data, such as
text or numbers. You create and name these fields in the OLE server
application file and in the Notes form.
For more information about fields in OLE server applications that exchange
data with Notes, see the documentation for the OLE server application.
Details
If field exchange is not taking place, check that Notes/FX is enabled.
Choose Design - Form Properties and click the Defaults tab. The Disable
Notes/FX check box should not appear selected.
When users use the form Trip Report to create reports, the total expenses
are automatically inserted in the document.
Publishing an action
1. Open the form in Design mode.
2. Choose View - Action pane to display the action pane.
3. Double-click the action you want to publish.
4. Click the NotesFlow Publishing tab.
5. Select Publish Action with OLE object.
6. Select a property that controls what happens after a user chooses an
action.
7. (Optional) Select Bring document window to front to change the
default setting.
8. Close and save the form.
For information about creating an action, see Chapter 7.
Details
If actions do not get published even after you select Publish action with
OLE object, make sure Notes/FX 2.0 is enabled. Choose Design - Form
Properties, click the Defaults tab. The Disable Notes/FX check box
should not appear selected.
Examples
A Word Pro document needs to be routed for approval. The Notes form
you create has an embedded Word Pro document set to autolaunch when
edited and an action called Send to Next Reviewer. When a user opens the
Notes document in Edit mode, the Word Pro document automatically
launches. When reviewing the Word Pro document, the user selects the
Send to Next Reviewer action from the Action menu in Word Pro. This
action sends the Notes document to the next reviewer and closes the object.
To provide other routing options, you can add the actions Ready for Next
Reviewer, Return to Previous Reviewer, and Archive Document to the
Notes form.
Details
To access an existing control, select it.
When a custom control is active, the menu is a combination of Notes (File,
Applet, and Window) and the custom control. The control may include one
menu item for itself for example, Spreadsheet for a spreadsheet control
and Help. The controls Help is substituted for Notes Help.
Use Applet menu choice to:
Copy and cut the entire object. Use the Edit menu to copy and cut
selected text in the object.
Access Notes properties for the control, including the name of the
control
Access the controls own properties
Set the controls mode
Freeze and unfreeze the controls events
If a control is active when you embed it in a form, a list of events appears in
the Define box in the forms design pane. You can attach scripts to these
events.
For information on attaching scripts to a custom control, see the
Programmers Guide.
Details
The property you choose takes effect after you save and close the form.
If you choose Size object to window, the following occurs:
When a user creates a document or opens an existing document in
edit mode, the custom control automatically expands to fill the entire
Notes window.
If the Notes document contains information below the custom
control, the user cannot view that information while the custom
control is expanded.
If you choose Size object below field, the following occurs:
When a user creates a document or opens an existing document in
edit mode, the custom control automatically expands to fill the area
of the Notes window below the layout region. If the document does
not contain a layout region, the custom control expands to fill the
entire Notes window.
If the document contains information below the layout region, the
user cannot see that information while the custom control is
expanded.
If the document contains two or more layout regions, the custom
control expands below the first layout region. The user cannot see
the other layout regions.
Details
When a user opens a document, the object automatically launches in Read
mode. The user can change the object and print the changes, but cannot
save the changes without first putting the document into Edit mode.
Details
Displaying the object in documents created using the form
When the object is autolaunched, modified by the user, and saved, it is
displayed in the document in the field you specify in the Create object in
field box. You can specify First Rich Text Field to display the saved
object in the first rich text field in the document. Select None if you do
not want to display a current representation of the object in documents.
To display the current representation of an object in the document, store the
form in the document. This causes updates to the object to replace the
original embedded object in the document. Storing the form in the
document uses a large amount of disk space and processing time.
To store the form with the document, open the form, choose Design - Form
Properties, click the Defaults tab, and select Store form in document.
Tip To display updates to autolaunched objects, store the object in a rich
text field in the document.
Objects and full text search
Full text searches can include embedded objects and attachments. When a
full text search finds a match in an embedded object or attachment, the
object or attachment opens, but the matching word or phrase does not
appear.
Nested objects
If the OLE server application is also a client application, an object in a Notes
document may have other objects within it. In this case, when an object is
updated, the object in the Notes document reflects the changes even if they
were made in an other application.
When an object that contains other objects is autolaunched, only the
application that created the object embedded in the Notes document is
launched.
Details
You can control whether the object in the first rich text field in a form
autolaunches when a document is created, edited, or opened. If the form
youre designing autolaunches a new object, make sure the Launch when
setting includes Creating, because this is the only event that launches a
new object. After the user creates the document, the new object is saved
with the document. Other Launch when settings, such as Reading or
Editing, take effect when a user subsequently opens the document.
If you set the form to Automatically enable edit mode (on the Form
Defaults tab of the Form Properties box), make sure the Launch when
settings are compatible. For example, if you design the form so that the
object launches only when users open the document in read mode and you
set the document to enable edit mode automatically, the document always
opens in edit mode and the object never autolaunches.
Examples
Design a form to distribute financial information contained in a 1-2-3 object.
In the form, you embed a 1-2-3 object that is a template for entering
financial information. Create a rich text field in the form, and specify that
the field display the object. Also specify that the object autolaunch only
when a user uses the form to create a document.
Details
When users create or open a document that opens in a modal dialog box,
they cannot access Notes menus. Instead, they have access to a small set of
actions that include:
Entering or modifying data
Launching the first embedded OLE object by clicking the Launch button
on the dialog box
Choosing a command from the Action menu at the bottom of the dialog
box
As the designer, you can control the list of commands available on the
Action menu.
For more information about showing form actions, see Chapter 7.
Details
You can design a form to hide the Notes document during any of these
activities.
Users create a document (Opening Create).
Users open a document to edit it (Opening Edit).
Users open a document to read it (Opening Read).
Users close a document after creating it (Closing Create). This option is
available only if Opening Create is selected.
Users close a document after editing it (Closing Edit). This option is
available only if Opening Edit is selected.
Users close a document after reading it (Closing Read). This option is
available only if Opening Read is selected.
Mixing Hide/Show options
You can design a form that hides the Notes document in some
circumstances and shows it in others. Use this type of form when document
creators, editors, and readers play different roles in maintaining the
information in the Notes database.
Hide Notes documents when:
The main focus of the document is the object, and users dont need to
fill in anything else.
The form contains only one object.
Users arent familiar with Notes and want to work in a familiar
application.
The Notes database is functioning solely as a container system for other
application files.
All users have access to and can launch the other application and
always work in that application.
Show Notes documents when:
Readers need to see more than the data object itself.
The form contains multiple objects.
Revising the data in the object is optional; therefore, you dont need to
launch every time the Notes document opens.
Examples
You create a report-tracking database that allows users to use 1-2-3 to
create and update their own expense reports. When users create or update
expense reports, they dont need to see the Notes document; instead, they
want to autolaunch the expense report object in 1-2-3.
To design a form that mirrors your users workflow, create an Expense
Report form, embed a worksheet object in the form, and set the form
properties to automatically launch the worksheet. In the Hide when box,
you select Opening Create, Closing Create, Opening Edit, and
Closing Edit.
When users choose Create - Expense Report, Notes automatically starts
1-2-3 and launches the embedded worksheet object. Users enter information
directly into the 1-2-3 worksheet object and never see the Notes document.
When users complete the expense reports and quit 1-2-3, the worksheet
object embedded in the form updates, users are returned to the view level
in Notes. If users want to edit their expense reports, they open the
document in edit mode, and 1-2-3 autolaunches. When they close 1-2-3,
users are returned to the view level of Notes.
Information from the expense report worksheet appears in the Notes
document or in the Notes view. The Notes database contains all of the
expense reports.
Details
These steps show how to add a data source in advance through the
Windows ODBC Administrator Utility. If you dont have the utility, contact
your system administrator for help. If you are using a platform other than
Windows 3.1, see the documentation for that platforms ODBC package.
Each data source must have a unique name of no more than 32 characters.
You can define more than one data source for a driver. For example, you
might want to use data sources on different servers or in different
directories.
To make a change later, open the ODBC utility, highlight the data source,
and click Setup.
For more information about registering data sources, see your system
documentation or the ODBC Driver Help documentation.
363
This figure below summarizes the steps you take to make and distribute
design changes:
Renaming a database
If a database title doesnt appear on the icon the way you want, you can
edit it.
1. Select the database.
2. Choose File - Database - Properties.
3. Enter a new database title.
A database name or title is not the same as the database file name. The file
name associated with a database is permanent. The only way to change the
file name is to make a copy or a replica of the database and give the new
database a different file name.
Database information
Database information summarizes administrative properties and is useful
for database managers. The synopsis can include one or more of the
following:
Database displays the database title, location, categories, and so on.
Design information
Design information summarizes properties selected for design elements and
is useful for database developers. The synopsis can include one or more of
the following:
Shared field shows the properties specified for each shared field in the
database.
Stored query displays the formula and selected options for full text search
queries saved with the database.
Agent displays the properties and formulas chosen for each shared and
private agent.
Script Library displays information about script libraries created for the
database.
Forms displays the properties specified for each form and subform you
select.
Views displays the properties specified for each view, folder, and navigator
you select.
Adding a field
If you create a new field, insert the new field into existing documents by
creating an agent that uses the formula:
FIELD New field name := value;
where New field name is the name of the field and value is the value you
want the field in these documents to have. The value can be the field default
value; a formula that calculates the value; or a null value () that inserts
the field into the documents, but doesnt give them any initial value.
Renaming a field
If you rename a field, existing documents continue to refer to the old field
name. To update documents to refer to the new name, create an agent that
uses the formula:
FIELD New field name := Old field name;
FIELD Old field name := @DeleteField;
where New field name is the new name for the field, and Old field name is the
original name for the field.
Examples
A customized discussion master template
You need to add a Confidentiality field to all discussion databases, so that
authors can mark specific documents as Confidential For internal use
only. All databases that base their design on the Discussion master
template will inherit this field.
Add the field directly to the Designer discussion master template. Every
database associated with the master template inherits the new Confidential
field.
DISCUSS4.NTF (StdR4Disc)
|- SALES.NSF Sales discussion inherits from StdR4Disc
|-TRAVEL.NSF Travel discussion inherits from StdR4Disc
A designers notebook
You create a new master template called DesignNotebook to store
centralized information, such as employee names and product numbers, as
well as generic design elements, such as Main Document forms and All by
Category views. Developers and experienced users browse through the
Design Notebook when they create a new database and copy and inherit
elements to speed up their design work.
DESIGN.NTF (DesignNotebook)
|- Suggestion Box: Inherit the All by Category view from
DesignNotebook
|- Employees Directory: Inherit the Employee
Information form and EmployeeID field
from DesignNotebook
|- Product Catalog: Inherit the Product ID Update agent from
DesignNotebook
This appendix lists all master templates and sample databases that are
available with Notes Designer and are specifically intended for use by
application developers. For more information on system administration
templates, see Getting Started with Domino.
385
Database File name Design template Audience Description
title name
continued
Discussion discsw46.ntf StdR46Disc General Electronic conference
- Notes & Notes users room.
Web and Web Features: Same
(R4.6)* browser features as Discussion
users (R4), with the addition
of multiple navigators,
alternate view
templates, and hotspot
actions for Web
browser users.
Document doclib4.ntf StdR4DocLib General Document storage.
Library Notes users Features: Review
(R4) workflow (parallel and
linear) and archiving.
Doc doclbw46.ntf StdR46NetLib General Document storage.
Library - Notes users Features: Review
Notes & and Web workflow (linear only)
Web browser and archiving.
(R4.6)* users
Frameset framew46.ntf StdR46WebFrames Notes/Web Customizable HTML
(R4.6)* designers frame layouts for
home pages.
Lotus doclibl4.ntf StdR4DocLibLS General Special version of the
SmartSuite Notes users Document Library
96 Library template dedicated to
(R4) this application suite.
Automatically
launches, stores, and
supports review cycles
of documents created
with suite products.
Microsoft doclbm46.ntf StdR46DocLibMS General Special version of the
Office Notes users Document Library
Library template dedicated to
(R4.6) this application suite.
Automatically
launches, stores, and
supports review cycles
of documents created
with suite products.
continued
Importing data allows you to move data from an old system into a view.
Exporting data allows you to create a table of the data in a view for use in a
presentation or report.
389
About importing options
Formatting options
You have three choices for generating the column titles and widths during
an import.
Choose View Defined if the column names and column widths in the
source worksheet are identical to the names and widths of the columns
in the view.
Choose WKS Title Defined if youve set up the worksheet so that the
cells in the first row of the worksheet match the column headers and
fields in the view. The cells in the first row must be labels.
Choose Format File Defined if you are using a column descriptor file
(.COL) that contains column style instructions.
Guidelines
Notes uses a character translation file (.CLS) to translate foreign symbols
and characters. The .CLS file must be in the Notes program directory.
Details
If you import a multiple-sheet worksheet file, Notes imports only the sheet
that was open when the file was last closed, or, if importing a specified
range, imports the range from that sheet.
Details
Header Line Count; Footer Line Count
To import only the data, specify the number of header and/or footer lines
that you want Notes to ignore in the source file.
Lines per Page
The Lines per Page setting establishes how many lines of data each Notes
document receives. The total number of lines in the imported documents
are calculated as:
Lines Per Page - (Header Line Count + Footer Line Count)
Details
Inter-document delimiter
Select Form-feed if the records in the source file are separated by a form
feed (ASCII 12).
Select Character Code if the records in the file are separated by a delimiter
other than the default, ASCII 12 (form-feed).
Guidelines
The formulas that you write in a .COL file describe how to modify the
incoming values for display in the Notes view. These formulas, which
follow the same rules as Notes view selection formulas, may perform such
operations as:
Use @If formulas to test incoming values and display a specific value
in the view, depending on the result of the formula
Use text manipulation functions to modify the appearance of the
incoming value for example, to concatenate values or trim excess
space characters from incoming values
Enter default values in fields
WKSCOL
This keyword allows you to associate a field name with a specific
worksheet column. The syntax for a statement using this keyword is:
fieldname: WKSCOL columnletter
Where:
fieldname is the name of the field in the view.
columnletter is the letter of the source column in the worksheet that
maps to that field name.
Domino imports only columns specified by the WKSCOL keyword.
RANGE
This keyword specifies the worksheet range to be imported. The syntax for
a statement using this keyword is:
RANGE rangename
Where:
rangename is the name of the range in the worksheet.
The range must be a valid range name in the imported file.
If there is no delimiter at the end of the record (row), you identify the end
of the last field as a null ().
Example
The following .COL file is used to import a 1-2-3 .WK3 file that records a
checkbook balance.
;COL file for checkbook worksheet
;Discovers checkbook errors
Define five columns of input
Exporting to a worksheet
When you export a view to a worksheet, each document becomes a row in
the worksheet. Each field becomes a column in the worksheet. The original
field contents become cell contents. Column titles become labels in the
worksheet.
When you export a view to a new worksheet file, Notes exports the file in
1-2-3 .WK1 format. Although you can specify any extension with the file
Exporting a view
1. Select the database and open the view you want to export.
2. (Optional) Select specific documents to export only a subset of the view.
3. Choose File - Export.
4. Select the file format youre exporting to.
5. Do one of the following:
To replace an existing file, select a directory and file name from the
list.
To create a new file, enter a new file name.
Details
Choose Form Feed to use a form-feed to separate records in the file, or
choose Character Code to separate the records in the file with the ASCII
code for a delimiter other than the default, ASCII 12 (form-feed).
The word wrap option represents the number of characters at which each
line wraps. The default is 75 characters.
This appendix describes the support available in Notes to access your Notes
mail file and the Public Address Book.
401
The Address Book provider searches the Public Address Book for
recipients names according to the order specified in the profile.
Any Simple or Extended MAPI client can use the Address Book provider to
access a Lotus Notes mail file and Public Address Book.
The majority of design features are available for both Notes and Web users.
This appendix describes the features that arent applicable to Web browsers
or arent yet supported for them.
Table of Notes form properties that are not supported on the Web
Avoid using the following form features in a Web application.
Feature Comments
Basics properties
Version control
Anonymous forms
Merge replication conflicts
Defaults properties
Store form in document - edit mode Read mode is supported, but do not use for
documents that need to be created or edited
on the Web.
Disable field exchange
Automatically refresh fields
On Create: Inherit entire selected Other On Create Inherit options are
document into rich text field as supported. Because document selection isnt
Link and as Collapsible rich text applicable to the Web, default value
formulas cannot reference a selected
document in the view.
On Open: Show context pane
Launch properties
Auto Launch options (First
Attachment, First Document Link,
First OLE object)
continued
409
Feature Comments
Security properties
Default encryption keys Not applicable to Web.
Disable printing/
forwarding/copying to clipboard
Form elements
Layout regions Use tables to align form components
instead.
Pop-up hotspots
ActiveX components, OLE, and OCX Not supported on Macintosh, UNIX, and
objects OS/2 platforms. Supported for display on
Windows NT and Windows 95 platforms,
but users cant save changes made to objects.
Border controls for tables If the top left cell of a Notes table has a
border, the entire table is displayed with a
border; otherwise, there is no border
because of limitations with HTML.
Table of Notes field properties that are not supported on the Web
Avoid using the following field features in a Web application.
Feature Comments
Notes/FX fields
Basics properties
Use Address dialog for choices Not applicable to the Web. Web user access
Use Access Control List for choices to databases is based on the authenticated
Use View dialog for choices name.
Compute after Validation
Keywords styles
Dont display entry helper button Not applicable to the Web.
Options properties
Help description
Give this field default focus
Enable encryption for this field Web users can read data in encrypted
fields.
Signed if mailed or saved in section
Table of Notes view properties that are not supported on the Web
Avoid using the following view and folder features in a Web application.
Feature Comments
Views and folders
Options properties
Collapse all when Web views do not expand or collapse all; instead they
database is first expand or collapse only one category at a time (equivalent
opened. to Expand/Collapse Selected Level).
Show in View menu Web applications do not have a View menu. To exclude a
view from the folders navigator, use the Design - Design
Properties box to hide the view from Web users or
surround the view name in parentheses for example
(HiddenView).
continued
Table of Notes navigator properties that are not supported on the Web
Avoid using the following navigator features in a Web application.
Feature Comments
Navigators
Basics properties
Auto adjust panes at
runtime
Objects
Polyline objects Polyline objects display on the Web, but clicking them has
no effect.
HiLite properties
Highlight when...
options for navigator
objects
@Function Comments
@Certificate
@DbCommand Available only with the syntax
@DbCommand(Domino;ViewNextPage) and
@DbCommand (Domino;ViewPreviousPage)
to create a link to the next/previous page in a
view. Not available in other contexts.
@DDEExecute
@DDEInitiate
@DDEPoke
@DDETerminate
@DocMark
@DeleteDocument
@DocChildren Not available except in column formulas.
@DocDescendants
@DocLevel
@DocNumber
@DocParentNumber
@DocSiblings
@IsCategory
@IsExpandable
@Responses
@DialogBox
@PickList
@Prompt
@IsModalHelp
@GetPortsList
@Environment Use predefined field names to gather information
@SetEnvironment about the Web users environment by requesting
ENVIRONMENT keyword Common Gateway Interface (CGI) environment
variables.
@MailSend
@Domain
@MailDbName
@MailEncryptSavedPreference
@MailEncryptSendPreference
@MailSavePreference
@MailSignPreference
@IsAgentEnabled
@IsDocBeingMailed
@URLGetHeader
@URLHistory
continued
Index 417
servers and, 172 Application Development Best Practices Automating
table of options, 168169, 171 Guide actions, 176, 181, 184
testing, 198 downloading, 273 agents, 176, 181
Web, 276, 291, 413 Applications applications, 159, 175, 343
Alias annotating, 232 buttons, 176, 181, 184
action names, 165 applets and, 311 calendar views, 176, 179
agent names, 165 automating, 159, 175, 343 databases, 159, 176, 178
view names, 106 completing, 227 documents, 160, 175
Aligning creating, 1719, 21 events, 159, 175176
design elements, 42 deploying, 234 fields, 176, 181
fields, 36 designing, 1719, 21, 337 folders, 176, 179
All by Category documenting, 229 forms, 176, 180
view, 132 mail-enabled, 325326, 328, 332 hotspots, 176, 181, 184
Annotating master design copies, 241 navigators, 153
applications, 232 master design templates, 241 OLE, 343
fields, 231232 NotesFlow, 337 replies, 333
Anonymous ODBC and, 339 subforms, 176
authors, 50 OLE, 337 tasks, 26
editors, 50 security, 201 views, 160, 176, 179
forms, 50 testing, 234, 240 Automation
users, 279 Web, 251 defined, 159
Applets workflow, 337 features, 160
attributes, 315316 ASCII Averages
BeanMachine and, 311 importing, 391393 calculating, 137
copying, 314 Assigning
creating, 311 encryption keys, 214
debugging, 312 Attaching
B
defined, 311 actions, 153 Backgrounds
deleting, 313, 319 files, 36 adding, 3435
displaying, 315 formulas, 153 color and, 35
editing, 317 Java programs, 183, 189 deleting, 35
enabling, 312 scripts, 153 Web, 274
events, 315316 signatures, 220, 222 BeanMachine
exporting, 319 Attachments using, 311
hiding, 318 displaying, 7980, 233 BMP files
importing, 313 displaying information about, 122 forms and, 3335
inserting, 312 form, 26, 36 icons and, 228
Java, 311 opening, 302 navigators and, 151
linking, 313 Web, 258 Borders
menu choices and, 347 Attributes layout regions, 42
parameters, 312313, 315 applet, 315316 Buttons
pasting, 314 HTML, 267268, 316 automating, 176, 181, 184
properties, 317 Authentication creating, 192
rearranging, 319 requiring, 305 deleting, 192
refreshing, 319 Authors editing, 192
restarting, 312 anonymous, 50 examples, 192
selecting, 312 displaying names, 122 hiding, 181
stopping, 317 fields, 66, 89, 203, 208209, 211 Submit, 266
testing, 314 selecting documents by, 117118 using, 160
text and, 274 Autolaunching Web, 266, 287
troubleshooting, 320 defined, 349
Web and, 313 examples, 352, 354
objects, 349350, 352354
Index 418
Check boxes Combo boxes
C displaying, 76 displaying, 76
Calculating Choices Commands
averages, 137 displaying, 39, 61, 65, 74, 76 URL, 293, 295, 297, 299300, 302,
columns, 137 forms and, 39 305306
field values, 122 Clickable Completing
percents, 137 objects, 152 applications, 227
totals, 137 CLS files Computed
values, 66, 93 importing and, 390 fields, 9394
Calendar views COL files Confirmations
automating, 176, 179 creating, 394396, 398 customizing, 285
creating, 114 defined, 394 Conflict
defined, 103 formulas and, 397 documents, 51
Capturing importing and, 390391, 394396 Controlling
CGI variables, 290292 keywords, 395396 access, 201203, 205209
Cascading Collapsing revisions, 4748
action names, 166 columns, 122 Converting
agent names, 166 fields, 44 databases to Web, 251
form names, 30 sections, 221 fonts, 275
view names, 108 views, 109, 138 tags, 275
Catalog Color Copying
database, 203 backgrounds, 35 actions, 190
Categories columns, 109 agents, 195
adding, 128129 navigators, 151 applets, 314
creating, 129 palette, 273 columns, 113
database, 235 rows, 109 databases, 17, 19
displaying, 128129 unread marks, 141 design elements, 19
fields, 129 views, 109 fields, 70, 72
formulas, 131 Columns forms, 28
naming, 129, 131 adding, 36 graphics, 3335, 150
subcategories, 131 calculating, 137 NSF files, 19
views and, 132 categorized, 128129 restricting, 207
Categorizing collapsing, 122 templates, 22
columns, 128129 copying, 113 views, 113
documents, 132 date, 135 Creating
views, 128129 deleting, 113 About This Database document,
cc:Mail expanding, 122 229230
mailing to, 330 formatting, 135136 actions, 183, 190
Certificates formulas and, 139 agents, 195196
SSL and, 306 hiding, 109, 127 applets, 311
CGI HTML and, 271 applications, 1719, 21
capturing, 290292 icons in, 123124 attachments, 258
defined, 290 linking, 261 buttons, 192
fields, 291 numbers, 136 categories, 129
running, 290 programming, 119, 122124 COL files, 394396, 398
variables, 290, 292 response, 134 custom controls, 346
CGN files sorting, 125 databases, 1719, 21, 374
importing and exporting, 389 styling, 109 design summary, 365366
Changes switching to a view, 128 dialog boxes, 5859
preventing, 379381 testing, 239 documents, 2, 196, 257, 300
Changing time, 135 encryption keys, 216
designs, 363 titles, 108109 fields, 7074, 82, 8588, 96, 100,
properties, 365 views and, 103 214, 218, 220, 222, 268, 291,
width, 109 328330, 339340
Index 419
folders, 106 size, 235
footers, 55 D summary, 365
form names, 3031 Data titles, 1819, 21, 235
forms, 8, 28, 4748, 5153, 5758, accessing, 339, 358 translating, 383
6062, 212, 286 defining for ODBC, 359 unlinking, 380
formulas, 183, 193 exchanging, 338340 version control and, 48
headers, 55 exporting, 398399 Web, 245246, 251
help, 229, 232 importing, 391393 DataLens
hotspots, 152, 193 registering sources, 359360 ODBC and, 359
icons, 16, 228 Data types Dates
indexes, 282 field, 65 columns for, 135
layout regions, 39, 41 Databases displaying, 135
mail-in databases, 333 access, 202203 examples, 84
master design copies, 241 access control lists, 202, 235, 277 fields for, 82
navigators, 147, 149, 261 agents and, 334 formatting, 135
NSF files, 21 automating, 159, 176, 178 selecting documents by, 117118
NTF files, 241 categories, 235 Debugging
prompts, 100 converting to Web, 251 applets, 312
scripts, 193 copying, 17, 19 Decrypting
sections, 44, 221 creating, 1719, 21, 374 documents, 214
shortcuts, 159 default forms, 46 Default
subcategories, 131 default views, 140 designs, 140
subforms, 37 defined, 17, 246 edit mode, 53
templates, 241, 371, 373 design synopsis, 234 encryption, 217
titles, 108 designing, 1719, 21 field, 96
Using This Database document, documenting, 229, 232 field values, 90
229230 encapsulated, 330 footers, 55
views, 113114, 132133, 212 examples, 388 forms, 4546
Web pages, 253 external, 358 formulas, 66, 90
Currency file names, 1819, 21 headers, 55
displaying, 80 forms and, 4550 Submit button, 287
fields, 80 hiding, 382 views, 140
Custom controls icons, 227228, 297 Web responses, 285
adding, 346347 information, 234 window title, 53, 55
creating, 346 launching default object, 233 Deleting
defined, 345 licenses and, 387 actions, 190
read-mode and, 349 linking, 53, 281, 374 agents, 195
resizing, 348 listing, 203 applets, 313, 319
running, 349 location, 235 backgrounds, 35
updating, 349 mail features and, 326, 328 buttons, 192
Customizing migrating to Web, 251 columns, 113
confirmations, 285 navigators, 156 data, 369
databases, 18 ODBC and, 339, 358 documents, 300
error messages, 286 opening, 233, 252, 295, 297 fields, 99
searching, 283 previewing, 234 forms, 29
sorting, 127 properties of, 365 formulas, 193
templates, 22, 371 renaming, 364 graphics, 35
window titles, 53, 55 replacing design of, 377378 hotspots, 193
replication, 203, 235 indexes, 143
response forms, 47 layout regions, 41
sample, 388 scripts, 193
searching, 282 sections, 44
security, 203 subforms, 3839
shared, 325 views, 113
Index 420
Deploying synopsis of, 234, 365 Distributing
applications, 234 templates and, 371 design changes, 363
forms, 63 testing, 236238 Doclinks
Design changes unlinking, 380 displaying, 233
inheriting, 22 updating, 375, 377378 launching, 252
making, 363 viewing, 7, 234 Documenting
NTF files and, 18 Dialog boxes applications, 229
preventing, 22 creating, 5859 databases, 229, 232
templates and, 18 designing, 59 Documents
Design elements displaying, 58, 76, 355 About This Database, 229230,
adding, 34, 3638, 41, 44 examples, 60 245
copying, 19 Disabling access, 203, 205209
deleting, 39 agents, 199 agents and, 168169, 196, 369
forms and, 33 replication, 203 anonymous, 50
hiding, 254, 382 Displaying applets and, 314
linking, 374 About This Database document, automating, 160, 175
master templates and, 374, 380 233 categorizing, 132
previewing, 253 actions, 164 conflict, 51
properties of, 365 agents, 164, 167 creating, 2, 196, 257, 300
protecting, 22, 379381 applets, 315 decrypting, 214
updating, 375, 377 attachments, 7980, 233 defined, 246
Design mode categories, 128129 deleting, 300
actions and, 190 check boxes, 76 deleting data in, 369
agents and, 195 choices, 39, 61, 65, 74, 76 displaying, 115, 117118, 355
Design summary combo boxes, 76 displaying information about, 122
creating, 234, 365366 currency, 80 edit mode, 53
displaying, 365 dates, 135 editing, 47, 196, 299, 369
viewing, 234235 design summaries, 365 encrypting, 213214, 217
Design tools dialog boxes, 58, 76, 355 fields, 368
graphic, 150 doc links, 233 footers, 55
Designer templates documents, 115, 117118, 355 form changes and, 367, 369
list of, 385 field values, 119, 122 forms and, 29, 45, 4950
Designing form names, 3032 forwarding, 327
applications, 1719, 21, 337 graphics, 7980, 272 headers, 55
databases, 1719, 21 Help, 346 help, 232
dialog boxes, 5859 icons, 123124 hiding, 355356
forms, 6062, 332, 350, 352353, links, 261 HTML and, 267268
355356 lists, 61, 65, 74, 76 indenting, 122
navigators, 147, 149 menu choices, 347 inheriting, 8586
views, 113114 navigators, 156, 233 launching, 230, 252
Web databases, 251 numbers, 80, 136 linking, 5253, 281, 301, 326
Web sites, 248 objects, 351 links and, 51
Designs programming, 175 Mail-in Database, 333
changing, 378 prompts, 60 mailing, 326
default, 140 radio buttons, 76 numbering, 119, 122
hiding, 254, 380381 responses, 133 opening, 299300
linking, 374 subforms, 38 previewing, 234
maintaining, 241 text, 7374 profile, 57
master templates and, 380 times, 135 prompting users, 60
preventing changes, 241, 379381 unread marks, 141 public, 212
refreshing, 375, 377 user names, 66, 88 reassigning to form, 370
replacing, 377378 values, 96 removing form from, 370
replication and, 378 views, 138 resaving, 369
summary of, 234, 365 response, 47
Index 421
restricting, 207 Notes/FX, 340 HTML, 269
revisions, 4748 Encapsulated prompts, 60
saving, 300 databases, 330 restricting, 205, 210, 222
searching, 171, 282 Encrypting scripts, 193, 291
security, 203, 205209 documents, 213214, 217 security, 210
selecting, 115118, 196 fields, 217 subforms, 38
sending, 326 Web transactions, 281 templates, 22, 372, 385
signing, 220, 222 Encryption Web, 269, 279, 285, 291
sorting, 125 default, 217 Exchanging
unread, 141 defined, 213 data, 338340
updating, 367, 369 enabling, 217 Expanding
URLs and, 58 examples, 215 columns, 122
Using This Database, 229230 fields, 214, 218 fields, 44
version tracking, 4748 keys, 213, 216 sections, 221
views and, 115, 117118 Web and, 280281 Exporting
Web, 245, 256257 Encryption keys applets, 319
Drawing creating, 216 data, 398399
objects, 151 defined, 213 files, 389
Drivers examples, 219 text, 389
ODBC, 358 fields for, 218 views, 389, 398399
listing, 218 worksheets, 389
Entering
E HTML, 267
Edit mode Error messages
F
forms and, 53 customizing, 286 Field-exchange
Editing Web, 286 defined, 339340
applets, 316317 Events disabling, 342
buttons, 192 applets, 315316 enabling, 342
documents, 47, 53, 196, 299, 369 automating, 159, 175176 Field values
fields, 211, 338 defined, 175 calculating, 122
forms, 367 examples, 193 displaying, 119, 122, 368
hotspots, 193 HTML, 316 Fields
HTML, 266, 316 list of, 176 $$HTMLHead, 269
HTTPD.CNF, 308 programming, 178181, 315 $$Return, 285
navigators, 149 Web, 276 $Actions, 368
restricting, 208209, 211 Examples $Anonymous, 211
revisions, 47 access, 210 $Body, 49, 368
window titles, 53, 55 access levels, 279 $File, 368
Editors actions, 191, 344 $Info, 49, 368
anonymous, 50 agents, 197, 291, 333335, 369 $Links, 368
sections and, 221 autolaunching, 352, 354 $PublicAccess, 212
tracking, 211 automating navigators, 154 $Readers, 368
Embedding buttons, 192 $Revisions, 368
defined, 345 dates, 84 $Title, 49, 368
HTML, 272 dialog boxes, 60 $UpdatedBy, 209, 211, 368
image maps, 262 encryption, 215 $VersionOpt, 87
navigators, 261262, 264265 encryption keys, 219 $WindowTitle, 49, 368
objects, 338, 345346 events, 193 active, 96
views, 261262, 264 exchanging data, 341 adding, 369
Enabling fields, 78, 331, 341 aligning, 36
agents, 199 formulas, 54, 84, 91, 94, 116, 131, annotating, 231232
applets, 312 193 attachment, 258
encryption, 217 hiding, 99, 357 Authors, 66, 89, 203, 208209, 211
field-exchange, 342 hotspots, 193 automatically-generated, 368
Index 422
automating, 176, 181 testing, 237 numbers, 80, 136
Categories, 129 text, 65, 68, 7374 times, 135
CGI, 291292 time, 66, 82 views, 271
collapsing, 44 user name, 88 Forms
computed, 66, 9394 values, 368 access lists, 203, 205209, 212
copying, 70, 72 Web, 246, 285, 410 actions, 160, 162, 266
creating, 7074, 82, 8588, 96, 100, File names anonymous, 50
214, 218, 268, 291, 328330, databases, 1819, 21 applets and, 312, 314
339340 templates, 22, 385 attachments on, 36
currency, 80 Files Authors fields on, 203, 208209
data types, 65 applet, 313 autolaunching and, 350
date, 82 attachments and, 36 automating, 176, 180
default, 96 BMP, 3335, 228 backgrounds on, 3435
default values for, 90 CGN, 389 choices on, 39, 61
defined, 26, 65, 246 CLS, 390 copying, 28
deleting, 99 COL, 390391, 394 creating, 8, 28, 4748, 5153,
editable, 66 exporting, 389 5758, 6062, 212, 286
editing, 211, 338 GIF, 3335, 272 default, 4546, 53
encrypting, 214, 217218 HTTPD.CNF, 308 defined, 2526, 246
encryption, 280 importing, 389, 394, 398 deleting, 29
examples, 78, 331, 341 JPEG, 3335, 272 deploying, 63
exchanging data, 338340 LTR, 389 design elements and, 33
expanding, 44 NSF, 17, 19, 21 designing, 6062, 332, 350,
FolderOptions, 100 NTF, 1718, 241, 371 352353, 355356
formulas, 66, 9093 PCX, 3335 dialog boxes on, 5859
grouping, 44 PRN, 389 documents and, 29
help for, 231232 RPT, 389 edit mode, 53
hiding, 44, 9798 STR, 389 editing, 367
HTML, 268269 TAB, 389 embedding objects in, 346
inheriting, 8586 TIFF, 3335 examples, 341
keywords, 66, 74, 76 TXT, 389 field-exchange, 338340
labeling, 33 WK1, 389 footers on, 55
labels, 68 WK3, 389 form names, 31
layout regions and, 42, 71 WK4, 389 formulas, 45
lists in, 66, 74, 76 WKS, 389 graphics on, 3335
mail-enabled, 328330 WR1, 389 headers on, 55
Names, 66, 68, 89 WRK, 389 hiding, 32
naming, 33, 70 Folders horizontal lines on, 34
Number, 66, 80 access, 204205 input, 58
objects and, 351 automating, 176, 179 layout regions on, 39, 41
re-using, 7273 creating, 106 linking objects in, 346
Readers, 66, 89, 203, 205206, defined, 106 links and, 5153
208209 opening, 5 lists on, 39
recalculating, 66 security, 205 main topic, 45
refreshing, 9596 Web, 260 naming, 2932, 264265
renaming, 70, 72, 369 Fonts navigators and, 264265
restricting, 280 Web, 275 objects and, 338, 350
rich text, 65, 7374, 7980 Footers OLE and, 346
SecretEncryptionKeys, 218 creating, 55 opening, 297
SendTo, 220, 222 Formatting parts of, 26
shared, 72, 235 columns, 135136 previewing, 63
signing, 220, 222 dates, 135 Readers fields on, 203, 205209
tab order of, 42 HTML, 267268, 271, 275 redesigning, 367
templates and, 69 importing and, 390, 394 removing, 32, 370
Index 423
renaming, 29, 31, 364 layout regions, 43
replication and, 51 G menu choices, 140
response, 45, 47 GIF files objects, 357
restricting, 280 forms and, 3335 section titles, 221
searching, 56 navigators and, 151 subforms, 38
sections, 44 Web and, 272 views, 107, 140
selecting documents by, 117118 Glossary Highlighting
storing, 45, 4950, 351, 370 Web, 245 navigators, 151
subforms and, 3739 Graphics Home pages
synonym form names, 29, 3132 adding, 41, 150 defined, 244, 249
tables on, 36 background, 274 launching, 249, 252
testing, 63, 236 colors, 273 specifying, 250
text on, 33 copying, 3335, 150 URLs, 250
types of, 45 deleting, 35 Web, 249
URLs and, 58 describing, 274 Horizontal lines
version tracking, 4748 design tools for, 150 adding, 34
Web, 246, 286, 409 displaying, 7980, 272 Hotspots
window titles, 53, 55 forms and, 26, 3335 automating, 176, 181, 184
Formulas importing, 3335, 150 creating, 152, 193
category, 131 layout regions and, 41 defined, 152
COL files and, 397 navigators and, 150 deleting, 193
columns and, 119, 122 pasting, 3335, 150 editing, 193
computing text, 258 removing, 35 examples, 193
creating, 183, 193 sizing, 274 forms and, 26
default, 66, 90 text and, 71 hiding, 181
deleting, 193 Web, 272, 274 navigators and, 152
dialog box, 58 Grouping restrictions, 200
examples, 91, 94, 116, 131, 193 fields, 44 text and, 274
field, 66, 90 views, 108 using, 160
fields, 66, 9193 HTML
form display, 45
input translation, 66, 91
H adding, 266, 271
agents and, 272
input validation, 66, 92 Headers applets and, 315
lookup, 139 creating, 55 attributes, 267268, 316
ODBC and, 360 HTML, 269 columns and, 271
prompting users, 60 Help defined, 244
recalculating, 66 creating, 229, 232 editing, 266, 316
response column, 134 displaying, 346 embedding, 272
restricting, 200 documents, 232 entering, 267
view, 115118 writing, 231232 events, 316
Web, 264, 266, 287288 Hiding fields, 268
window title, 5355 actions, 181 formatting, 267268, 271, 275
writing, 12, 9093, 95, 115119, agents, 382 headers, 269
122124, 139, 287288, 360, 397 applets, 318 LotusScript and, 272
Forwarding buttons, 181 storing, 268
documents, 327 columns, 109, 127 URLs and, 293
restricting, 207 databases, 382 viewing, 266
Full text search design elements, 254, 382 views and, 271
forms and, 56 designs, 380381 HTTP
documents, 355356 defined, 244
examples, 357 HTTPD.CNF
fields, 44, 9799 editing, 308
forms, 32 Hypertext
hotspots, 181 links, 281
Index 424
Jumps Lines
I Web, 285 adding, 34
Icons wrapping on Web, 260
creating, 16, 228 Linking
database, 227228 K applets, 313
displaying, 123124 Keywords columns, 261
Image files COL files and, 395396 databases, 281, 374
opening, 303 defined, 74 defined, 345
Image maps fields, 66, 74, 76 design elements, 374
embedding, 262 generating, 74, 76 designs, 374
Web and, 261 refreshing, 95 documents, 281, 301, 326
Importing synonyms, 78 mail, 326
applets, 313 master templates and, 374
data, 391393
files, 389, 394, 398
L objects, 338, 345346
templates and, 374
graphics, 3335, 150 Labeling
URLs, 281
options for, 390 fields, 33, 68 views, 281
text, 389, 391393, 396 Launching
Web, 281
worksheets, 389391, 395 About This Database documents,
Links
Indenting 233, 252 database, 53
documents, 122 default object, 233
displaying, 261
responses, 133 doclinks, 252
document, 51, 52
Indexes documents, 230, 252 forms and, 26, 5153
creating, 282 home pages, 249, 252
hypertext, 281
deleting, 143 navigators, 252
sending, 326
refreshing, 143 objects, 338, 350, 352354 URL, 281
view, 143 URLs, 58
view, 52
Information Layout regions
Lists
design, 234 adding, 39, 41 CGI variables, 292
sharing, 339 aligning design elements, 42
displaying, 61, 65, 74, 76
Inheriting borders, 42
fields for, 65, 74, 76
design changes, 22 creating, 39, 41 forms and, 39
documents, 86 dates in, 82
URL commands, 295, 297,
values, 85 defined, 26
299300, 302, 305
Input deleting, 41 LotusScript
formulas, 66 dialog boxes on, 5859
agents, 172, 291
Inserting fields on, 42, 71
HTML and, 272
applets, 312 forms and, 39, 41, 58 OLE and, 345
subforms, 38 graphics on, 41
using, 12
hiding, 43
Web and, 413
rearranging design elements, 42
J resizing, 42
writing, 183
LTR files
Java sizing, 42
importing and exporting, 389
agents and, 183, 189 styling, 42
applets, 311 tab order, 42
attaching programs, 183, 189 text on, 41 M
BeanMachine and, 311 times in, 82 Mail
files, 313 Licenses agents, 333335
Notes classes, 190 types of, 387 applications, 325
Java Programmer's Guide, 190 Limiting fields, 328330
JPEG files searching, 304 forwarding, 327
forms and, 3335 Limits linking, 326
navigators and, 151 view, 145 sending, 326
Web and, 272 workflow, 325
Index 425
Mail-in Database Navigating using, 18
agents and, 333334 Web sites, 261262, 264 Number
creating, 333 Navigators fields, 66, 80
documents, 333 actions, 148, 153 Numbering
Mailing automating, 153 documents, 119, 122
automatic, 326, 332 color, 151 Numbers
documents, 326 creating, 147, 149, 261 columns for, 136
Main documents defined, 147, 247 displaying, 80, 136
selecting, 117118 designing, 147, 149
Main topic form displaying, 156, 233
defined, 45 editing, 149
O
MAPI embedding, 262, 264265 Objects
Address Book provider, 401 examples, 154 autolaunching, 349350, 352354
classes and methods, 404 formulas and, 153 clickable, 152
defined, 401 graphics and, 150 displaying, 351
Message Store provider, 402 highlighting, 151 drawing, 151
Message Transport provider, 403 hotspots and, 152 embedding, 345346
platforms, 403 launching, 252 enhancing, 151
recipient types, 403 opening, 6, 156, 298 fields and, 351
requirements, 403 programming, 148, 153 hiding, 357
Master design copies renaming, 364 hotspot, 152
creating, 241 scripts and, 153 launching, 338, 350, 352354
Master templates styling, 151 linking, 345346
creating, 373 templates and, 264265 resizing, 347
defined, 371 testing, 157 searching, 351
linking, 374 text on, 151 updating, 349
list of, 385 Web, 247, 261, 264265, 412 OCX
replication and, 378 web applications and, 148 defined, 345
unlinking, 380 Notes/FX ODBC
unlinking design elements, 380 enabling, 340 applications and, 339
Menus using, 339340 data sources, 359360
displaying, 347 NOTES.INI file DataLens and, 359
hiding choices, 140 profile documents and, 57 formulas and, 360
Messages NOTES.INI settings requirements, 358
Web, 286 Default_Index_Lifetime_Days, setting up, 358
Migrating 143 using, 358
databases to Web, 251 NoExternalApps, 200 OLE
MIME Notes Global Designer actions and, 343
type mappings, 308 using, 383 applications, 337
NotesFlow automating, 343
actions, 338, 343 custom controls, 345349
N defined, 337 exchanging data, 339340
Names field-exchange, 338 LotusScript and, 345
alias, 165 object-embedding, 338 objects on forms, 26
cascading, 166 object-linking, 338 resizing, 347348
displaying, 66 NSF files OLE objects
fields, 68, 89 copying, 19 fields for, 7980
Naming creating, 21 opening, 303
actions, 165 defined, 17 Opening
agents, 165 NTF files About This Database document,
categories, 129, 131 access control and, 242 297
fields, 33, 70 creating, 241 agents, 298
forms, 29, 3132 defined, 17, 371 attachments, 302
views, 106 design changes and, 18 database icon, 297
Index 426
databases, 233, 295 events, 178181, 315 Recalculating
documents, 299300 navigators, 148, 153 formulas, 66
folders, 5 types of, 183 values, 93
forms, 297 Prompts Redesigning
image files, 303 creating, 100 forms, 367
navigators, 6, 156, 298 examples, 60 templates, 371
OLE objects, 303 Properties Refreshing
rows, 138 applet, 317 applets, 319
servers, 295 changing, 365 defined, 375
Using This Database document, database, 365 designs, 377
297 elements, 365 fields, 9596
views, 5, 138, 295 Protecting keywords, 95
Web databases, 252 anonymity, 50 values, 9596
Outline design elements, 22, 379381 views, 143
views, 103 designs, 379 Registering
Protocols data sources, 359360
HTML, 244 Removing
P SSL, 281 form names from menu, 32
Parameters URL, 244 forms, 370
applet, 312313, 315 Public access graphics, 35
setting for applets, 315 agents, 212213 subforms, 3839
Pasting defined, 212 Renaming
applets, 314 documents, 212 agents, 364
graphics, 3335, 150 forms, 212 databases, 364
PCX files views, 212 fields, 70, 72, 369
forms and, 3335 Publishing forms, 29, 31, 364
navigators and, 151 actions, 338, 343344 navigators, 364
Percents examples of, 344 views, 106, 364
calculating, 137 Replacing
Performance defined, 377
script, 95 Q designs, 377378
Perl QuickStart, 248 Replication
Web and, 290 database, 235
Personal
views, 105
R disabling, 203
forms and, 51
Planning Radio buttons
templates and, 378
Web sites, 248 displaying, 76
Replies
Preventing Re-using automating, 333
design changes, 22, 241, 379381 fields, 7273
Resaving
Previewing Read-mode
documents, 369
databases, 234 custom controls and, 349 Resizing
documents, 234 Read access list
custom controls, 348
forms, 63 folders, 204
layout regions, 42
Web design elements, 253 forms, 205206 objects, 347
Printing views, 204
Response documents
restricting, 207 Readers
selecting, 117118
PRN files fields, 66, 89, 203, 208209 Response forms
importing and exporting, 389 Reading
creating, 47
Profile documents restricting, 205, 207209
defined, 45
creating, 57 Rearranging Responses
using, 57 applets, 319
columns for, 134
Programming design elements, 42
displaying, 122, 133
columns, 119, 122124 Reassigning formulas, 134
displaying, 175 documents to form, 370
indenting, 133
Index 427
tracking, 134 customizing, 283, 285 using, 73
Restarting databases, 282 Sharing
applets, 312 documents, 171, 282 information, 339
Restricting forms, 56 Shortcuts
access, 201209, 221, 277, 280 limiting, 304 creating, 159
actions, 200 objects, 351 menu choices and, 166
copying, 207 views, 282 Signatures
design changes, 241 Web, 282283, 285 attaching, 220, 222
editing, 208209, 211 Sections defined, 220, 222
examples of, 210 access, 221 storing, 224
fields, 280 collapsing, 221 verifying, 224
forms, 280 creating, 44, 221 Signing
formulas, 200 defined, 44 documents, 220, 222
forwarding, 207 deleting, 44 Simple actions, 184, 186
hotspots, 200 editors and, 221 Sizes
printing, 207 Security database, 235
reading, 205, 207209 actions and, 200 Sizing
views, 280 database, 202203 graphics, 274
Revisions defined, 201 layout regions, 42
tracking, 4748 documents, 203, 205209 Sorting
Rich text examples, 210 columns, 125
fields, 65, 7374, 7980 folders, 205 customizing, 127
Roles hotspots and, 200 documents, 125
defined, 280 types of, 201 hidden columns, 127
Rows Selecting Spacing
adding, 36 applets, 312 rows, 109
opening to, 138 documents for view, 115118 SSL
spacing, 109 documents with agents, 195196 certificates, 306
styling, 109 Selection formulas protocol, 281
RPT files view, 117118 Server document and, 281
importing and exporting, 389 Sending URL commands, 306
Running documents, 326 Status
agents, 168169, 172, 276 links, 326 tracking, 134
CGI programs, 290 Server document Stopping
custom controls, 349 HTTP format, 272 applets, 317
SSL and, 281 Storing
Web settings, 249250 forms, 45, 4950, 351
S Server tasks HTML, 268
Sample databases Updall, 143 signatures, 224
list of, 388 Servers STR files
Saving agents and, 172 importing and exporting, 389
documents, 300 opening, 295 Styling
Scheduling Web, 243 action bar, 164
agents, 168169, 172, 196 Setting columns, 109
Scripts applet attributes, 315 layout regions, 42
creating, 193 applet parameters, 315 navigators, 151
deleting, 193 Shared rows, 109
examples, 193, 291 databases, 325 titles, 108
HTML and, 272 views, 105 views, 109
Java and, 190 Shared fields Subcategories
performance, 95 copying, 72 creating, 131
Perl, 290 creating, 7273 Subforms
Searching defined, 72 adding, 37
agents and, 171 renaming, 72 automating, 176
Index 428
creating, 37 Web, 247 opening the About This Database
defined, 26, 37 Testing document, 14
deleting, 3839 agents, 198 opening the Using This Database
displaying, 38 applets, 314 document, 15
examples, 38 applications, 234, 240 opening views and folders, 5
forms and, 3739 columns, 239 using LotusScript, 12
hiding, 38 design, 237238 viewing database design, 7
inserting, 38 designs, 236 writing formulas, 12
removing, 3839 fields, 237 Tracking
Submit button forms, 63, 236 responses, 134
customizing, 287 navigators, 157 revisions, 4748
Web and, 266 views, 238 status, 134
Synonyms Text unread documents, 141
form names and, 29, 3132 adding, 41, 274 versions, 87
keywords and, 78 applets and, 274 Transactions
Synopsis computed, 258 encrypting, 281
design, 234, 365 displaying, 7374 Translating
Syntax exporting, 389 databases, 383
URL commands, 293 fields, 65, 68, 7374 foreign languages, 390
forms and, 26, 33 input, 91
graphics and, 71 Translation
T hotspots and, 274 formulas, 66
TAB files importing, 391393, 396 Troubleshooting
importing and exporting, 389 navigators and, 151 applets, 320
Tables Web, 258, 276, 411 calendar views, 114
forms and, 26, 36 window title, 5355 TXT files
Tabs Text files importing and exporting, 389
converting, 275 exporting, 398399
setting order, 42 TIFF files
Tags forms and, 3335
U
adding, 269 navigators and, 151 Unlinking
Templates Times databases, 380
agents and, 371 columns for, 135 design elements, 380
changing, 363, 371 displaying, 135 master templates and, 380
converting, 373 fields for, 66, 82 Unread marks
copying, 22 formatting, 135 color, 141
creating, 241, 371, 373 Titles displaying, 141
customizing, 22, 371 adding, 108 Updall, 143
defined, 17, 247, 371 column, 108109 Updating
design changes and, 18 creating, 108 custom controls, 349
Designer, 385 database, 1819, 21, 235 design elements, 375, 377
examples of, 372, 385 hiding, 221 designs, 375, 377
fields in, 69 styling, 108 documents, 367, 369
file names, 22 Totals objects, 349
licenses and, 387 calculating, 137 views, 143
linking to, 374 Tour URL commands
list of, 385 creating database icons, 16 defined, 293
master, 371 creating documents, 2 HTML and, 293
navigator, 264265 creating forms, 8 lists of, 295, 297, 299300, 302,
redesigning, 371 creating the About This Database 305306
replacing design and, 377 document, 14 syntax, 293
replication and, 363, 378 creating the Using This Database URLs
using, 1718 document, 15 defined, 244
view, 264 opening navigators, 6 documents and, 58
Index 429
forms and, 58 displaying, 138 encryption and, 280281
home page, 250 documents and, 115, 117118 error messages, 286
launching, 58 embedding, 261262, 264 events, 276
linking, 281 exporting, 389, 398399 examples, 269, 279, 285, 291
Using This Database document formatting, 271 fields, 246, 285, 410
creating, 15 formulas, 115118, 139 folders, 260
opening, 15, 297 grouping, 108 fonts, 275
hiding, 107, 140 forms, 246, 286, 409
HTML and, 271 formulas, 264, 266, 287288
V importing and, 391 graphics, 272, 274
Validating indexes, 143 hiding design elements, 382
input, 92 limits, 145 home pages, 249
Validation linking, 52, 281 HTML, 266
formulas, 66 naming, 106 image maps, 261
Values opening, 5, 138, 295 jumps, 285
calculating, 93 outline, 103 line wrap, 260
displaying, 96 personal, 105 linking, 281
field, 368 public access, 212 LotusScript and, 413
inheriting, 85 refreshing, 143 mailing features, 328
recalculating, 66, 93 renaming, 106, 364 messages, 286
refreshing, 9596 restricting, 280 migrating databases to, 251
selecting documents by, 117118 searching, 282 navigating, 261262, 264
Variables shared, 105 navigators, 148, 247, 261, 264265,
CGI, 290 sorting documents, 125 412
Verifying styling, 109 Perl and, 290
signatures, 224 switching, 128 previewing design elements, 253
Versions templates and, 264 QuickStart, 248
tracking, 4748, 87 testing, 238 responses, 285
Viewing troubleshooting, 114 searching, 282283, 285
About This Database document, types of, 103, 105 Server document and, 249250
230 unread marks, 141 Submit button, 287
design, 7 updating, 143 templates, 247
designs, 234 version tracking and, 47 text, 258, 276, 411
HTML, 266 Web, 247, 259, 411 unsupported features, 409414
Using This Database document, views, 247, 259, 411
230 Web databases
Views W defined, 245
access, 204 Web Web pages
actions, 160, 162, 266 @commands, 288 creating, 253
alias names, 106 @functions, 414 defined, 245
All by Category, 132 @functions and, 287 Web server
automating, 160, 176, 179 access control, 277279 defined, 243
calendar, 103, 114 actions, 264, 266, 413 Web site
cascading, 108 agents, 276, 291, 413 defined, 245
categories and, 128129 anonymous users, 279 designing, 248
categorizing, 128129 applets and, 313 planning, 248
collapsing, 109, 138 applications, 251 types of, 248
columns in, 103 attachments, 258 WH1 files
copying, 113 authentication, 305 importing and exporting, 389
creating, 113114, 132133, 212 buttons, 266, 287 Width
default, 140 CGI and, 290 columns, 109
defined, 103, 247 databases, 246, 251 Window titles
deleting, 113 designing for, 248, 251 customizing, 53, 55
designing, 113114 documents, 245, 256257 examples, 54
Index 430
WK3 files
importing and exporting, 389
WK4 files
importing and exporting, 389
WKS files
importing and exporting, 389
Workflow
applications, 337
defined, 325
features, 326, 328
Worksheets
exporting, 389, 398399
importing, 389391, 395
WR1 files
importing and exporting, 389
Wrapping
lines on Web, 260
Writing
formulas, 9093, 95, 115119,
122124, 139, 287288, 360, 397
help, 231232
WRK files
importing and exporting, 389
Index 431
Part No. 12952
Application Developer's Guide Lotus Notes Designer 4.6