Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

With ViaWorks (now Locator) 2.4, the search results templates were changed. Any custom templates developed for ViaWorks 2.3.x or earlier are not compatible with the ViaWorks 2.4 templates.

 


In ViaWorks 2.3.x and earlier, the templates were based on source types (e.g. SharePoint, Exchange, etc).  Starting with ViaWorks 2.4, templates are based on the item type: Appointment, Contact, Email, File. 


There are two templates for each type:

  • Item - controls what is presented for the individual search result
  • Hover - controls what is presented in the hover panel, which contains the preview
 


For ViaWorks Versions 2.4.x - 2.5.x

The default templates are saved in:

Program Files\VirtualWorks\ViaWorks\RestService\Resources\TemplatesV3\Item
 Program Files\VirtualWorks\ViaWorks\RestService\Resources\TemplatesV3\Hover

 


To override the default templates, place the new HTML template file in:

 Program Files\VirtualWorks\ViaWorks\RestService\Custom\Resources\TemplatesV3\Item
 Program Files\VirtualWorks\ViaWorks\RestService\Custom\Resources\TemplatesV3\Hover

 


You will need to create the folder structure under the "Program Files\VirtualWorks\ViaWorks\RestService\Custom" folder. Templates placed in the Custom folder take precedence over the default templates and are not modified during a ViaWorks upgrade. 


For ViaWorks and Locator Version 2.6 or newer

The default templates are saved in:

 Program Files\VirtualWorks\ViaWorks\RestService\Resources\Themes\Standard\Templates\Item
 Program Files\VirtualWorks\ViaWorks\RestService\Resources\Themes\Standard\Templates\Hover

To override the default templates, place the new HTML template file in:

 Program Files\VirtualWorks\ViaWorks\RestService\Custom\Resources\Templates\Item
 Program Files\VirtualWorks\ViaWorks\RestService\Custom\Resources\Templates\Hover

...or in a theme specific folder:

 Program Files\VirtualWorks\ViaWorks\RestService\Custom\Resources\Themes\Standard\Templates\Item
 Program Files\VirtualWorks\ViaWorks\RestService\Custom\Resources\Themes\Standard\Templates\Hover

 Note: In ViaWorks 2.6, "Standard" is the only existing theme.  The "Simple" theme, which was available with ViaWorks versions 2.5.9336 - 2.5.9517, has been removed.

You will need to create the folder structure under the "Program Files\VirtualWorks\ViaWorks\RestService\Custom" folder. Templates placed in the Custom folder take precedence over the default templates and are not modified during a ViaWorks upgrade.

If you are upgrading to ViaWorks 2.6 from a 2.4.x or a 2.5.x release, and have previously placed new HTML files in the locations below to override the default templates, they will remain active after the upgrade
:

 Program Files\VirtualWorks\ViaWorks\RestService\Custom\Resources\TemplatesV3\Item
 Program Files\VirtualWorks\ViaWorks\RestService\Custom\Resources\TemplatesV3\Hover

...