Manage Viewer Templates

The Post Installer provides a number of functions to add and manage viewer templates. When you install a viewer template, the management functions become available in the list of installed templates. To show the management functions for a particular template, click the template.

Location of the buttons to manage a viewer template

The management functions are:

Install a Viewer Template

Viewers are applications that end users use to view your maps and related GIS resources—in other words, to view your Essentials sites.

A viewer template is a file that packages the application files that make up the viewer framework. This includes the Management Pack, which integrates the viewer framework with Manager. Installing the Management Pack enables you to use Manager to add viewers to your sites and configure the viewers you have added. The file extension for template files is .vte.

You only need to install the template once in an instance of Essentials, and then you can add as many viewers of that type as you want, to as many sites as you want. You use the Post Installer to install viewer templates.

Before you begin, download the installation packages for the viewer frameworks from the Geocortex Support Center. For instructions, see Download Geocortex Essentials.

To install a viewer template:

  1. In the Post Installer, click Configure Viewer Templates in the side panel.

  2. Click Add.

  3. Browse to the template (.vte) file, and then click Open.

    You are prompted to install the Management Pack.

  4. To install the Management Pack, click Yes.

    If you click No, you can install the Management Pack later, after you have installed the template. See Deploy a Viewer's Management Pack for instructions.

    A prompt asks you if you want to deploy the viewer application to IIS. 

  5. To deploy the viewer application to IIS, click Yes.

    If you click No, you can deploy the template later, after you have installed the template. See Deploy a Viewer Template to IIS for instructions.

    The Deploy Template to an IIS Virtual Directory dialog box opens.

  6. If you want to deploy the viewer to a website that does not exist yet, create the site in IIS.

  7. In the Select Web Site box, select the website you want to deploy the viewer to.

  8. In the Select Virtual Directory box, type a name or path for the virtual directory where you want the viewer to be deployed.

    The virtual directory must not already exist—Essentials will create the web folder needed to deploy the viewer.

  9. If you want to be able to launch your viewers from Manager, make sure the Register URL with Manager checkbox is selected.

    If you clear the Register URL with Manager checkbox, the launch links do not appear in Manager, but you can still add and configure viewers in Manager.

    For the HTML5 viewer, the URL you register with Manager must have the same domain as Manager. The viewer cannot launch or load configuration from a different domain.

  10. If the URL beside the checkbox is not fully qualified, replace it with the fully qualified URL.

    A fully qualified URL specifies the host and domain, for example, host.domain.com. A URL that omits the domain is not fully qualified.

    Geocortex Essentials 3.11.1 and later versions provide the fully qualified URL by default.

  11. Click Deploy.

    A success message displays.

  12. Click OK.

    The viewer is listed in the Installed Templates area of the Configure Templates panel.

    To remove a template from the list, select it from the list of templates and click Remove. This does not remove the viewer framework from Manager, nor does it remove virtual directories from IIS.

  13. Click Finish.

    You have now installed the viewer template.

Deploy a Viewer Template to IIS

Deploying a viewer template creates the IIS web components that the viewer requires. It also allows you to use Essentials to upgrade your viewers. If you did not deploy a viewer template to IIS when you installed the template, you can deploy it at any time later.

To deploy a template to an IIS virtual directory:

  1. In the Post Installer, click Configure Templates in the side panel.

  2. Click the template that you want to deploy.

    Clicking the template in the list reveals buttons that you can use to manage the template.

  3. Click Deploy Template to IIS.

    The Deploy Template to an IIS Virtual Directory dialog box opens.

  4. If you want to deploy the viewer to a website that does not exist yet, create and configure the website in IIS.

  5. In the Select Web Site box, select the website you want to deploy the viewer to.

  6. In the Select Virtual Directory box, type a name or path for the virtual directory where you want the viewer to be deployed.

    The virtual directory must not already exist—Essentials will create the web folders needed to deploy the viewer.

  7. If you want to be able to launch your viewers from Manager, make sure the Register URL with Manager checkbox is selected.

    If you clear the Register URL with Manager checkbox, the launch links do not appear in Essentials, but you can still add and configure viewers in Manager.

    For the HTML5 viewer, the URL you register with Manager must have the same domain as Manager—the viewer cannot launch or load configuration from a different domain.

  8. If the URL beside the checkbox is not fully qualified, replace it with the fully qualified URL.

    A fully qualified URL specifies the host and domain, for example, host.domain.com. A URL that omits the domain is not fully qualified.

    Geocortex Essentials 3.11.1 and later versions provide the fully qualified URL by default.

  9. Click Deploy.

    A success message displays.

  10. Click OK.

  11. Click Finish.

    You have now deployed the viewer template to IIS.

Deploy a Viewer's Management Pack

Deploying a viewer's Management Pack integrates the viewer configuration with Geocortex Essentials Manager, so you can use Manager to configure the viewer. If you did not deploy the Management Pack when you installed the viewer template, you can deploy it at any time later.

To deploy a viewer's management Pack:

  1. In the Post Installer, click Configure Templates in the side panel.

  2. Click the template that you want to deploy.

    Clicking the template in the list reveals buttons that you can use to manage the template.

  3. Click Deploy Management Pack.

    A success message displays.

  4. Click OK.

  5. Click Finish.

    You have now deployed the viewer's Management Pack.

© 2019 Latitude Geographics Group Ltd. All Rights Reserved.

Documentation Version 4.11