Home
HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
Application Design
Welcome to the Application Design section of Domino® Designer Help.
Developing applications using third-party tools and WebDAV
As you are developing an application, you may want to supplement the tools provided with Domino® Designer with tools of your own choosing. For example, you may have a favorite graphics editor you use to design images for your application, or you may have a favorite HTML editor that you want to use to design pages. You launch and use third-party tools from within Designer.
Using WebDAV in a replicated environment
When WebDAV is used to modify the design of a database in a replicated environment, you should enable design note locking on the replicated databases and use WebDAV-enabled applications that support locking. Locking ensures that any changes are replicated to the master lock database on the administration server whenever a design element is locked or unlocked, and that other applications are not allowed to modify a design element while it is locked. For WebDAV clients that do not support locking (such as Windows™ Explorer), the Domino® Web Server will lock design elements on the client's behalf prior to making any updates, then unlock the design element after the update is complete. In addition, methods that return information about an unlocked design element on a database that has design note locking enabled (for example -- GET, HEAD, and PROPFIND) will replicate the design note with the master lock database if necessary before returning any data. This minimizes the chances of lost updates or replication conflicts when using WebDAV clients that do not support locking.

HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in Domino Designer 14?
  The following features are new for developers in HCL Domino® Designer 14.
- What's new in Nomad Designer?
  HCL Nomad for web browsers v1.0.10 introduces the capability to design Notes databases. For more information, see HCL Nomad for web browsers User Documentation, Nomad web Designer.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
  - Introduction to Domino® Designer
    Welcome to Domino® Designer. Domino Designer is an integrated application development environment that lets developers and Web site designers create, manage, and deploy secure, interactive applications.
  - Planning an application
    Before you begin any design work, create a plan for how users will access and use your application. At the minimum, your application plan should address these questions:
  - Creating an application
    All Domino® applications begin with a Domino database. Domino databases are the containers for your application. Databases hold the data, logic, and design elements for your application. Your Domino application can be made up of one or more Domino databases.
  - Designing pages
    Pages and forms are similar in certain ways. A page is a database design element that displays information. Pages can be used anywhere in your application that you have text, graphics, or an embedded control, such as an outline, to present to the user. A page or form can contain the following:
  - Designing forms
    Forms, like pages, display information. Everything that can be done with a page can be done with a form. What sets forms apart from pages is that forms can be used to collect information. A form provides the structure for creating and displaying documents, and documents are the design elements that store data in the database. When a user fills out the information in a form and saves it, the information is saved as a document. When a user opens the document, the document uses the form as a template to provide the structure for displaying the data.
  - Designing fields
    A field is the part of an application that collects data. You create fields on forms, subforms, or in layout regions. Each field stores a single type of information. A field's field type defines the kind of information a field accepts, such as text, numbers, dates, or names. When a user, either in a Notes® client or a Web browser, creates a form, fills out the information in the fields, and saves the form, the data in the fields is stored in an individual document. The contents of the fields can then be displayed in documents and views or can be retrieved for use in formulas. A field can be used on a single form, or you can create shared fields for use in multiple forms in a database.
  - Designing framesets
    A frameset is a collection of frames and can add structure to your Web site or Notes® database. A frame is one section, or pane, of the larger frameset window and is independently scrollable.
  - Designing views
  - Designing navigation for an application
    You can use the following navigational tools in your application:
  - Adding automation to applications
    Automation in an application speeds up repetitive tasks, handles workflow, updates information, performs calculations, runs programs, and checks for errors.
  - Developing applications using third-party tools and WebDAV
    As you are developing an application, you may want to supplement the tools provided with Domino® Designer with tools of your own choosing. For example, you may have a favorite graphics editor you use to design images for your application, or you may have a favorite HTML editor that you want to use to design pages. You launch and use third-party tools from within Designer.
    - Editing and managing database resources using a WebDAV client
      The Domino® Web server supports Web-based Distributed Authoring and Versioning (WebDAV), a technology that allows users with Designer access to a database to edit or move items in the design collection of a database without using a Domino Designer client. For example, you may build a page using a favorite HTML editor. Using Windows™ Explorer, you can drag that page into an NSF file for inclusion in a Domino application. Similarly, an application designer collaborating on a project might open an HTML page using the Internet Explorer 5.x, edit the page, and then place the page back into the database. WebDAV technology gives you much greater flexibility in the development process as you can use third-party tools and contribute to application design from remote Web clients.
    - Accessing database resources using a WebDAV client
      WebDAV uses a containment hierarchy -- much like a file system directory -- to organize files into groups called collections. A collection can contain other collections and/or files. In Domino®, this hierarchy is represented using the name of each design element (the value stored in the $TITLE field for each element) as the file name. For example, a graphic resource named images/logo.gif would appear in a WebDAV collection as a file named logo.gif in the root collection named images. In the Domino Designer client, collection elements appear in the Shared File Resources design list with a trailing slash appended to the name in the $TITLE field and an optional comment. Collection elements are file resource design elements with the additional design flag '/' in the $Flags field.
    - Using WebDAV in a replicated environment
      When WebDAV is used to modify the design of a database in a replicated environment, you should enable design note locking on the replicated databases and use WebDAV-enabled applications that support locking. Locking ensures that any changes are replicated to the master lock database on the administration server whenever a design element is locked or unlocked, and that other applications are not allowed to modify a design element while it is locked. For WebDAV clients that do not support locking (such as Windows™ Explorer), the Domino® Web Server will lock design elements on the client's behalf prior to making any updates, then unlock the design element after the update is complete. In addition, methods that return information about an unlocked design element on a database that has design note locking enabled (for example -- GET, HEAD, and PROPFIND) will replicate the design note with the master lock database if necessary before returning any data. This minimizes the chances of lost updates or replication conflicts when using WebDAV clients that do not support locking.
  - Connecting to enterprise data
    Incorporating back-end data into everyday business processes maximizes the value of a Domino® Designer application. Designer includes a range of technologies for the security and control of business processes, forms routing, and approvals management. With enterprise integration technologies, you can incorporate traditionally difficult-to-reach data into your business applications.
  - Including Java™ applets in applications
    Applets are self-contained Java™ programs that can run in your Domino® application. Java applets are often used to add animation to Web applications. Although Java applets are mostly used for Web applications, you can also include them in the following elements of a Domino application:
  - Including Java™ servlets in Web applications
    A servlet is a Java™ program that is run by the Domino® Web server in response to a browser request. Servlets provide a convenient way to add powerful functionality to your Web application. In some ways, servlets act like CGI programs, but they are more tightly integrated with the server and can take advantage of special Java classes. For example, a servlet may connect to a relational database or enterprise system and get data in response to a Web browser request.
  - Including XML in Designer applications
    Extensible Markup Language (XML) is a standard for creating markup languages that describe the structure and meaning of data in a document. XML separates the content of a document from its presentation and provides a common format for transferring data across the World Wide Web (WWW) or company intranet. The result is a technology that makes data available regardless of the proprietary systems involved.
  - Including OLE objects in applications
    Using Object Linking and Embedding (OLE) and OLE tools lets you extend the capability of Domino® Designer. OLE technology lets you integrate data from other applications, such as spreadsheets, graphics tools, and other data sources, into your application.
  - Creating a workflow application
    Workflow applications let you automate tasks. These tasks most often involve automatically sending mail messages or automatically routing documents, such as tracking orders and project plans to be reviewed. All projects need one or more people to complete a series of tasks and can benefit from workflow applications because they guide the project through these tasks automatically. Workflow applications reduce overhead and errors, speed processes, and track the status of a project. For example, a workflow application might automatically send a document in a publishing company from writer to editor to proofreader to production. At each stage, an individual is responsible for specific tasks related to that document. Once the task is complete, the workflow application ensures that the individuals responsible for the next task are notified and receive the data they need to execute their part of the project.
  - Domino® Designer templates
    The templates described in the following table are available with Domino® Designer and are specifically intended for use by application developers.
  - Importing to and exporting from views
  - Developing applications using MAPI
    Domino® Designer Release 6 and later supports the messaging application program interface (MAPI), which allows mail integration between Domino and a MAPI-compliant messaging application, such as Microsoft™ Outlook, Microsoft Office applications, or user-written C++ programs.
  - Features to avoid using in Web applications
    Developers creating applications specifically for the Web, or for the dual purpose of serving Notes® and Web clients, should review the following tables for features that are not supported on the Web.
  - URL commands for Web applications
    You have a variety of options for programming a Web site. You can directly manipulate objects such as documents or views in an application using Domino® URL commands. Adding Domino URL commands as HTML in forms gives users shortcuts for navigating databases and performing other tasks quickly.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino® Query Language (DQL) is a facility running on a Domino server that provides a terse, shorthand syntax for finding documents. It supports a wide variety and complexity of search terms. It leverages existing design elements, avoiding the need to write detailed code to access them. DQL consolidates all methods in Domino for searching document contents.
