Customizing the virtual viewer by using HTML parameters

You can use HTML parameters to configure and customize the viewer.

Before you begin

You can review HTML parameters in the HTML API reference section.

About this task

Use the following format for adding a parameter to the HTML file that loads the viewer:

<param name="name1" value="value1" />

Replace name1 with the parameter name and value1 with the parameter value.

Use the internet URL address format to specify file names and hyperlink addresses, for example http://mysite/myimage.tif. If you provide a relative location, for example, myimage.tif, the viewer assumes a base address that is the same as the viewer location (the codebase).

Except for file names and hyperlink addresses, all parameters are not case-sensitive.

Checking your parameters

If you are unsure whether IBM Daeja ViewONE processed any of your parameters correctly, or are having problems with a particular parameter, you can check the actual list of processed parameters. See Step 5.

Let this check be your first check after you add a parameter. If you find that the parameter fails to do what is expected, always check that it was processed correctly before you take the next step.

Procedure

To add HTML parameters:

  1. Use a text editor to open the HTML file that loads the viewer.
  2. Add the parameters and values.
  3. Save your changes.
  4. Restart the web application server.

To access the list of processed parameters in the viewer and check they were processed correctly:

  1. Start IBM Daeja ViewONE by going to your web page that contains the viewer.
  2. Click in the center of the viewer and then press Shift+T.
  3. Review the list.
    If a parameter that you specified in your HTML does not appear in the list that is provided by this check, then this check indicates that there is either a syntax error in the inclusion of the parameter name in the HTML, or there is a deployment issue.