APPLICATION DESIGN


URL commands for opening servers, databases, and views
The following commands access servers, databases, views, "About This Database" documents, Help documents, and database icons. Databases must be in the notes\data directory or a subdirectory of the notes\data directory in order to be accessed by a URL command, except server commands such as ?Login, ?Logout, and ?Redirect. You may use the name of a database that does not exist in the server command syntax if a database is required, as it is with Microsoft Internet Information Server. If the database referenced in a server command does not exist, it will be ignored. Use ?Redirect to redirect doclinks across servers. Hidden design elements are hidden from the server too; you canft use IBMR LotusR Domino(TM) URL commands to access documents in hidden views.

Caution If the database property "Do Not Allow URL Open" is set, these URL commands are disabled.

Note The URLs shown below are for example only. They do not point to existing Web sites.

Redirect

Syntax

http://Server/Dummy.nsf?Redirect&Name=notesserver&Id=To=encodedurl

Where:


Example

http://mercury.com/dummy.nsf?Redirect&Name=Mister%2FHankey&Id=0525666D0060ABBF&To=%FAView%3FOpenView

Note If you force a logout using the ?Logout command, you can redirect to another Web site using the &RedirectTo parameter.

OpenDatabase

Syntax

http://Host/__DatabaseReplicaID.nsf?OpenDatabase

Examples

http://www.mercury.com/leads.nsf?OpenDatabase

http://www.mercury.com/sales/discussion.nsf?OpenDatabase

http://www.mercury.com/__852562F3007ABFD6.nsf?OpenDatabase

OpenView

Syntax

http://Host/Database/ViewName?OpenView

http://Host/Database/ViewUniversalID?OpenView

http://Host/Database/$defaultview?OpenView

Examples

http://www.mercury.com/leads.nsf/By+Salesperson?OpenView

http://www.mercury.com/leads.nsf/DDC087A8ACE170F8852562F300702264?OpenView

http://www.mercury.com/leads.nsf/$defaultview?OpenView

Optional arguments for OpenView

Append optional arguments to refine the URL. Combine any of the following arguments for the desired result except where otherwise noted.

Collapse=n


CollapseView
Count=n
Expand=n
ExpandView
RestrictToCategory=category
Start=n
StartKey=string
Examples

http://www.mercury.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?OpenView&CollapseView

http://www.mercury.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?OpenView&ExpandView

http://www.mercury.com/leads.nsf/By+Category?OpenView&RestrictToCategory=pricing

http://www.mercury.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?OpenView&Start=3&Count=15

http://www.mercury.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?OpenView&StartKey=F

ReadViewEntries

Use this command to access view data in XML form without appearance attributes such as fonts, list separators, date formats, HTML settings, view templates and frame redirections.

Note This command only returns the documents a user is allowed to access.

Syntax

http://Host/Database/ViewName?ReadViewEntries

http://Host/Database/ViewUniversalID?ReadViewEntries

http://Host/Database/$defaultview?ReadViewEntries

Examples

http://www.mercury.com/leads.nsf/By+Salesperson?ReadViewEntries

http://www.mercury.com/leads.nsf/DDC087A8ACE170F8852562F300702264?ReadViewEntries

http://www.mercury.com/leads.nsf/$defaultview?ReadViewEntries

Optional arguments for ReadViewEntries

Append optional arguments to refine the URL. Combine any of the following arguments for the desired result except where otherwise noted.

Collapse=n


CollapseView
Count=n
Endview=1
Expand=n
ExpandView
KeyType=text|time|number
NavigateReverse=1
Outputformat=JSON
PreFormat
ResortAscending=column number

ResortDecending=column number


RestrictToCategory=category
Start=n
StartKey=string
UntilKey=string
Examples

http://www.mercury.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?ReadViewEntries&CollapseView

http://www.mercury.com/leads.nsf/By+Category?ReadViewEntries&Endview=1&Count=3

http://www.mercury.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?ReadViewEntries&ExpandView

http://www.mercury.com/leads.nsf/By+Category?ReadViewEntries&NavigateReverse=1&Start=50

http://www.mercury.com/leads.nsf/By+Category?ReadViewEntries&outputformat=JSON

http://www.mercury.com/leads.nsf/By+Category?ReadViewEntries&PreFormat

http://www.mercury.com/leads.nsf/By+Category?ReadViewEntries&RestrictToCategory=pricing

http://www.mercury.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?ReadViewEntries&Start=3&Count=15

http://www.mercury.com/leads.nsf/DDC087A8ACE170F8852562F30070226400000196?ReadViewEntries&StartKey=F

http://www.mercury.com/leads.nsf/By+Department?ReadViewEntries&StartKey=312&KeyType=number

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

See Also