- Composite Applications - Design and Management
  Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
- Formula Language
  This section documents the formula language.
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
- LotusScript/COM/OLE Classes
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
- Connectors
  Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.

Using WebDAV in a replicated environment

When WebDAV is used to modify the design of a database in a replicated environment, you should enable design note locking on the replicated databases and use WebDAV-enabled applications that support locking. Locking ensures that any changes are replicated to the master lock database on the administration server whenever a design element is locked or unlocked, and that other applications are not allowed to modify a design element while it is locked. For WebDAV clients that do not support locking (such as Windows™ Explorer), the Domino® Web Server will lock design elements on the client's behalf prior to making any updates, then unlock the design element after the update is complete. In addition, methods that return information about an unlocked design element on a database that has design note locking enabled (for example -- GET, HEAD, and PROPFIND) will replicate the design note with the master lock database if necessary before returning any data. This minimizes the chances of lost updates or replication conflicts when using WebDAV clients that do not support locking.

The down side of the protection provided by locking this is:

The administration server (also known as the "Master Lock" server) for the database must be available in order to do anything with WebDAV if design note locking is enabled. The administration server is specified on the Advanced panel of the database access control list.
Performance is significantly impacted for replicas that are not on the administration server. If you need to use a WebDAV client that does not support locking to perform operations on a large number of files (for example, using Windows™ Explorer to copy a collection of files into a database), you may want to temporarily disable design note locking, or set the administration server for the database to be the server on which the database resides, prior to performing the operation. When you have completed the operation, you can restore the original settings and then replicate the database with the master lock database and deal with any replication conflicts. Depending on the number of elements involved, this can be much more efficient than the multiple single note replications that the Domino® server would be required to do otherwise.