Using Domino URL Syntax

Domino URL commands enable designers to manipulate objects, such as forms or images, directly. Designers can provide navigational elements by adding URL commands as HTML on the form or button.

Domino URL syntax is as follows:

http://Host/Database/DominoObject?Action&Arguments

Table 16.4 explains URL syntax by listing its parameters and their descriptions.

Table 16.4. URL Syntax
ParameterDescription
HostAdd DNS entry or IP address to identify the server. Do not use the server's name.
DatabaseDatabase in which DominoObject resides. If opening a database, the syntax would be

http://Host/Database.nsf?OpenDatabase

Database can be identified:

By its filename or

By its replica ID, preceded with a double underscore and appended with .nsf.
DominoObjectObject being accessed, such as a form, document, view, navigator, agent, image, and so on. DominoObject can be identified by the object's name, universal ID, or special identifier ($defaultView refers to the default view designated in database).
ActionOperation for specific DominoObject. Example: ?OpenDatabase, ?OpenView, ?OpenDocument, ?EditDocument. Explicit actions are ?OpenDocument or ?EditDocument. Implicit actions are ?Open or ?Edit. If an action is not specified, the default is ?Open.
ArgumentsQualifier to the Action. &count=5 with ?OpenView, for example, limits rows displayed. &Login attached with ?OpenDatabase forces authentication.
Special IdentifiersIdentifies such things as default views and forms with $defaultView or $defaultForm. Some others are $searchForm, $file, $icon, $help, $about, and $first.

URLs cannot contain spaces, so designers need to replace spaces with a plus (+) symbol or the hex ASCII equivalent (%20). You must use the Hex ASCII equivalent if a symbol conflicts with the URL syntax. For example, imagine that a view named Sales&Commission is used in an URL. The Ampersand (&) symbol conflicts with the &Arguments and must be replaced with the HEX ASCII equivalent. Ampersands (&) use %26 and forward slashes use %2F.

To attach URLs to a button or a hotspot Click event, first select the Use JavaScript When Generating Pages option in the Database Properties. If this option isn't checked, the URL will be computed when rendered to the Web.

Table 16.5 shows some examples of DominoObjects and their URLs.

Table 16.5. URL Examples
DominoObjectURL
Attachmentshttp://Host/Database/View/Document$File/InternalFileName?OpenElement
Databasehttp://Host/__DatabaseReplicaID.nsf?OpenDatabase
Viewhttp://Host/Database/ViewName?OpenView
DefaultViewhttp://Host/Database/$defaultview?OpenView
View data in XML form without attributesThis command returns only the documents a user is allowed to access. http://Host/Database/ViewName?
About This Databasehttp://Host/Database/$about?OpenAbout
Using This Databasehttp://Host/Database/$help?OpenHelp
Access Database Iconhttp://Host/Database/$icon?OpenIcon
FrameSethttp://Host/Database/FramesetName?OpenFrameset
Agentshttp://Host/Database/AgentName?OpenAgent
Form

Default Form

Read Form
http://Host/Database/FormName?OpenForm

http://Host/Database/$defaultform?OpenForm

http://Host/Database/FormName?ReadForm
Navigator Default Navigatorhttp://Host/Database/NavigatorName?OpenNavigator

http://host/database.nsf/$DefaultNav?OpenNavigator

The above displays all non-hidden views to the Web. Enclose View Names in parens to block this.
Pageshttp://Host/Database/PageName?OpenPage
Documenthttp://Host/Database/FormName?CreateDocument

http://Host/Database/View/Document?OpenDocument

http://Host/Database/View/Document?EditDocument

http://Host/Database/View/Document?DeleteDocument

http://Host/Database/View/Document?SaveDocument
SearchViewLimits search to one database view. http://Host/Database/ViewName/[$SearchForm]? SearchView[ArgumentList]
Image Resourceshttp://Host/Database/ ImageResourceName?OpenImageResource
File Resourceshttp://Host/Database/ FileResourceName?OpenFileResource
Web Preferenceshttp://Host/$Preferences.nsf?OpenPreferences&Argument Allows users to set time zone and regional settings such as date/time formats. These settings are stored in a cookie in the user's browser. Web preferences need to be enabled through Internet Site documents. $Preferences.nsf is a virtual database that resides at the root of the Domino 6 server.

Designers can also restrict users from opening forms or views with URL commands by setting the Don't Allow URL Open property in the Basics tab of the Database.

..................Content has been hidden....................

You can't read the all page of ebook, please click here login for view all page.
Reset
18.191.236.255