Linking to Hyperview in a Browser pages from other applications

Linking to Hyperview in a Browser pages from other applications

It is possible to link to Hyperview "web pages" from outside Hyperview in a browser. For example, you could put links into an email or document, or provide them to some other application which could then launch a web browser to show the specified link.

There are two ways to make a URL for doing this:

  1. Use a bookmark URL
  2. Use a "command line" URL

Link to Hyperview web page with a bookmark URL

You can bookmark any document displayed in the Hyperview web application. Use the Bookmarks option in the side menu to create a bookmark. Once you have the bookmark, select it in the bookmarks list and press the Show in Tab button. A new tab will be opened with a "bookmark" URL. You can use this URL in links in the same network context as Hyperview in a Browser. This is probably most useful if the Hyperview Service is configured to not require user login. See the No Login Required option when a Hyperview Service is configured.

The URL generated in this manner will look something like this:

http://computer:8000/hyperview?cmd=bmk&toc=dbdoc%3A%2F%2Fchapter%2FCONDNTCHP%2F%2F%2Feliot%2Fclient-data%2FI90demo%2520new%2FSample&topic=dbdoc%3A%2F%2Ffile%2F%2F%2Feliot%2Fclient-data%2FI90demo%2520new%2FSample%2FBLOWER_1_OVERVIEW.m1

This approach will work for most purposes, but if there are URL length limitations in your context, the "command line" approach will result in much shorter (but potentially non-unique) URLs. This approach also bookmarks both the index and the content panes.

Link to Hyperview web page with a "command line" URL

You can also build a link with the following format:

http://computer:8000/hyperview?cmd=cmdline&doc=DOCNAME

where DOCNAME is the name of the document you want to bookmark. The name of the document can be found in the title bar, after the colon ":". Be careful if your document name happens to contain a colon -- this is fine, but might make it unclear which colon to use as the separator.

Hyperview title.PNG

Hyperview doc title.PNG


In this example, the link would look like

http://computer:8000/hyperview?cmd=cmdline&doc=BLOWER_1_ALARMS.m1

It is only necessary to include enough of the document name to make it unique in the context of your project, so, most likely the following would also be fine:

http://computer:8000/hyperview?cmd=cmdline&doc=BLOWER_1_ALARMS

If the specified DOCNAME does not match the start of an existing document name uniquely, the first match will be displayed. If the specified DOCNAME has a space, or other problematic character, you need to escape it with URL encoding. For example, " " (space) would become "%20".

Some of the same options are available to specify display of documents in a web browser as via the command line for the desktop Hyperview application. For example, you could bring up a tag database page with

http://computer:8000/hyperview?cmd=cmdline&tag=TAGNAME

The supported cmd=cmdline options are tag, block, doc, and type'. The type option is used (optionally) in conjunction with the doc option.

See Launching Hyperview from the command line for full documentation about the options available.


See Also