For general information, see "Domino URL Commands" in Designer help under "Application Design > URL commands for Web applications" in the Lotus Domino Designer Basic User Guide and Reference.


    http://myserver/foo.nsf/main.xsp?OpenXPage&par1=bar&par2=baz

    http://localhost/foo.nsf/main.xsp?OpenXPage&par1=bar&par2=baz

    notes://myserver/foo.nsf/main.xsp?OpenXPage&par1=bar&par2=baz

    notes:foo.nsf/main.xsp?OpenXPage&par1=bar&par2=baz

Protocol

The first part of the syntax is the protocol: http to open the XPage on the Web; notes to open the XPage in Notes.

In Notes, you can use @URLOpen to send the URL command. For example, here is a view action that opens an XPage in Notes:

    @URLOpen(notes:/foo.nsf/main.xsp?OpenXPage)

You can also use LotusScript as illustrated below:

    Sub Click(Source As Button)
        Dim ws As New NotesUIWorkspace
        Call ws.URLOpen("notes:foo.nsf/main.xsp?OpenXPage")
    End Sub

Server

The second part of the syntax identifies the server. For local Web access, you can specify the server as localhost. For the local Notes client, omit the server name.

Application

The third part of the syntax identifies the application. Specify the full name of the application or its replica ID. Specify the file name of the application or its replica ID. A file name specification is relative to the Notes/Domino data directory. Include any subdirectories in the specification, for example, myfolder/foo.nsf or myfolder1/myfolder2/foo.nsf.

XPage

The fourth part of the syntax identifies the XPage. Use ".xsp" as the suffix for an XPage and ".component" for a component that is opening an XPage.

OpenXPage

This is the command name. It is preceded by a question mark. You should make this specification although you may get away without it depending on context.

Parameters

The parameters are optional and you can specify any number. The syntax for one parameter is an ampersand, the name of the parameter, an equals sign, and a string value.

On the XPage, you can use JavaScript to get the value of a parameter with the getUrlParameter method of XSPContext accessible through the context global variable. For example, this script returns the value of the parameter named par2.

    context.getUrlParameter("par2")

If there is no such parameter, this method returns an empty string.

The data source for the XPage automatically interprets the parameters listed below to set properties. You can suppress this by specifying true for ignoreRequestParams for the data source. Or you can set requestParamPrefix for the data source, for example, in case you have multiple data sources and want to avoid conflicts (a URL can drive multiple data sources at once).

 A document data source processes the following parameters:

• databaseName
• documentId
• parentId
• action

A view data source processes the following parameters:

• databaseName
• viewName
• search
• searchMaxDocs
• categoryFilter
• parentId
• sortColumn
• sortOrder
• expandLevel
• keys
• keysExactMatch