Creating URLs to access the web clients

In the web client, forms are accessed using URLs. These URLs can be constructed with a base URL and optional URL parameters. In some cases, you can bypass the normal URL and construct a URL that does not require the user to log in by bypassing the Sign In page.

The base URL

The URLs used to access forms must adhere to a specific format. The base format is:

http(s)://webserver/wswebclient/default.aspx

where webserver is the name of the web server on which the web client software resides.

Note: The only two URLs/pages that intended for direct access are "default.aspx" and "mobile.aspx". You should use the latter page when designing or accessing a mobile app. Use the default.aspx for all other direct access.

Use URL parameters to specify what happens when the web client is accessed.

Bypassing the Sign In page

In some cases, you might want your users to be able to log in to a particular form in your application without having to sign in. You can do this with a URL formatted like this:

http://webserver/WSWebClient/session/open/configname/username/password

where:

  • webserver is the name of the web server on which the web client software resides.
  • configname is the name of the configuration the user is authorized to use.
  • username is the Mongoose user ID of the user.
  • password is the user password for the Mongoose user.

You can also append URL parameters to this URL format.

Going directly to the Web Designer page

If you want to go directly to the Web Designer for form/application work, without having to first launch the main (default.aspx) page, use a base URL similar to this:

http://webserver/WSWebClient/designer/

where webserver is the name of the web server on which the web client software resides.

You can combine this with /session/open.

You can also append URL parameters to this URL format.

URL parameters

To the base URL, you can add any of a number of URL parameters that control what happens when the web client opens. To append these parameters to the base URL:

  • Add a question mark immediately at the end of the base URL.
  • Specify one or more parameters without spaces.
  • Separate multiple parameters with ampersand symbols (&).

Parameters need not appear in any particular order for the system to use them.

URL parameters for web client access generally fall into one of two categories:

  • Parameters for general use - These are parameters that are available for anyone's use in configuring a URL for Mongoose web client access.
  • Parameters for specialized use - These parameters are designed to be used in specialized cases; for example, for integration with external applications.
Related topics